twitter-ads 5.1.0 → 7.0.1

data/lib/twitter-ads/client.rb

@@ -3,7 +3,7 @@
 
 module TwitterAds
 
-  API_VERSION = '5'
+  API_VERSION = '7'
 
   # The Ads API Client class which functions as a
   # container for basic API consumer information.
@@ -34,7 +34,7 @@ module TwitterAds
       @consumer_secret     = consumer_secret
       @access_token        = access_token
       @access_token_secret = access_token_secret
-      @options             = opts
+      @options             = opts.fetch(:options, {})
       validate
       self
     end

data/lib/twitter-ads/creative/account_media.rb

@@ -12,15 +12,13 @@ module TwitterAds
 
       attr_reader :account
 
-      property :created_at, type: :time, read_only: true
       property :deleted, type: :bool, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :updated_at, type: :time, read_only: true
       property :id, read_only: true
+      property :creative_type, read_only: true
+      property :media_key, read_only: true
       property :media_url, read_only: true
-      property :updated_at, type: :time, read_only: true
-
-      property :creative_type
-      property :media_id
-      property :video_id
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
                             'accounts/%{account_id}/account_media' # @api private

data/lib/twitter-ads/creative/draft_tweet.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  module Creative
+
+    class DraftTweet
+
+      include TwitterAds::DSL
+      include TwitterAds::Resource
+      include TwitterAds::Persistence
+
+      attr_reader :account
+
+      # read-only
+      property :id, read_only: true
+      property :id_str, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :updated_at, type: :time, read_only: true
+      property :user_id, read_only: true
+      # writable
+      property :as_user_id
+      property :card_uri
+      property :media_keys
+      property :nullcast, type: :bool
+      property :text
+
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/draft_tweets' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/draft_tweets/%{id}' # @api private
+
+      def initialize(account)
+        @account = account
+        self
+      end
+
+    end
+  end
+end

data/lib/twitter-ads/creative/image_app_download_card.rb

@@ -20,7 +20,7 @@ module TwitterAds
       property :image_display_height, read_only: true
       property :image_display_width, read_only: true
       property :updated_at, type: :time, read_only: true
-      property :wide_app_image, read_only: true
+      property :media_url, read_only: true
 
       property :country_code
       property :app_cta
@@ -31,7 +31,7 @@ module TwitterAds
       property :ipad_app_id
       property :ipad_deep_link
       property :name
-      property :wide_app_image_media_id
+      property :media_key
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
                             'accounts/%{account_id}/cards/image_app_download' # @api private

data/lib/twitter-ads/creative/image_conversation_card.rb

@@ -19,13 +19,14 @@ module TwitterAds
       property :id, read_only: true
       property :image, read_only: true
       property :updated_at, type: :time, read_only: true
+      property :media_url, read_only: true
 
-      property :cover_image_id
+      property :unlocked_image_media_key
       property :first_cta
       property :first_cta_tweet
       property :fourth_cta
       property :fourth_cta_tweet
-      property :image_media_id
+      property :media_key
       property :name
       property :second_cta
       property :second_cta_tweet

data/lib/twitter-ads/creative/media_creative.rb

@@ -4,12 +4,11 @@
 module TwitterAds
   module Creative
 
-    class MediaCreative
+    class MediaCreative < Analytics
 
       include TwitterAds::DSL
       include TwitterAds::Resource
       include TwitterAds::Persistence
-      include TwitterAds::Analytics
 
       attr_reader :account
 
@@ -17,7 +16,7 @@ module TwitterAds
       property :created_at, type: :time, read_only: true
       property :deleted, type: :bool, read_only: true
       property :id, read_only: true
-      property :serving_status, read_only: true
+      property :entity_status, read_only: true
       property :updated_at, type: :time, read_only: true
 
       property :account_media_id

data/lib/twitter-ads/creative/media_library.rb

@@ -22,17 +22,14 @@ module TwitterAds
       property :media_url, read_only: true
       property :tweeted, type: :bool, read_only: true
       property :updated_at, type: :time, read_only: true
-      property :poster_image_url, read_only: true
+      property :poster_media_url, read_only: true
 
       # writable
-      property :media_category
-      property :media_id
       property :media_key
       property :description
       property :file_name
       property :name
-      property :poster_image_media_id
-      property :poster_image_media_key
+      property :poster_media_key
       property :title
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
@@ -48,15 +45,17 @@ module TwitterAds
         end
       end
 
-      def save
+      def add
         params = to_params
-        if @media_key
-          resource = self.class::RESOURCE % { account_id: account.id, id: media_key }
-          response = Request.new(account.client, :put, resource, params: params).perform
-        else
-          resource = self.class::RESOURCE_COLLECTION % { account_id: account.id }
-          response = Request.new(account.client, :post, resource, params: params).perform
-        end
+        resource = self.class::RESOURCE_COLLECTION % { account_id: account.id }
+        response = Request.new(account.client, :post, resource, params: params).perform
+        from_response(response.body[:data])
+      end
+
+      def update
+        params = to_params
+        resource = self.class::RESOURCE % { account_id: account.id, id: media_key }
+        response = Request.new(account.client, :put, resource, params: params).perform
         from_response(response.body[:data])
       end
 

data/lib/twitter-ads/creative/promoted_account.rb

@@ -4,12 +4,11 @@
 module TwitterAds
   module Creative
 
-    class PromotedAccount
+    class PromotedAccount < Analytics
 
       include TwitterAds::DSL
       include TwitterAds::Resource
       include TwitterAds::Persistence
-      include TwitterAds::Analytics
 
       attr_reader :account
 

data/lib/twitter-ads/creative/promoted_tweet.rb

@@ -4,12 +4,11 @@
 module TwitterAds
   module Creative
 
-    class PromotedTweet
+    class PromotedTweet < Analytics
 
       include TwitterAds::DSL
       include TwitterAds::Resource
       include TwitterAds::Persistence
-      include TwitterAds::Analytics
 
       attr_reader :account
 

data/lib/twitter-ads/creative/scheduled_tweet.rb

@@ -17,7 +17,6 @@ module TwitterAds
       property :created_at, type: :time, read_only: true
       property :id, read_only: true
       property :id_str, read_only: true
-      property :media_keys, read_only: true
       property :scheduled_status, read_only: true
       property :tweet_id, read_only: true
       property :updated_at, type: :time, read_only: true
@@ -26,7 +25,7 @@ module TwitterAds
       # writable
       property :as_user_id
       property :card_uri
-      property :media_ids
+      property :media_keys
       property :nullcast, type: :bool
       property :scheduled_at, type: :time
       property :text
@@ -35,16 +34,6 @@ module TwitterAds
                             'accounts/%{account_id}/scheduled_tweets' # @api private
       RESOURCE = "/#{TwitterAds::API_VERSION}/" \
                  'accounts/%{account_id}/scheduled_tweets/%{id}' # @api private
-      PREVIEW  = "/#{TwitterAds::API_VERSION}/" \
-                 'accounts/%{account_id}/scheduled_tweets/preview/%{id}' # @api private
-
-      def preview(account, opts = {})
-        if @id
-          resource = self.class::PREVIEW % { account_id: account.id, id: id }
-          response = TwitterAds::Request.new(account.client, :get, resource, params: opts).perform
-          response.body[:data]
-        end
-      end
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/tweets.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  module Creative
+
+    class Tweets
+
+      include TwitterAds::DSL
+      include TwitterAds::Resource
+
+      attr_reader :account
+
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/tweets' # @api private
+
+      # Retrieve Tweet details for the account's full promotable user (default)
+      # or the user specified in the user_id parameter.
+      #
+      # @example
+      #   tweets = TwitterAds::Creative::Tweets.all(
+      #     account,
+      #     tweet_type: 'PUBLISHED',
+      #     tweet_ids: %w(1122911801354510336 1102836745790316550),
+      #     timeline_type: 'ORGANIC'
+      #   )
+      #
+      # @param account [Account] The Account object instance.
+      # @param tweet_type [String] The Tweet type for the specified tweet_ids.
+      # @option opts [Int] :count The number of records to try and retrieve per distinct request.
+      # @option opts [String] :cursor A cursor to get the next page of results.
+      # @option opts [String] :timeline_type The granularity to use (default: NULLCAST).
+      # @option opts [Boolean] :trim_user Whether to exclude the user object
+      #   in the Tweet response (default: false).
+      # @option opts [Array] :tweet_ids A collection of tweet IDs to be fetched.
+      # @option opts [Long] :user_id The user ID to scope Tweets to.
+      #
+      # @return A list of tweets details.
+      #
+      # @see https://developer.twitter.com/en/docs/ads/creatives/api-reference/tweets#get-accounts-account-id-tweets
+      # @since 6.0.0
+
+      def self.all(account, opts = {})
+        params = TwitterAds::Utils.flatten_params(opts)
+        resource = self::RESOURCE_COLLECTION % { account_id: account.id }
+        request = Request.new(account.client, :get, resource, params: params)
+        Cursor.new(nil, request, init_with: [account])
+      end
+
+    end
+  end
+end

data/lib/twitter-ads/creative/video_app_download_card.rb

@@ -18,15 +18,13 @@ module TwitterAds
       property :deleted, type: :bool, read_only: true
       property :id, read_only: true
       property :updated_at, type: :time, read_only: true
-      property :video_content_id, read_only: true
-      property :video_hls_url, read_only: true
       property :video_owner_id, read_only: true
-      property :video_poster_url, read_only: true
-      property :video_url, read_only: true
+      property :poster_media_url, read_only: true
+      property :media_url, read_only: true
 
       property :country_code
       property :app_cta
-      property :image_media_id
+      property :poster_media_key
       property :ipad_app_id
       property :ipad_deep_link
       property :iphone_app_id
@@ -34,7 +32,7 @@ module TwitterAds
       property :googleplay_app_id
       property :googleplay_deep_link
       property :name
-      property :video_id
+      property :media_key
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
                             'accounts/%{account_id}/cards/video_app_download' # @api private

data/lib/twitter-ads/creative/video_conversation_card.rb

@@ -18,14 +18,14 @@ module TwitterAds
       property :deleted, type: :bool, read_only: true
       property :id, read_only: true
       property :updated_at, type: :time, read_only: true
-      property :video_url, read_only: true
-      property :video_poster_url, read_only: true
+      property :media_url, read_only: true
+      property :poster_media_url, read_only: true
 
-      property :cover_image_id
-      property :cover_video_id
+      property :unlocked_image_media_key
+      property :unlocked_video_media_key
       property :fourth_cta
       property :fourth_cta_tweet
-      property :image_media_id
+      property :poster_media_key
       property :first_cta
       property :first_cta_tweet
       property :name
@@ -36,7 +36,7 @@ module TwitterAds
       property :third_cta
       property :third_cta_tweet
       property :title
-      property :video_id
+      property :media_key
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
                             'accounts/%{account_id}/cards/video_conversation' # @api private

data/lib/twitter-ads/creative/video_website_card.rb

@@ -19,21 +19,19 @@ module TwitterAds
       property :deleted, type: :bool, read_only: true
       property :id, read_only: true
       property :updated_at, type: :time, read_only: true
-      property :video_content_id, read_only: true
       property :video_height, read_only: true
-      property :video_hls_url, read_only: true
       property :video_owner_id, read_only: true
       property :video_poster_height, read_only: true
-      property :video_poster_url, read_only: true
+      property :poster_media_url, read_only: true
       property :video_poster_width, read_only: true
-      property :video_url, read_only: true
+      property :media_url, read_only: true
       property :video_width, read_only: true
       property :website_display_url, read_only: true
       property :website_dest_url, read_only: true
 
       property :name
       property :title
-      property :video_id
+      property :media_key
       property :website_url
 
       RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/accounts/%{account_id}/cards/video_website"

data/lib/twitter-ads/creative/website_card.rb

@@ -17,14 +17,14 @@ module TwitterAds
       property :created_at, type: :time, read_only: true
       property :deleted, type: :bool, read_only: true
       property :id, read_only: true
-      property :image, read_only: true
+      property :media_url, read_only: true
       property :image_display_height, read_only: true
       property :image_display_width, read_only: true
       property :updated_at, type: :time, read_only: true
       property :website_dest_url, read_only: true
       property :website_display_url, read_only: true
 
-      property :image_media_id
+      property :media_key
       property :name
       property :website_title
       property :website_url

data/lib/twitter-ads/cursor.rb

@@ -112,6 +112,12 @@ module TwitterAds
     def from_response(response)
       @next_cursor = response.body[:next_cursor]
       @total_count = response.body[:total_count].to_i if response.body.key?(:total_count)
+
+      TwitterAds::Utils.extract_response_headers(response.headers).each { |key, value|
+        singleton_class.class_eval { attr_accessor key }
+        instance_variable_set("@#{key}", value)
+      }
+
       response.body.fetch(:data, []).each do |object|
         @collection << if @klass&.method_defined?(:from_response)
                          @klass.new(

data/lib/twitter-ads/enum.rb

@@ -24,10 +24,15 @@ module TwitterAds
     end
 
     module Placement
-      ALL_ON_TWITTER    = 'ALL_ON_TWITTER'
-      TWITTER_SEARCH    = 'TWITTER_SEARCH'
-      TWITTER_TIMELINE  = 'TWITTER_TIMELINE'
-      PUBLISHER_NETWORK = 'PUBLISHER_NETWORK'
+      ALL_ON_TWITTER     = 'ALL_ON_TWITTER'
+      TWITTER_SEARCH     = 'TWITTER_SEARCH'
+      TWITTER_TIMELINE   = 'TWITTER_TIMELINE'
+      PUBLISHER_NETWORK  = 'PUBLISHER_NETWORK'
+      TAP_FULL           = 'TAP_FULL'
+      TAP_FULL_LANDSCAPE = 'TAP_FULL_LANDSCAPE'
+      TAP_BANNER         = 'TAP_BANNER'
+      TAP_NATIVE         = 'TAP_NATIVE'
+      TAP_MRECT          = 'TAP_MRECT'
     end
 
     module Placement
@@ -106,6 +111,7 @@ module TwitterAds
       FUNDING_INSTRUMENT = 'FUNDING_INSTRUMENT'
       CAMPAIGN           = 'CAMPAIGN'
       LINE_ITEM          = 'LINE_ITEM'
+      PROMOTED_ACCOUNT   = 'PROMOTED_ACCOUNT'
       PROMOTED_TWEET     = 'PROMOTED_TWEET'
       ORGANIC_TWEET      = 'ORGANIC_TWEET'
       MEDIA_CREATIVE     = 'MEDIA_CREATIVE'
@@ -143,7 +149,10 @@ module TwitterAds
     end
 
     module Optimizations
+      APP_CLICKS          = 'APP_CLICKS'
+      APP_INSTALLS        = 'APP_INSTALLS'
       DEFAULT             = 'DEFAULT'
+      ENGAGEMENTS         = 'ENGAGEMENTS'
       WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'
     end
 
@@ -218,11 +227,6 @@ module TwitterAds
       HASHTAG = 'HASHTAG'
     end
 
-    module AudienceDefinition
-      TARGETING_CRITERIA = 'TARGETING_CRITERIA'
-      KEYWORD_AUDIENCE = 'KEYWORD_AUDIENCE'
-    end
-
     module LookalikeExpansion
       DEFINED = 'DEFINED'
       EXPANDED = 'EXPANDED'
@@ -233,5 +237,11 @@ module TwitterAds
       PUBLISHED = 'PUBLISHED'
       SCHEDULED = 'SCHEDULED'
     end
+
+    module TimelineType
+      ALL = 'ALL'
+      NULLCAST = 'NULLCAST'
+      ORGANIC = 'ORGANIC'
+    end
   end
 end