twitter4jads.impl

Class TwitterAdsPromotedTweetApiImpl

java.lang.Object

twitter4jads.impl.TwitterAdsPromotedTweetApiImpl

All Implemented Interfaces:

TwitterAdsPromotedTweetApi

public class TwitterAdsPromotedTweetApiImpl
extends java.lang.Object
implements TwitterAdsPromotedTweetApi

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

Constructor Summary

Constructors

Constructor and Description
TwitterAdsPromotedTweetApiImpl(TwitterAdsClient twitterAdsClient)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TwitterAdsPromotedTweetApiImpl

public TwitterAdsPromotedTweetApiImpl(TwitterAdsClient twitterAdsClient)

Method Detail

getAllPromotedTweets

public 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

Specified by:

getAllPromotedTweets in interface TwitterAdsPromotedTweetApi

Parameters:

accountId - The identifier for the leveraged account.

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

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

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

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

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

Specified by:

getPromotedTweetsById in interface TwitterAdsPromotedTweetApi

Parameters:

accountId - The identifier for the leveraged account.

promotedTweetsId - 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

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

Specified by:

createPromotedTweets in interface TwitterAdsPromotedTweetApi

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

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

Specified by:

deletePromotedTweets in interface TwitterAdsPromotedTweetApi

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

public 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

Specified by:

createPromotedVideoTweet in interface TwitterAdsPromotedTweetApi

Throws:

TwitterException

java.io.IOException

java.lang.InterruptedException

createScheduledPromotedTweets

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

Specified by:

createScheduledPromotedTweets in interface TwitterAdsPromotedTweetApi

Throws:

TwitterException

deleteScheduledPromotedTweet

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

Specified by:

deleteScheduledPromotedTweet in interface TwitterAdsPromotedTweetApi

Throws:

TwitterException

getScheduledPromotedTweets

public 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

Specified by:

getScheduledPromotedTweets in interface TwitterAdsPromotedTweetApi

Throws:

TwitterException

createPromotedTweetV2

public 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

Specified by:

createPromotedTweetV2 in interface TwitterAdsPromotedTweetApi

Throws:

TwitterException

java.io.IOException