twitter4jads.api

Interface TwitterAdsAudienceApi

All Known Implementing Classes:

TwitterAdsAudienceApiImpl

public interface TwitterAdsAudienceApi

User: abhay Date: 4/5/16 Time: 10:54 AM

Method Summary

Modifier and Type	Method and Description
BaseAdsResponse<TailoredAudienceMatchingRules>	addMatchingRulesToAudience(TailoredAudienceMatchingRules tailoredAudienceMatchingRules, java.lang.String accountId)
BaseAdsListBatchPostResponse<TailoredAudience>	createFlexibleTailoredAudience(java.lang.String accountId, java.lang.String requestBody)
BaseAdsResponse<TailoredAudience>	createTailoredAudience(java.lang.String accountId, java.lang.String name)
BaseAdsResponse<TailoredAudience>	deleteTailoredAudience(java.lang.String accountId, java.lang.String tailoredAudienceId)
BaseAdsListResponseIterable<TailoredAudience>	getAllTailoredAudiences(java.lang.String accountId, java.util.Optional<java.lang.Integer> count, java.util.Optional<java.lang.Boolean> withDeleted, java.util.Optional<java.lang.String> cursor)
BaseAdsResponse<TailoredAudience>	getTailoredAudienceForId(java.lang.String accountId, java.lang.String tailoredAudienceId)
BaseAdsListResponse<TailoredAudiencePermission>	getTailoredAudiencePermission(java.lang.String accountId, java.lang.String tailoredAudienceId)
BaseAdsResponse<TailoredAudiencePermission>	shareTailoredAudience(java.lang.String accountId, java.lang.String tailoredAudienceId, java.lang.String grantedAccountId)
java.util.List<TailoredAudienceOperation>	updateTailoredAudienceById(java.lang.String accountId, java.lang.String tailoredAudienceId, java.util.List<TailoredAudienceOperation> operations) Update tailored audience using specified operation.

Method Detail

getAllTailoredAudiences

BaseAdsListResponseIterable<TailoredAudience> getAllTailoredAudiences(java.lang.String accountId,
                                                                      java.util.Optional<java.lang.Integer> count,
                                                                      java.util.Optional<java.lang.Boolean> withDeleted,
                                                                      java.util.Optional<java.lang.String> cursor)
                                                               throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

withDeleted - (optional) Include deleted results in your request. Defaults to false.

count - (optional) Limit the number returned per page of requests to the specified amount.

cursor - (optional) Specifies a cursor to get the next page of TailoredAudience objects (function automatically handles paging upon iteration when you do not specify cursor value).

Returns:

the collection of TailoredAudience objects belonging to the authenticated user.

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/tailored_audiences

getTailoredAudienceForId

BaseAdsResponse<TailoredAudience> getTailoredAudienceForId(java.lang.String accountId,
                                                           java.lang.String tailoredAudienceId)
                                                    throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

tailoredAudienceId - The identifier for a specific tailored audience.

Returns:

detailed information on a specific tailored audience.

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/tailored_audiences/%3Aid

deleteTailoredAudience

BaseAdsResponse<TailoredAudience> deleteTailoredAudience(java.lang.String accountId,
                                                         java.lang.String tailoredAudienceId)
                                                  throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

tailoredAudienceId - The identifier for a specific tailored audience.

Returns:

response of deleting a tailored audience.

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/delete/accounts/%3Aaccount_id/tailored_audiences/%3Aid

createTailoredAudience

BaseAdsResponse<TailoredAudience> createTailoredAudience(java.lang.String accountId,
                                                         java.lang.String name)
                                                  throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

name - The name of the tailored audience to create.

Returns:

response of creating a tailored audience.

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/post/accounts/%3Aaccount_id/tailored_audiences

addMatchingRulesToAudience

BaseAdsResponse<TailoredAudienceMatchingRules> addMatchingRulesToAudience(TailoredAudienceMatchingRules tailoredAudienceMatchingRules,
                                                                          java.lang.String accountId)
                                                                   throws TwitterException

Parameters:

tailoredAudienceMatchingRules -

accountId - The identifier for the leveraged account.

Returns:

Resultant matching rules for tailored audiences

Throws:

TwitterException

updateTailoredAudienceById

java.util.List<TailoredAudienceOperation> updateTailoredAudienceById(java.lang.String accountId,
                                                                     java.lang.String tailoredAudienceId,
                                                                     java.util.List<TailoredAudienceOperation> operations)
                                                              throws TwitterException

Update tailored audience using specified operation. Returns operations as actually sent to twitter. The supplied operations will not be mixed but might be broken down into smaller operations for batch processing.

The operations returned are not guaranteed to be in the same order as when supplied. Only the user detail correspondence with the effective, expire and operation fields is maintained.

Batching of operations is taken care automatically Returns on first batch that fails.

Parameters:

accountId - The identifier for the leveraged account.

tailoredAudienceId - The identifier for a specific tailored audience.

operations - List of tailored audience operations to be performed

Returns:

On successful update returns list of operations as actually sent with batching. On failure, last operation in list will be the one that failed.

Throws:

TwitterException

createFlexibleTailoredAudience

BaseAdsListBatchPostResponse<TailoredAudience> createFlexibleTailoredAudience(java.lang.String accountId,
                                                                              java.lang.String requestBody)
                                                                       throws TwitterException

Parameters:

accountId -

requestBody -

Returns:

Throws:

TwitterException

getTailoredAudiencePermission

BaseAdsListResponse<TailoredAudiencePermission> getTailoredAudiencePermission(java.lang.String accountId,
                                                                              java.lang.String tailoredAudienceId)
                                                                       throws TwitterException

Parameters:

accountId -

tailoredAudienceId -

Returns:

Throws:

TwitterException

shareTailoredAudience

BaseAdsResponse<TailoredAudiencePermission> shareTailoredAudience(java.lang.String accountId,
                                                                  java.lang.String tailoredAudienceId,
                                                                  java.lang.String grantedAccountId)
                                                           throws TwitterException

Parameters:

accountId -

tailoredAudienceId -

grantedAccountId -

Returns:

Throws:

TwitterException