AdCreative (com.facebook.business.sdk:facebook-java-business-sdk 3.1.4 API)

java.lang.Object
- com.facebook.ads.sdk.APINode
- - com.facebook.ads.sdk.AdCreative

All Implemented Interfaces:

APIResponse
```
public class AdCreative
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`	`AdCreative.APIRequestCreateAdLabel`
`static class`	`AdCreative.APIRequestDelete`
`static class`	`AdCreative.APIRequestDeleteAdLabels`
`static class`	`AdCreative.APIRequestGet`
`static class`	`AdCreative.APIRequestGetPreviews`
`static class`	`AdCreative.APIRequestUpdate`
`static class`	`AdCreative.EnumApplinkTreatment`
`static class`	`AdCreative.EnumAuthorizationCategory`
`static class`	`AdCreative.EnumCallToActionType`
`static class`	`AdCreative.EnumCategorizationCriteria`
`static class`	`AdCreative.EnumCategoryMediaSource`
`static class`	`AdCreative.EnumDynamicAdVoice`
`static class`	`AdCreative.EnumObjectType`
`static class`	`AdCreative.EnumOperator`
`static class`	`AdCreative.EnumStatus`

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, rawValue

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

Constructor Summary

Constructors
Constructor and Description

AdCreative()

AdCreative(Long id, APIContext context)

AdCreative(String id, APIContext context)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdCreative`	`copyFrom(AdCreative instance)`
`AdCreative.APIRequestCreateAdLabel`	`createAdLabel()`
`AdCreative.APIRequestDelete`	`delete()`
`AdCreative.APIRequestDeleteAdLabels`	`deleteAdLabels()`
`AdCreative`	`fetch()`
`static AdCreative`	`fetchById(Long id, APIContext context)`
`static AdCreative`	`fetchById(String id, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<AdCreative>`	`fetchByIdAsync(Long id, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<AdCreative>`	`fetchByIdAsync(String id, APIContext context)`
`static APINodeList<AdCreative>`	`fetchByIds(List<String> ids, List<String> fields, APIContext context)`
`static com.google.common.util.concurrent.ListenableFuture<APINodeList<AdCreative>>`	`fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)`
`AdCreative.APIRequestGet`	`get()`
`APIContext`	`getContext()`
`String`	`getFieldAccountId()`
`String`	`getFieldActorId()`
`List<AdLabel>`	`getFieldAdlabels()`
`AdCreative.EnumApplinkTreatment`	`getFieldApplinkTreatment()`
`String`	`getFieldAssetFeedId()`
`AdAssetFeedSpec`	`getFieldAssetFeedSpec()`
`String`	`getFieldAuthorizationCategory()`
`Boolean`	`getFieldAutoUpdate()`
`String`	`getFieldBody()`
`String`	`getFieldBrandedContentSponsorPageId()`
`String`	`getFieldBundleFolderId()`
`AdCreative.EnumCallToActionType`	`getFieldCallToActionType()`
`String`	`getFieldCategorizationCriteria()`
`String`	`getFieldCategoryMediaSource()`
`String`	`getFieldDestinationSetId()`
`String`	`getFieldDynamicAdVoice()`
`String`	`getFieldEffectiveAuthorizationCategory()`
`String`	`getFieldEffectiveInstagramStoryId()`
`String`	`getFieldEffectiveObjectStoryId()`
`Boolean`	`getFieldEnableDirectInstall()`
`Boolean`	`getFieldEnableLaunchInstantApp()`
`String`	`getFieldId()`
`AdsImageCrops`	`getFieldImageCrops()`
`String`	`getFieldImageHash()`
`String`	`getFieldImageUrl()`
`String`	`getFieldInstagramActorId()`
`String`	`getFieldInstagramPermalinkUrl()`
`String`	`getFieldInstagramStoryId()`
`String`	`getFieldLinkDeepLinkUrl()`
`String`	`getFieldLinkOgId()`
`String`	`getFieldLinkUrl()`
`String`	`getFieldMessengerSponsoredMessage()`
`String`	`getFieldName()`
`String`	`getFieldObjectId()`
`String`	`getFieldObjectStoreUrl()`
`String`	`getFieldObjectStoryId()`
`AdCreativeObjectStorySpec`	`getFieldObjectStorySpec()`
`AdCreative.EnumObjectType`	`getFieldObjectType()`
`String`	`getFieldObjectUrl()`
`String`	`getFieldPlacePageSetId()`
`AdCreativePlatformCustomization`	`getFieldPlatformCustomizations()`
`String`	`getFieldPlayableAssetId()`
`String`	`getFieldProductSetId()`
`AdCreativeRecommenderSettings`	`getFieldRecommenderSettings()`
`AdCreative.EnumStatus`	`getFieldStatus()`
`String`	`getFieldTemplateUrl()`
`AdCreativeTemplateURLSpec`	`getFieldTemplateUrlSpec()`
`String`	`getFieldThumbnailUrl()`
`String`	`getFieldTitle()`
`String`	`getFieldUrlTags()`
`Boolean`	`getFieldUsePageActorOverride()`
`String`	`getFieldVideoId()`
`String`	`getId()`
`static APIRequest.ResponseParser<AdCreative>`	`getParser()`
`AdCreative.APIRequestGetPreviews`	`getPreviews()`
`static AdCreative`	`loadJSON(String json, APIContext context)`
`static APINodeList<AdCreative>`	`parseResponse(String json, APIContext context, APIRequest request)`
`void`	`setContext(APIContext context)`
`AdCreative`	`setFieldAccountId(String value)`
`AdCreative`	`setFieldActorId(String value)`
`AdCreative`	`setFieldAdlabels(List<AdLabel> value)`
`AdCreative`	`setFieldAdlabels(String value)`
`AdCreative`	`setFieldApplinkTreatment(AdCreative.EnumApplinkTreatment value)`
`AdCreative`	`setFieldAssetFeedId(String value)`
`AdCreative`	`setFieldAssetFeedSpec(AdAssetFeedSpec value)`
`AdCreative`	`setFieldAssetFeedSpec(String value)`
`AdCreative`	`setFieldAuthorizationCategory(String value)`
`AdCreative`	`setFieldAutoUpdate(Boolean value)`
`AdCreative`	`setFieldBody(String value)`
`AdCreative`	`setFieldBrandedContentSponsorPageId(String value)`
`AdCreative`	`setFieldBundleFolderId(String value)`
`AdCreative`	`setFieldCallToActionType(AdCreative.EnumCallToActionType value)`
`AdCreative`	`setFieldCategorizationCriteria(String value)`
`AdCreative`	`setFieldCategoryMediaSource(String value)`
`AdCreative`	`setFieldDestinationSetId(String value)`
`AdCreative`	`setFieldDynamicAdVoice(String value)`
`AdCreative`	`setFieldEffectiveAuthorizationCategory(String value)`
`AdCreative`	`setFieldEffectiveInstagramStoryId(String value)`
`AdCreative`	`setFieldEffectiveObjectStoryId(String value)`
`AdCreative`	`setFieldEnableDirectInstall(Boolean value)`
`AdCreative`	`setFieldEnableLaunchInstantApp(Boolean value)`
`AdCreative`	`setFieldId(String value)`
`AdCreative`	`setFieldImageCrops(AdsImageCrops value)`
`AdCreative`	`setFieldImageCrops(String value)`
`AdCreative`	`setFieldImageHash(String value)`
`AdCreative`	`setFieldImageUrl(String value)`
`AdCreative`	`setFieldInstagramActorId(String value)`
`AdCreative`	`setFieldInstagramPermalinkUrl(String value)`
`AdCreative`	`setFieldInstagramStoryId(String value)`
`AdCreative`	`setFieldLinkDeepLinkUrl(String value)`
`AdCreative`	`setFieldLinkOgId(String value)`
`AdCreative`	`setFieldLinkUrl(String value)`
`AdCreative`	`setFieldMessengerSponsoredMessage(String value)`
`AdCreative`	`setFieldName(String value)`
`AdCreative`	`setFieldObjectId(String value)`
`AdCreative`	`setFieldObjectStoreUrl(String value)`
`AdCreative`	`setFieldObjectStoryId(String value)`
`AdCreative`	`setFieldObjectStorySpec(AdCreativeObjectStorySpec value)`
`AdCreative`	`setFieldObjectStorySpec(String value)`
`AdCreative`	`setFieldObjectType(AdCreative.EnumObjectType value)`
`AdCreative`	`setFieldObjectUrl(String value)`
`AdCreative`	`setFieldPlacePageSetId(String value)`
`AdCreative`	`setFieldPlatformCustomizations(AdCreativePlatformCustomization value)`
`AdCreative`	`setFieldPlatformCustomizations(String value)`
`AdCreative`	`setFieldPlayableAssetId(String value)`
`AdCreative`	`setFieldProductSetId(String value)`
`AdCreative`	`setFieldRecommenderSettings(AdCreativeRecommenderSettings value)`
`AdCreative`	`setFieldRecommenderSettings(String value)`
`AdCreative`	`setFieldStatus(AdCreative.EnumStatus value)`
`AdCreative`	`setFieldTemplateUrl(String value)`
`AdCreative`	`setFieldTemplateUrlSpec(AdCreativeTemplateURLSpec value)`
`AdCreative`	`setFieldTemplateUrlSpec(String value)`
`AdCreative`	`setFieldThumbnailUrl(String value)`
`AdCreative`	`setFieldTitle(String value)`
`AdCreative`	`setFieldUrlTags(String value)`
`AdCreative`	`setFieldUsePageActorOverride(Boolean value)`
`AdCreative`	`setFieldVideoId(String value)`
`String`	`toString()`
`AdCreative.APIRequestUpdate`	`update()`

Methods inherited from class com.facebook.ads.sdk.APINode
getException, 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

AdCreative
```
public AdCreative()
```

AdCreative

public AdCreative(Long id,
                  APIContext context)

AdCreative

public AdCreative(String id,
                  APIContext context)

Method Detail

fetch

public AdCreative fetch()
                 throws APIException

Throws:: APIException

fetchById

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

Throws:: APIException

fetchByIdAsync

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

Throws:: APIException

fetchById

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

Throws:: APIException

fetchByIdAsync

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

Throws:: APIException

fetchByIds

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

Throws:: APIException

fetchByIdsAsync

public static com.google.common.util.concurrent.ListenableFuture<APINodeList<AdCreative>> 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 AdCreative loadJSON(String json,
                                  APIContext context)

parseResponse

public static APINodeList<AdCreative> parseResponse(String json,
                                                    APIContext context,
                                                    APIRequest request)
                                             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

deleteAdLabels

public AdCreative.APIRequestDeleteAdLabels deleteAdLabels()

createAdLabel

public AdCreative.APIRequestCreateAdLabel createAdLabel()

getPreviews

public AdCreative.APIRequestGetPreviews getPreviews()

delete

public AdCreative.APIRequestDelete delete()

get
```
public AdCreative.APIRequestGet get()
```

update

public AdCreative.APIRequestUpdate update()

getFieldAccountId
```
public String getFieldAccountId()
```

setFieldAccountId

public AdCreative setFieldAccountId(String value)

getFieldActorId
```
public String getFieldActorId()
```

setFieldActorId

public AdCreative setFieldActorId(String value)

getFieldAdlabels

public List<AdLabel> getFieldAdlabels()

setFieldAdlabels

public AdCreative setFieldAdlabels(List<AdLabel> value)

setFieldAdlabels

public AdCreative setFieldAdlabels(String value)

getFieldApplinkTreatment

public AdCreative.EnumApplinkTreatment getFieldApplinkTreatment()

setFieldApplinkTreatment

public AdCreative setFieldApplinkTreatment(AdCreative.EnumApplinkTreatment value)

getFieldAssetFeedId
```
public String getFieldAssetFeedId()
```

setFieldAssetFeedId

public AdCreative setFieldAssetFeedId(String value)

getFieldAssetFeedSpec

public AdAssetFeedSpec getFieldAssetFeedSpec()

setFieldAssetFeedSpec

public AdCreative setFieldAssetFeedSpec(AdAssetFeedSpec value)

setFieldAssetFeedSpec

public AdCreative setFieldAssetFeedSpec(String value)

getFieldAuthorizationCategory

public String getFieldAuthorizationCategory()

setFieldAuthorizationCategory

public AdCreative setFieldAuthorizationCategory(String value)

getFieldAutoUpdate
```
public Boolean getFieldAutoUpdate()
```

setFieldAutoUpdate

public AdCreative setFieldAutoUpdate(Boolean value)

getFieldBody
```
public String getFieldBody()
```

setFieldBody

public AdCreative setFieldBody(String value)

getFieldBrandedContentSponsorPageId

public String getFieldBrandedContentSponsorPageId()

setFieldBrandedContentSponsorPageId

public AdCreative setFieldBrandedContentSponsorPageId(String value)

getFieldBundleFolderId

public String getFieldBundleFolderId()

setFieldBundleFolderId

public AdCreative setFieldBundleFolderId(String value)

getFieldCallToActionType

public AdCreative.EnumCallToActionType getFieldCallToActionType()

setFieldCallToActionType

public AdCreative setFieldCallToActionType(AdCreative.EnumCallToActionType value)

getFieldCategorizationCriteria

public String getFieldCategorizationCriteria()

setFieldCategorizationCriteria

public AdCreative setFieldCategorizationCriteria(String value)

getFieldCategoryMediaSource

public String getFieldCategoryMediaSource()

setFieldCategoryMediaSource

public AdCreative setFieldCategoryMediaSource(String value)

getFieldDestinationSetId

public String getFieldDestinationSetId()

setFieldDestinationSetId

public AdCreative setFieldDestinationSetId(String value)

getFieldDynamicAdVoice

public String getFieldDynamicAdVoice()

setFieldDynamicAdVoice

public AdCreative setFieldDynamicAdVoice(String value)

getFieldEffectiveAuthorizationCategory

public String getFieldEffectiveAuthorizationCategory()

setFieldEffectiveAuthorizationCategory

public AdCreative setFieldEffectiveAuthorizationCategory(String value)

getFieldEffectiveInstagramStoryId

public String getFieldEffectiveInstagramStoryId()

setFieldEffectiveInstagramStoryId

public AdCreative setFieldEffectiveInstagramStoryId(String value)

getFieldEffectiveObjectStoryId

public String getFieldEffectiveObjectStoryId()

setFieldEffectiveObjectStoryId

public AdCreative setFieldEffectiveObjectStoryId(String value)

getFieldEnableDirectInstall

public Boolean getFieldEnableDirectInstall()

setFieldEnableDirectInstall

public AdCreative setFieldEnableDirectInstall(Boolean value)

getFieldEnableLaunchInstantApp

public Boolean getFieldEnableLaunchInstantApp()

setFieldEnableLaunchInstantApp

public AdCreative setFieldEnableLaunchInstantApp(Boolean value)

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

setFieldId

public AdCreative setFieldId(String value)

getFieldImageCrops

public AdsImageCrops getFieldImageCrops()

setFieldImageCrops

public AdCreative setFieldImageCrops(AdsImageCrops value)

setFieldImageCrops

public AdCreative setFieldImageCrops(String value)

getFieldImageHash
```
public String getFieldImageHash()
```

setFieldImageHash

public AdCreative setFieldImageHash(String value)

getFieldImageUrl
```
public String getFieldImageUrl()
```

setFieldImageUrl

public AdCreative setFieldImageUrl(String value)

getFieldInstagramActorId

public String getFieldInstagramActorId()

setFieldInstagramActorId

public AdCreative setFieldInstagramActorId(String value)

getFieldInstagramPermalinkUrl

public String getFieldInstagramPermalinkUrl()

setFieldInstagramPermalinkUrl

public AdCreative setFieldInstagramPermalinkUrl(String value)

getFieldInstagramStoryId

public String getFieldInstagramStoryId()

setFieldInstagramStoryId

public AdCreative setFieldInstagramStoryId(String value)

getFieldLinkDeepLinkUrl

public String getFieldLinkDeepLinkUrl()

setFieldLinkDeepLinkUrl

public AdCreative setFieldLinkDeepLinkUrl(String value)

getFieldLinkOgId
```
public String getFieldLinkOgId()
```

setFieldLinkOgId

public AdCreative setFieldLinkOgId(String value)

getFieldLinkUrl
```
public String getFieldLinkUrl()
```

setFieldLinkUrl

public AdCreative setFieldLinkUrl(String value)

getFieldMessengerSponsoredMessage

public String getFieldMessengerSponsoredMessage()

setFieldMessengerSponsoredMessage

public AdCreative setFieldMessengerSponsoredMessage(String value)

getFieldName
```
public String getFieldName()
```

setFieldName

public AdCreative setFieldName(String value)

getFieldObjectId
```
public String getFieldObjectId()
```

setFieldObjectId

public AdCreative setFieldObjectId(String value)

getFieldObjectStoreUrl

public String getFieldObjectStoreUrl()

setFieldObjectStoreUrl

public AdCreative setFieldObjectStoreUrl(String value)

getFieldObjectStoryId
```
public String getFieldObjectStoryId()
```

setFieldObjectStoryId

public AdCreative setFieldObjectStoryId(String value)

getFieldObjectStorySpec

public AdCreativeObjectStorySpec getFieldObjectStorySpec()

setFieldObjectStorySpec

public AdCreative setFieldObjectStorySpec(AdCreativeObjectStorySpec value)

setFieldObjectStorySpec

public AdCreative setFieldObjectStorySpec(String value)

getFieldObjectType

public AdCreative.EnumObjectType getFieldObjectType()

setFieldObjectType

public AdCreative setFieldObjectType(AdCreative.EnumObjectType value)

getFieldObjectUrl
```
public String getFieldObjectUrl()
```

setFieldObjectUrl

public AdCreative setFieldObjectUrl(String value)

getFieldPlacePageSetId

public String getFieldPlacePageSetId()

setFieldPlacePageSetId

public AdCreative setFieldPlacePageSetId(String value)

getFieldPlatformCustomizations

public AdCreativePlatformCustomization getFieldPlatformCustomizations()

setFieldPlatformCustomizations

public AdCreative setFieldPlatformCustomizations(AdCreativePlatformCustomization value)

setFieldPlatformCustomizations

public AdCreative setFieldPlatformCustomizations(String value)

getFieldPlayableAssetId

public String getFieldPlayableAssetId()

setFieldPlayableAssetId

public AdCreative setFieldPlayableAssetId(String value)

getFieldProductSetId
```
public String getFieldProductSetId()
```

setFieldProductSetId

public AdCreative setFieldProductSetId(String value)

getFieldRecommenderSettings

public AdCreativeRecommenderSettings getFieldRecommenderSettings()

setFieldRecommenderSettings

public AdCreative setFieldRecommenderSettings(AdCreativeRecommenderSettings value)

setFieldRecommenderSettings

public AdCreative setFieldRecommenderSettings(String value)

getFieldStatus

public AdCreative.EnumStatus getFieldStatus()

setFieldStatus

public AdCreative setFieldStatus(AdCreative.EnumStatus value)

getFieldTemplateUrl
```
public String getFieldTemplateUrl()
```

setFieldTemplateUrl

public AdCreative setFieldTemplateUrl(String value)

getFieldTemplateUrlSpec

public AdCreativeTemplateURLSpec getFieldTemplateUrlSpec()

setFieldTemplateUrlSpec

public AdCreative setFieldTemplateUrlSpec(AdCreativeTemplateURLSpec value)

setFieldTemplateUrlSpec

public AdCreative setFieldTemplateUrlSpec(String value)

getFieldThumbnailUrl
```
public String getFieldThumbnailUrl()
```

setFieldThumbnailUrl

public AdCreative setFieldThumbnailUrl(String value)

getFieldTitle
```
public String getFieldTitle()
```

setFieldTitle

public AdCreative setFieldTitle(String value)

getFieldUrlTags
```
public String getFieldUrlTags()
```

setFieldUrlTags

public AdCreative setFieldUrlTags(String value)

getFieldUsePageActorOverride

public Boolean getFieldUsePageActorOverride()

setFieldUsePageActorOverride

public AdCreative setFieldUsePageActorOverride(Boolean value)

getFieldVideoId
```
public String getFieldVideoId()
```

setFieldVideoId

public AdCreative setFieldVideoId(String value)

copyFrom

public AdCreative copyFrom(AdCreative instance)

getParser

public static APIRequest.ResponseParser<AdCreative> getParser()

Class AdCreative

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

AdCreative

AdCreative

AdCreative

Method Detail

fetch

fetchById

fetchByIdAsync

fetchById

fetchByIdAsync

fetchByIds

fetchByIdsAsync

getId

loadJSON

parseResponse

getContext

setContext

toString

deleteAdLabels

createAdLabel

getPreviews

delete

get

update

getFieldAccountId

setFieldAccountId

getFieldActorId

setFieldActorId

getFieldAdlabels

setFieldAdlabels

setFieldAdlabels

getFieldApplinkTreatment

setFieldApplinkTreatment

getFieldAssetFeedId

setFieldAssetFeedId

getFieldAssetFeedSpec

setFieldAssetFeedSpec

setFieldAssetFeedSpec

getFieldAuthorizationCategory

setFieldAuthorizationCategory

getFieldAutoUpdate

setFieldAutoUpdate

getFieldBody

setFieldBody

getFieldBrandedContentSponsorPageId

setFieldBrandedContentSponsorPageId

getFieldBundleFolderId

setFieldBundleFolderId

getFieldCallToActionType

setFieldCallToActionType

getFieldCategorizationCriteria

setFieldCategorizationCriteria

getFieldCategoryMediaSource

setFieldCategoryMediaSource

getFieldDestinationSetId

setFieldDestinationSetId

getFieldDynamicAdVoice

setFieldDynamicAdVoice

getFieldEffectiveAuthorizationCategory

setFieldEffectiveAuthorizationCategory

getFieldEffectiveInstagramStoryId

setFieldEffectiveInstagramStoryId

getFieldEffectiveObjectStoryId

setFieldEffectiveObjectStoryId

getFieldEnableDirectInstall

setFieldEnableDirectInstall

getFieldEnableLaunchInstantApp

setFieldEnableLaunchInstantApp

getFieldId

setFieldId