twitter4jads.api.TwitterAdsPromotedTweetApi 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
The newest version!
package twitter4jads.api;

import com.google.common.base.Optional;
import twitter4jads.BaseAdsListResponse;
import twitter4jads.BaseAdsListResponseIterable;
import twitter4jads.BaseAdsResponse;
import twitter4jads.internal.models4j.Status;
import twitter4jads.internal.models4j.TwitterException;
import twitter4jads.models.ads.PromotedTweets;
import twitter4jads.models.ads.sort.PromotedTweetsSortByField;

import java.io.IOException;
import java.util.Collection;
import java.util.List;

/**
 * User: abhay
 * Date: 4/22/16
 * Time: 1:04 PM
 */
public interface TwitterAdsPromotedTweetApi {

    /**
     * @param accountId   The identifier for the leveraged account.
     * @param withDeleted Include deleted results in your request. Defaults to false.
     * @param sortByField (optional) Sorts by supported attribute in ascending or descending order.
     * @param count       (optional) Specifies the number of Promoted Tweets to try to retrieve, up to a maximum of 1000 per distinct request.
     * @param cursor      (optional) Specify a cursor to retrieve data from a specific page (function automatically handles paging upon iteration when you do not specify cursor value).
     * @return Retrieve references to the Promoted Tweets associated with one or more line items.
     * @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/promoted_tweets
     */
    BaseAdsListResponseIterable getAllPromotedTweets(String accountId, boolean withDeleted,
                                                                     Optional count, String cursor, Optional sortByField) throws TwitterException;


    /**
     * @param accountId       The identifier for the leveraged account.
     * @param promotedTweetId A reference to the promoted tweet you are operating with in the request.
     * @return Retrieve references to the Promoted Tweets associated with the promotedTweetId.
     * @throws TwitterException
     * @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/promoted_tweets
     */
    BaseAdsResponse getPromotedTweetsById(String accountId, String promotedTweetId) throws TwitterException;

    /**
     * @param accountId  The identifier for the leveraged account.
     * @param lineItemId Scope the response to just the desired line item
     * @param tweetIds   tweet ids to promote
     * @return created promoted tweet details
     * @throws TwitterException
     * @see https://dev.twitter.com/ads/reference/post/accounts/%3Aaccount_id/promoted_tweets
     */
    BaseAdsListResponse createPromotedTweets(String accountId, String lineItemId, Collection tweetIds)
            throws TwitterException;

    /**
     * @param accountId The identifier for the leveraged account.
     * @param tweetId   Tweet Id to be deleted
     * @return Promoted tweet with deleted field set to true
     * @throws TwitterException
     * @see https://dev.twitter.com/ads/reference/delete/accounts/%3Aaccount_id/promoted_tweets/%3Aid
     */
    BaseAdsResponse deletePromotedTweets(String accountId, String tweetId) throws TwitterException;

    Status createPromotedVideoTweet(String accountId, String targetUserId, String tweetText, String videoId, String videoTitle,
                                    String videoDescription, String callToAction, String ctaValue)
            throws TwitterException, IOException, InterruptedException;


    BaseAdsResponse createScheduledPromotedTweets(String accountId, String lineItemId, String scheduledTweetId)
            throws TwitterException;


    BaseAdsResponse deleteScheduledPromotedTweet(String accountId, String scheduledPromotedTweet) throws TwitterException;


    Status createPromotedTweetV2(String accountId, String targetUserId, String tweetText, List mediaIds,
                                 String videoId, String videoTitle, String videoDescription, String videoCallToAction, String videoCtaValue,
                                 String cardUri, boolean promotedOnly) throws TwitterException, IOException;

      /*
    @param accountId: The identifier for the leveraged account.
    @param line_item_ids: Scope the response to just the scheduled Tweets associated with specific line items by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.
    @param scheduled_promoted_tweet_ids: Scope the response to just the desired scheduled promoted Tweets by specifying a comma-separated list of identifiers. Up to 200 IDs may be provided.
    @param sort_by: Sorts by supported attribute in ascending or descending order.
    @param with_deleted: Include deleted results in your request.
    @param with_total_count: Include the total_count response attribute.
     */

    BaseAdsListResponseIterable getScheduledPromotedTweets(String accountId, List lineItemIds,
                                                                           List scheduledPromotedTweetIds, Integer count, String cursor,
                                                                           String sortBy, boolean withDeleted, boolean includeTotalCount)
            throws TwitterException;


}