AdsUserSettings (com.facebook.business.sdk:facebook-java-business-sdk 24.0.1 API)

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

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

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

Constructor Summary

Constructors
Constructor and Description

AdsUserSettings(Long id, APIContext context)

AdsUserSettings(String id, APIContext context)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()`
`String`	`getFieldAddOverlaysOptInStatus()`
`Object`	`getFieldAdgroupNameTemplate()`
`List<Map<String,Long>>`	`getFieldAdsCsCatalogOptOutTimestamp()`
`String`	`getFieldAdsCsDynamicSeOptInStatus()`
`List<Map<String,Long>>`	`getFieldAdsCsDynamicSeOptOutTimestamp()`
`String`	`getFieldAdsCsSitelinksOptInStatus()`
`List<Map<String,Long>>`	`getFieldAdsCsSitelinksOptOutTimestamp()`
`List<Map<String,Long>>`	`getFieldAdsDestinationOptimizationOptOutTimestamp()`
`List<Object>`	`getFieldAdsToolVisits()`
`String`	`getFieldApluscAiAgentOptInStatus()`
`String`	`getFieldApluscCarouselCdaOptInStatus()`
`String`	`getFieldApluscCarouselInlineCommentOptInStatus()`
`String`	`getFieldApluscDaOptInStatus()`
`String`	`getFieldApluscEnhanceCtaOptInStatus()`
`String`	`getFieldApluscEpaOptInStatus()`
`String`	`getFieldApluscLocalStoreExtensionOptInStatus()`
`List<String>`	`getFieldApluscOptOutFriction()`
`Boolean`	`getFieldAPlusCSurveySeen()`
`String`	`getFieldApluscVideofilterOptInStatus()`
`String`	`getFieldApluscVideouncropOptInStatus()`
`String`	`getFieldAutoflowLiteOptInStatus()`
`Boolean`	`getFieldAutoflowLiteShouldOptIn()`
`String`	`getFieldBlendedAdsCreationDefaultingOptInStatus()`
`List<Long>`	`getFieldBlendedAdsCreationDefaultingOptOutCampaignGroupIds()`
`List<Page>`	`getFieldBookmarkedPages()`
`Object`	`getFieldCampaignGroupNameTemplate()`
`Object`	`getFieldCampaignNameTemplate()`
`String`	`getFieldCarouselToVideoOptInStatus()`
`String`	`getFieldConnectedSourcesCatalogOptInStatus()`
`String`	`getFieldCreateCtaStickerOptInStatus()`
`String`	`getFieldCreativeFlexOptInStatus()`
`String`	`getFieldDaAddOverlaysOptInStatus()`
`String`	`getFieldDaCreativeFlexOptInStatus()`
`String`	`getFieldDaHidePriceOptInStatus()`
`Long`	`getFieldDaManualMediaNuxImpressions()`
`String`	`getFieldDefaultCreationMode()`
`String`	`getFieldDynamicPartnershipAdsOptInStatus()`
`String`	`getFieldEnhanceCtaTextExtractionOptInStatus()`
`String`	`getFieldExportFormatDefault()`
`String`	`getFieldFocusModeDefault()`
`Long`	`getFieldGenAiAlphaTestStatus()`
`String`	`getFieldGenAiAutoSelectOptInStatus()`
`String`	`getFieldId()`
`String`	`getFieldImageBackgroundGenerationOptInStatus()`
`String`	`getFieldImageBrightnessAndContrastOptInStatus()`
`String`	`getFieldImageExpansionOptInStatus()`
`String`	`getFieldImageTemplatesTextExtractionOptInStatus()`
`Boolean`	`getFieldIsAdsAiConsented()`
`Boolean`	`getFieldIsCboDefaultOn()`
`Boolean`	`getFieldIsSeRemovalGuidanceDismissed()`
`String`	`getFieldLastUsedPostFormat()`
`String`	`getFieldLastVisitedTime()`
`Long`	`getFieldMetadataBrandKitLastOptOutTimestamp()`
`String`	`getFieldMetadataBrandKitOptInStatus()`
`List<Map<String,String>>`	`getFieldMusicOnReelsOptIn()`
`List<String>`	`getFieldMutedCboMidflightEducationMessages()`
`String`	`getFieldOnsiteDestinationOptimizationOptIn()`
`List<String>`	`getFieldOpenTabs()`
`String`	`getFieldPacRelaxationOptInStatus()`
`String`	`getFieldPlacementGroupSquareOptInStatus()`
`String`	`getFieldPlacementGroupVerticalOptInStatus()`
`List<String>`	`getFieldPreviouslySeenRecommendations()`
`String`	`getFieldProductExtensionsOptIn()`
`List<Object>`	`getFieldReactiveControlSettings()`
`String`	`getFieldReplaceMediaTextOptInStatus()`
`String`	`getFieldSaOffConvLocSeen()`
`String`	`getFieldSaoffPublishedL2ConvLocSeen()`
`String`	`getFieldSaonMigrL1SeenStatus()`
`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`	`getFieldShowSummaryOptInStatus()`
`String`	`getFieldStaticAdProductExtensionsOptIn()`
`String`	`getFieldStickySettingAfterDefaultOn()`
`String`	`getFieldSydCampaignTrendsMetric()`
`String`	`getFieldTextOptimizationsTextExtractionOptInStatus()`
`String`	`getFieldTextTranslationOptInStatus()`
`String`	`getFieldTextVariationsStickyOptInStatus()`
`Long`	`getFieldTotalCouponSydDismissals()`
`Long`	`getFieldTotalCouponUpsellDismissals()`
`Long`	`getFieldUrlPrefillRemovalTimestamp()`
`Boolean`	`getFieldUsePeCreateFlow()`
`User`	`getFieldUser()`
`Boolean`	`getFieldUseStepperPrimaryEntry()`
`String`	`getFieldWebsiteMediaOptInStatus()`
`String`	`getFieldWebsiteReviewsDataOptInStatus()`
`String`	`getFieldWebsiteSellingPointsDataOptInStatus()`
`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()

getFieldAddOverlaysOptInStatus

public String getFieldAddOverlaysOptInStatus()

getFieldAdgroupNameTemplate

public Object getFieldAdgroupNameTemplate()

getFieldAdsCsCatalogOptOutTimestamp

public List<Map<String,Long>> getFieldAdsCsCatalogOptOutTimestamp()

getFieldAdsCsDynamicSeOptInStatus

public String getFieldAdsCsDynamicSeOptInStatus()

getFieldAdsCsDynamicSeOptOutTimestamp

public List<Map<String,Long>> getFieldAdsCsDynamicSeOptOutTimestamp()

getFieldAdsCsSitelinksOptInStatus

public String getFieldAdsCsSitelinksOptInStatus()

getFieldAdsCsSitelinksOptOutTimestamp

public List<Map<String,Long>> getFieldAdsCsSitelinksOptOutTimestamp()

getFieldAdsDestinationOptimizationOptOutTimestamp

public List<Map<String,Long>> getFieldAdsDestinationOptimizationOptOutTimestamp()

getFieldAdsToolVisits

public List<Object> getFieldAdsToolVisits()

getFieldApluscAiAgentOptInStatus

public String getFieldApluscAiAgentOptInStatus()

getFieldApluscCarouselCdaOptInStatus

public String getFieldApluscCarouselCdaOptInStatus()

getFieldApluscCarouselInlineCommentOptInStatus

public String getFieldApluscCarouselInlineCommentOptInStatus()

getFieldApluscDaOptInStatus

public String getFieldApluscDaOptInStatus()

getFieldApluscEnhanceCtaOptInStatus

public String getFieldApluscEnhanceCtaOptInStatus()

getFieldApluscEpaOptInStatus

public String getFieldApluscEpaOptInStatus()

getFieldApluscLocalStoreExtensionOptInStatus

public String getFieldApluscLocalStoreExtensionOptInStatus()

getFieldApluscOptOutFriction

public List<String> getFieldApluscOptOutFriction()

getFieldApluscVideofilterOptInStatus

public String getFieldApluscVideofilterOptInStatus()

getFieldApluscVideouncropOptInStatus

public String getFieldApluscVideouncropOptInStatus()

getFieldAutoflowLiteOptInStatus

public String getFieldAutoflowLiteOptInStatus()

getFieldAutoflowLiteShouldOptIn

public Boolean getFieldAutoflowLiteShouldOptIn()

getFieldBlendedAdsCreationDefaultingOptInStatus

public String getFieldBlendedAdsCreationDefaultingOptInStatus()

getFieldBlendedAdsCreationDefaultingOptOutCampaignGroupIds

public List<Long> getFieldBlendedAdsCreationDefaultingOptOutCampaignGroupIds()

getFieldBookmarkedPages

public List<Page> getFieldBookmarkedPages()

getFieldCampaignGroupNameTemplate

public Object getFieldCampaignGroupNameTemplate()

getFieldCampaignNameTemplate

public Object getFieldCampaignNameTemplate()

getFieldCarouselToVideoOptInStatus

public String getFieldCarouselToVideoOptInStatus()

getFieldConnectedSourcesCatalogOptInStatus

public String getFieldConnectedSourcesCatalogOptInStatus()

getFieldCreateCtaStickerOptInStatus

public String getFieldCreateCtaStickerOptInStatus()

getFieldCreativeFlexOptInStatus

public String getFieldCreativeFlexOptInStatus()

getFieldDaAddOverlaysOptInStatus

public String getFieldDaAddOverlaysOptInStatus()

getFieldDaCreativeFlexOptInStatus

public String getFieldDaCreativeFlexOptInStatus()

getFieldDaHidePriceOptInStatus

public String getFieldDaHidePriceOptInStatus()

getFieldDaManualMediaNuxImpressions

public Long getFieldDaManualMediaNuxImpressions()

getFieldDefaultCreationMode

public String getFieldDefaultCreationMode()

getFieldDynamicPartnershipAdsOptInStatus

public String getFieldDynamicPartnershipAdsOptInStatus()

getFieldEnhanceCtaTextExtractionOptInStatus

public String getFieldEnhanceCtaTextExtractionOptInStatus()

getFieldExportFormatDefault

public String getFieldExportFormatDefault()

getFieldFocusModeDefault

public String getFieldFocusModeDefault()

getFieldGenAiAlphaTestStatus

public Long getFieldGenAiAlphaTestStatus()

getFieldGenAiAutoSelectOptInStatus

public String getFieldGenAiAutoSelectOptInStatus()

getFieldId
```
public String getFieldId()
```

getFieldImageBackgroundGenerationOptInStatus

public String getFieldImageBackgroundGenerationOptInStatus()

getFieldImageBrightnessAndContrastOptInStatus

public String getFieldImageBrightnessAndContrastOptInStatus()

getFieldImageExpansionOptInStatus

public String getFieldImageExpansionOptInStatus()

getFieldImageTemplatesTextExtractionOptInStatus

public String getFieldImageTemplatesTextExtractionOptInStatus()

getFieldIsAdsAiConsented

public Boolean getFieldIsAdsAiConsented()

getFieldIsCboDefaultOn

public Boolean getFieldIsCboDefaultOn()

getFieldIsSeRemovalGuidanceDismissed

public Boolean getFieldIsSeRemovalGuidanceDismissed()

getFieldLastUsedPostFormat

public String getFieldLastUsedPostFormat()

getFieldLastVisitedTime

public String getFieldLastVisitedTime()

getFieldMetadataBrandKitLastOptOutTimestamp

public Long getFieldMetadataBrandKitLastOptOutTimestamp()

getFieldMetadataBrandKitOptInStatus

public String getFieldMetadataBrandKitOptInStatus()

getFieldMusicOnReelsOptIn

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

getFieldMutedCboMidflightEducationMessages

public List<String> getFieldMutedCboMidflightEducationMessages()

getFieldOnsiteDestinationOptimizationOptIn

public String getFieldOnsiteDestinationOptimizationOptIn()

getFieldOpenTabs

public List<String> getFieldOpenTabs()

getFieldPacRelaxationOptInStatus

public String getFieldPacRelaxationOptInStatus()

getFieldPlacementGroupSquareOptInStatus

public String getFieldPlacementGroupSquareOptInStatus()

getFieldPlacementGroupVerticalOptInStatus

public String getFieldPlacementGroupVerticalOptInStatus()

getFieldPreviouslySeenRecommendations

public List<String> getFieldPreviouslySeenRecommendations()

getFieldProductExtensionsOptIn

public String getFieldProductExtensionsOptIn()

getFieldReactiveControlSettings

public List<Object> getFieldReactiveControlSettings()

getFieldReplaceMediaTextOptInStatus

public String getFieldReplaceMediaTextOptInStatus()

getFieldSaOffConvLocSeen

public String getFieldSaOffConvLocSeen()

getFieldSaoffPublishedL2ConvLocSeen

public String getFieldSaoffPublishedL2ConvLocSeen()

getFieldSaonMigrL1SeenStatus

public String getFieldSaonMigrL1SeenStatus()

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()

getFieldShowSummaryOptInStatus

public String getFieldShowSummaryOptInStatus()

getFieldStaticAdProductExtensionsOptIn

public String getFieldStaticAdProductExtensionsOptIn()

getFieldStickySettingAfterDefaultOn

public String getFieldStickySettingAfterDefaultOn()

getFieldSydCampaignTrendsMetric

public String getFieldSydCampaignTrendsMetric()

getFieldTextOptimizationsTextExtractionOptInStatus

public String getFieldTextOptimizationsTextExtractionOptInStatus()

getFieldTextTranslationOptInStatus

public String getFieldTextTranslationOptInStatus()

getFieldTextVariationsStickyOptInStatus

public String getFieldTextVariationsStickyOptInStatus()

getFieldTotalCouponSydDismissals

public Long getFieldTotalCouponSydDismissals()

getFieldTotalCouponUpsellDismissals

public Long getFieldTotalCouponUpsellDismissals()

getFieldUrlPrefillRemovalTimestamp

public Long getFieldUrlPrefillRemovalTimestamp()

getFieldUsePeCreateFlow

public Boolean getFieldUsePeCreateFlow()

getFieldUseStepperPrimaryEntry

public Boolean getFieldUseStepperPrimaryEntry()

getFieldUser
```
public User getFieldUser()
```

getFieldWebsiteMediaOptInStatus

public String getFieldWebsiteMediaOptInStatus()

getFieldWebsiteReviewsDataOptInStatus

public String getFieldWebsiteReviewsDataOptInStatus()

getFieldWebsiteSellingPointsDataOptInStatus

public String getFieldWebsiteSellingPointsDataOptInStatus()

copyFrom

public AdsUserSettings copyFrom(AdsUserSettings instance)

getParser

public static APIRequest.ResponseParser<AdsUserSettings> getParser()

Class AdsUserSettings

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

gson

Constructor Detail

AdsUserSettings

AdsUserSettings

Method Detail

fetch

fetchById

fetchByIdAsync

fetchById

fetchByIdAsync

fetchByIds

fetchByIdsAsync

getId

loadJSON

parseResponse

getContext

setContext

toString

get

getFieldAPlusCSurveySeen

getFieldAddOverlaysOptInStatus

getFieldAdgroupNameTemplate

getFieldAdsCsCatalogOptOutTimestamp

getFieldAdsCsDynamicSeOptInStatus

getFieldAdsCsDynamicSeOptOutTimestamp

getFieldAdsCsSitelinksOptInStatus

getFieldAdsCsSitelinksOptOutTimestamp

getFieldAdsDestinationOptimizationOptOutTimestamp

getFieldAdsToolVisits

getFieldApluscAiAgentOptInStatus

getFieldApluscCarouselCdaOptInStatus

getFieldApluscCarouselInlineCommentOptInStatus

getFieldApluscDaOptInStatus

getFieldApluscEnhanceCtaOptInStatus

getFieldApluscEpaOptInStatus

getFieldApluscLocalStoreExtensionOptInStatus

getFieldApluscOptOutFriction

getFieldApluscVideofilterOptInStatus

getFieldApluscVideouncropOptInStatus

getFieldAutoflowLiteOptInStatus

getFieldAutoflowLiteShouldOptIn

getFieldBlendedAdsCreationDefaultingOptInStatus

getFieldBlendedAdsCreationDefaultingOptOutCampaignGroupIds

getFieldBookmarkedPages

getFieldCampaignGroupNameTemplate

getFieldCampaignNameTemplate

getFieldCarouselToVideoOptInStatus

getFieldConnectedSourcesCatalogOptInStatus

getFieldCreateCtaStickerOptInStatus

getFieldCreativeFlexOptInStatus

getFieldDaAddOverlaysOptInStatus

getFieldDaCreativeFlexOptInStatus

getFieldDaHidePriceOptInStatus

getFieldDaManualMediaNuxImpressions

getFieldDefaultCreationMode

getFieldDynamicPartnershipAdsOptInStatus

getFieldEnhanceCtaTextExtractionOptInStatus

getFieldExportFormatDefault

getFieldFocusModeDefault

getFieldGenAiAlphaTestStatus

getFieldGenAiAutoSelectOptInStatus

getFieldId

getFieldImageBackgroundGenerationOptInStatus

getFieldImageBrightnessAndContrastOptInStatus

getFieldImageExpansionOptInStatus

getFieldImageTemplatesTextExtractionOptInStatus

getFieldIsAdsAiConsented

getFieldIsCboDefaultOn

getFieldIsSeRemovalGuidanceDismissed

getFieldLastUsedPostFormat

getFieldLastVisitedTime