twitter4j.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
There is a newer version: 2.2
package twitter4j.api;

import com.google.common.base.Optional;
import twitter4j.BaseAdsListResponseIterable;
import twitter4j.BaseAdsResponse;
import twitter4j.TwitterException;
import twitter4j.models.ads.AdAccount;
import twitter4j.models.ads.PromotableUser;
import twitter4j.models.ads.TwitterAccountPermissions;
import twitter4j.models.ads.sort.AccountsSortByField;

import java.util.List;

/**
 * User: abhay
 * Date: 4/4/16
 * Time: 7:52 PM
 */
public interface TwitterAdsAccountApi {
    /**
     * @param withDeleted Include deleted results in your request. Defaults to false.
     * @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) 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;

}