twitter4jads.api.TwitterAdsAccountApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twitter4j-ads Show documentation
TwitterAds sdk
The newest version!
package twitter4jads.api;

import twitter4jads.BaseAdsListResponseIterable;
import twitter4jads.BaseAdsResponse;
import twitter4jads.internal.models4j.TwitterException;
import twitter4jads.models.ads.AdAccount;
import twitter4jads.models.ads.AdAccountNativePermissions;
import twitter4jads.models.ads.PromotableUser;
import twitter4jads.models.ads.sort.AccountsSortByField;

import java.util.List;
import java.util.Optional;

public interface TwitterAdsAccountApi {
    /**
     * @param withDeleted Include deleted results in your request. Defaults to false.
     * @param q           An optional query to scope resource by name
     * @return all the advertising-enabled accounts the authenticating user has access to.
     * @throws TwitterException
     * @see https://dev.twitter.com/ads/reference/get/accounts
     */
    BaseAdsListResponseIterable getAllAccounts(Boolean withDeleted, Optional accountsSortByField, Optional> accountIds, Optional q) throws TwitterException;

    /**
     * @param accountId   The identifier for the leveraged account.
     * @param withDeleted Include deleted results in your request. Defaults to false.
     * @return detailed information on the specified account that the authenticating user has access to.
     * @throws TwitterException
     * @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id
     */
    BaseAdsResponse getAdAccountById(String accountId, Boolean withDeleted) throws TwitterException;

    /**
     * @param accountId The identifier for the leveraged account.
     * @return account features associated with the given account.
     * @throws TwitterException
     * @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/features
     */
    List getAccountPermissions(String accountId) throws TwitterException;

    /**
     * @param accountId   The identifier for the leveraged account.
     * @param withDeleted Include deleted results in your request. Defaults to false.
     * @return the collection of promotable_users associated with an account.
     * @throws TwitterException
     * @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/promotable_users
     */
    BaseAdsListResponseIterable getPromotableUsers(String accountId, boolean withDeleted) throws TwitterException;

    /**
     * @param accountId The identifier for the leveraged account.
     * @return permissions of the currently authenticated user (access_token) as they relate to the specified ads account
     * @throws TwitterException
     */
    BaseAdsResponse getAdAccountNativePermissions(String accountId) throws TwitterException;
}