All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.facebook.ads.sdk.AdsUserSettings Maven / Gradle / Ivy

Go to download

Facebook Business Solutions SDK for Java

There is a newer version: 21.0.2
Show newest version
/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * This source code is licensed under the license found in the
 * LICENSE file in the root directory of this source tree.
 */

package com.facebook.ads.sdk;

import java.io.File;
import java.lang.reflect.Modifier;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.google.common.base.Function;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.common.util.concurrent.SettableFuture;
import com.google.gson.JsonObject;
import com.google.gson.JsonArray;
import com.google.gson.annotations.SerializedName;
import com.google.gson.reflect.TypeToken;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;

import com.facebook.ads.sdk.APIException.MalformedResponseException;

/**
 * This class is auto-generated.
 *
 * For any issues or feature requests related to this class, please let us know
 * on github and we'll fix in our codegen framework. We'll not be able to accept
 * pull request for this class.
 *
 */
public class AdsUserSettings extends APINode {
  @SerializedName("a_plus_c_survey_seen")
  private Boolean mAPlusCSurveySeen = null;
  @SerializedName("adgroup_name_template")
  private Object mAdgroupNameTemplate = null;
  @SerializedName("ads_cs_catalog_opt_out_timestamp")
  private List> mAdsCsCatalogOptOutTimestamp = null;
  @SerializedName("ads_tool_visits")
  private List mAdsToolVisits = null;
  @SerializedName("aplusc_carousel_cda_opt_in_status")
  private String mApluscCarouselCdaOptInStatus = null;
  @SerializedName("aplusc_carousel_inline_comment_opt_in_status")
  private String mApluscCarouselInlineCommentOptInStatus = null;
  @SerializedName("aplusc_epa_opt_in_status")
  private String mApluscEpaOptInStatus = null;
  @SerializedName("aplusc_opt_out_friction")
  private List mApluscOptOutFriction = null;
  @SerializedName("autoflow_lite_opt_in_status")
  private String mAutoflowLiteOptInStatus = null;
  @SerializedName("autoflow_lite_should_opt_in")
  private Boolean mAutoflowLiteShouldOptIn = null;
  @SerializedName("blended_ads_creation_defaulting_opt_in_status")
  private String mBlendedAdsCreationDefaultingOptInStatus = null;
  @SerializedName("blended_ads_creation_defaulting_opt_out_campaign_group_ids")
  private List mBlendedAdsCreationDefaultingOptOutCampaignGroupIds = null;
  @SerializedName("bookmarked_pages")
  private List mBookmarkedPages = null;
  @SerializedName("campaign_group_name_template")
  private Object mCampaignGroupNameTemplate = null;
  @SerializedName("campaign_name_template")
  private Object mCampaignNameTemplate = null;
  @SerializedName("carousel_to_video_opt_in_status")
  private String mCarouselToVideoOptInStatus = null;
  @SerializedName("connected_sources_catalog_opt_in_status")
  private String mConnectedSourcesCatalogOptInStatus = null;
  @SerializedName("default_creation_mode")
  private String mDefaultCreationMode = null;
  @SerializedName("export_format_default")
  private String mExportFormatDefault = null;
  @SerializedName("focus_mode_default")
  private String mFocusModeDefault = null;
  @SerializedName("gen_ai_alpha_test_status")
  private Long mGenAiAlphaTestStatus = null;
  @SerializedName("id")
  private String mId = null;
  @SerializedName("image_expansion_opt_in_status")
  private String mImageExpansionOptInStatus = null;
  @SerializedName("is_ads_ai_consented")
  private Boolean mIsAdsAiConsented = null;
  @SerializedName("is_cbo_default_on")
  private Boolean mIsCboDefaultOn = null;
  @SerializedName("is_se_removal_guidance_dismissed")
  private Boolean mIsSeRemovalGuidanceDismissed = null;
  @SerializedName("last_used_post_format")
  private String mLastUsedPostFormat = null;
  @SerializedName("last_visited_time")
  private String mLastVisitedTime = null;
  @SerializedName("music_on_reels_opt_in")
  private List> mMusicOnReelsOptIn = null;
  @SerializedName("muted_cbo_midflight_education_messages")
  private List mMutedCboMidflightEducationMessages = null;
  @SerializedName("onsite_destination_optimization_opt_in")
  private String mOnsiteDestinationOptimizationOptIn = null;
  @SerializedName("open_tabs")
  private List mOpenTabs = null;
  @SerializedName("previously_seen_recommendations")
  private List mPreviouslySeenRecommendations = null;
  @SerializedName("product_extensions_opt_in")
  private String mProductExtensionsOptIn = null;
  @SerializedName("selected_ad_account")
  private AdAccount mSelectedAdAccount = null;
  @SerializedName("selected_comparison_timerange")
  private Object mSelectedComparisonTimerange = null;
  @SerializedName("selected_metric_cic")
  private String mSelectedMetricCic = null;
  @SerializedName("selected_metrics_cic")
  private List mSelectedMetricsCic = null;
  @SerializedName("selected_page")
  private Page mSelectedPage = null;
  @SerializedName("selected_page_section")
  private String mSelectedPageSection = null;
  @SerializedName("selected_power_editor_pane")
  private String mSelectedPowerEditorPane = null;
  @SerializedName("selected_stat_range")
  private Object mSelectedStatRange = null;
  @SerializedName("should_export_filter_empty_cols")
  private String mShouldExportFilterEmptyCols = null;
  @SerializedName("should_export_rows_without_unsupported_feature")
  private String mShouldExportRowsWithoutUnsupportedFeature = null;
  @SerializedName("should_not_auto_expand_tree_table")
  private Boolean mShouldNotAutoExpandTreeTable = null;
  @SerializedName("should_not_show_cbo_campaign_toggle_off_confirmation_message")
  private Boolean mShouldNotShowCboCampaignToggleOffConfirmationMessage = null;
  @SerializedName("should_not_show_publish_message_on_editor_close")
  private Boolean mShouldNotShowPublishMessageOnEditorClose = null;
  @SerializedName("show_original_videos_opt_in")
  private String mShowOriginalVideosOptIn = null;
  @SerializedName("static_ad_product_extensions_opt_in")
  private String mStaticAdProductExtensionsOptIn = null;
  @SerializedName("sticky_setting_after_default_on")
  private String mStickySettingAfterDefaultOn = null;
  @SerializedName("syd_campaign_trends_metric")
  private String mSydCampaignTrendsMetric = null;
  @SerializedName("total_coupon_syd_dismissals")
  private Long mTotalCouponSydDismissals = null;
  @SerializedName("total_coupon_upsell_dismissals")
  private Long mTotalCouponUpsellDismissals = null;
  @SerializedName("url_prefill_removal_timestamp")
  private Long mUrlPrefillRemovalTimestamp = null;
  @SerializedName("use_pe_create_flow")
  private Boolean mUsePeCreateFlow = null;
  @SerializedName("use_stepper_primary_entry")
  private Boolean mUseStepperPrimaryEntry = null;
  @SerializedName("user")
  private User mUser = null;
  protected static Gson gson = null;

  AdsUserSettings() {
  }

  public AdsUserSettings(Long id, APIContext context) {
    this(id.toString(), context);
  }

  public AdsUserSettings(String id, APIContext context) {
    this.mId = id;

    this.context = context;
  }

  public AdsUserSettings fetch() throws APIException{
    AdsUserSettings newInstance = fetchById(this.getPrefixedId().toString(), this.context);
    this.copyFrom(newInstance);
    return this;
  }

  public static AdsUserSettings fetchById(Long id, APIContext context) throws APIException {
    return fetchById(id.toString(), context);
  }

  public static ListenableFuture fetchByIdAsync(Long id, APIContext context) throws APIException {
    return fetchByIdAsync(id.toString(), context);
  }

  public static AdsUserSettings fetchById(String id, APIContext context) throws APIException {
    return
      new APIRequestGet(id, context)
      .requestAllFields()
      .execute();
  }

  public static ListenableFuture fetchByIdAsync(String id, APIContext context) throws APIException {
    return
      new APIRequestGet(id, context)
      .requestAllFields()
      .executeAsync();
  }

  public static APINodeList fetchByIds(List ids, List fields, APIContext context) throws APIException {
    return (APINodeList)(
      new APIRequest(context, "", "/", "GET", AdsUserSettings.getParser())
        .setParam("ids", APIRequest.joinStringList(ids))
        .requestFields(fields)
        .execute()
    );
  }

  public static ListenableFuture> fetchByIdsAsync(List ids, List fields, APIContext context) throws APIException {
    return
      new APIRequest(context, "", "/", "GET", AdsUserSettings.getParser())
        .setParam("ids", APIRequest.joinStringList(ids))
        .requestFields(fields)
        .executeAsyncBase();
  }

  private String getPrefixedId() {
    return getId();
  }

  public String getId() {
    return getFieldId().toString();
  }
  public static AdsUserSettings loadJSON(String json, APIContext context, String header) {
    AdsUserSettings adsUserSettings = getGson().fromJson(json, AdsUserSettings.class);
    if (context.isDebug()) {
      JsonParser parser = new JsonParser();
      JsonElement o1 = parser.parse(json);
      JsonElement o2 = parser.parse(adsUserSettings.toString());
      if (o1.getAsJsonObject().get("__fb_trace_id__") != null) {
        o2.getAsJsonObject().add("__fb_trace_id__", o1.getAsJsonObject().get("__fb_trace_id__"));
      }
      if (!o1.equals(o2)) {
        context.log("[Warning] When parsing response, object is not consistent with JSON:");
        context.log("[JSON]" + o1);
        context.log("[Object]" + o2);
      }
    }
    adsUserSettings.context = context;
    adsUserSettings.rawValue = json;
    adsUserSettings.header = header;
    return adsUserSettings;
  }

  public static APINodeList parseResponse(String json, APIContext context, APIRequest request, String header) throws MalformedResponseException {
    APINodeList adsUserSettingss = new APINodeList(request, json, header);
    JsonArray arr;
    JsonObject obj;
    JsonParser parser = new JsonParser();
    Exception exception = null;
    try{
      JsonElement result = parser.parse(json);
      if (result.isJsonArray()) {
        // First, check if it's a pure JSON Array
        arr = result.getAsJsonArray();
        for (int i = 0; i < arr.size(); i++) {
          adsUserSettingss.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
        };
        return adsUserSettingss;
      } else if (result.isJsonObject()) {
        obj = result.getAsJsonObject();
        if (obj.has("data")) {
          if (obj.has("paging")) {
            JsonObject paging = obj.get("paging").getAsJsonObject();
            if (paging.has("cursors")) {
                JsonObject cursors = paging.get("cursors").getAsJsonObject();
                String before = cursors.has("before") ? cursors.get("before").getAsString() : null;
                String after = cursors.has("after") ? cursors.get("after").getAsString() : null;
                adsUserSettingss.setCursors(before, after);
            }
            String previous = paging.has("previous") ? paging.get("previous").getAsString() : null;
            String next = paging.has("next") ? paging.get("next").getAsString() : null;
            adsUserSettingss.setPaging(previous, next);
            if (context.hasAppSecret()) {
              adsUserSettingss.setAppSecret(context.getAppSecretProof());
            }
          }
          if (obj.get("data").isJsonArray()) {
            // Second, check if it's a JSON array with "data"
            arr = obj.get("data").getAsJsonArray();
            for (int i = 0; i < arr.size(); i++) {
              adsUserSettingss.add(loadJSON(arr.get(i).getAsJsonObject().toString(), context, header));
            };
          } else if (obj.get("data").isJsonObject()) {
            // Third, check if it's a JSON object with "data"
            obj = obj.get("data").getAsJsonObject();
            boolean isRedownload = false;
            for (String s : new String[]{"campaigns", "adsets", "ads"}) {
              if (obj.has(s)) {
                isRedownload = true;
                obj = obj.getAsJsonObject(s);
                for (Map.Entry entry : obj.entrySet()) {
                  adsUserSettingss.add(loadJSON(entry.getValue().toString(), context, header));
                }
                break;
              }
            }
            if (!isRedownload) {
              adsUserSettingss.add(loadJSON(obj.toString(), context, header));
            }
          }
          return adsUserSettingss;
        } else if (obj.has("images")) {
          // Fourth, check if it's a map of image objects
          obj = obj.get("images").getAsJsonObject();
          for (Map.Entry entry : obj.entrySet()) {
              adsUserSettingss.add(loadJSON(entry.getValue().toString(), context, header));
          }
          return adsUserSettingss;
        } else {
          // Fifth, check if it's an array of objects indexed by id
          boolean isIdIndexedArray = true;
          for (Map.Entry entry : obj.entrySet()) {
            String key = (String) entry.getKey();
            if (key.equals("__fb_trace_id__")) {
              continue;
            }
            JsonElement value = (JsonElement) entry.getValue();
            if (
              value != null &&
              value.isJsonObject() &&
              value.getAsJsonObject().has("id") &&
              value.getAsJsonObject().get("id") != null &&
              value.getAsJsonObject().get("id").getAsString().equals(key)
            ) {
              adsUserSettingss.add(loadJSON(value.toString(), context, header));
            } else {
              isIdIndexedArray = false;
              break;
            }
          }
          if (isIdIndexedArray) {
            return adsUserSettingss;
          }

          // Sixth, check if it's pure JsonObject
          adsUserSettingss.clear();
          adsUserSettingss.add(loadJSON(json, context, header));
          return adsUserSettingss;
        }
      }
    } catch (Exception e) {
      exception = e;
    }
    throw new MalformedResponseException(
      "Invalid response string: " + json,
      exception
    );
  }

  @Override
  public APIContext getContext() {
    return context;
  }

  @Override
  public void setContext(APIContext context) {
    this.context = context;
  }

  @Override
  public String toString() {
    return getGson().toJson(this);
  }

  public APIRequestGet get() {
    return new APIRequestGet(this.getPrefixedId().toString(), context);
  }


  public Boolean getFieldAPlusCSurveySeen() {
    return mAPlusCSurveySeen;
  }

  public Object getFieldAdgroupNameTemplate() {
    return mAdgroupNameTemplate;
  }

  public List> getFieldAdsCsCatalogOptOutTimestamp() {
    return mAdsCsCatalogOptOutTimestamp;
  }

  public List getFieldAdsToolVisits() {
    return mAdsToolVisits;
  }

  public String getFieldApluscCarouselCdaOptInStatus() {
    return mApluscCarouselCdaOptInStatus;
  }

  public String getFieldApluscCarouselInlineCommentOptInStatus() {
    return mApluscCarouselInlineCommentOptInStatus;
  }

  public String getFieldApluscEpaOptInStatus() {
    return mApluscEpaOptInStatus;
  }

  public List getFieldApluscOptOutFriction() {
    return mApluscOptOutFriction;
  }

  public String getFieldAutoflowLiteOptInStatus() {
    return mAutoflowLiteOptInStatus;
  }

  public Boolean getFieldAutoflowLiteShouldOptIn() {
    return mAutoflowLiteShouldOptIn;
  }

  public String getFieldBlendedAdsCreationDefaultingOptInStatus() {
    return mBlendedAdsCreationDefaultingOptInStatus;
  }

  public List getFieldBlendedAdsCreationDefaultingOptOutCampaignGroupIds() {
    return mBlendedAdsCreationDefaultingOptOutCampaignGroupIds;
  }

  public List getFieldBookmarkedPages() {
    return mBookmarkedPages;
  }

  public Object getFieldCampaignGroupNameTemplate() {
    return mCampaignGroupNameTemplate;
  }

  public Object getFieldCampaignNameTemplate() {
    return mCampaignNameTemplate;
  }

  public String getFieldCarouselToVideoOptInStatus() {
    return mCarouselToVideoOptInStatus;
  }

  public String getFieldConnectedSourcesCatalogOptInStatus() {
    return mConnectedSourcesCatalogOptInStatus;
  }

  public String getFieldDefaultCreationMode() {
    return mDefaultCreationMode;
  }

  public String getFieldExportFormatDefault() {
    return mExportFormatDefault;
  }

  public String getFieldFocusModeDefault() {
    return mFocusModeDefault;
  }

  public Long getFieldGenAiAlphaTestStatus() {
    return mGenAiAlphaTestStatus;
  }

  public String getFieldId() {
    return mId;
  }

  public String getFieldImageExpansionOptInStatus() {
    return mImageExpansionOptInStatus;
  }

  public Boolean getFieldIsAdsAiConsented() {
    return mIsAdsAiConsented;
  }

  public Boolean getFieldIsCboDefaultOn() {
    return mIsCboDefaultOn;
  }

  public Boolean getFieldIsSeRemovalGuidanceDismissed() {
    return mIsSeRemovalGuidanceDismissed;
  }

  public String getFieldLastUsedPostFormat() {
    return mLastUsedPostFormat;
  }

  public String getFieldLastVisitedTime() {
    return mLastVisitedTime;
  }

  public List> getFieldMusicOnReelsOptIn() {
    return mMusicOnReelsOptIn;
  }

  public List getFieldMutedCboMidflightEducationMessages() {
    return mMutedCboMidflightEducationMessages;
  }

  public String getFieldOnsiteDestinationOptimizationOptIn() {
    return mOnsiteDestinationOptimizationOptIn;
  }

  public List getFieldOpenTabs() {
    return mOpenTabs;
  }

  public List getFieldPreviouslySeenRecommendations() {
    return mPreviouslySeenRecommendations;
  }

  public String getFieldProductExtensionsOptIn() {
    return mProductExtensionsOptIn;
  }

  public AdAccount getFieldSelectedAdAccount() {
    if (mSelectedAdAccount != null) {
      mSelectedAdAccount.context = getContext();
    }
    return mSelectedAdAccount;
  }

  public Object getFieldSelectedComparisonTimerange() {
    return mSelectedComparisonTimerange;
  }

  public String getFieldSelectedMetricCic() {
    return mSelectedMetricCic;
  }

  public List getFieldSelectedMetricsCic() {
    return mSelectedMetricsCic;
  }

  public Page getFieldSelectedPage() {
    if (mSelectedPage != null) {
      mSelectedPage.context = getContext();
    }
    return mSelectedPage;
  }

  public String getFieldSelectedPageSection() {
    return mSelectedPageSection;
  }

  public String getFieldSelectedPowerEditorPane() {
    return mSelectedPowerEditorPane;
  }

  public Object getFieldSelectedStatRange() {
    return mSelectedStatRange;
  }

  public String getFieldShouldExportFilterEmptyCols() {
    return mShouldExportFilterEmptyCols;
  }

  public String getFieldShouldExportRowsWithoutUnsupportedFeature() {
    return mShouldExportRowsWithoutUnsupportedFeature;
  }

  public Boolean getFieldShouldNotAutoExpandTreeTable() {
    return mShouldNotAutoExpandTreeTable;
  }

  public Boolean getFieldShouldNotShowCboCampaignToggleOffConfirmationMessage() {
    return mShouldNotShowCboCampaignToggleOffConfirmationMessage;
  }

  public Boolean getFieldShouldNotShowPublishMessageOnEditorClose() {
    return mShouldNotShowPublishMessageOnEditorClose;
  }

  public String getFieldShowOriginalVideosOptIn() {
    return mShowOriginalVideosOptIn;
  }

  public String getFieldStaticAdProductExtensionsOptIn() {
    return mStaticAdProductExtensionsOptIn;
  }

  public String getFieldStickySettingAfterDefaultOn() {
    return mStickySettingAfterDefaultOn;
  }

  public String getFieldSydCampaignTrendsMetric() {
    return mSydCampaignTrendsMetric;
  }

  public Long getFieldTotalCouponSydDismissals() {
    return mTotalCouponSydDismissals;
  }

  public Long getFieldTotalCouponUpsellDismissals() {
    return mTotalCouponUpsellDismissals;
  }

  public Long getFieldUrlPrefillRemovalTimestamp() {
    return mUrlPrefillRemovalTimestamp;
  }

  public Boolean getFieldUsePeCreateFlow() {
    return mUsePeCreateFlow;
  }

  public Boolean getFieldUseStepperPrimaryEntry() {
    return mUseStepperPrimaryEntry;
  }

  public User getFieldUser() {
    if (mUser != null) {
      mUser.context = getContext();
    }
    return mUser;
  }



  public static class APIRequestGet extends APIRequest {

    AdsUserSettings lastResponse = null;
    @Override
    public AdsUserSettings getLastResponse() {
      return lastResponse;
    }
    public static final String[] PARAMS = {
    };

    public static final String[] FIELDS = {
      "a_plus_c_survey_seen",
      "adgroup_name_template",
      "ads_cs_catalog_opt_out_timestamp",
      "ads_tool_visits",
      "aplusc_carousel_cda_opt_in_status",
      "aplusc_carousel_inline_comment_opt_in_status",
      "aplusc_epa_opt_in_status",
      "aplusc_opt_out_friction",
      "autoflow_lite_opt_in_status",
      "autoflow_lite_should_opt_in",
      "blended_ads_creation_defaulting_opt_in_status",
      "blended_ads_creation_defaulting_opt_out_campaign_group_ids",
      "bookmarked_pages",
      "campaign_group_name_template",
      "campaign_name_template",
      "carousel_to_video_opt_in_status",
      "connected_sources_catalog_opt_in_status",
      "default_creation_mode",
      "export_format_default",
      "focus_mode_default",
      "gen_ai_alpha_test_status",
      "id",
      "image_expansion_opt_in_status",
      "is_ads_ai_consented",
      "is_cbo_default_on",
      "is_se_removal_guidance_dismissed",
      "last_used_post_format",
      "last_visited_time",
      "music_on_reels_opt_in",
      "muted_cbo_midflight_education_messages",
      "onsite_destination_optimization_opt_in",
      "open_tabs",
      "previously_seen_recommendations",
      "product_extensions_opt_in",
      "selected_ad_account",
      "selected_comparison_timerange",
      "selected_metric_cic",
      "selected_metrics_cic",
      "selected_page",
      "selected_page_section",
      "selected_power_editor_pane",
      "selected_stat_range",
      "should_export_filter_empty_cols",
      "should_export_rows_without_unsupported_feature",
      "should_not_auto_expand_tree_table",
      "should_not_show_cbo_campaign_toggle_off_confirmation_message",
      "should_not_show_publish_message_on_editor_close",
      "show_original_videos_opt_in",
      "static_ad_product_extensions_opt_in",
      "sticky_setting_after_default_on",
      "syd_campaign_trends_metric",
      "total_coupon_syd_dismissals",
      "total_coupon_upsell_dismissals",
      "url_prefill_removal_timestamp",
      "use_pe_create_flow",
      "use_stepper_primary_entry",
      "user",
    };

    @Override
    public AdsUserSettings parseResponse(String response, String header) throws APIException {
      return AdsUserSettings.parseResponse(response, getContext(), this, header).head();
    }

    @Override
    public AdsUserSettings execute() throws APIException {
      return execute(new HashMap());
    }

    @Override
    public AdsUserSettings execute(Map extraParams) throws APIException {
      ResponseWrapper rw = executeInternal(extraParams);
      lastResponse = parseResponse(rw.getBody(), rw.getHeader());
      return lastResponse;
    }

    public ListenableFuture executeAsync() throws APIException {
      return executeAsync(new HashMap());
    };

    public ListenableFuture executeAsync(Map extraParams) throws APIException {
      return Futures.transform(
        executeAsyncInternal(extraParams),
        new Function() {
           public AdsUserSettings apply(ResponseWrapper result) {
             try {
               return APIRequestGet.this.parseResponse(result.getBody(), result.getHeader());
             } catch (Exception e) {
               throw new RuntimeException(e);
             }
           }
         },
         MoreExecutors.directExecutor()
      );
    };

    public APIRequestGet(String nodeId, APIContext context) {
      super(context, nodeId, "/", "GET", Arrays.asList(PARAMS));
    }

    @Override
    public APIRequestGet setParam(String param, Object value) {
      setParamInternal(param, value);
      return this;
    }

    @Override
    public APIRequestGet setParams(Map params) {
      setParamsInternal(params);
      return this;
    }


    public APIRequestGet requestAllFields () {
      return this.requestAllFields(true);
    }

    public APIRequestGet requestAllFields (boolean value) {
      for (String field : FIELDS) {
        this.requestField(field, value);
      }
      return this;
    }

    @Override
    public APIRequestGet requestFields (List fields) {
      return this.requestFields(fields, true);
    }

    @Override
    public APIRequestGet requestFields (List fields, boolean value) {
      for (String field : fields) {
        this.requestField(field, value);
      }
      return this;
    }

    @Override
    public APIRequestGet requestField (String field) {
      this.requestField(field, true);
      return this;
    }

    @Override
    public APIRequestGet requestField (String field, boolean value) {
      this.requestFieldInternal(field, value);
      return this;
    }

    public APIRequestGet requestAPlusCSurveySeenField () {
      return this.requestAPlusCSurveySeenField(true);
    }
    public APIRequestGet requestAPlusCSurveySeenField (boolean value) {
      this.requestField("a_plus_c_survey_seen", value);
      return this;
    }
    public APIRequestGet requestAdgroupNameTemplateField () {
      return this.requestAdgroupNameTemplateField(true);
    }
    public APIRequestGet requestAdgroupNameTemplateField (boolean value) {
      this.requestField("adgroup_name_template", value);
      return this;
    }
    public APIRequestGet requestAdsCsCatalogOptOutTimestampField () {
      return this.requestAdsCsCatalogOptOutTimestampField(true);
    }
    public APIRequestGet requestAdsCsCatalogOptOutTimestampField (boolean value) {
      this.requestField("ads_cs_catalog_opt_out_timestamp", value);
      return this;
    }
    public APIRequestGet requestAdsToolVisitsField () {
      return this.requestAdsToolVisitsField(true);
    }
    public APIRequestGet requestAdsToolVisitsField (boolean value) {
      this.requestField("ads_tool_visits", value);
      return this;
    }
    public APIRequestGet requestApluscCarouselCdaOptInStatusField () {
      return this.requestApluscCarouselCdaOptInStatusField(true);
    }
    public APIRequestGet requestApluscCarouselCdaOptInStatusField (boolean value) {
      this.requestField("aplusc_carousel_cda_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestApluscCarouselInlineCommentOptInStatusField () {
      return this.requestApluscCarouselInlineCommentOptInStatusField(true);
    }
    public APIRequestGet requestApluscCarouselInlineCommentOptInStatusField (boolean value) {
      this.requestField("aplusc_carousel_inline_comment_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestApluscEpaOptInStatusField () {
      return this.requestApluscEpaOptInStatusField(true);
    }
    public APIRequestGet requestApluscEpaOptInStatusField (boolean value) {
      this.requestField("aplusc_epa_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestApluscOptOutFrictionField () {
      return this.requestApluscOptOutFrictionField(true);
    }
    public APIRequestGet requestApluscOptOutFrictionField (boolean value) {
      this.requestField("aplusc_opt_out_friction", value);
      return this;
    }
    public APIRequestGet requestAutoflowLiteOptInStatusField () {
      return this.requestAutoflowLiteOptInStatusField(true);
    }
    public APIRequestGet requestAutoflowLiteOptInStatusField (boolean value) {
      this.requestField("autoflow_lite_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestAutoflowLiteShouldOptInField () {
      return this.requestAutoflowLiteShouldOptInField(true);
    }
    public APIRequestGet requestAutoflowLiteShouldOptInField (boolean value) {
      this.requestField("autoflow_lite_should_opt_in", value);
      return this;
    }
    public APIRequestGet requestBlendedAdsCreationDefaultingOptInStatusField () {
      return this.requestBlendedAdsCreationDefaultingOptInStatusField(true);
    }
    public APIRequestGet requestBlendedAdsCreationDefaultingOptInStatusField (boolean value) {
      this.requestField("blended_ads_creation_defaulting_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestBlendedAdsCreationDefaultingOptOutCampaignGroupIdsField () {
      return this.requestBlendedAdsCreationDefaultingOptOutCampaignGroupIdsField(true);
    }
    public APIRequestGet requestBlendedAdsCreationDefaultingOptOutCampaignGroupIdsField (boolean value) {
      this.requestField("blended_ads_creation_defaulting_opt_out_campaign_group_ids", value);
      return this;
    }
    public APIRequestGet requestBookmarkedPagesField () {
      return this.requestBookmarkedPagesField(true);
    }
    public APIRequestGet requestBookmarkedPagesField (boolean value) {
      this.requestField("bookmarked_pages", value);
      return this;
    }
    public APIRequestGet requestCampaignGroupNameTemplateField () {
      return this.requestCampaignGroupNameTemplateField(true);
    }
    public APIRequestGet requestCampaignGroupNameTemplateField (boolean value) {
      this.requestField("campaign_group_name_template", value);
      return this;
    }
    public APIRequestGet requestCampaignNameTemplateField () {
      return this.requestCampaignNameTemplateField(true);
    }
    public APIRequestGet requestCampaignNameTemplateField (boolean value) {
      this.requestField("campaign_name_template", value);
      return this;
    }
    public APIRequestGet requestCarouselToVideoOptInStatusField () {
      return this.requestCarouselToVideoOptInStatusField(true);
    }
    public APIRequestGet requestCarouselToVideoOptInStatusField (boolean value) {
      this.requestField("carousel_to_video_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestConnectedSourcesCatalogOptInStatusField () {
      return this.requestConnectedSourcesCatalogOptInStatusField(true);
    }
    public APIRequestGet requestConnectedSourcesCatalogOptInStatusField (boolean value) {
      this.requestField("connected_sources_catalog_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestDefaultCreationModeField () {
      return this.requestDefaultCreationModeField(true);
    }
    public APIRequestGet requestDefaultCreationModeField (boolean value) {
      this.requestField("default_creation_mode", value);
      return this;
    }
    public APIRequestGet requestExportFormatDefaultField () {
      return this.requestExportFormatDefaultField(true);
    }
    public APIRequestGet requestExportFormatDefaultField (boolean value) {
      this.requestField("export_format_default", value);
      return this;
    }
    public APIRequestGet requestFocusModeDefaultField () {
      return this.requestFocusModeDefaultField(true);
    }
    public APIRequestGet requestFocusModeDefaultField (boolean value) {
      this.requestField("focus_mode_default", value);
      return this;
    }
    public APIRequestGet requestGenAiAlphaTestStatusField () {
      return this.requestGenAiAlphaTestStatusField(true);
    }
    public APIRequestGet requestGenAiAlphaTestStatusField (boolean value) {
      this.requestField("gen_ai_alpha_test_status", value);
      return this;
    }
    public APIRequestGet requestIdField () {
      return this.requestIdField(true);
    }
    public APIRequestGet requestIdField (boolean value) {
      this.requestField("id", value);
      return this;
    }
    public APIRequestGet requestImageExpansionOptInStatusField () {
      return this.requestImageExpansionOptInStatusField(true);
    }
    public APIRequestGet requestImageExpansionOptInStatusField (boolean value) {
      this.requestField("image_expansion_opt_in_status", value);
      return this;
    }
    public APIRequestGet requestIsAdsAiConsentedField () {
      return this.requestIsAdsAiConsentedField(true);
    }
    public APIRequestGet requestIsAdsAiConsentedField (boolean value) {
      this.requestField("is_ads_ai_consented", value);
      return this;
    }
    public APIRequestGet requestIsCboDefaultOnField () {
      return this.requestIsCboDefaultOnField(true);
    }
    public APIRequestGet requestIsCboDefaultOnField (boolean value) {
      this.requestField("is_cbo_default_on", value);
      return this;
    }
    public APIRequestGet requestIsSeRemovalGuidanceDismissedField () {
      return this.requestIsSeRemovalGuidanceDismissedField(true);
    }
    public APIRequestGet requestIsSeRemovalGuidanceDismissedField (boolean value) {
      this.requestField("is_se_removal_guidance_dismissed", value);
      return this;
    }
    public APIRequestGet requestLastUsedPostFormatField () {
      return this.requestLastUsedPostFormatField(true);
    }
    public APIRequestGet requestLastUsedPostFormatField (boolean value) {
      this.requestField("last_used_post_format", value);
      return this;
    }
    public APIRequestGet requestLastVisitedTimeField () {
      return this.requestLastVisitedTimeField(true);
    }
    public APIRequestGet requestLastVisitedTimeField (boolean value) {
      this.requestField("last_visited_time", value);
      return this;
    }
    public APIRequestGet requestMusicOnReelsOptInField () {
      return this.requestMusicOnReelsOptInField(true);
    }
    public APIRequestGet requestMusicOnReelsOptInField (boolean value) {
      this.requestField("music_on_reels_opt_in", value);
      return this;
    }
    public APIRequestGet requestMutedCboMidflightEducationMessagesField () {
      return this.requestMutedCboMidflightEducationMessagesField(true);
    }
    public APIRequestGet requestMutedCboMidflightEducationMessagesField (boolean value) {
      this.requestField("muted_cbo_midflight_education_messages", value);
      return this;
    }
    public APIRequestGet requestOnsiteDestinationOptimizationOptInField () {
      return this.requestOnsiteDestinationOptimizationOptInField(true);
    }
    public APIRequestGet requestOnsiteDestinationOptimizationOptInField (boolean value) {
      this.requestField("onsite_destination_optimization_opt_in", value);
      return this;
    }
    public APIRequestGet requestOpenTabsField () {
      return this.requestOpenTabsField(true);
    }
    public APIRequestGet requestOpenTabsField (boolean value) {
      this.requestField("open_tabs", value);
      return this;
    }
    public APIRequestGet requestPreviouslySeenRecommendationsField () {
      return this.requestPreviouslySeenRecommendationsField(true);
    }
    public APIRequestGet requestPreviouslySeenRecommendationsField (boolean value) {
      this.requestField("previously_seen_recommendations", value);
      return this;
    }
    public APIRequestGet requestProductExtensionsOptInField () {
      return this.requestProductExtensionsOptInField(true);
    }
    public APIRequestGet requestProductExtensionsOptInField (boolean value) {
      this.requestField("product_extensions_opt_in", value);
      return this;
    }
    public APIRequestGet requestSelectedAdAccountField () {
      return this.requestSelectedAdAccountField(true);
    }
    public APIRequestGet requestSelectedAdAccountField (boolean value) {
      this.requestField("selected_ad_account", value);
      return this;
    }
    public APIRequestGet requestSelectedComparisonTimerangeField () {
      return this.requestSelectedComparisonTimerangeField(true);
    }
    public APIRequestGet requestSelectedComparisonTimerangeField (boolean value) {
      this.requestField("selected_comparison_timerange", value);
      return this;
    }
    public APIRequestGet requestSelectedMetricCicField () {
      return this.requestSelectedMetricCicField(true);
    }
    public APIRequestGet requestSelectedMetricCicField (boolean value) {
      this.requestField("selected_metric_cic", value);
      return this;
    }
    public APIRequestGet requestSelectedMetricsCicField () {
      return this.requestSelectedMetricsCicField(true);
    }
    public APIRequestGet requestSelectedMetricsCicField (boolean value) {
      this.requestField("selected_metrics_cic", value);
      return this;
    }
    public APIRequestGet requestSelectedPageField () {
      return this.requestSelectedPageField(true);
    }
    public APIRequestGet requestSelectedPageField (boolean value) {
      this.requestField("selected_page", value);
      return this;
    }
    public APIRequestGet requestSelectedPageSectionField () {
      return this.requestSelectedPageSectionField(true);
    }
    public APIRequestGet requestSelectedPageSectionField (boolean value) {
      this.requestField("selected_page_section", value);
      return this;
    }
    public APIRequestGet requestSelectedPowerEditorPaneField () {
      return this.requestSelectedPowerEditorPaneField(true);
    }
    public APIRequestGet requestSelectedPowerEditorPaneField (boolean value) {
      this.requestField("selected_power_editor_pane", value);
      return this;
    }
    public APIRequestGet requestSelectedStatRangeField () {
      return this.requestSelectedStatRangeField(true);
    }
    public APIRequestGet requestSelectedStatRangeField (boolean value) {
      this.requestField("selected_stat_range", value);
      return this;
    }
    public APIRequestGet requestShouldExportFilterEmptyColsField () {
      return this.requestShouldExportFilterEmptyColsField(true);
    }
    public APIRequestGet requestShouldExportFilterEmptyColsField (boolean value) {
      this.requestField("should_export_filter_empty_cols", value);
      return this;
    }
    public APIRequestGet requestShouldExportRowsWithoutUnsupportedFeatureField () {
      return this.requestShouldExportRowsWithoutUnsupportedFeatureField(true);
    }
    public APIRequestGet requestShouldExportRowsWithoutUnsupportedFeatureField (boolean value) {
      this.requestField("should_export_rows_without_unsupported_feature", value);
      return this;
    }
    public APIRequestGet requestShouldNotAutoExpandTreeTableField () {
      return this.requestShouldNotAutoExpandTreeTableField(true);
    }
    public APIRequestGet requestShouldNotAutoExpandTreeTableField (boolean value) {
      this.requestField("should_not_auto_expand_tree_table", value);
      return this;
    }
    public APIRequestGet requestShouldNotShowCboCampaignToggleOffConfirmationMessageField () {
      return this.requestShouldNotShowCboCampaignToggleOffConfirmationMessageField(true);
    }
    public APIRequestGet requestShouldNotShowCboCampaignToggleOffConfirmationMessageField (boolean value) {
      this.requestField("should_not_show_cbo_campaign_toggle_off_confirmation_message", value);
      return this;
    }
    public APIRequestGet requestShouldNotShowPublishMessageOnEditorCloseField () {
      return this.requestShouldNotShowPublishMessageOnEditorCloseField(true);
    }
    public APIRequestGet requestShouldNotShowPublishMessageOnEditorCloseField (boolean value) {
      this.requestField("should_not_show_publish_message_on_editor_close", value);
      return this;
    }
    public APIRequestGet requestShowOriginalVideosOptInField () {
      return this.requestShowOriginalVideosOptInField(true);
    }
    public APIRequestGet requestShowOriginalVideosOptInField (boolean value) {
      this.requestField("show_original_videos_opt_in", value);
      return this;
    }
    public APIRequestGet requestStaticAdProductExtensionsOptInField () {
      return this.requestStaticAdProductExtensionsOptInField(true);
    }
    public APIRequestGet requestStaticAdProductExtensionsOptInField (boolean value) {
      this.requestField("static_ad_product_extensions_opt_in", value);
      return this;
    }
    public APIRequestGet requestStickySettingAfterDefaultOnField () {
      return this.requestStickySettingAfterDefaultOnField(true);
    }
    public APIRequestGet requestStickySettingAfterDefaultOnField (boolean value) {
      this.requestField("sticky_setting_after_default_on", value);
      return this;
    }
    public APIRequestGet requestSydCampaignTrendsMetricField () {
      return this.requestSydCampaignTrendsMetricField(true);
    }
    public APIRequestGet requestSydCampaignTrendsMetricField (boolean value) {
      this.requestField("syd_campaign_trends_metric", value);
      return this;
    }
    public APIRequestGet requestTotalCouponSydDismissalsField () {
      return this.requestTotalCouponSydDismissalsField(true);
    }
    public APIRequestGet requestTotalCouponSydDismissalsField (boolean value) {
      this.requestField("total_coupon_syd_dismissals", value);
      return this;
    }
    public APIRequestGet requestTotalCouponUpsellDismissalsField () {
      return this.requestTotalCouponUpsellDismissalsField(true);
    }
    public APIRequestGet requestTotalCouponUpsellDismissalsField (boolean value) {
      this.requestField("total_coupon_upsell_dismissals", value);
      return this;
    }
    public APIRequestGet requestUrlPrefillRemovalTimestampField () {
      return this.requestUrlPrefillRemovalTimestampField(true);
    }
    public APIRequestGet requestUrlPrefillRemovalTimestampField (boolean value) {
      this.requestField("url_prefill_removal_timestamp", value);
      return this;
    }
    public APIRequestGet requestUsePeCreateFlowField () {
      return this.requestUsePeCreateFlowField(true);
    }
    public APIRequestGet requestUsePeCreateFlowField (boolean value) {
      this.requestField("use_pe_create_flow", value);
      return this;
    }
    public APIRequestGet requestUseStepperPrimaryEntryField () {
      return this.requestUseStepperPrimaryEntryField(true);
    }
    public APIRequestGet requestUseStepperPrimaryEntryField (boolean value) {
      this.requestField("use_stepper_primary_entry", value);
      return this;
    }
    public APIRequestGet requestUserField () {
      return this.requestUserField(true);
    }
    public APIRequestGet requestUserField (boolean value) {
      this.requestField("user", value);
      return this;
    }
  }


  synchronized /*package*/ static Gson getGson() {
    if (gson != null) {
      return gson;
    } else {
      gson = new GsonBuilder()
        .excludeFieldsWithModifiers(Modifier.STATIC)
        .excludeFieldsWithModifiers(Modifier.PROTECTED)
        .disableHtmlEscaping()
        .create();
    }
    return gson;
  }

  public AdsUserSettings copyFrom(AdsUserSettings instance) {
    this.mAPlusCSurveySeen = instance.mAPlusCSurveySeen;
    this.mAdgroupNameTemplate = instance.mAdgroupNameTemplate;
    this.mAdsCsCatalogOptOutTimestamp = instance.mAdsCsCatalogOptOutTimestamp;
    this.mAdsToolVisits = instance.mAdsToolVisits;
    this.mApluscCarouselCdaOptInStatus = instance.mApluscCarouselCdaOptInStatus;
    this.mApluscCarouselInlineCommentOptInStatus = instance.mApluscCarouselInlineCommentOptInStatus;
    this.mApluscEpaOptInStatus = instance.mApluscEpaOptInStatus;
    this.mApluscOptOutFriction = instance.mApluscOptOutFriction;
    this.mAutoflowLiteOptInStatus = instance.mAutoflowLiteOptInStatus;
    this.mAutoflowLiteShouldOptIn = instance.mAutoflowLiteShouldOptIn;
    this.mBlendedAdsCreationDefaultingOptInStatus = instance.mBlendedAdsCreationDefaultingOptInStatus;
    this.mBlendedAdsCreationDefaultingOptOutCampaignGroupIds = instance.mBlendedAdsCreationDefaultingOptOutCampaignGroupIds;
    this.mBookmarkedPages = instance.mBookmarkedPages;
    this.mCampaignGroupNameTemplate = instance.mCampaignGroupNameTemplate;
    this.mCampaignNameTemplate = instance.mCampaignNameTemplate;
    this.mCarouselToVideoOptInStatus = instance.mCarouselToVideoOptInStatus;
    this.mConnectedSourcesCatalogOptInStatus = instance.mConnectedSourcesCatalogOptInStatus;
    this.mDefaultCreationMode = instance.mDefaultCreationMode;
    this.mExportFormatDefault = instance.mExportFormatDefault;
    this.mFocusModeDefault = instance.mFocusModeDefault;
    this.mGenAiAlphaTestStatus = instance.mGenAiAlphaTestStatus;
    this.mId = instance.mId;
    this.mImageExpansionOptInStatus = instance.mImageExpansionOptInStatus;
    this.mIsAdsAiConsented = instance.mIsAdsAiConsented;
    this.mIsCboDefaultOn = instance.mIsCboDefaultOn;
    this.mIsSeRemovalGuidanceDismissed = instance.mIsSeRemovalGuidanceDismissed;
    this.mLastUsedPostFormat = instance.mLastUsedPostFormat;
    this.mLastVisitedTime = instance.mLastVisitedTime;
    this.mMusicOnReelsOptIn = instance.mMusicOnReelsOptIn;
    this.mMutedCboMidflightEducationMessages = instance.mMutedCboMidflightEducationMessages;
    this.mOnsiteDestinationOptimizationOptIn = instance.mOnsiteDestinationOptimizationOptIn;
    this.mOpenTabs = instance.mOpenTabs;
    this.mPreviouslySeenRecommendations = instance.mPreviouslySeenRecommendations;
    this.mProductExtensionsOptIn = instance.mProductExtensionsOptIn;
    this.mSelectedAdAccount = instance.mSelectedAdAccount;
    this.mSelectedComparisonTimerange = instance.mSelectedComparisonTimerange;
    this.mSelectedMetricCic = instance.mSelectedMetricCic;
    this.mSelectedMetricsCic = instance.mSelectedMetricsCic;
    this.mSelectedPage = instance.mSelectedPage;
    this.mSelectedPageSection = instance.mSelectedPageSection;
    this.mSelectedPowerEditorPane = instance.mSelectedPowerEditorPane;
    this.mSelectedStatRange = instance.mSelectedStatRange;
    this.mShouldExportFilterEmptyCols = instance.mShouldExportFilterEmptyCols;
    this.mShouldExportRowsWithoutUnsupportedFeature = instance.mShouldExportRowsWithoutUnsupportedFeature;
    this.mShouldNotAutoExpandTreeTable = instance.mShouldNotAutoExpandTreeTable;
    this.mShouldNotShowCboCampaignToggleOffConfirmationMessage = instance.mShouldNotShowCboCampaignToggleOffConfirmationMessage;
    this.mShouldNotShowPublishMessageOnEditorClose = instance.mShouldNotShowPublishMessageOnEditorClose;
    this.mShowOriginalVideosOptIn = instance.mShowOriginalVideosOptIn;
    this.mStaticAdProductExtensionsOptIn = instance.mStaticAdProductExtensionsOptIn;
    this.mStickySettingAfterDefaultOn = instance.mStickySettingAfterDefaultOn;
    this.mSydCampaignTrendsMetric = instance.mSydCampaignTrendsMetric;
    this.mTotalCouponSydDismissals = instance.mTotalCouponSydDismissals;
    this.mTotalCouponUpsellDismissals = instance.mTotalCouponUpsellDismissals;
    this.mUrlPrefillRemovalTimestamp = instance.mUrlPrefillRemovalTimestamp;
    this.mUsePeCreateFlow = instance.mUsePeCreateFlow;
    this.mUseStepperPrimaryEntry = instance.mUseStepperPrimaryEntry;
    this.mUser = instance.mUser;
    this.context = instance.context;
    this.rawValue = instance.rawValue;
    return this;
  }

  public static APIRequest.ResponseParser getParser() {
    return new APIRequest.ResponseParser() {
      public APINodeList parseResponse(String response, APIContext context, APIRequest request, String header) throws MalformedResponseException {
        return AdsUserSettings.parseResponse(response, context, request, header);
      }
    };
  }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy