Add new preview endpoint support (#191)

Author: smaeda-ks

examples/tweet_preview.py

@@ -2,6 +2,14 @@
 from twitter_ads.campaign import Tweet
 from twitter_ads.creative import WebsiteCard
 
+"""
+"Tweet.preview()" will no longer be available on August 20, 2019.
+ https://twittercommunity.com/t/announcement-new-and-improved-tweet-previews/126064
+
+Please use "TweetPreview.load()" instead. See examples/tweet_previews.py for reference.
+"""
+
+
 CONSUMER_KEY = 'your consumer key'
 CONSUMER_SECRET = 'your consumer secret'
 ACCESS_TOKEN = 'access token'

examples/tweet_previews.py

@@ -0,0 +1,30 @@
+from twitter_ads.client import Client
+from twitter_ads.creative import TweetPreview
+from twitter_ads.enum import TWEET_TYPE
+
+CONSUMER_KEY = ''
+CONSUMER_SECRET = ''
+ACCESS_TOKEN = ''
+ACCESS_TOKEN_SECRET = ''
+ACCOUNT_ID = ''
+
+# initialize the client
+client = Client(
+    CONSUMER_KEY,
+    CONSUMER_SECRET,
+    ACCESS_TOKEN,
+    ACCESS_TOKEN_SECRET)
+
+# load the advertiser account instance
+account = client.accounts(ACCOUNT_ID)
+
+# fetch preview data
+tweets = TweetPreview.load(
+    account,
+    tweet_ids=['1130942781109596160', '1101254234031370240'],
+    tweet_type=TWEET_TYPE.PUBLISHED)
+
+# iterate for each tweet
+for k in tweets:
+    print(k.tweet_id)
+    print(k.preview)

twitter_ads/creative.py

@@ -548,3 +548,26 @@ def reload(self):
 resource_property(CardsFetch, 'website_title', readonly=True)
 resource_property(CardsFetch, 'website_url', readonly=True)
 resource_property(CardsFetch, 'wide_app_image', readonly=True)
+
+
+class TweetPreview(Resource):
+
+    PROPERTIES = {}
+
+    RESOURCE_COLLECTION = '/' + API_VERSION + '/accounts/{account_id}/tweet_previews'
+
+    @classmethod
+    def load(klass, account, tweet_ids=None, tweet_type=None):
+        params = {}
+
+        params['tweet_ids'] = ','.join(map(str, tweet_ids))
+        params['tweet_type'] = tweet_type
+        resource = klass.RESOURCE_COLLECTION.format(account_id=account.id)
+        request = Request(account.client, 'get', resource, params=params)
+        return Cursor(klass, request, init_with=[account])
+
+
+# tweet preview properties
+# read-only
+resource_property(TweetPreview, 'preview', readonly=True)
+resource_property(TweetPreview, 'tweet_id', readonly=True)

twitter_ads/enum.py

@@ -189,3 +189,9 @@ def enum(**enums):
     DEFINED='DEFINED',
     EXPANDED='EXPANDED'
 )
+
+TWEET_TYPE = enum(
+    DRAFT='DRAFT',
+    PUBLISHED='PUBLISHED',
+    SCHEDULED='SCHEDULED'
+)