com.facebook.ads.sdk

Class AdsUserSettings

java.lang.Object

com.facebook.ads.sdk.APINode

com.facebook.ads.sdk.AdsUserSettings

All Implemented Interfaces:

APIResponse

public class AdsUserSettings
extends APINode

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdsUserSettings.APIRequestGet

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.gson.Gson	gson

Fields inherited from class com.facebook.ads.sdk.APINode

context, header, rawValue

Constructor Summary

Constructors

Constructor and Description
AdsUserSettings(Long id, APIContext context)
AdsUserSettings(String id, APIContext context)

Method Summary

Modifier and Type	Method and Description
AdsUserSettings	copyFrom(AdsUserSettings instance)
AdsUserSettings	fetch()
static AdsUserSettings	fetchById(Long id, APIContext context)
static AdsUserSettings	fetchById(String id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<AdsUserSettings>	fetchByIdAsync(Long id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<AdsUserSettings>	fetchByIdAsync(String id, APIContext context)
static APINodeList<AdsUserSettings>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<APINodeList<AdsUserSettings>>	fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)
AdsUserSettings.APIRequestGet	get()
APIContext	getContext()
Object	getFieldAdgroupNameTemplate()
List<Object>	getFieldAdsToolVisits()
String	getFieldApluscCarouselCdaOptInStatus()
String	getFieldApluscCarouselInlineCommentOptInStatus()
String	getFieldApluscEpaOptInStatus()
List<String>	getFieldApluscOptOutFriction()
Boolean	getFieldAPlusCSurveySeen()
String	getFieldAutoflowLiteOptInStatus()
Boolean	getFieldAutoflowLiteShouldOptIn()
String	getFieldBlendedAdsCreationDefaultingOptInStatus()
List<Page>	getFieldBookmarkedPages()
Object	getFieldCampaignGroupNameTemplate()
Object	getFieldCampaignNameTemplate()
String	getFieldCarouselToVideoOptInStatus()
String	getFieldConnectedSourcesCatalogOptInStatus()
String	getFieldDefaultCreationMode()
String	getFieldExportFormatDefault()
String	getFieldFocusModeDefault()
Long	getFieldGenAiAlphaTestStatus()
String	getFieldId()
String	getFieldImageExpansionOptInStatus()
Boolean	getFieldIsAdsAiConsented()
Boolean	getFieldIsCboDefaultOn()
Boolean	getFieldIsSeRemovalGuidanceDismissed()
String	getFieldLastUsedPostFormat()
String	getFieldLastVisitedTime()
List<Map<String,String>>	getFieldMultiAdsSettings()
List<Map<String,String>>	getFieldMusicOnReelsOptIn()
List<String>	getFieldMutedCboMidflightEducationMessages()
String	getFieldOnsiteDestinationOptimizationOptIn()
List<String>	getFieldOpenTabs()
List<String>	getFieldPreviouslySeenRecommendations()
String	getFieldProductExtensionsOptIn()
AdAccount	getFieldSelectedAdAccount()
Object	getFieldSelectedComparisonTimerange()
String	getFieldSelectedMetricCic()
List<String>	getFieldSelectedMetricsCic()
Page	getFieldSelectedPage()
String	getFieldSelectedPageSection()
String	getFieldSelectedPowerEditorPane()
Object	getFieldSelectedStatRange()
String	getFieldShouldExportFilterEmptyCols()
String	getFieldShouldExportRowsWithoutUnsupportedFeature()
Boolean	getFieldShouldNotAutoExpandTreeTable()
Boolean	getFieldShouldNotShowCboCampaignToggleOffConfirmationMessage()
Boolean	getFieldShouldNotShowPublishMessageOnEditorClose()
String	getFieldShowOriginalVideosOptIn()
String	getFieldStaticAdProductExtensionsOptIn()
String	getFieldStickySettingAfterDefaultOn()
String	getFieldSydCampaignTrendsMetric()
Long	getFieldTotalCouponSydDismissals()
Long	getFieldTotalCouponUpsellDismissals()
Boolean	getFieldUsePeCreateFlow()
User	getFieldUser()
Boolean	getFieldUseStepperPrimaryEntry()
String	getId()
static APIRequest.ResponseParser<AdsUserSettings>	getParser()
static AdsUserSettings	loadJSON(String json, APIContext context, String header)
static APINodeList<AdsUserSettings>	parseResponse(String json, APIContext context, APIRequest request, String header)
void	setContext(APIContext context)
String	toString()

Methods inherited from class com.facebook.ads.sdk.APINode

getException, getHeader, getRawResponse, getRawResponseAsJsonObject, getRawValue, head, parseResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

gson

protected static com.google.gson.Gson gson

Constructor Detail

AdsUserSettings

public AdsUserSettings(Long id,
                       APIContext context)

AdsUserSettings

public AdsUserSettings(String id,
                       APIContext context)

Method Detail

fetch

public AdsUserSettings fetch()
                      throws APIException

Throws:

APIException

fetchById

public static AdsUserSettings fetchById(Long id,
                                        APIContext context)
                                 throws APIException

Throws:

APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<AdsUserSettings> fetchByIdAsync(Long id,
                                                                                                 APIContext context)
                                                                                          throws APIException

Throws:

APIException

fetchById

public static AdsUserSettings fetchById(String id,
                                        APIContext context)
                                 throws APIException

Throws:

APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<AdsUserSettings> fetchByIdAsync(String id,
                                                                                                 APIContext context)
                                                                                          throws APIException

Throws:

APIException

fetchByIds

public static APINodeList<AdsUserSettings> fetchByIds(List<String> ids,
                                                      List<String> fields,
                                                      APIContext context)
                                               throws APIException

Throws:

APIException

fetchByIdsAsync

public static com.google.common.util.concurrent.ListenableFuture<APINodeList<AdsUserSettings>> fetchByIdsAsync(List<String> ids,
                                                                                                               List<String> fields,
                                                                                                               APIContext context)
                                                                                                        throws APIException

Throws:

APIException

getId

public String getId()

Overrides:

getId in class APINode

loadJSON

public static AdsUserSettings loadJSON(String json,
                                       APIContext context,
                                       String header)

parseResponse

public static APINodeList<AdsUserSettings> parseResponse(String json,
                                                         APIContext context,
                                                         APIRequest request,
                                                         String header)
                                                  throws APIException.MalformedResponseException

Throws:

APIException.MalformedResponseException

getContext

public APIContext getContext()

Overrides:

getContext in class APINode

setContext

public void setContext(APIContext context)

Overrides:

setContext in class APINode

toString

public String toString()

Overrides:

toString in class APINode

get

public AdsUserSettings.APIRequestGet get()

getFieldAPlusCSurveySeen

public Boolean getFieldAPlusCSurveySeen()

getFieldAdgroupNameTemplate

public Object getFieldAdgroupNameTemplate()

getFieldAdsToolVisits

public List<Object> getFieldAdsToolVisits()

getFieldApluscCarouselCdaOptInStatus

public String getFieldApluscCarouselCdaOptInStatus()

getFieldApluscCarouselInlineCommentOptInStatus

public String getFieldApluscCarouselInlineCommentOptInStatus()

getFieldApluscEpaOptInStatus

public String getFieldApluscEpaOptInStatus()

getFieldApluscOptOutFriction

public List<String> getFieldApluscOptOutFriction()

getFieldAutoflowLiteOptInStatus

public String getFieldAutoflowLiteOptInStatus()

getFieldAutoflowLiteShouldOptIn

public Boolean getFieldAutoflowLiteShouldOptIn()

getFieldBlendedAdsCreationDefaultingOptInStatus

public String getFieldBlendedAdsCreationDefaultingOptInStatus()

getFieldBookmarkedPages

public List<Page> getFieldBookmarkedPages()

getFieldCampaignGroupNameTemplate

public Object getFieldCampaignGroupNameTemplate()

getFieldCampaignNameTemplate

public Object getFieldCampaignNameTemplate()

getFieldCarouselToVideoOptInStatus

public String getFieldCarouselToVideoOptInStatus()

getFieldConnectedSourcesCatalogOptInStatus

public String getFieldConnectedSourcesCatalogOptInStatus()

getFieldDefaultCreationMode

public String getFieldDefaultCreationMode()

getFieldExportFormatDefault

public String getFieldExportFormatDefault()

getFieldFocusModeDefault

public String getFieldFocusModeDefault()

getFieldGenAiAlphaTestStatus

public Long getFieldGenAiAlphaTestStatus()

getFieldId

public String getFieldId()

getFieldImageExpansionOptInStatus

public String getFieldImageExpansionOptInStatus()

getFieldIsAdsAiConsented

public Boolean getFieldIsAdsAiConsented()

getFieldIsCboDefaultOn

public Boolean getFieldIsCboDefaultOn()

getFieldIsSeRemovalGuidanceDismissed

public Boolean getFieldIsSeRemovalGuidanceDismissed()

getFieldLastUsedPostFormat

public String getFieldLastUsedPostFormat()

getFieldLastVisitedTime

public String getFieldLastVisitedTime()

getFieldMultiAdsSettings

public List<Map<String,String>> getFieldMultiAdsSettings()

getFieldMusicOnReelsOptIn

public List<Map<String,String>> getFieldMusicOnReelsOptIn()

getFieldMutedCboMidflightEducationMessages

public List<String> getFieldMutedCboMidflightEducationMessages()

getFieldOnsiteDestinationOptimizationOptIn

public String getFieldOnsiteDestinationOptimizationOptIn()

getFieldOpenTabs

public List<String> getFieldOpenTabs()

getFieldPreviouslySeenRecommendations

public List<String> getFieldPreviouslySeenRecommendations()

getFieldProductExtensionsOptIn

public String getFieldProductExtensionsOptIn()

getFieldSelectedAdAccount

public AdAccount getFieldSelectedAdAccount()

getFieldSelectedComparisonTimerange

public Object getFieldSelectedComparisonTimerange()

getFieldSelectedMetricCic

public String getFieldSelectedMetricCic()

getFieldSelectedMetricsCic

public List<String> getFieldSelectedMetricsCic()

getFieldSelectedPage

public Page getFieldSelectedPage()

getFieldSelectedPageSection

public String getFieldSelectedPageSection()

getFieldSelectedPowerEditorPane

public String getFieldSelectedPowerEditorPane()

getFieldSelectedStatRange

public Object getFieldSelectedStatRange()

getFieldShouldExportFilterEmptyCols

public String getFieldShouldExportFilterEmptyCols()

getFieldShouldExportRowsWithoutUnsupportedFeature

public String getFieldShouldExportRowsWithoutUnsupportedFeature()

getFieldShouldNotAutoExpandTreeTable

public Boolean getFieldShouldNotAutoExpandTreeTable()

getFieldShouldNotShowCboCampaignToggleOffConfirmationMessage

public Boolean getFieldShouldNotShowCboCampaignToggleOffConfirmationMessage()

getFieldShouldNotShowPublishMessageOnEditorClose

public Boolean getFieldShouldNotShowPublishMessageOnEditorClose()

getFieldShowOriginalVideosOptIn

public String getFieldShowOriginalVideosOptIn()

getFieldStaticAdProductExtensionsOptIn

public String getFieldStaticAdProductExtensionsOptIn()

getFieldStickySettingAfterDefaultOn

public String getFieldStickySettingAfterDefaultOn()

getFieldSydCampaignTrendsMetric

public String getFieldSydCampaignTrendsMetric()

getFieldTotalCouponSydDismissals

public Long getFieldTotalCouponSydDismissals()

getFieldTotalCouponUpsellDismissals

public Long getFieldTotalCouponUpsellDismissals()

getFieldUsePeCreateFlow

public Boolean getFieldUsePeCreateFlow()

getFieldUseStepperPrimaryEntry

public Boolean getFieldUseStepperPrimaryEntry()

getFieldUser

public User getFieldUser()

copyFrom

public AdsUserSettings copyFrom(AdsUserSettings instance)

getParser

public static APIRequest.ResponseParser<AdsUserSettings> getParser()