com.facebook.ads.sdk

Class CustomAudience

java.lang.Object

com.facebook.ads.sdk.APINode

com.facebook.ads.sdk.CustomAudience

All Implemented Interfaces:

APIResponse

public class CustomAudience
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	CustomAudience.APIRequestCreateAdAccount
static class	CustomAudience.APIRequestCreateCapability
static class	CustomAudience.APIRequestCreateDatum
static class	CustomAudience.APIRequestCreateUpload
static class	CustomAudience.APIRequestCreateUser
static class	CustomAudience.APIRequestDelete
static class	CustomAudience.APIRequestDeleteAdAccounts
static class	CustomAudience.APIRequestDeleteCapabilities
static class	CustomAudience.APIRequestDeleteUpload
static class	CustomAudience.APIRequestDeleteUsers
static class	CustomAudience.APIRequestGet
static class	CustomAudience.APIRequestGetAdAccounts
static class	CustomAudience.APIRequestGetAds
static class	CustomAudience.APIRequestGetPrefills
static class	CustomAudience.APIRequestGetSessions
static class	CustomAudience.APIRequestGetShareDAccountInfo
static class	CustomAudience.APIRequestUpdate
static class	CustomAudience.EnumActionType
static class	CustomAudience.EnumClaimObjective
static class	CustomAudience.EnumContentType
static class	CustomAudience.EnumCustomerFileSource
static class	CustomAudience.EnumEncoding
static class	CustomAudience.EnumEntryType
static class	CustomAudience.EnumSubtype

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CustomAudience	copyFrom(CustomAudience instance)
CustomAudience.APIRequestCreateAdAccount	createAdAccount()
CustomAudience.APIRequestCreateCapability	createCapability()
CustomAudience.APIRequestCreateDatum	createDatum()
CustomAudience.APIRequestCreateUpload	createUpload()
CustomAudience.APIRequestCreateUser	createUser()
CustomAudience.APIRequestDelete	delete()
CustomAudience.APIRequestDeleteAdAccounts	deleteAdAccounts()
CustomAudience.APIRequestDeleteCapabilities	deleteCapabilities()
CustomAudience.APIRequestDeleteUpload	deleteUpload()
CustomAudience.APIRequestDeleteUsers	deleteUsers()
CustomAudience	fetch()
static CustomAudience	fetchById(Long id, APIContext context)
static CustomAudience	fetchById(String id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<CustomAudience>	fetchByIdAsync(Long id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<CustomAudience>	fetchByIdAsync(String id, APIContext context)
static APINodeList<CustomAudience>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<APINodeList<CustomAudience>>	fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)
CustomAudience.APIRequestGet	get()
CustomAudience.APIRequestGetAdAccounts	getAdAccounts()
CustomAudience.APIRequestGetAds	getAds()
APIContext	getContext()
String	getFieldAccountId()
Long	getFieldApproximateCount()
String	getFieldCustomerFileSource()
String	getFieldDatafileCustomAudienceUploadingStatus()
CustomAudienceDataSource	getFieldDataSource()
String	getFieldDataSourceTypes()
CustomAudienceStatus	getFieldDeliveryStatus()
String	getFieldDescription()
List<CustomAudience>	getFieldExcludedCustomAudiences()
Long	getFieldExpiryTime()
AdsPixel	getFieldExternalEventSource()
Long	getFieldHouseholdAudience()
String	getFieldId()
List<CustomAudience>	getFieldIncludedCustomAudiences()
Boolean	getFieldIsHousehold()
Boolean	getFieldIsSnapshot()
Boolean	getFieldIsValueBased()
List<String>	getFieldListOfAccounts()
List<String>	getFieldLookalikeAudienceIds()
LookalikeSpec	getFieldLookalikeSpec()
String	getFieldName()
CustomAudienceStatus	getFieldOperationStatus()
String	getFieldOptOutLink()
AudiencePermissionForActions	getFieldPermissionForActions()
String	getFieldPixelId()
Long	getFieldRetentionDays()
Long	getFieldRevSharePolicyId()
String	getFieldRule()
String	getFieldRuleAggregation()
String	getFieldRuleV2()
Long	getFieldSeedAudience()
CustomAudienceSharingStatus	getFieldSharingStatus()
AudienceInsightsStudySpec	getFieldStudySpec()
String	getFieldSubtype()
Long	getFieldTimeContentUpdated()
Long	getFieldTimeCreated()
Long	getFieldTimeUpdated()
String	getId()
static APIRequest.ResponseParser<CustomAudience>	getParser()
CustomAudience.APIRequestGetPrefills	getPrefills()
CustomAudience.APIRequestGetSessions	getSessions()
CustomAudience.APIRequestGetShareDAccountInfo	getShareDAccountInfo()
static CustomAudience	loadJSON(String json, APIContext context)
static APINodeList<CustomAudience>	parseResponse(String json, APIContext context, APIRequest request)
void	setContext(APIContext context)
String	toString()
CustomAudience.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

CustomAudience

public CustomAudience(Long id,
                      APIContext context)

CustomAudience

public CustomAudience(String id,
                      APIContext context)

Method Detail

fetch

public CustomAudience fetch()
                     throws APIException

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchById

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

Throws:

APIException

fetchByIdAsync

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

Throws:

APIException

fetchByIds

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

Throws:

APIException

fetchByIdsAsync

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

parseResponse

public static APINodeList<CustomAudience> 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

deleteAdAccounts

public CustomAudience.APIRequestDeleteAdAccounts deleteAdAccounts()

getAdAccounts

public CustomAudience.APIRequestGetAdAccounts getAdAccounts()

createAdAccount

public CustomAudience.APIRequestCreateAdAccount createAdAccount()

getAds

public CustomAudience.APIRequestGetAds getAds()

deleteCapabilities

public CustomAudience.APIRequestDeleteCapabilities deleteCapabilities()

createCapability

public CustomAudience.APIRequestCreateCapability createCapability()

createDatum

public CustomAudience.APIRequestCreateDatum createDatum()

getPrefills

public CustomAudience.APIRequestGetPrefills getPrefills()

getSessions

public CustomAudience.APIRequestGetSessions getSessions()

getShareDAccountInfo

public CustomAudience.APIRequestGetShareDAccountInfo getShareDAccountInfo()

deleteUpload

public CustomAudience.APIRequestDeleteUpload deleteUpload()

createUpload

public CustomAudience.APIRequestCreateUpload createUpload()

deleteUsers

public CustomAudience.APIRequestDeleteUsers deleteUsers()

createUser

public CustomAudience.APIRequestCreateUser createUser()

delete

public CustomAudience.APIRequestDelete delete()

get

public CustomAudience.APIRequestGet get()

update

public CustomAudience.APIRequestUpdate update()

getFieldAccountId

public String getFieldAccountId()

getFieldApproximateCount

public Long getFieldApproximateCount()

getFieldCustomerFileSource

public String getFieldCustomerFileSource()

getFieldDataSource

public CustomAudienceDataSource getFieldDataSource()

getFieldDataSourceTypes

public String getFieldDataSourceTypes()

getFieldDatafileCustomAudienceUploadingStatus

public String getFieldDatafileCustomAudienceUploadingStatus()

getFieldDeliveryStatus

public CustomAudienceStatus getFieldDeliveryStatus()

getFieldDescription

public String getFieldDescription()

getFieldExcludedCustomAudiences

public List<CustomAudience> getFieldExcludedCustomAudiences()

getFieldExpiryTime

public Long getFieldExpiryTime()

getFieldExternalEventSource

public AdsPixel getFieldExternalEventSource()

getFieldHouseholdAudience

public Long getFieldHouseholdAudience()

getFieldId

public String getFieldId()

getFieldIncludedCustomAudiences

public List<CustomAudience> getFieldIncludedCustomAudiences()

getFieldIsHousehold

public Boolean getFieldIsHousehold()

getFieldIsSnapshot

public Boolean getFieldIsSnapshot()

getFieldIsValueBased

public Boolean getFieldIsValueBased()

getFieldListOfAccounts

public List<String> getFieldListOfAccounts()

getFieldLookalikeAudienceIds

public List<String> getFieldLookalikeAudienceIds()

getFieldLookalikeSpec

public LookalikeSpec getFieldLookalikeSpec()

getFieldName

public String getFieldName()

getFieldOperationStatus

public CustomAudienceStatus getFieldOperationStatus()

getFieldOptOutLink

public String getFieldOptOutLink()

getFieldPermissionForActions

public AudiencePermissionForActions getFieldPermissionForActions()

getFieldPixelId

public String getFieldPixelId()

getFieldRetentionDays

public Long getFieldRetentionDays()

getFieldRevSharePolicyId

public Long getFieldRevSharePolicyId()

getFieldRule

public String getFieldRule()

getFieldRuleAggregation

public String getFieldRuleAggregation()

getFieldRuleV2

public String getFieldRuleV2()

getFieldSeedAudience

public Long getFieldSeedAudience()

getFieldSharingStatus

public CustomAudienceSharingStatus getFieldSharingStatus()

getFieldStudySpec

public AudienceInsightsStudySpec getFieldStudySpec()

getFieldSubtype

public String getFieldSubtype()

getFieldTimeContentUpdated

public Long getFieldTimeContentUpdated()

getFieldTimeCreated

public Long getFieldTimeCreated()

getFieldTimeUpdated

public Long getFieldTimeUpdated()

copyFrom

public CustomAudience copyFrom(CustomAudience instance)

getParser

public static APIRequest.ResponseParser<CustomAudience> getParser()