twitter4jads.impl

Class TwitterAdsAccountApiImpl

java.lang.Object

twitter4jads.impl.TwitterAdsAccountApiImpl

All Implemented Interfaces:

TwitterAdsAccountApi

public class TwitterAdsAccountApiImpl
extends java.lang.Object
implements TwitterAdsAccountApi

User: abhay Date: 4/4/16 Time: 7:54 PM

Constructor Summary

Constructors

Constructor and Description
TwitterAdsAccountApiImpl(TwitterAdsClient twitterAdsClient)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAccountPermissions(java.lang.String accountId)
BaseAdsResponse<AdAccount>	getAdAccountById(java.lang.String accountId, boolean withDeleted)
BaseAdsResponse<AdAccountNativePermissions>	getAdAccountNativePermissions(java.lang.String accountId)
BaseAdsListResponseIterable<AdAccount>	getAllAccounts(boolean withDeleted, java.util.Optional<AccountsSortByField> sortByField)
BaseAdsListResponseIterable<TwitterPoliticalAgreement>	getPoliticalAgreementForAccount(java.lang.String accountId)
BaseAdsListResponseIterable<PromotableUser>	getPromotableUsers(java.lang.String accountId, boolean withDeleted)

Methods inherited from class java.lang.Object

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

Constructor Detail

TwitterAdsAccountApiImpl

public TwitterAdsAccountApiImpl(TwitterAdsClient twitterAdsClient)

Method Detail

getAllAccounts

public BaseAdsListResponseIterable<AdAccount> getAllAccounts(boolean withDeleted,
                                                             java.util.Optional<AccountsSortByField> sortByField)
                                                      throws TwitterException

Specified by:

getAllAccounts in interface TwitterAdsAccountApi

Parameters:

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

Returns:

all the advertising-enabled accounts the authenticating user has access to.

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/get/accounts

getAdAccountById

public BaseAdsResponse<AdAccount> getAdAccountById(java.lang.String accountId,
                                                   boolean withDeleted)
                                            throws TwitterException

Specified by:

getAdAccountById in interface TwitterAdsAccountApi

Parameters:

accountId - The identifier for the leveraged account.

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

Returns:

detailed information on the specified account that the authenticating user has access to.

Throws:

TwitterException

See Also:

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

getAccountPermissions

public java.util.List<java.lang.String> getAccountPermissions(java.lang.String accountId)
                                                       throws TwitterException

Specified by:

getAccountPermissions in interface TwitterAdsAccountApi

Parameters:

accountId - The identifier for the leveraged account.

Returns:

account features associated with the given account.

Throws:

TwitterException

See Also:

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

getPromotableUsers

public BaseAdsListResponseIterable<PromotableUser> getPromotableUsers(java.lang.String accountId,
                                                                      boolean withDeleted)
                                                               throws TwitterException

Specified by:

getPromotableUsers in interface TwitterAdsAccountApi

Parameters:

accountId - The identifier for the leveraged account.

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

Returns:

the collection of promotable_users associated with an account.

Throws:

TwitterException

See Also:

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

getAdAccountNativePermissions

public BaseAdsResponse<AdAccountNativePermissions> getAdAccountNativePermissions(java.lang.String accountId)
                                                                          throws TwitterException

Specified by:

getAdAccountNativePermissions in interface TwitterAdsAccountApi

Throws:

TwitterException

getPoliticalAgreementForAccount

public BaseAdsListResponseIterable<TwitterPoliticalAgreement> getPoliticalAgreementForAccount(java.lang.String accountId)
                                                                                       throws TwitterException

Specified by:

getPoliticalAgreementForAccount in interface TwitterAdsAccountApi

Parameters:

accountId - The identifier for the leveraged account.

Returns:

Political agreement for the ad account if applicable.

Throws:

TwitterException