twitter4jads.impl

Class TwitterAdsAudienceApiImpl

java.lang.Object

twitter4jads.impl.TwitterAdsAudienceApiImpl

All Implemented Interfaces:

TwitterAdsAudienceApi

public class TwitterAdsAudienceApiImpl
extends java.lang.Object
implements TwitterAdsAudienceApi

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

Constructor Summary

Constructors

Constructor and Description
TwitterAdsAudienceApiImpl(TwitterAdsClient twitterAdsClient)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TwitterAdsAudienceApiImpl

public TwitterAdsAudienceApiImpl(TwitterAdsClient twitterAdsClient)

Method Detail

getAllTailoredAudiences

public 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

Specified by:

getAllTailoredAudiences in interface TwitterAdsAudienceApi

Parameters:

accountId - The identifier for the leveraged account.

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

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

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

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

Specified by:

getTailoredAudienceForId in interface TwitterAdsAudienceApi

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

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

Specified by:

deleteTailoredAudience in interface TwitterAdsAudienceApi

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

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

Specified by:

createTailoredAudience in interface TwitterAdsAudienceApi

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

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

Specified by:

addMatchingRulesToAudience in interface TwitterAdsAudienceApi

accountId - The identifier for the leveraged account.

Returns:

Resultant matching rules for tailored audiences

Throws:

TwitterException

createFlexibleTailoredAudience

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

Specified by:

createFlexibleTailoredAudience in interface TwitterAdsAudienceApi

Returns:

Throws:

TwitterException

updateTailoredAudienceById

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

Description copied from interface: TwitterAdsAudienceApi

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.

Specified by:

updateTailoredAudienceById in interface TwitterAdsAudienceApi

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

getTailoredAudiencePermission

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

Specified by:

getTailoredAudiencePermission in interface TwitterAdsAudienceApi

Returns:

Throws:

TwitterException

shareTailoredAudience

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

Specified by:

shareTailoredAudience in interface TwitterAdsAudienceApi

Returns:

Throws:

TwitterException