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.APIRequestCreateUser
static class	CustomAudience.APIRequestDelete
static class	CustomAudience.APIRequestDeleteAdAccounts
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.APIRequestUpdate
static class	CustomAudience.EnumClaimObjective
static class	CustomAudience.EnumContentType
static class	CustomAudience.EnumFields
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.APIRequestCreateUser	createUser()
CustomAudience.APIRequestDelete	delete()
CustomAudience.APIRequestDeleteAdAccounts	deleteAdAccounts()
CustomAudience.APIRequestDeleteUsers	deleteUsers()
CustomAudience	fetch()
static CustomAudience	fetchById(Long id, APIContext context)
static CustomAudience	fetchById(String id, APIContext context)
static APINodeList<CustomAudience>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
CustomAudience.APIRequestGet	get()
CustomAudience.APIRequestGetAdAccounts	getAdAccounts()
CustomAudience.APIRequestGetAds	getAds()
APIContext	getContext()
String	getFieldAccountId()
Long	getFieldApproximateCount()
CustomAudienceDataSource	getFieldDataSource()
CustomAudienceStatus	getFieldDeliveryStatus()
String	getFieldDescription()
AdsPixel	getFieldExternalEventSource()
String	getFieldId()
Boolean	getFieldIsValueBased()
List<String>	getFieldLookalikeAudienceIds()
LookalikeSpec	getFieldLookalikeSpec()
String	getFieldName()
CustomAudienceStatus	getFieldOperationStatus()
String	getFieldOptOutLink()
CustomAudiencePermission	getFieldPermissionForActions()
String	getFieldPixelId()
Long	getFieldRetentionDays()
String	getFieldRule()
String	getFieldRuleAggregation()
String	getFieldSubtype()
Long	getFieldTimeContentUpdated()
Long	getFieldTimeCreated()
Long	getFieldTimeUpdated()
String	getId()
static APIRequest.ResponseParser<CustomAudience>	getParser()
CustomAudience.APIRequestGetPrefills	getPrefills()
CustomAudience.APIRequestGetSessions	getSessions()
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

fetchById

public static CustomAudience fetchById(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

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

getPrefills

public CustomAudience.APIRequestGetPrefills getPrefills()

getSessions

public CustomAudience.APIRequestGetSessions getSessions()

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

getFieldDataSource

public CustomAudienceDataSource getFieldDataSource()

getFieldDeliveryStatus

public CustomAudienceStatus getFieldDeliveryStatus()

getFieldDescription

public String getFieldDescription()

getFieldExternalEventSource

public AdsPixel getFieldExternalEventSource()

getFieldId

public String getFieldId()

getFieldIsValueBased

public Boolean getFieldIsValueBased()

getFieldLookalikeAudienceIds

public List<String> getFieldLookalikeAudienceIds()

getFieldLookalikeSpec

public LookalikeSpec getFieldLookalikeSpec()

getFieldName

public String getFieldName()

getFieldOperationStatus

public CustomAudienceStatus getFieldOperationStatus()

getFieldOptOutLink

public String getFieldOptOutLink()

getFieldPermissionForActions

public CustomAudiencePermission getFieldPermissionForActions()

getFieldPixelId

public String getFieldPixelId()

getFieldRetentionDays

public Long getFieldRetentionDays()

getFieldRule

public String getFieldRule()

getFieldRuleAggregation

public String getFieldRuleAggregation()

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