twitter4jads.api

Interface TwitterAdsPromotedTweetApi

All Known Implementing Classes:

TwitterAdsPromotedTweetApiImpl

public interface TwitterAdsPromotedTweetApi

User: abhay Date: 4/22/16 Time: 1:04 PM

Method Summary

Modifier and Type	Method and Description
BaseAdsListResponse<PromotedTweets>	createPromotedTweets(java.lang.String accountId, java.lang.String lineItemId, java.util.Collection<java.lang.String> tweetIds)
Status	createPromotedTweetV2(java.lang.String accountId, java.lang.String targetUserId, java.lang.String tweetText, java.util.List<java.lang.String> mediaIds, java.lang.String videoId, java.lang.String videoTitle, java.lang.String videoDescription, java.lang.String videoCallToAction, java.lang.String videoCtaValue, java.lang.String cardUri, boolean promotedOnly)
Status	createPromotedVideoTweet(java.lang.String accountId, java.lang.String targetUserId, java.lang.String tweetText, java.lang.String videoId, java.lang.String videoTitle, java.lang.String videoDescription, java.lang.String callToAction, java.lang.String ctaValue)
BaseAdsResponse<PromotedTweets>	createScheduledPromotedTweets(java.lang.String accountId, java.lang.String lineItemId, java.lang.String scheduledTweetId)
BaseAdsResponse<PromotedTweets>	deletePromotedTweets(java.lang.String accountId, java.lang.String tweetId)
BaseAdsResponse<PromotedTweets>	deleteScheduledPromotedTweet(java.lang.String accountId, java.lang.String scheduledPromotedTweet)
BaseAdsListResponseIterable<PromotedTweets>	getAllPromotedTweets(java.lang.String accountId, boolean withDeleted, java.util.Optional<java.util.Collection<java.lang.String>> lineItemIds, java.util.Optional<java.lang.Integer> count, java.lang.String cursor, java.util.Optional<PromotedTweetsSortByField> sortByField)
BaseAdsResponse<PromotedTweets>	getPromotedTweetsById(java.lang.String accountId, java.lang.String promotedTweetId)
BaseAdsListResponseIterable<PromotedTweets>	getScheduledPromotedTweets(java.lang.String accountId, java.util.List<java.lang.String> lineItemIds, java.util.List<java.lang.String> scheduledPromotedTweetIds, java.lang.Integer count, java.lang.String cursor, java.lang.String sortBy, boolean withDeleted, boolean includeTotalCount)

Method Detail

getAllPromotedTweets

BaseAdsListResponseIterable<PromotedTweets> getAllPromotedTweets(java.lang.String accountId,
                                                                 boolean withDeleted,
                                                                 java.util.Optional<java.util.Collection<java.lang.String>> lineItemIds,
                                                                 java.util.Optional<java.lang.Integer> count,
                                                                 java.lang.String cursor,
                                                                 java.util.Optional<PromotedTweetsSortByField> sortByField)
                                                          throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

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

sortByField - (optional) Sorts by supported attribute in ascending or descending order.

count - (optional) Specifies the number of Promoted Tweets to try to retrieve, up to a maximum of 1000 per distinct request.

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).

Returns:

Retrieve references to the Promoted Tweets associated with one or more line items.

Throws:

TwitterException

See Also:

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

getPromotedTweetsById

BaseAdsResponse<PromotedTweets> getPromotedTweetsById(java.lang.String accountId,
                                                      java.lang.String promotedTweetId)
                                               throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

promotedTweetId - A reference to the promoted tweet you are operating with in the request.

Returns:

Retrieve references to the Promoted Tweets associated with the promotedTweetId.

Throws:

TwitterException

See Also:

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

createPromotedTweets

BaseAdsListResponse<PromotedTweets> createPromotedTweets(java.lang.String accountId,
                                                         java.lang.String lineItemId,
                                                         java.util.Collection<java.lang.String> tweetIds)
                                                  throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

lineItemId - Scope the response to just the desired line item

tweetIds - tweet ids to promote

Returns:

created promoted tweet details

Throws:

TwitterException

deletePromotedTweets

BaseAdsResponse<PromotedTweets> deletePromotedTweets(java.lang.String accountId,
                                                     java.lang.String tweetId)
                                              throws TwitterException

Parameters:

accountId - The identifier for the leveraged account.

tweetId - Tweet Id to be deleted

Returns:

Promoted tweet with deleted field set to true

Throws:

TwitterException

See Also:

https://dev.twitter.com/ads/reference/delete/accounts/%3Aaccount_id/promoted_tweets/%3Aid

createPromotedVideoTweet

Status createPromotedVideoTweet(java.lang.String accountId,
                                java.lang.String targetUserId,
                                java.lang.String tweetText,
                                java.lang.String videoId,
                                java.lang.String videoTitle,
                                java.lang.String videoDescription,
                                java.lang.String callToAction,
                                java.lang.String ctaValue)
                         throws TwitterException,
                                java.io.IOException,
                                java.lang.InterruptedException

Throws:

TwitterException

java.io.IOException

java.lang.InterruptedException

createPromotedTweetV2

Status createPromotedTweetV2(java.lang.String accountId,
                             java.lang.String targetUserId,
                             java.lang.String tweetText,
                             java.util.List<java.lang.String> mediaIds,
                             java.lang.String videoId,
                             java.lang.String videoTitle,
                             java.lang.String videoDescription,
                             java.lang.String videoCallToAction,
                             java.lang.String videoCtaValue,
                             java.lang.String cardUri,
                             boolean promotedOnly)
                      throws TwitterException,
                             java.io.IOException

Throws:

TwitterException

java.io.IOException

createScheduledPromotedTweets

BaseAdsResponse<PromotedTweets> createScheduledPromotedTweets(java.lang.String accountId,
                                                              java.lang.String lineItemId,
                                                              java.lang.String scheduledTweetId)
                                                       throws TwitterException

Throws:

TwitterException

deleteScheduledPromotedTweet

BaseAdsResponse<PromotedTweets> deleteScheduledPromotedTweet(java.lang.String accountId,
                                                             java.lang.String scheduledPromotedTweet)
                                                      throws TwitterException

Throws:

TwitterException

getScheduledPromotedTweets

BaseAdsListResponseIterable<PromotedTweets> getScheduledPromotedTweets(java.lang.String accountId,
                                                                       java.util.List<java.lang.String> lineItemIds,
                                                                       java.util.List<java.lang.String> scheduledPromotedTweetIds,
                                                                       java.lang.Integer count,
                                                                       java.lang.String cursor,
                                                                       java.lang.String sortBy,
                                                                       boolean withDeleted,
                                                                       boolean includeTotalCount)
                                                                throws TwitterException

Throws:

TwitterException