Package com.restfb.types.ads
Klasse CustomAudience
java.lang.Object
com.restfb.types.AbstractFacebookType
com.restfb.types.ads.BaseAdsObject
com.restfb.types.ads.NamedAdsObject
com.restfb.types.ads.CustomAudience
- Alle implementierten Schnittstellen:
Serializable
Represents the Custom
Audience Marketing API type
- Siehe auch:
-
Konstruktorübersicht
-
Methodenübersicht
Modifizierer und TypMethodeBeschreibunggetRule()
void
setAccountId
(String accountId) Ad Account IDvoid
setApproximateCount
(Long approximateCount) Approximate number of people in this audiencevoid
setDataSource
(CustomAudienceDataSource dataSource) JSON dictionary of type, sub_type to indicate by which method the custom audience was created.void
setDeliveryStatus
(CustomAudienceStatus deliveryStatus) JSON dictionary of code and description.void
setDescription
(String description) Custom audience descriptionvoid
setExcludedCustomAudiences
(List<CustomAudience> excludedCustomAudiences) void
setExternalEventSource
(AdsPixel externalEventSource) Read-only JSON dictionary with key id containing the pixel id whose traffic generated this custom audiencevoid
setIncludedCustomAudiences
(List<CustomAudience> includedCustomAudiences) void
setLastUsedTime
(String lastUsedTime) last used time of this object by the current viewervoid
setLookalikeAudienceIds
(List<String> lookalikeAudienceIds) The IDs of the lookalike audiences generated from this audiencevoid
setLookalikeSpec
(LookalikeSpec lookalikeSpec) Generated only when the subtype is LOOKALIKE.void
setOperationStatus
(CustomAudienceStatus operationStatus) JSON dictionary of code to int value and description to a description string.void
setOptOutLink
(String optOutLink) Your opt-out URL so people can choose not to be targetedvoid
setOriginAudienceId
(Long originAudienceId) The ID of origin Custom Audience.void
setOwnerBusiness
(Business ownerBusiness) owner business of this objectvoid
setPermissionForActions
(CustomAudiencePermission permissionForActions) JSON dictionary of permissions (string) to boolean value if the custom audience has that permissionvoid
setPixelId
(String pixelId) ID of the pixel which is collecting events for this Website Custom audiencevoid
setRetentionDays
(Long retentionDays) Number of days to keep the user in this cluster.void
Audience rules to be applied on the referrer URLvoid
setSubtype
(String subtype) Type of custom audience, derived from original data sourcevoid
setTimeContentUpdated
(Long timeContentUpdated) Last update of people in this custom audiencevoid
setTimeCreated
(Long timeCreated) Creation timevoid
setTimeUpdated
(Long timeUpdated) Last time this audience metadata was updatedVon Klasse geerbte Methoden com.restfb.types.ads.NamedAdsObject
getName, setName
Von Klasse geerbte Methoden com.restfb.types.ads.BaseAdsObject
getId, setId
Von Klasse geerbte Methoden com.restfb.types.AbstractFacebookType
equals, hashCode, toString
-
Konstruktordetails
-
CustomAudience
public CustomAudience()
-
-
Methodendetails
-
getAccountId
- Gibt zurück:
- Ad Account ID
-
setAccountId
Ad Account ID -
getApproximateCount
- Gibt zurück:
- Approximate number of people in this audience
-
setApproximateCount
Approximate number of people in this audience -
getDataSource
- Gibt zurück:
- JSON dictionary of type, sub_type to indicate by which method the custom audience was created.
-
setDataSource
JSON dictionary of type, sub_type to indicate by which method the custom audience was created. -
getDeliveryStatus
- Gibt zurück:
- dictionary of code and description
-
setDeliveryStatus
JSON dictionary of code and description. Indicates whether or not an audience can be used in ads. There are two situations that an audience will make ads not deliverable. First, if the size is smaller than 20 people, the audience can't be delivered. Second, if for some reason the audience is disabled (such as violation of policy, expired), validation will fail when it is used in ads. -
getDescription
- Gibt zurück:
- Custom audience description
-
setDescription
Custom audience description -
getExcludedCustomAudiences
-
setExcludedCustomAudiences
-
getExternalEventSource
- Gibt zurück:
- Read-only JSON dictionary with key id containing the pixel id whose traffic generated this custom audience
-
setExternalEventSource
Read-only JSON dictionary with key id containing the pixel id whose traffic generated this custom audience -
getIncludedCustomAudiences
-
setIncludedCustomAudiences
-
getLastUsedTime
- Gibt zurück:
- last used time of this object by the current viewer
-
setLastUsedTime
last used time of this object by the current viewer -
getLookalikeAudienceIds
- Gibt zurück:
- The IDs of the lookalike audiences generated from this audience
-
setLookalikeAudienceIds
The IDs of the lookalike audiences generated from this audience -
getLookalikeSpec
- Gibt zurück:
- Generated only when the subtype is LOOKALIKE.
-
setLookalikeSpec
Generated only when the subtype is LOOKALIKE. -
getOperationStatus
- Gibt zurück:
- dictionary of code to int value and description to a description string
-
setOperationStatus
JSON dictionary of code to int value and description to a description string. The operation status represents the status of the last operation performed on an audience. In general, it will have following states:- 0: Status not available
- 200: Normal: there is no updating or issues found
- 400: Warning: there is some message we would like advertisers to know
- 410: No upload: no file has been uploaded
- 411: Low match rate: low rate of matched people
- 412: High invalid rate: high rate of invalid people
- 421: No pixel: Your Facebook pixel hasn't been installed on your website yet
- 422: Pixel not firing: Your Facebook pixel isn't firing
- 423: Invalid pixel: Your Facebook pixel is invalid
- 431: Lookalike Audience refresh failed
- 432: Lookalike Audience build failed
- 433: Lookalike Audience build failed
- 434: Lookalike Audience build retrying
- 500: Error: there is some error and advertisers need to take action items to fix the error
-
getOptOutLink
- Gibt zurück:
- Your opt-out URL so people can choose not to be targeted
-
setOptOutLink
Your opt-out URL so people can choose not to be targeted -
getOriginAudienceId
- Gibt zurück:
- The ID of origin Custom Audience. The origin audience you create must have a minimum size of 100.
-
setOriginAudienceId
The ID of origin Custom Audience. The origin audience you create must have a minimum size of 100. -
getOwnerBusiness
- Gibt zurück:
- owner business of this object
-
setOwnerBusiness
owner business of this object -
getPermissionForActions
- Gibt zurück:
- JSON dictionary of permissions (string) to boolean value if the custom audience has that permission
-
setPermissionForActions
JSON dictionary of permissions (string) to boolean value if the custom audience has that permission -
getPixelId
- Gibt zurück:
- ID of the pixel which is collecting events for this Website Custom audience
-
setPixelId
ID of the pixel which is collecting events for this Website Custom audience -
getRetentionDays
- Gibt zurück:
- Number of days to keep the user in this cluster.
-
setRetentionDays
Number of days to keep the user in this cluster. You can use any value between 1 and 180 days. Defaults to 14 days if not specified -
getRule
- Gibt zurück:
- Audience rules to be applied on the referrer URL
-
setRule
Audience rules to be applied on the referrer URL -
getSubtype
- Gibt zurück:
- Type of custom audience, derived from original data source
-
setSubtype
Type of custom audience, derived from original data source -
getTimeContentUpdated
- Gibt zurück:
- Last update of people in this custom audience
-
setTimeContentUpdated
Last update of people in this custom audience -
getTimeCreated
- Gibt zurück:
- Creation time
-
setTimeCreated
Creation time -
getTimeUpdated
- Gibt zurück:
- Last time this audience metadata was updated
-
setTimeUpdated
Last time this audience metadata was updated
-