twitter-ads 5.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd47b38d08667bf292088700123342cf46e6576a3cb9a315ae9011517f85db4
-  data.tar.gz: d8d0de8d946a946c483373d0a01cfbd716a0c43e2c48932e3dc77a091d4bdfeb
+  metadata.gz: '05206182b0393791a3d5541b133b276f37fbd7bd440db7977b5fb7f17b3c3abc'
+  data.tar.gz: 72617e530b12e11efed8b8c33a259a5aaa26b50088da58f66e9e9c234047bcb1
 SHA512:
-  metadata.gz: 5e9298f7816c6a34f72d57ec64a36ca867bd226601486a41de01716283139ac3142788a7b4506567f097e143ebd39ff54bddd34db64bd84599815dd98a4a3a81
-  data.tar.gz: fb148af4796eaad730508ea7a4b3e63d5bcb36f56270e305707df52c36b96dbb485093bf2998684dcaaa8550e3a3ef8cf80294f1dee740ebc4c931b16d27b31d
+  metadata.gz: ce83a7aec3141813b2b93050bd192bb235b4bf8ff4318c2c8807b5bc1de214ccfe5cae7d31c8bacbf8b918850e637d2e72618682679f5ef7f37dc40550268246
+  data.tar.gz: 27389f140dc023a6eafc4bc0a758bc6105fe502fab32e3f5b5c6c8ecbb6c6811b0b4542bd0b0ed227760c506d16c3d3f7f1a24909ceb543681c5a8426c0efa5e

data/lib/twitter-ads.rb

@@ -27,7 +27,8 @@ require 'twitter-ads/resources/batch'
 require 'twitter-ads/http/request'
 require 'twitter-ads/http/response'
 
-require 'twitter-ads/audiences/audience_intelligence'
+require 'twitter-ads/restapi.rb'
+
 require 'twitter-ads/audiences/tailored_audience'
 
 require 'twitter-ads/campaign/app_list'
@@ -63,12 +64,14 @@ require 'twitter-ads/creative/media_library'
 require 'twitter-ads/creative/promoted_account'
 require 'twitter-ads/creative/promoted_tweet'
 require 'twitter-ads/creative/scheduled_tweet'
+require 'twitter-ads/creative/draft_tweet'
 require 'twitter-ads/creative/video_app_download_card'
 require 'twitter-ads/creative/video_conversation_card'
 require 'twitter-ads/creative/video_website_card'
 require 'twitter-ads/creative/website_card'
 require 'twitter-ads/creative/poll_cards'
 require 'twitter-ads/creative/tweet_previews'
+require 'twitter-ads/creative/tweets'
 
 require 'twitter-ads/targeting/reach_estimate'
 

data/lib/twitter-ads/account.rb

@@ -17,14 +17,13 @@ module TwitterAds
     property :updated_at, type: :time, read_only: true
     property :deleted, type: :bool, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
-                          'accounts' # @api private
-    RESOURCE            = "/#{TwitterAds::API_VERSION}/" \
-                          'accounts/%{id}' # @api private
-    FEATURES            = "/#{TwitterAds::API_VERSION}/" \
-                          'accounts/%{id}/features' # @api private
-    SCOPED_TIMELINE     = "/#{TwitterAds::API_VERSION}/" \
-                          'accounts/%{id}/scoped_timeline' # @api private
+    RESOURCE_COLLECTION       = "/#{TwitterAds::API_VERSION}/" \
+                                'accounts' # @api private
+    RESOURCE                  = "/#{TwitterAds::API_VERSION}/" \
+                                'accounts/%{id}' # @api private
+    FEATURES                  = "/#{TwitterAds::API_VERSION}/" \
+                                'accounts/%{id}/features' # @api private
+    SCOPED_TIMELINE           = '/5/accounts/%{id}/scoped_timeline' # @api private
     AUTHENTICATED_USER_ACCESS = "/#{TwitterAds::API_VERSION}/" \
                                 'accounts/%{id}/authenticated_user_access' # @api private
 
@@ -257,6 +256,8 @@ module TwitterAds
     #
     # @since 0.2.3
     def scoped_timeline(id, opts = {})
+      TwitterAds::Utils.deprecated(
+        'Scoped Timeline')
       params   = { user_id: id }.merge!(opts)
       resource = SCOPED_TIMELINE % { id: @id }
       request  = Request.new(client, :get, resource, params: params)

data/lib/twitter-ads/campaign/campaign.rb

@@ -2,12 +2,11 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  class Campaign
+  class Campaign < Analytics
 
     include TwitterAds::DSL
     include TwitterAds::Resource
     include TwitterAds::Persistence
-    include TwitterAds::Analytics
     include TwitterAds::Batch
 
     attr_reader :account

data/lib/twitter-ads/campaign/funding_instrument.rb

@@ -2,11 +2,10 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  class FundingInstrument
+  class FundingInstrument < Analytics
 
     include TwitterAds::DSL
     include TwitterAds::Resource
-    include TwitterAds::Analytics
 
     attr_reader :account
 

data/lib/twitter-ads/campaign/line_item.rb

@@ -2,12 +2,11 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  class LineItem
+  class LineItem < Analytics
 
     include TwitterAds::DSL
     include TwitterAds::Resource
     include TwitterAds::Persistence
-    include TwitterAds::Analytics
     include TwitterAds::Batch
 
     attr_reader :account
@@ -40,7 +39,7 @@ module TwitterAds
     property :advertiser_user_id
     property :bid_type
     property :tracking_tags
-    property :lookalike_expansion
+    property :audience_expansion
 
     # sdk only
     property :to_delete, type: :bool

data/lib/twitter-ads/campaign/organic_tweet.rb

@@ -3,9 +3,7 @@
 # Author Bob, Nugit
 
 module TwitterAds
-  class OrganicTweet
-
-    include TwitterAds::Analytics
+  class OrganicTweet < Analytics
 
   end
 end

data/lib/twitter-ads/campaign/targeting_criteria.rb

@@ -22,7 +22,6 @@ module TwitterAds
     property :targeting_type
     property :targeting_value
     property :tailored_audience_expansion, type: :bool
-    property :tailored_audience_type
     property :location_type
 
     # sdk only

data/lib/twitter-ads/campaign/tweet.rb

@@ -2,66 +2,21 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  module Tweet
+  class Tweet < Analytics
 
-    # cannot instaniate Tweet, only including class methods for stats
-    extend TwitterAds::Analytics::ClassMethods
-
-    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tweet/preview' # @api private
-    RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tweet/preview/%{id}' # @api private
-    RESOURCE_CREATE      = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tweet' # @api private
+    RESOURCE_CREATE = "/#{TwitterAds::API_VERSION}/" \
+                      'accounts/%{account_id}/tweet' # @api private
 
     class << self
 
-      # Returns an HTML preview of a tweet, either new or existing
-      #
-      # @example
-      #   Tweet.preview(account, text: 'potatoes can be deadly...')
-      #   Tweet.preview(account, id: 634798319504617472)
-      #
-      # @param client [Client] The Client object instance.
-      # @param account [Account] The Account object instance.
-      # @param opts [Hash] A hash of options.
-      #
-      # @option opts [Integer] :id The ID of an existing Tweet you want to preview.
-      # @option opts [String] :text The text of your status update.
-      # @option opts [Array] :media_ids A list of up to four media IDs to associate with the Tweet.
-      # @option opts [String] :card_id The base-36 ID of a revenue card to be embedded in the Tweet.
-      # @option opts [String] :preview_target The target to render the Tweet preview
-      #   for (eg. TWITTER_TIMELINES).
-      #
-      # @return [Array] An array containing platforms & their respective tweet previews
-      #
-      # @since 0.2.0
-      # @see https://dev.twitter.com/ads/reference/get/accounts/%3Aaccount_id/tweet/preview
-      def preview(account, opts = {})
-        resource = opts.key?(:id) ? RESOURCE : RESOURCE_COLLECTION
-        resource = resource % { account_id: account.id, id: opts.delete(:id) }
-
-        # url encodes status message if present
-        opts[:text] = URI.escape(opts[:text]) if opts.key?(:text)
-
-        # handles array to string conversion for media IDs
-        if opts.key?(:media_ids) && opts[:media_ids].respond_to?(:join)
-          opts[:media_ids] = opts[:media_ids].join(',')
-        end
-
-        response = TwitterAds::Request.new(account.client, :get, resource, params: opts).perform
-        response.body[:data]
-      end
-
       # Creates a "Promoted-Only" Tweet using the specialized Ads API end point.
       #
       # @param opts [Hash] A hash of options.
       #
       # @option opts [String] :text The main Tweet body.
-      # @option opts [Array] :media_ids A list of up to four media IDs to associate with the Tweet.
+      # @option opts [Array] :media_keys A list of media keys (up to 4) to associate with the Tweet.
       # @option opts [Integer] :as_user_id The user ID whom you are posting the Tweet on behalf of.
       # @option opts [Boolean] :trim_user Excludes the user object from the hydrated Tweet response.
-      # @option opts [String] :video_id The Video UUID to be associated with thie Tweet.
       # @option opts [String] :video_title An optional title to be included.
       # @option opts [String] :video_description An optional description to be included.
       # @option opts [String] :video_cta An optional CTA value for the associated video.

data/lib/twitter-ads/client.rb

@@ -3,7 +3,7 @@
 
 module TwitterAds
 
-  API_VERSION = '5'
+  API_VERSION = '6'
 
   # 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
 

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

@@ -22,17 +22,15 @@ 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}/" \

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