twitter4jads.api

Interface TwitterAdsAccountApi

All Known Implementing Classes:

TwitterAdsAccountApiImpl

public interface TwitterAdsAccountApi

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

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> accountsSortByField)
BaseAdsListResponseIterable<TwitterPoliticalAgreement>	getPoliticalAgreementForAccount(java.lang.String accountId)
BaseAdsListResponseIterable<PromotableUser>	getPromotableUsers(java.lang.String accountId, boolean withDeleted)

Method Detail

getAllAccounts

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

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

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

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

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

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

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

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

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

Throws:

TwitterException

getPoliticalAgreementForAccount

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

Parameters:

accountId - The identifier for the leveraged account.

Returns:

Political agreement for the ad account if applicable.

Throws:

TwitterException