Support for new cards endpoint (#275)

* Adding support to create and read from the new cards endpoint
* Include a card create example

Author: juanshishido

examples/cards.py

@@ -0,0 +1,29 @@
+from twitter_ads.client import Client
+from twitter_ads.creative import Card
+from twitter_ads.campaign import Tweet
+from twitter_ads.restapi import UserIdLookup
+
+
+CONSUMER_KEY = 'your consumer key'
+CONSUMER_SECRET = 'your consumer secret'
+ACCESS_TOKEN = 'access token'
+ACCESS_TOKEN_SECRET = 'access token secret'
+ACCOUNT_ID = '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)
+
+# 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)
+# https://twitter.com/apimctestface/status/1372283476615958529

twitter_ads/account.py

@@ -10,7 +10,7 @@
 
 from twitter_ads.resource import resource_property, Resource
 from twitter_ads.creative import (AccountMedia, MediaCreative, ScheduledTweet,
-                                  VideoWebsiteCard, PromotedTweet)
+                                  Card, VideoWebsiteCard, PromotedTweet)
 from twitter_ads.audience import TailoredAudience
 from twitter_ads.campaign import (AppList, Campaign, FundingInstrument, LineItem,
                                   PromotableUser, ScheduledPromotedTweet)
@@ -154,6 +154,12 @@ def video_website_cards(self, id=None, **kwargs):
         """
         return self._load_resource(VideoWebsiteCard, id, **kwargs)
 
+    def cards(self, id=None, **kwargs):
+        """
+        Returns a collection of Cards available to the current account.
+        """
+        return self._load_resource(Card, id, **kwargs)
+
 
 # account properties
 resource_property(Account, 'id', readonly=True)

twitter_ads/creative.py

@@ -2,6 +2,7 @@
 
 """Container for all creative management logic used by the Ads API SDK."""
 
+import json
 from requests.exceptions import HTTPError
 from twitter_ads import API_VERSION
 from twitter_ads.cursor import Cursor
@@ -595,3 +596,39 @@ def all(klass, account, **kwargs):
         resource = klass.RESOURCE_COLLECTION.format(account_id=account.id)
         request = Request(account.client, 'get', resource, params=kwargs)
         return Cursor(None, request)
+
+
+class Card(Resource):
+
+    PROPERTIES = {}
+
+    RESOURCE_COLLECTION = '/' + API_VERSION + '/accounts/{account_id}/cards'
+
+    @classmethod
+    def create(klass, account, name, components):
+        method = 'post'
+        resource = klass.RESOURCE_COLLECTION.format(account_id=account.id)
+        headers = {'Content-Type': 'application/json'}
+        payload = {'name': name, 'components': components}
+        response = Request(
+            account.client, method, resource,
+            headers=headers, body=json.dumps(payload)
+        ).perform()
+        return klass(account).from_response(response.body['data'])
+
+    def load(klass):
+        raise AttributeError("'Card' object has no attribute 'load'")
+
+    def reload(klass):
+        raise AttributeError("'Card' object has no attribute 'reload'")
+
+
+# card properties
+# read-only
+resource_property(Card, 'card_uri', readonly=True)
+resource_property(Card, 'created_at', readonly=True, transform=TRANSFORM.TIME)
+resource_property(Card, 'deleted', readonly=True, transform=TRANSFORM.BOOL)
+resource_property(Card, 'updated_at', readonly=True, transform=TRANSFORM.TIME)
+# these are writable, but not in the sense that they can be set on an object and then saved
+resource_property(Card, 'name', readonly=True)
+resource_property(Card, 'components', readonly=True, transform=TRANSFORM.LIST)

twitter_ads/resource.py

@@ -78,10 +78,6 @@ def to_params(self):
 
             if isinstance(value, datetime):
                 params[name] = format_time(value)
-            elif isinstance(value, list):
-                if not value:
-                    continue
-                params[name] = ','.join(map(str, value))
             elif isinstance(value, bool):
                 params[name] = str(value).lower()
             else: