Ads API v11 (#296)

* updated cards class and examples * added tests * remove deprecated card types * line item budget optimization changes * bump version * removed references to video website cards * removed start/end times from campaigns * Remove _str versions of parameters Co-authored-by: Tom Osowski <[email protected]>
xdevplatform · May 27, 2022 · a3dd581 · a3dd581
1 parent 2567d75
commit a3dd581
Show file tree

Hide file tree

Showing 15 changed files with 1,064 additions and 176 deletions.
diff --git a/examples/cards.py b/examples/cards.py
@@ -1,29 +1,89 @@
 from twitter_ads.client import Client
 from twitter_ads.creative import Card
-from twitter_ads.campaign import Tweet
-from twitter_ads.restapi import UserIdLookup
+from twitter_ads.http import Request
 
 
 CONSUMER_KEY = 'your consumer key'
 CONSUMER_SECRET = 'your consumer secret'
-ACCESS_TOKEN = 'access token'
-ACCESS_TOKEN_SECRET = 'access token secret'
-ACCOUNT_ID = 'account id'
+ACCESS_TOKEN = 'user access token'
+ACCESS_TOKEN_SECRET = 'user access token secret'
+ACCOUNT_ID = 'ads 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)
 
-# create the card
-name = 'video website card'
-components = [{"type":"MEDIA","media_key":"13_1191948012077092867"},{"type":"DETAILS","title":"Twitter","destination":{"type":"WEBSITE", "url":"http://twitter.com/"}}]
-video_website_card = Card.create(account, name=name, components=components)
+# fetch all
+card = Card.all(account, card_ids="1502039998987587584").first
+
+# fetch by card-id
+card = Card.load(account=account, id="1502039998987587584")
+
+# edit card destination.url
+card.components= [
+        {
+          "media_key": "13_794652834998325248",
+          "media_metadata": {
+            "13_794652834998325248": {
+              "type": "VIDEO",
+              "url": "https://video.twimg.com/amplify_video/794652834998325248/vid/640x360/pUgE2UKcfPwF_5Uh.mp4",
+              "width": 640,
+              "height": 360,
+              "video_duration": 7967,
+              "video_aspect_ratio": "16:9"
+            }
+          },
+          "type": "MEDIA"
+        },
+        {
+          "title": "Twitter",
+          "destination": {
+            "url": "http://twitter.com/newvalue",
+            "type": "WEBSITE"
+          },
+          "type": "DETAILS"
+        }
+      ]
+
+card.save()
+print(card.components)
+
+# create new card
+newcard = Card(account=account)
+newcard.name="my new card"
+components= [
+        {
+          "media_key": "13_794652834998325248",
+          "media_metadata": {
+            "13_794652834998325248": {
+              "type": "VIDEO",
+              "url": "https://video.twimg.com/amplify_video/794652834998325248/vid/640x360/pUgE2UKcfPwF_5Uh.mp4",
+              "width": 640,
+              "height": 360,
+              "video_duration": 7967,
+              "video_aspect_ratio": "16:9"
+            }
+          },
+          "type": "MEDIA"
+        },
+        {
+          "title": "Twitter",
+          "destination": {
+            "url": "http://twitter.com/login",
+            "type": "WEBSITE"
+          },
+          "type": "DETAILS"
+        }
+      ]
+newcard.components=components
+newcard.save()
+print(newcard.id)
 
 # get user_id for as_user_id parameter
 user_id = UserIdLookup.load(account, screen_name='your_twitter_handle_name').id
 
 # create a tweet using this new card
-Tweet.create(account, text='Created from the SDK', as_user_id=user_id, card_uri=video_website_card.card_uri)
+Tweet.create(account, text='Created from the SDK', as_user_id=user_id, card_uri=card.card_uri)
 # https://twitter.com/apimctestface/status/1372283476615958529
diff --git a/examples/draft_tweet.py b/examples/draft_tweet.py
@@ -22,27 +22,27 @@
 # fetch draft tweets from a given account
 tweets = DraftTweet.all(account)
 for tweet in tweets:
-    print(tweet.id_str)
+    print(tweet.id)
     print(tweet.text)
 
 # create a new draft tweet
 draft_tweet = DraftTweet(account)
 draft_tweet.text = 'draft tweet - new'
 draft_tweet.as_user_id = user_id
 draft_tweet = draft_tweet.save()
-print(draft_tweet.id_str)
+print(draft_tweet.id)
 print(draft_tweet.text)
 
 # fetch single draft tweet metadata
-tweet_id = draft_tweet.id_str
+tweet_id = draft_tweet.id
 draft_tweet = draft_tweet.load(account, tweet_id)
-print(draft_tweet.id_str)
+print(draft_tweet.id)
 print(draft_tweet.text)
 
 # update (PUT) metadata
 draft_tweet.text = 'draft tweet - update'
 draft_tweet = draft_tweet.save()
-print(draft_tweet.id_str)
+print(draft_tweet.id)
 print(draft_tweet.text)
 
 # create a nullcasted tweet using draft tweet metadata

diff --git a/tests/fixtures/analytics_async_get.json b/tests/fixtures/analytics_async_get.json
@@ -12,7 +12,7 @@
       "start_time": "2019-01-01T00:00:00Z",
       "segmentation_type": null,
       "url": "https://ton.twimg.com/advertiser-api-async-analytics/stats.json.gz",
-      "id_str": "111111111111111111",
+      "id": "111111111111111111",
       "entity_ids": [
         "aaaa"
       ],

diff --git a/tests/fixtures/analytics_async_post.json b/tests/fixtures/analytics_async_post.json
@@ -18,7 +18,7 @@
     "start_time": "2019-01-01T00:00:00Z",
     "segmentation_type": null,
     "url": null,
-    "id_str": "111111111111111111",
+    "id": "111111111111111111",
     "entity_ids": [
       "aaaa"
     ],