com.facebook.ads.sdk

Class AdAccount.APIRequestCreateCustomAudience

java.lang.Object

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

com.facebook.ads.sdk.AdAccount.APIRequestCreateCustomAudience

Enclosing class:

AdAccount

public static class AdAccount.APIRequestCreateCustomAudience
extends APIRequest<CustomAudience>

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
APIRequestCreateCustomAudience(String nodeId, APIContext context)

Method Summary

Modifier and Type	Method and Description
CustomAudience	execute()
CustomAudience	execute(Map<String,Object> extraParams)
com.google.common.util.concurrent.ListenableFuture<CustomAudience>	executeAsync()
com.google.common.util.concurrent.ListenableFuture<CustomAudience>	executeAsync(Map<String,Object> extraParams)
CustomAudience	getLastResponse()
CustomAudience	parseResponse(String response, String header)
AdAccount.APIRequestCreateCustomAudience	requestAllFields()
AdAccount.APIRequestCreateCustomAudience	requestAllFields(boolean value)
AdAccount.APIRequestCreateCustomAudience	requestField(String field)
AdAccount.APIRequestCreateCustomAudience	requestField(String field, boolean value)
AdAccount.APIRequestCreateCustomAudience	requestFields(List<String> fields)
AdAccount.APIRequestCreateCustomAudience	requestFields(List<String> fields, boolean value)
AdAccount.APIRequestCreateCustomAudience	setAccountid(String accountid)
AdAccount.APIRequestCreateCustomAudience	setAdditionalmetadata(String additionalmetadata)
AdAccount.APIRequestCreateCustomAudience	setAllowedDomains(List<String> allowedDomains)
AdAccount.APIRequestCreateCustomAudience	setAllowedDomains(String allowedDomains)
AdAccount.APIRequestCreateCustomAudience	setAssociatedAudienceId(Long associatedAudienceId)
AdAccount.APIRequestCreateCustomAudience	setAssociatedAudienceId(String associatedAudienceId)
AdAccount.APIRequestCreateCustomAudience	setClaimObjective(CustomAudience.EnumClaimObjective claimObjective)
AdAccount.APIRequestCreateCustomAudience	setClaimObjective(String claimObjective)
AdAccount.APIRequestCreateCustomAudience	setContentType(CustomAudience.EnumContentType contentType)
AdAccount.APIRequestCreateCustomAudience	setContentType(String contentType)
AdAccount.APIRequestCreateCustomAudience	setCountries(String countries)
AdAccount.APIRequestCreateCustomAudience	setCreationParams(Map<String,String> creationParams)
AdAccount.APIRequestCreateCustomAudience	setCreationParams(String creationParams)
AdAccount.APIRequestCreateCustomAudience	setCustomerFileSource(CustomAudience.EnumCustomerFileSource customerFileSource)
AdAccount.APIRequestCreateCustomAudience	setCustomerFileSource(String customerFileSource)
AdAccount.APIRequestCreateCustomAudience	setDatasetId(String datasetId)
AdAccount.APIRequestCreateCustomAudience	setDescription(String description)
AdAccount.APIRequestCreateCustomAudience	setDetails(String details)
AdAccount.APIRequestCreateCustomAudience	setEnableFetchOrCreate(Boolean enableFetchOrCreate)
AdAccount.APIRequestCreateCustomAudience	setEnableFetchOrCreate(String enableFetchOrCreate)
AdAccount.APIRequestCreateCustomAudience	setEventSourceGroup(String eventSourceGroup)
AdAccount.APIRequestCreateCustomAudience	setEventSources(List<Map<String,String>> eventSources)
AdAccount.APIRequestCreateCustomAudience	setEventSources(String eventSources)
AdAccount.APIRequestCreateCustomAudience	setExclusions(List<Object> exclusions)
AdAccount.APIRequestCreateCustomAudience	setExclusions(String exclusions)
AdAccount.APIRequestCreateCustomAudience	setExpectedsize(Long expectedsize)
AdAccount.APIRequestCreateCustomAudience	setExpectedsize(String expectedsize)
AdAccount.APIRequestCreateCustomAudience	setGender(String gender)
AdAccount.APIRequestCreateCustomAudience	setInclusions(List<Object> inclusions)
AdAccount.APIRequestCreateCustomAudience	setInclusions(String inclusions)
AdAccount.APIRequestCreateCustomAudience	setIsHousehold(Boolean isHousehold)
AdAccount.APIRequestCreateCustomAudience	setIsHousehold(String isHousehold)
AdAccount.APIRequestCreateCustomAudience	setIsHouseholdExclusion(Boolean isHouseholdExclusion)
AdAccount.APIRequestCreateCustomAudience	setIsHouseholdExclusion(String isHouseholdExclusion)
AdAccount.APIRequestCreateCustomAudience	setIsprivate(Boolean isprivate)
AdAccount.APIRequestCreateCustomAudience	setIsprivate(String isprivate)
AdAccount.APIRequestCreateCustomAudience	setIsSnapshot(Boolean isSnapshot)
AdAccount.APIRequestCreateCustomAudience	setIsSnapshot(String isSnapshot)
AdAccount.APIRequestCreateCustomAudience	setIsValueBased(Boolean isValueBased)
AdAccount.APIRequestCreateCustomAudience	setIsValueBased(String isValueBased)
AdAccount.APIRequestCreateCustomAudience	setListOfAccounts(List<Long> listOfAccounts)
AdAccount.APIRequestCreateCustomAudience	setListOfAccounts(String listOfAccounts)
AdAccount.APIRequestCreateCustomAudience	setLookalikeSpec(String lookalikeSpec)
AdAccount.APIRequestCreateCustomAudience	setMaxage(Long maxage)
AdAccount.APIRequestCreateCustomAudience	setMaxage(String maxage)
AdAccount.APIRequestCreateCustomAudience	setMinage(Long minage)
AdAccount.APIRequestCreateCustomAudience	setMinage(String minage)
AdAccount.APIRequestCreateCustomAudience	setName(String name)
AdAccount.APIRequestCreateCustomAudience	setOptOutLink(String optOutLink)
AdAccount.APIRequestCreateCustomAudience	setOriginAudienceId(String originAudienceId)
AdAccount.APIRequestCreateCustomAudience	setParam(String param, Object value)
AdAccount.APIRequestCreateCustomAudience	setParams(Map<String,Object> params)
AdAccount.APIRequestCreateCustomAudience	setParentAudienceId(Long parentAudienceId)
AdAccount.APIRequestCreateCustomAudience	setParentAudienceId(String parentAudienceId)
AdAccount.APIRequestCreateCustomAudience	setPartnerid(String partnerid)
AdAccount.APIRequestCreateCustomAudience	setPartnerReferenceKey(String partnerReferenceKey)
AdAccount.APIRequestCreateCustomAudience	setPixelId(String pixelId)
AdAccount.APIRequestCreateCustomAudience	setPrefill(Boolean prefill)
AdAccount.APIRequestCreateCustomAudience	setPrefill(String prefill)
AdAccount.APIRequestCreateCustomAudience	setProductSetId(String productSetId)
AdAccount.APIRequestCreateCustomAudience	setRegulatedAudienceSpec(String regulatedAudienceSpec)
AdAccount.APIRequestCreateCustomAudience	setRetentionDays(Long retentionDays)
AdAccount.APIRequestCreateCustomAudience	setRetentionDays(String retentionDays)
AdAccount.APIRequestCreateCustomAudience	setRevSharePolicyId(Long revSharePolicyId)
AdAccount.APIRequestCreateCustomAudience	setRevSharePolicyId(String revSharePolicyId)
AdAccount.APIRequestCreateCustomAudience	setRule(String rule)
AdAccount.APIRequestCreateCustomAudience	setRuleAggregation(String ruleAggregation)
AdAccount.APIRequestCreateCustomAudience	setSeedAudience(Long seedAudience)
AdAccount.APIRequestCreateCustomAudience	setSeedAudience(String seedAudience)
AdAccount.APIRequestCreateCustomAudience	setSource(String source)
AdAccount.APIRequestCreateCustomAudience	setStudySpec(Map<String,String> studySpec)
AdAccount.APIRequestCreateCustomAudience	setStudySpec(String studySpec)
AdAccount.APIRequestCreateCustomAudience	setSubtype(CustomAudience.EnumSubtype subtype)
AdAccount.APIRequestCreateCustomAudience	setSubtype(String subtype)
AdAccount.APIRequestCreateCustomAudience	setTags(List<String> tags)
AdAccount.APIRequestCreateCustomAudience	setTags(String tags)
AdAccount.APIRequestCreateCustomAudience	setVideoGroupIds(List<String> videoGroupIds)
AdAccount.APIRequestCreateCustomAudience	setVideoGroupIds(String videoGroupIds)

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

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

APIRequestCreateCustomAudience

public APIRequestCreateCustomAudience(String nodeId,
                                      APIContext context)

Method Detail

getLastResponse

public CustomAudience getLastResponse()

Overrides:

getLastResponse in class APIRequest<CustomAudience>

parseResponse

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

Overrides:

parseResponse in class APIRequest<CustomAudience>

Throws:

APIException

execute

public CustomAudience execute()
                       throws APIException

Overrides:

execute in class APIRequest<CustomAudience>

Throws:

APIException

execute

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

Overrides:

execute in class APIRequest<CustomAudience>

Throws:

APIException

executeAsync

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

Throws:

APIException

executeAsync

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

Throws:

APIException

setParam

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

Overrides:

setParam in class APIRequest<CustomAudience>

setParams

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

Overrides:

setParams in class APIRequest<CustomAudience>

setAccountid

public AdAccount.APIRequestCreateCustomAudience setAccountid(String accountid)

setAdditionalmetadata

public AdAccount.APIRequestCreateCustomAudience setAdditionalmetadata(String additionalmetadata)

setAllowedDomains

public AdAccount.APIRequestCreateCustomAudience setAllowedDomains(List<String> allowedDomains)

setAllowedDomains

public AdAccount.APIRequestCreateCustomAudience setAllowedDomains(String allowedDomains)

setAssociatedAudienceId

public AdAccount.APIRequestCreateCustomAudience setAssociatedAudienceId(Long associatedAudienceId)

setAssociatedAudienceId

public AdAccount.APIRequestCreateCustomAudience setAssociatedAudienceId(String associatedAudienceId)

setClaimObjective

public AdAccount.APIRequestCreateCustomAudience setClaimObjective(CustomAudience.EnumClaimObjective claimObjective)

setClaimObjective

public AdAccount.APIRequestCreateCustomAudience setClaimObjective(String claimObjective)

setContentType

public AdAccount.APIRequestCreateCustomAudience setContentType(CustomAudience.EnumContentType contentType)

setContentType

public AdAccount.APIRequestCreateCustomAudience setContentType(String contentType)

setCountries

public AdAccount.APIRequestCreateCustomAudience setCountries(String countries)

setCreationParams

public AdAccount.APIRequestCreateCustomAudience setCreationParams(Map<String,String> creationParams)

setCreationParams

public AdAccount.APIRequestCreateCustomAudience setCreationParams(String creationParams)

setCustomerFileSource

public AdAccount.APIRequestCreateCustomAudience setCustomerFileSource(CustomAudience.EnumCustomerFileSource customerFileSource)

setCustomerFileSource

public AdAccount.APIRequestCreateCustomAudience setCustomerFileSource(String customerFileSource)

setDatasetId

public AdAccount.APIRequestCreateCustomAudience setDatasetId(String datasetId)

setDescription

public AdAccount.APIRequestCreateCustomAudience setDescription(String description)

setDetails

public AdAccount.APIRequestCreateCustomAudience setDetails(String details)

setEnableFetchOrCreate

public AdAccount.APIRequestCreateCustomAudience setEnableFetchOrCreate(Boolean enableFetchOrCreate)

setEnableFetchOrCreate

public AdAccount.APIRequestCreateCustomAudience setEnableFetchOrCreate(String enableFetchOrCreate)

setEventSourceGroup

public AdAccount.APIRequestCreateCustomAudience setEventSourceGroup(String eventSourceGroup)

setEventSources

public AdAccount.APIRequestCreateCustomAudience setEventSources(List<Map<String,String>> eventSources)

setEventSources

public AdAccount.APIRequestCreateCustomAudience setEventSources(String eventSources)

setExclusions

public AdAccount.APIRequestCreateCustomAudience setExclusions(List<Object> exclusions)

setExclusions

public AdAccount.APIRequestCreateCustomAudience setExclusions(String exclusions)

setExpectedsize

public AdAccount.APIRequestCreateCustomAudience setExpectedsize(Long expectedsize)

setExpectedsize

public AdAccount.APIRequestCreateCustomAudience setExpectedsize(String expectedsize)

setGender

public AdAccount.APIRequestCreateCustomAudience setGender(String gender)

setInclusions

public AdAccount.APIRequestCreateCustomAudience setInclusions(List<Object> inclusions)

setInclusions

public AdAccount.APIRequestCreateCustomAudience setInclusions(String inclusions)

setIsprivate

public AdAccount.APIRequestCreateCustomAudience setIsprivate(Boolean isprivate)

setIsprivate

public AdAccount.APIRequestCreateCustomAudience setIsprivate(String isprivate)

setIsHousehold

public AdAccount.APIRequestCreateCustomAudience setIsHousehold(Boolean isHousehold)

setIsHousehold

public AdAccount.APIRequestCreateCustomAudience setIsHousehold(String isHousehold)

setIsHouseholdExclusion

public AdAccount.APIRequestCreateCustomAudience setIsHouseholdExclusion(Boolean isHouseholdExclusion)

setIsHouseholdExclusion

public AdAccount.APIRequestCreateCustomAudience setIsHouseholdExclusion(String isHouseholdExclusion)

setIsSnapshot

public AdAccount.APIRequestCreateCustomAudience setIsSnapshot(Boolean isSnapshot)

setIsSnapshot

public AdAccount.APIRequestCreateCustomAudience setIsSnapshot(String isSnapshot)

setIsValueBased

public AdAccount.APIRequestCreateCustomAudience setIsValueBased(Boolean isValueBased)

setIsValueBased

public AdAccount.APIRequestCreateCustomAudience setIsValueBased(String isValueBased)

setListOfAccounts

public AdAccount.APIRequestCreateCustomAudience setListOfAccounts(List<Long> listOfAccounts)

setListOfAccounts

public AdAccount.APIRequestCreateCustomAudience setListOfAccounts(String listOfAccounts)

setLookalikeSpec

public AdAccount.APIRequestCreateCustomAudience setLookalikeSpec(String lookalikeSpec)

setMaxage

public AdAccount.APIRequestCreateCustomAudience setMaxage(Long maxage)

setMaxage

public AdAccount.APIRequestCreateCustomAudience setMaxage(String maxage)

setMinage

public AdAccount.APIRequestCreateCustomAudience setMinage(Long minage)

setMinage

public AdAccount.APIRequestCreateCustomAudience setMinage(String minage)

setName

public AdAccount.APIRequestCreateCustomAudience setName(String name)

setOptOutLink

public AdAccount.APIRequestCreateCustomAudience setOptOutLink(String optOutLink)

setOriginAudienceId

public AdAccount.APIRequestCreateCustomAudience setOriginAudienceId(String originAudienceId)

setParentAudienceId

public AdAccount.APIRequestCreateCustomAudience setParentAudienceId(Long parentAudienceId)

setParentAudienceId

public AdAccount.APIRequestCreateCustomAudience setParentAudienceId(String parentAudienceId)

setPartnerid

public AdAccount.APIRequestCreateCustomAudience setPartnerid(String partnerid)

setPartnerReferenceKey

public AdAccount.APIRequestCreateCustomAudience setPartnerReferenceKey(String partnerReferenceKey)

setPixelId

public AdAccount.APIRequestCreateCustomAudience setPixelId(String pixelId)

setPrefill

public AdAccount.APIRequestCreateCustomAudience setPrefill(Boolean prefill)

setPrefill

public AdAccount.APIRequestCreateCustomAudience setPrefill(String prefill)

setProductSetId

public AdAccount.APIRequestCreateCustomAudience setProductSetId(String productSetId)

setRegulatedAudienceSpec

public AdAccount.APIRequestCreateCustomAudience setRegulatedAudienceSpec(String regulatedAudienceSpec)

setRetentionDays

public AdAccount.APIRequestCreateCustomAudience setRetentionDays(Long retentionDays)

setRetentionDays

public AdAccount.APIRequestCreateCustomAudience setRetentionDays(String retentionDays)

setRevSharePolicyId

public AdAccount.APIRequestCreateCustomAudience setRevSharePolicyId(Long revSharePolicyId)

setRevSharePolicyId

public AdAccount.APIRequestCreateCustomAudience setRevSharePolicyId(String revSharePolicyId)

setRule

public AdAccount.APIRequestCreateCustomAudience setRule(String rule)

setRuleAggregation

public AdAccount.APIRequestCreateCustomAudience setRuleAggregation(String ruleAggregation)

setSeedAudience

public AdAccount.APIRequestCreateCustomAudience setSeedAudience(Long seedAudience)

setSeedAudience

public AdAccount.APIRequestCreateCustomAudience setSeedAudience(String seedAudience)

setSource

public AdAccount.APIRequestCreateCustomAudience setSource(String source)

setStudySpec

public AdAccount.APIRequestCreateCustomAudience setStudySpec(Map<String,String> studySpec)

setStudySpec

public AdAccount.APIRequestCreateCustomAudience setStudySpec(String studySpec)

setSubtype

public AdAccount.APIRequestCreateCustomAudience setSubtype(CustomAudience.EnumSubtype subtype)

setSubtype

public AdAccount.APIRequestCreateCustomAudience setSubtype(String subtype)

setTags

public AdAccount.APIRequestCreateCustomAudience setTags(List<String> tags)

setTags

public AdAccount.APIRequestCreateCustomAudience setTags(String tags)

setVideoGroupIds

public AdAccount.APIRequestCreateCustomAudience setVideoGroupIds(List<String> videoGroupIds)

setVideoGroupIds

public AdAccount.APIRequestCreateCustomAudience setVideoGroupIds(String videoGroupIds)

requestAllFields

public AdAccount.APIRequestCreateCustomAudience requestAllFields()

requestAllFields

public AdAccount.APIRequestCreateCustomAudience requestAllFields(boolean value)

requestFields

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

Overrides:

requestFields in class APIRequest<CustomAudience>

requestFields

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

Overrides:

requestFields in class APIRequest<CustomAudience>

requestField

public AdAccount.APIRequestCreateCustomAudience requestField(String field)

Overrides:

requestField in class APIRequest<CustomAudience>

requestField

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

Overrides:

requestField in class APIRequest<CustomAudience>