twitter-ads 5.0.0 → 5.1.0

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

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class FundingInstrument
 
     include TwitterAds::DSL
     include TwitterAds::Resource
+    include TwitterAds::Analytics
 
     attr_reader :account
 
@@ -24,10 +25,10 @@ module TwitterAds
     property :io_header, read_only: true
     property :reasons_not_able_to_fund, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/funding_instruments'.freeze # @api private
-    RESOURCE            = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/funding_instruments/%{id}'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/funding_instruments' # @api private
+    RESOURCE            = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/funding_instruments/%{id}' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class IABCategory
@@ -13,7 +13,7 @@ module TwitterAds
     property :name, read_only: true
     property :parent_id, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/iab_categories".freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/iab_categories" # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class LineItem
@@ -17,23 +17,24 @@ module TwitterAds
     property :created_at, type: :time, read_only: true
     property :updated_at, type: :time, read_only: true
 
-    property :name
-    property :campaign_id
     property :advertiser_domain
+    property :automatically_select_bid
+    property :bid_amount_local_micro
+    property :bid_unit
+    property :campaign_id
     property :categories
     property :charge_by
+    property :end_time, type: :time
+    property :entity_status
     property :include_sentiment
+    property :name
     property :objective
     property :optimization
-    property :entity_status
+    property :placements
     property :primary_web_event_tag
     property :product_type
-    property :placements
-    property :bid_unit
-    property :automatically_select_bid
-    property :bid_amount_local_micro
+    property :start_time, type: :time
     property :total_budget_amount_local_micro
-    property :target_cpa_local_micro
 
     # beta (not yet generally available)
     property :advertiser_user_id
@@ -44,18 +45,14 @@ module TwitterAds
     # sdk only
     property :to_delete, type: :bool
 
-    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/line_items'.freeze # @api private
-    RESOURCE_STATS       = "/#{TwitterAds::API_VERSION}/" +
-                           'stats/accounts/%{account_id}'.freeze # @api private
-    RESOURCE_ASYNC_STATS = "/#{TwitterAds::API_VERSION}/" +
-                           'stats/jobs/accounts/%{account_id}'.freeze # @api private
-    RESOURCE_BATCH       = "/#{TwitterAds::API_VERSION}/" +
-                           'batch/accounts/%{account_id}/line_items'.freeze # @api private
-    RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/line_items/%{id}'.freeze # @api private
-    RESOURCE_PLACEMENTS  = "/#{TwitterAds::API_VERSION}/" +
-                           'line_items/placements'.freeze # @api private
+    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/line_items' # @api private
+    RESOURCE_BATCH       = "/#{TwitterAds::API_VERSION}/" \
+                           'batch/accounts/%{account_id}/line_items' # @api private
+    RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/line_items/%{id}' # @api private
+    RESOURCE_PLACEMENTS  = "/#{TwitterAds::API_VERSION}/" \
+                           'line_items/placements' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 # Author Bob, Nugit
 
 module TwitterAds
@@ -7,9 +7,5 @@ module TwitterAds
 
     include TwitterAds::Analytics
 
-    RESOURCE_STATS       = "/#{TwitterAds::API_VERSION}/" +
-                           'stats/accounts/%{account_id}'.freeze # @api private
-    RESOURCE_ASYNC_STATS = "/#{TwitterAds::API_VERSION}/" +
-                           'stats/jobs/accounts/%{account_id}'.freeze # @api private
   end
 end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class PromotableUser
@@ -16,10 +16,10 @@ module TwitterAds
     property :updated_at, type: :time, read_only: true
     property :deleted, type: :bool, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/promotable_users'.freeze # @api private
-    RESOURCE            = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/promotable_users/%{id}'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/promotable_users' # @api private
+    RESOURCE            = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/promotable_users/%{id}' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class TargetingCriteria
@@ -28,12 +28,12 @@ module TwitterAds
     # sdk only
     property :to_delete, type: :bool
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/targeting_criteria'.freeze # @api private
-    RESOURCE_BATCH      = "/#{TwitterAds::API_VERSION}/" +
-                          'batch/accounts/%{account_id}/targeting_criteria'.freeze # @api private
-    RESOURCE            = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/targeting_criteria/%{id}'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/targeting_criteria' # @api private
+    RESOURCE_BATCH      = "/#{TwitterAds::API_VERSION}/" \
+                          'batch/accounts/%{account_id}/targeting_criteria' # @api private
+    RESOURCE            = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/targeting_criteria/%{id}' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Tweet
@@ -7,16 +7,12 @@ module TwitterAds
     # cannot instaniate Tweet, only including class methods for stats
     extend TwitterAds::Analytics::ClassMethods
 
-    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/tweet/preview'.freeze # @api private
-    RESOURCE_STATS       = "/#{TwitterAds::API_VERSION}/" +
-                           'stats/accounts/%{account_id}'.freeze # @api private
-    RESOURCE_ASYNC_STATS = "/#{TwitterAds::API_VERSION}/" +
-                           'stats/jobs/accounts/%{account_id}'.freeze # @api private
-    RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/tweet/preview/%{id}'.freeze # @api private
-    RESOURCE_CREATE      = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/tweet'.freeze # @api private
+    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
 
     class << self
 

data/lib/twitter-ads/client.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
 
-  API_VERSION = '5'.freeze
+  API_VERSION = '5'
 
   # The Ads API Client class which functions as a
   # container for basic API consumer information.
@@ -13,8 +13,7 @@ module TwitterAds
                   :consumer_secret,
                   :access_token,
                   :access_token_secret,
-                  :options,
-                  :logger
+                  :options
 
     # Creates a new Ads API client instance.
     #

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -22,10 +22,10 @@ module TwitterAds
       property :media_id
       property :video_id
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/account_media'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/account_media/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/account_media' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/account_media/%{id}' # @api private
 
       def initialize(account)
         @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -72,9 +72,9 @@ module TwitterAds
       property :id, read_only: true
 
       FETCH_URI = "/#{TwitterAds::API_VERSION}/" +
-                  'accounts/%{account_id}/cards/all'.freeze # @api private
+                  'accounts/%{account_id}/cards/all' # @api private
       FETCH_ID  = "/#{TwitterAds::API_VERSION}/" +
-                  'accounts/%{account_id}/cards/all/%{id}'.freeze # @api private
+                  'accounts/%{account_id}/cards/all/%{id}' # @api private
 
       def all(*)
         raise ArgumentError.new(
@@ -87,17 +87,19 @@ module TwitterAds
                              'Please supply one or the other, but not both.')
         end
 
+        params = {}.merge!(opts)
+
         if with_deleted && TwitterAds::Utils.to_bool(with_deleted)
-          params = { with_deleted: true }.merge!(opts)
+          params = { with_deleted: true }.merge!(params)
         end
 
         if card_uris
-          params = { card_uris: Array(card_uris).join(',') }.merge!(opts).merge!(params)
+          params = { card_uris: Array(card_uris).join(',') }.merge!(params)
           resource = FETCH_URI % { account_id: account.id }
           request = Request.new(account.client, :get, resource, params: params)
           return Cursor.new(self.class, request, init_with: [account])
         else
-          params = { card_id: card_id }.merge!(opts).merge!(params)
+          params = { card_id: card_id }.merge!(params)
           resource = FETCH_ID % { account_id: account.id, id: card_id }
           response = Request.new(account.client, :get, resource, params: params).perform
           return from_response(response.body[:data])

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -33,10 +33,10 @@ module TwitterAds
       property :name
       property :wide_app_image_media_id
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/cards/image_app_download'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/cards/image_app_download/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/cards/image_app_download' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/cards/image_app_download/%{id}' # @api private
 
       def initialize(account)
         @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -35,10 +35,10 @@ module TwitterAds
       property :third_cta_tweet
       property :title
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/cards/image_conversation'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/cards/image_conversation/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/cards/image_conversation' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/cards/image_conversation/%{id}' # @api private
 
       def initialize(account)
         @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -9,6 +9,7 @@ module TwitterAds
       include TwitterAds::DSL
       include TwitterAds::Resource
       include TwitterAds::Persistence
+      include TwitterAds::Analytics
 
       attr_reader :account
 
@@ -23,10 +24,10 @@ module TwitterAds
       property :line_item_id
       property :landing_url
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/media_creatives'.freeze # @api private
-      RESOURCE            = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/media_creatives/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/media_creatives' # @api private
+      RESOURCE            = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/media_creatives/%{id}' # @api private
 
       def initialize(account)
         @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -35,10 +35,10 @@ module TwitterAds
       property :poster_image_media_key
       property :title
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/media_library'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/media_library/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/media_library' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/media_library/%{id}' # @api private
 
       def reload(account, opts = {})
         if @media_key

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -40,10 +40,10 @@ module TwitterAds
       property :third_choice
       property :fourth_choice
 
-      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                            'accounts/%{account_id}/cards/poll'.freeze # @api private
-      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/cards/poll/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                            'accounts/%{account_id}/cards/poll' # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                 'accounts/%{account_id}/cards/poll/%{id}' # @api private
 
       def initialize(account)
         @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -23,14 +23,10 @@ module TwitterAds
       property :user_id
       property :paused, type: :bool
 
-      RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
-                             'accounts/%{account_id}/promoted_accounts'.freeze # @api private
-      RESOURCE_STATS       = "/#{TwitterAds::API_VERSION}/" +
-                             'stats/accounts/%{account_id}'.freeze # @api private
-      RESOURCE_ASYNC_STATS = "/#{TwitterAds::API_VERSION}/" +
-                             'stats/jobs/accounts/%{account_id}'.freeze # @api private
-      RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
-                             'accounts/%{account_id}/promoted_accounts/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
+                             'accounts/%{account_id}/promoted_accounts' # @api private
+      RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
+                             'accounts/%{account_id}/promoted_accounts/%{id}' # @api private
 
       def initialize(account)
         @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Creative
@@ -23,14 +23,10 @@ module TwitterAds
       property :line_item_id
       property :tweet_id
 
-      RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
-                             'accounts/%{account_id}/promoted_tweets'.freeze # @api private
-      RESOURCE_STATS       = "/#{TwitterAds::API_VERSION}/" +
-                             'stats/accounts/%{account_id}'.freeze # @api private
-      RESOURCE_ASYNC_STATS = "/#{TwitterAds::API_VERSION}/" +
-                             'stats/jobs/accounts/%{account_id}'.freeze # @api private
-      RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
-                             'accounts/%{account_id}/promoted_tweets/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
+                             'accounts/%{account_id}/promoted_tweets' # @api private
+      RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
+                             'accounts/%{account_id}/promoted_tweets/%{id}' # @api private
 
       def initialize(account)
         @account = account