com.facebook.ads.sdk

Class AdAccount.APIRequestCreateAdCreative

java.lang.Object

com.facebook.ads.sdk.APIRequest<AdCreative>

com.facebook.ads.sdk.AdAccount.APIRequestCreateAdCreative

Enclosing class:

AdAccount

public static class AdAccount.APIRequestCreateAdCreative
extends APIRequest<AdCreative>

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.ads.sdk.APIRequest

APIRequest.DefaultAsyncRequestExecutor, APIRequest.DefaultRequestExecutor, APIRequest.IAsyncRequestExecutor, APIRequest.IRequestExecutor, APIRequest.RequestHelper, APIRequest.ResponseParser<T extends APINode>, APIRequest.ResponseWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	FIELDS
static String[]	PARAMS

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

context, endpoint, method, nodeId, paramNames, params, parser, returnFields, USER_AGENT, useVideoEndpoint

Constructor Summary

Constructors

Constructor and Description
APIRequestCreateAdCreative(String nodeId, APIContext context)

Method Summary

Modifier and Type	Method and Description
AdCreative	execute()
AdCreative	execute(Map<String,Object> extraParams)
com.google.common.util.concurrent.ListenableFuture<AdCreative>	executeAsync()
com.google.common.util.concurrent.ListenableFuture<AdCreative>	executeAsync(Map<String,Object> extraParams)
AdCreative	getLastResponse()
AdCreative	parseResponse(String response, String header)
AdAccount.APIRequestCreateAdCreative	requestAllFields()
AdAccount.APIRequestCreateAdCreative	requestAllFields(boolean value)
AdAccount.APIRequestCreateAdCreative	requestField(String field)
AdAccount.APIRequestCreateAdCreative	requestField(String field, boolean value)
AdAccount.APIRequestCreateAdCreative	requestFields(List<String> fields)
AdAccount.APIRequestCreateAdCreative	requestFields(List<String> fields, boolean value)
AdAccount.APIRequestCreateAdCreative	setActorId(Long actorId)
AdAccount.APIRequestCreateAdCreative	setActorId(String actorId)
AdAccount.APIRequestCreateAdCreative	setAdlabels(List<Object> adlabels)
AdAccount.APIRequestCreateAdCreative	setAdlabels(String adlabels)
AdAccount.APIRequestCreateAdCreative	setApplinkTreatment(AdCreative.EnumApplinkTreatment applinkTreatment)
AdAccount.APIRequestCreateAdCreative	setApplinkTreatment(String applinkTreatment)
AdAccount.APIRequestCreateAdCreative	setAssetFeedSpec(Object assetFeedSpec)
AdAccount.APIRequestCreateAdCreative	setAssetFeedSpec(String assetFeedSpec)
AdAccount.APIRequestCreateAdCreative	setAuthorizationCategory(AdCreative.EnumAuthorizationCategory authorizationCategory)
AdAccount.APIRequestCreateAdCreative	setAuthorizationCategory(String authorizationCategory)
AdAccount.APIRequestCreateAdCreative	setBody(String body)
AdAccount.APIRequestCreateAdCreative	setBrandedContentSponsorPageId(String brandedContentSponsorPageId)
AdAccount.APIRequestCreateAdCreative	setBundleFolderId(String bundleFolderId)
AdAccount.APIRequestCreateAdCreative	setCallToAction(Object callToAction)
AdAccount.APIRequestCreateAdCreative	setCallToAction(String callToAction)
AdAccount.APIRequestCreateAdCreative	setCategorizationCriteria(AdCreative.EnumCategorizationCriteria categorizationCriteria)
AdAccount.APIRequestCreateAdCreative	setCategorizationCriteria(String categorizationCriteria)
AdAccount.APIRequestCreateAdCreative	setCategoryMediaSource(AdCreative.EnumCategoryMediaSource categoryMediaSource)
AdAccount.APIRequestCreateAdCreative	setCategoryMediaSource(String categoryMediaSource)
AdAccount.APIRequestCreateAdCreative	setDestinationSetId(String destinationSetId)
AdAccount.APIRequestCreateAdCreative	setDynamicAdVoice(AdCreative.EnumDynamicAdVoice dynamicAdVoice)
AdAccount.APIRequestCreateAdCreative	setDynamicAdVoice(String dynamicAdVoice)
AdAccount.APIRequestCreateAdCreative	setEnableLaunchInstantApp(Boolean enableLaunchInstantApp)
AdAccount.APIRequestCreateAdCreative	setEnableLaunchInstantApp(String enableLaunchInstantApp)
AdAccount.APIRequestCreateAdCreative	setImageCrops(Map<String,String> imageCrops)
AdAccount.APIRequestCreateAdCreative	setImageCrops(String imageCrops)
AdAccount.APIRequestCreateAdCreative	setImageFile(String imageFile)
AdAccount.APIRequestCreateAdCreative	setImageHash(String imageHash)
AdAccount.APIRequestCreateAdCreative	setImageUrl(String imageUrl)
AdAccount.APIRequestCreateAdCreative	setInstagramActorId(String instagramActorId)
AdAccount.APIRequestCreateAdCreative	setInstagramPermalinkUrl(String instagramPermalinkUrl)
AdAccount.APIRequestCreateAdCreative	setInstagramUserId(String instagramUserId)
AdAccount.APIRequestCreateAdCreative	setInstantCheckoutSetting(AdCreative.EnumInstantCheckoutSetting instantCheckoutSetting)
AdAccount.APIRequestCreateAdCreative	setInstantCheckoutSetting(String instantCheckoutSetting)
AdAccount.APIRequestCreateAdCreative	setInteractiveComponentsSpec(Map<String,String> interactiveComponentsSpec)
AdAccount.APIRequestCreateAdCreative	setInteractiveComponentsSpec(String interactiveComponentsSpec)
AdAccount.APIRequestCreateAdCreative	setIsDcoInternal(Boolean isDcoInternal)
AdAccount.APIRequestCreateAdCreative	setIsDcoInternal(String isDcoInternal)
AdAccount.APIRequestCreateAdCreative	setLinkOgId(String linkOgId)
AdAccount.APIRequestCreateAdCreative	setLinkUrl(String linkUrl)
AdAccount.APIRequestCreateAdCreative	setMessengerSponsoredMessage(String messengerSponsoredMessage)
AdAccount.APIRequestCreateAdCreative	setName(String name)
AdAccount.APIRequestCreateAdCreative	setObjectId(Long objectId)
AdAccount.APIRequestCreateAdCreative	setObjectId(String objectId)
AdAccount.APIRequestCreateAdCreative	setObjectStoryId(String objectStoryId)
AdAccount.APIRequestCreateAdCreative	setObjectStorySpec(AdCreativeObjectStorySpec objectStorySpec)
AdAccount.APIRequestCreateAdCreative	setObjectStorySpec(String objectStorySpec)
AdAccount.APIRequestCreateAdCreative	setObjectType(String objectType)
AdAccount.APIRequestCreateAdCreative	setObjectUrl(String objectUrl)
AdAccount.APIRequestCreateAdCreative	setParam(String param, Object value)
AdAccount.APIRequestCreateAdCreative	setParams(Map<String,Object> params)
AdAccount.APIRequestCreateAdCreative	setPlatformCustomizations(Object platformCustomizations)
AdAccount.APIRequestCreateAdCreative	setPlatformCustomizations(String platformCustomizations)
AdAccount.APIRequestCreateAdCreative	setPlayableAssetId(String playableAssetId)
AdAccount.APIRequestCreateAdCreative	setPortraitCustomizations(Map<String,String> portraitCustomizations)
AdAccount.APIRequestCreateAdCreative	setPortraitCustomizations(String portraitCustomizations)
AdAccount.APIRequestCreateAdCreative	setProductSetId(String productSetId)
AdAccount.APIRequestCreateAdCreative	setRecommenderSettings(Map<String,String> recommenderSettings)
AdAccount.APIRequestCreateAdCreative	setRecommenderSettings(String recommenderSettings)
AdAccount.APIRequestCreateAdCreative	setSourceInstagramMediaId(String sourceInstagramMediaId)
AdAccount.APIRequestCreateAdCreative	setTemplateUrl(String templateUrl)
AdAccount.APIRequestCreateAdCreative	setTemplateUrlSpec(Object templateUrlSpec)
AdAccount.APIRequestCreateAdCreative	setTemplateUrlSpec(String templateUrlSpec)
AdAccount.APIRequestCreateAdCreative	setThumbnailUrl(String thumbnailUrl)
AdAccount.APIRequestCreateAdCreative	setTitle(String title)
AdAccount.APIRequestCreateAdCreative	setUrlTags(String urlTags)
AdAccount.APIRequestCreateAdCreative	setUsePageActorOverride(Boolean usePageActorOverride)
AdAccount.APIRequestCreateAdCreative	setUsePageActorOverride(String usePageActorOverride)

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

addToBatch, addToBatch, addToBatch, changeAsyncRequestExecutor, changeRequestExecutor, executeAsyncBase, executeAsyncBase, executeAsyncInternal, executeAsyncInternal, executeInternal, executeInternal, getAsyncExecutor, getContext, getExecutor, joinStringList, requestFieldInternal, setContext, setOverrideUrl, setParamInternal, setParamsInternal, setUseVideoEndpoint

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS

public static final String[] PARAMS

FIELDS

public static final String[] FIELDS

Constructor Detail

APIRequestCreateAdCreative

public APIRequestCreateAdCreative(String nodeId,
                                  APIContext context)

Method Detail

getLastResponse

public AdCreative getLastResponse()

Overrides:

getLastResponse in class APIRequest<AdCreative>

parseResponse

public AdCreative parseResponse(String response,
                                String header)
                         throws APIException

Overrides:

parseResponse in class APIRequest<AdCreative>

Throws:

APIException

execute

public AdCreative execute()
                   throws APIException

Overrides:

execute in class APIRequest<AdCreative>

Throws:

APIException

execute

public AdCreative execute(Map<String,Object> extraParams)
                   throws APIException

Overrides:

execute in class APIRequest<AdCreative>

Throws:

APIException

executeAsync

public com.google.common.util.concurrent.ListenableFuture<AdCreative> executeAsync()
                                                                            throws APIException

Throws:

APIException

executeAsync

public com.google.common.util.concurrent.ListenableFuture<AdCreative> executeAsync(Map<String,Object> extraParams)
                                                                            throws APIException

Throws:

APIException

setParam

public AdAccount.APIRequestCreateAdCreative setParam(String param,
                                                     Object value)

Overrides:

setParam in class APIRequest<AdCreative>

setParams

public AdAccount.APIRequestCreateAdCreative setParams(Map<String,Object> params)

Overrides:

setParams in class APIRequest<AdCreative>

setActorId

public AdAccount.APIRequestCreateAdCreative setActorId(Long actorId)

setActorId

public AdAccount.APIRequestCreateAdCreative setActorId(String actorId)

setAdlabels

public AdAccount.APIRequestCreateAdCreative setAdlabels(List<Object> adlabels)

setAdlabels

public AdAccount.APIRequestCreateAdCreative setAdlabels(String adlabels)

setApplinkTreatment

public AdAccount.APIRequestCreateAdCreative setApplinkTreatment(AdCreative.EnumApplinkTreatment applinkTreatment)

setApplinkTreatment

public AdAccount.APIRequestCreateAdCreative setApplinkTreatment(String applinkTreatment)

setAssetFeedSpec

public AdAccount.APIRequestCreateAdCreative setAssetFeedSpec(Object assetFeedSpec)

setAssetFeedSpec

public AdAccount.APIRequestCreateAdCreative setAssetFeedSpec(String assetFeedSpec)

setAuthorizationCategory

public AdAccount.APIRequestCreateAdCreative setAuthorizationCategory(AdCreative.EnumAuthorizationCategory authorizationCategory)

setAuthorizationCategory

public AdAccount.APIRequestCreateAdCreative setAuthorizationCategory(String authorizationCategory)

setBody

public AdAccount.APIRequestCreateAdCreative setBody(String body)

setBrandedContentSponsorPageId

public AdAccount.APIRequestCreateAdCreative setBrandedContentSponsorPageId(String brandedContentSponsorPageId)

setBundleFolderId

public AdAccount.APIRequestCreateAdCreative setBundleFolderId(String bundleFolderId)

setCallToAction

public AdAccount.APIRequestCreateAdCreative setCallToAction(Object callToAction)

setCallToAction

public AdAccount.APIRequestCreateAdCreative setCallToAction(String callToAction)

setCategorizationCriteria

public AdAccount.APIRequestCreateAdCreative setCategorizationCriteria(AdCreative.EnumCategorizationCriteria categorizationCriteria)

setCategorizationCriteria

public AdAccount.APIRequestCreateAdCreative setCategorizationCriteria(String categorizationCriteria)

setCategoryMediaSource

public AdAccount.APIRequestCreateAdCreative setCategoryMediaSource(AdCreative.EnumCategoryMediaSource categoryMediaSource)

setCategoryMediaSource

public AdAccount.APIRequestCreateAdCreative setCategoryMediaSource(String categoryMediaSource)

setDestinationSetId

public AdAccount.APIRequestCreateAdCreative setDestinationSetId(String destinationSetId)

setDynamicAdVoice

public AdAccount.APIRequestCreateAdCreative setDynamicAdVoice(AdCreative.EnumDynamicAdVoice dynamicAdVoice)

setDynamicAdVoice

public AdAccount.APIRequestCreateAdCreative setDynamicAdVoice(String dynamicAdVoice)

setEnableLaunchInstantApp

public AdAccount.APIRequestCreateAdCreative setEnableLaunchInstantApp(Boolean enableLaunchInstantApp)

setEnableLaunchInstantApp

public AdAccount.APIRequestCreateAdCreative setEnableLaunchInstantApp(String enableLaunchInstantApp)

setImageCrops

public AdAccount.APIRequestCreateAdCreative setImageCrops(Map<String,String> imageCrops)

setImageCrops

public AdAccount.APIRequestCreateAdCreative setImageCrops(String imageCrops)

setImageFile

public AdAccount.APIRequestCreateAdCreative setImageFile(String imageFile)

setImageHash

public AdAccount.APIRequestCreateAdCreative setImageHash(String imageHash)

setImageUrl

public AdAccount.APIRequestCreateAdCreative setImageUrl(String imageUrl)

setInstagramActorId

public AdAccount.APIRequestCreateAdCreative setInstagramActorId(String instagramActorId)

setInstagramPermalinkUrl

public AdAccount.APIRequestCreateAdCreative setInstagramPermalinkUrl(String instagramPermalinkUrl)

setInstagramUserId

public AdAccount.APIRequestCreateAdCreative setInstagramUserId(String instagramUserId)

setInstantCheckoutSetting

public AdAccount.APIRequestCreateAdCreative setInstantCheckoutSetting(AdCreative.EnumInstantCheckoutSetting instantCheckoutSetting)

setInstantCheckoutSetting

public AdAccount.APIRequestCreateAdCreative setInstantCheckoutSetting(String instantCheckoutSetting)

setInteractiveComponentsSpec

public AdAccount.APIRequestCreateAdCreative setInteractiveComponentsSpec(Map<String,String> interactiveComponentsSpec)

setInteractiveComponentsSpec

public AdAccount.APIRequestCreateAdCreative setInteractiveComponentsSpec(String interactiveComponentsSpec)

setIsDcoInternal

public AdAccount.APIRequestCreateAdCreative setIsDcoInternal(Boolean isDcoInternal)

setIsDcoInternal

public AdAccount.APIRequestCreateAdCreative setIsDcoInternal(String isDcoInternal)

setLinkOgId

public AdAccount.APIRequestCreateAdCreative setLinkOgId(String linkOgId)

setLinkUrl

public AdAccount.APIRequestCreateAdCreative setLinkUrl(String linkUrl)

setMessengerSponsoredMessage

public AdAccount.APIRequestCreateAdCreative setMessengerSponsoredMessage(String messengerSponsoredMessage)

setName

public AdAccount.APIRequestCreateAdCreative setName(String name)

setObjectId

public AdAccount.APIRequestCreateAdCreative setObjectId(Long objectId)

setObjectId

public AdAccount.APIRequestCreateAdCreative setObjectId(String objectId)

setObjectStoryId

public AdAccount.APIRequestCreateAdCreative setObjectStoryId(String objectStoryId)

setObjectStorySpec

public AdAccount.APIRequestCreateAdCreative setObjectStorySpec(AdCreativeObjectStorySpec objectStorySpec)

setObjectStorySpec

public AdAccount.APIRequestCreateAdCreative setObjectStorySpec(String objectStorySpec)

setObjectType

public AdAccount.APIRequestCreateAdCreative setObjectType(String objectType)

setObjectUrl

public AdAccount.APIRequestCreateAdCreative setObjectUrl(String objectUrl)

setPlatformCustomizations

public AdAccount.APIRequestCreateAdCreative setPlatformCustomizations(Object platformCustomizations)

setPlatformCustomizations

public AdAccount.APIRequestCreateAdCreative setPlatformCustomizations(String platformCustomizations)

setPlayableAssetId

public AdAccount.APIRequestCreateAdCreative setPlayableAssetId(String playableAssetId)

setPortraitCustomizations

public AdAccount.APIRequestCreateAdCreative setPortraitCustomizations(Map<String,String> portraitCustomizations)

setPortraitCustomizations

public AdAccount.APIRequestCreateAdCreative setPortraitCustomizations(String portraitCustomizations)

setProductSetId

public AdAccount.APIRequestCreateAdCreative setProductSetId(String productSetId)

setRecommenderSettings

public AdAccount.APIRequestCreateAdCreative setRecommenderSettings(Map<String,String> recommenderSettings)

setRecommenderSettings

public AdAccount.APIRequestCreateAdCreative setRecommenderSettings(String recommenderSettings)

setSourceInstagramMediaId

public AdAccount.APIRequestCreateAdCreative setSourceInstagramMediaId(String sourceInstagramMediaId)

setTemplateUrl

public AdAccount.APIRequestCreateAdCreative setTemplateUrl(String templateUrl)

setTemplateUrlSpec

public AdAccount.APIRequestCreateAdCreative setTemplateUrlSpec(Object templateUrlSpec)

setTemplateUrlSpec

public AdAccount.APIRequestCreateAdCreative setTemplateUrlSpec(String templateUrlSpec)

setThumbnailUrl

public AdAccount.APIRequestCreateAdCreative setThumbnailUrl(String thumbnailUrl)

setTitle

public AdAccount.APIRequestCreateAdCreative setTitle(String title)

setUrlTags

public AdAccount.APIRequestCreateAdCreative setUrlTags(String urlTags)

setUsePageActorOverride

public AdAccount.APIRequestCreateAdCreative setUsePageActorOverride(Boolean usePageActorOverride)

setUsePageActorOverride

public AdAccount.APIRequestCreateAdCreative setUsePageActorOverride(String usePageActorOverride)

requestAllFields

public AdAccount.APIRequestCreateAdCreative requestAllFields()

requestAllFields

public AdAccount.APIRequestCreateAdCreative requestAllFields(boolean value)

requestFields

public AdAccount.APIRequestCreateAdCreative requestFields(List<String> fields)

Overrides:

requestFields in class APIRequest<AdCreative>

requestFields

public AdAccount.APIRequestCreateAdCreative requestFields(List<String> fields,
                                                          boolean value)

Overrides:

requestFields in class APIRequest<AdCreative>

requestField

public AdAccount.APIRequestCreateAdCreative requestField(String field)

Overrides:

requestField in class APIRequest<AdCreative>

requestField

public AdAccount.APIRequestCreateAdCreative requestField(String field,
                                                         boolean value)

Overrides:

requestField in class APIRequest<AdCreative>