twitter-ads 6.0.1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 711cd962e65906bf2d4812dc41d48f1f21dfc405
-  data.tar.gz: 0c266f4c5b2c97fde746e9ba0c55dcba0e63f0a4
+SHA256:
+  metadata.gz: 3ab4c35b2b3ff9a24fb3475717b923563c484d80b2ac7e981c18570ddbaebdbc
+  data.tar.gz: e5f228604a745b96a063c59d80248bd976f27a4cc43243cd34a0f45a55548cb0
 SHA512:
-  metadata.gz: efeea0e20e53512c8a5cfeae1f3a8f922d1dd97e955e13f2d270128a3c4be57832213691fd79f110868412eb597923b85d11a180ebb7aa0e856509737545dd83
-  data.tar.gz: 197895b12bb107706f7d84dadadbb72c82b5bc91bbf0c72409ad6d45479bef5f5345b128e09ba74d7879f1550539bf253689ab70f80fff58f99b4102344a0476
+  metadata.gz: d17c433739bebd2d74a7c62c20e58819f5f4ea29e241b3dd53ec4baeba4e55213761a27f40833d497b356638a8057770ab7a16f73578df96732555f511ddd43c
+  data.tar.gz: 2aff371a6a36636f82adce64fa00766bcd6e5257a6c288ea58f06740df3bb879008bc1e2afe8b286c8b0b1e431ce5bf413a011562cae9e5594f65133f5d63752

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (C) 2019 Twitter, Inc.
+Copyright (C) 2020 Twitter, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

data/README.md

@@ -1,4 +1,4 @@
-Getting Started [![Build Status](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk.svg?branch=master)](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk) [![Code Climate](https://codeclimate.com/github/twitterdev/twitter-ruby-ads-sdk/badges/gpa.svg)](https://codeclimate.com/github/twitterdev/twitter-ruby-ads-sdk) [![Test Coverage](https://codeclimate.com/github/twitterdev/twitter-ruby-ads-sdk/badges/coverage.svg)](https://codeclimate.com/github/twitterdev/twitter-ruby-ads-sdk/coverage) [![Gem Version](https://badge.fury.io/rb/twitter-ads.svg)](http://badge.fury.io/rb/twitter-ads)
+Getting Started [![Build Status](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk.svg?branch=master)](https://travis-ci.org/twitterdev/twitter-ruby-ads-sdk)[![Gem Version](https://badge.fury.io/rb/twitter-ads.svg)](http://badge.fury.io/rb/twitter-ads)
 ------
 
 ##### Installation

data/lib/twitter-ads.rb

@@ -29,7 +29,7 @@ require 'twitter-ads/http/response'
 
 require 'twitter-ads/restapi.rb'
 
-require 'twitter-ads/audiences/tailored_audience'
+require 'twitter-ads/audiences/custom_audience'
 
 require 'twitter-ads/campaign/app_list'
 require 'twitter-ads/campaign/campaign'
@@ -40,6 +40,8 @@ require 'twitter-ads/campaign/targeting_criteria'
 require 'twitter-ads/campaign/tweet'
 require 'twitter-ads/campaign/organic_tweet'
 require 'twitter-ads/campaign/iab_category'
+require 'twitter-ads/campaign/advertiser_business_categories'
+require 'twitter-ads/campaign/content_categories'
 
 require 'twitter-ads/targeting_criteria/tv_market'
 require 'twitter-ads/targeting_criteria/tv_show'
@@ -52,12 +54,11 @@ require 'twitter-ads/targeting_criteria/network_operator'
 require 'twitter-ads/targeting_criteria/location'
 require 'twitter-ads/targeting_criteria/interest'
 require 'twitter-ads/targeting_criteria/language'
-require 'twitter-ads/targeting_criteria/behavior'
-require 'twitter-ads/targeting_criteria/behavior_taxonomy'
 require 'twitter-ads/targeting_criteria/app_store_category'
 
 require 'twitter-ads/creative/account_media'
 require 'twitter-ads/creative/cards_fetch'
+require 'twitter-ads/creative/cards'
 require 'twitter-ads/creative/image_app_download_card'
 require 'twitter-ads/creative/image_conversation_card'
 require 'twitter-ads/creative/media_creative'
@@ -74,7 +75,7 @@ require 'twitter-ads/creative/poll_cards'
 require 'twitter-ads/creative/tweet_previews'
 require 'twitter-ads/creative/tweets'
 
-require 'twitter-ads/targeting/reach_estimate'
+require 'twitter-ads/targeting/audience_summary'
 
 require 'twitter-ads/measurement/web_event_tag'
 require 'twitter-ads/measurement/app_event_tag'

data/lib/twitter-ads/account.rb

@@ -23,7 +23,6 @@ module TwitterAds
                                 '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
 
@@ -233,9 +232,9 @@ module TwitterAds
       load_resource(AppList, id, opts)
     end
 
-    # Returns a collection of tailored audiences available to the current account.
+    # Returns a collection of custom audiences available to the current account.
     #
-    # @param id [String] The TailoredAudience ID value.
+    # @param id [String] The CustomAudience ID value.
     # @param opts [Hash] A Hash of extended options.
     # @option opts [Boolean] :with_deleted Indicates if deleted items should be included.
     # @option opts [String] :sort_by The object param to sort the API response by.
@@ -243,26 +242,8 @@ module TwitterAds
     # @since 0.3.0
     #
     # @return A Cursor or object instance.
-    def tailored_audiences(id = nil, opts = {})
-      load_resource(TailoredAudience, id, opts)
-    end
-
-    # Returns the most recent promotable Tweets created by one or more specified Twitter users.
-    #
-    # @param ids [Array] An Array of Twitter user IDs.
-    # @param opts [Hash] A Hash of extended options.
-    #
-    # @return [Array] An Array of Tweet objects.
-    #
-    # @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)
-      response = request.perform
-      response.body[:data]
+    def custom_audiences(id = nil, opts = {})
+      load_resource(CustomAudience, id, opts)
     end
 
     def authenticated_user_access

data/lib/twitter-ads/audiences/{tailored_audience.rb → custom_audience.rb}

@@ -2,7 +2,7 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  class TailoredAudience
+  class CustomAudience
 
     include TwitterAds::DSL
     include TwitterAds::Resource
@@ -19,18 +19,19 @@ module TwitterAds
 
     property :audience_size, read_only: true
     property :audience_type, read_only: true
-    property :metadata, read_only: true
     property :partner_source, read_only: true
     property :reasons_not_targetable, read_only: true
     property :targetable, type: :bool, read_only: true
     property :targetable_types, read_only: true
+    property :permission_level, read_only: true
+    property :owner_account_id, read_only: true
 
     RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tailored_audiences' # @api private
+                           'accounts/%{account_id}/custom_audiences' # @api private
     RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tailored_audiences/%{id}' # @api private
+                           'accounts/%{account_id}/custom_audiences/%{id}' # @api private
     RESOURCE_USERS       = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tailored_audiences/' \
+                           'accounts/%{account_id}/custom_audiences/' \
                            '%{id}/users' # @api private
 
     LIST_TYPES = %w(
@@ -54,17 +55,17 @@ module TwitterAds
 
     class << self
 
-      # Creates a new tailored audience.
+      # Creates a new custom audience.
       #
       # @example
-      #   audience = TailoredAudience.create(account, 'my list')
+      #   audience = CustomAudience.create(account, 'my list')
       #
       # @param account [Account] The account object instance.
-      # @param name [String] The tailored audience name.
+      # @param name [String] The custom audience name.
       #
       # @since 4.0
       #
-      # @return [TailoredAudience] The newly created tailored audience instance.
+      # @return [CustomAudience] The newly created custom audience instance.
       def create(account, name)
         audience = new(account)
         params = { name: name }
@@ -75,7 +76,7 @@ module TwitterAds
 
     end
 
-    # Deletes the current tailored audience instance.
+    # Deletes the current custom audience instance.
     #
     # @example
     #   audience.delete!
@@ -84,21 +85,21 @@ module TwitterAds
     #
     # @since 0.3.0
     #
-    # @return [self] Returns the tailored audience instance refreshed from the API.
+    # @return [self] Returns the custom audience instance refreshed from the API.
     def delete!
       resource = RESOURCE % { account_id: account.id, id: id }
       response = Request.new(account.client, :delete, resource).perform
       from_response(response.body[:data])
     end
 
-    # This is a private API and requires whitelisting from Twitter.
+    # This is a private API and requires allowlisting from Twitter.
     #
     # This endpoint will allow partners to add, update and remove users from a given
-    # tailored_audience_id.
+    # custom_audience_id.
     # The endpoint will also accept multiple user identifier types per user as well.
     #
     # @example
-    #   tailored_audience.users(
+    #   custom_audience.users(
     #     account,
     #     [
     #       {
@@ -137,9 +138,63 @@ module TwitterAds
       [success_count, total_count]
     end
 
+    # Retrieves the entites targeting the current tailored audience instance.
+    #
+    # @example
+    #   audience.targeted(with_active=true)
+    #
+    # @param with_active [bool] Include active/inactive
+    #
+    # @since 8.0.0
+    #
+    # @return [self] Returns a Cursor instance of the targeted entities.
+    def targeted(opts = {})
+      validate_loaded
+      params = {}.merge!(opts)
+      TargetedTailoredAudience.load(account, id, params)
+    end
+
+    def validate_loaded
+      raise ArgumentError.new(
+        "Error! #{self.class} object not yet initialized, " \
+        "call #{self.class}.load first") if id.nil?
+    end
+  end
+
+  class TargetedTailoredAudience
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+
+    attr_reader :account
+
+    # read-only
+    property :campaign_id, read_only: true
+    property :campaign_name, read_only: true
+    property :line_items, read_only: true
+
+    RESOURCE_TARGETED = "/#{TwitterAds::API_VERSION}/" \
+                        'accounts/%{account_id}/tailored_audiences/%{id}/targeted' # @api private
+
+    def initialize(account)
+      @account = account
+      self
+    end
+
+    class << self
+
+      def load(account, tailored_audience_id, params)
+        resource = RESOURCE_TARGETED % { account_id: account.id, id: tailored_audience_id }
+        request = TwitterAds::Request.new(account.client,
+                                          :get,
+                                          resource,
+                                          params: params)
+        Cursor.new(self, request, init_with: [account])
+      end
+    end
   end
 
-  class TailoredAudiencePermission
+  class CustomAudiencePermission
 
     include TwitterAds::DSL
     include TwitterAds::Resource
@@ -152,16 +207,16 @@ module TwitterAds
     property :deleted, type: :bool, read_only: true
 
     property :id
-    property :tailored_audience_id
+    property :custom_audience_id
     property :granted_account_id
     property :permission_level
 
     RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tailored_audiences/' \
-                           '%{tailored_audience_id}/permissions' # @api private
+                           'accounts/%{account_id}/custom_audiences/' \
+                           '%{custom_audience_id}/permissions' # @api private
     RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/tailored_audiences/' \
-                           '%{tailored_audience_id}/permissions/%{id}' # @api private
+                           'accounts/%{account_id}/custom_audiences/' \
+                           '%{custom_audience_id}/permissions/%{id}' # @api private
 
     def initialize(account)
       @account = account
@@ -171,22 +226,22 @@ module TwitterAds
     class << self
 
       # Retrieve details for some or
-      # all permissions associated with the specified tailored audience.
+      # all permissions associated with the specified custom audience.
       #
       # @exapmle
-      #   permissions = TailoredAudiencePermission.all(account, '36n4f')
+      #   permissions = CustomAudiencePermission.all(account, '36n4f')
       #
       # @param account [Account] The account object instance.
-      # @param tailored_audience_id [String] The tailored audience id.
+      # @param custom_audience_id [String] The custom audience id.
       #
       # @since 5.2.0
       #
-      # @return [TailoredAudiencePermission] The tailored audience permission instance.
-      def all(account, tailored_audience_id, opts = {})
+      # @return [CustomAudiencePermission] The custom audience permission instance.
+      def all(account, custom_audience_id, opts = {})
         params = {}.merge!(opts)
         resource = RESOURCE_COLLECTION % {
           account_id: account.id,
-          tailored_audience_id: tailored_audience_id
+          custom_audience_id: custom_audience_id
         }
         request = Request.new(account.client, :get, resource, params: params)
         Cursor.new(self, request, init_with: [account])
@@ -195,7 +250,7 @@ module TwitterAds
     end
 
     # Saves or updates the current object instance
-    # depending on the presence of `object.tailored_audience_id`.
+    # depending on the presence of `object.custom_audience_id`.
     #
     # @exapmle
     #   object.save
@@ -206,14 +261,14 @@ module TwitterAds
     def save
       resource = RESOURCE_COLLECTION % {
         account_id: account.id,
-        tailored_audience_id: tailored_audience_id
+        custom_audience_id: custom_audience_id
       }
       params = to_params
       response = Request.new(account.client, :post, resource, params: params).perform
       from_response(response.body[:data])
     end
 
-    # Deletes the current or specified tailored audience permission.
+    # Deletes the current or specified custom audience permission.
     #
     # @example
     #   object.delete!
@@ -226,7 +281,7 @@ module TwitterAds
     def delete!
       resource = RESOURCE % {
         account_id: account.id,
-        tailored_audience_id: tailored_audience_id,
+        custom_audience_id: custom_audience_id,
         id: @id
       }
       response = Request.new(account.client, :delete, resource).perform

data/lib/twitter-ads/{targeting_criteria/behavior_taxonomy.rb → campaign/advertiser_business_categories.rb}

@@ -2,19 +2,19 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  class BehaviorTaxonomy
+  class AdvertiserBusinessCategories
 
     include TwitterAds::DSL
     include TwitterAds::Resource
 
+    attr_reader :account
+
     property :id, read_only: true
     property :name, read_only: true
-    property :parent_id, read_only: true
-    property :created_at, read_only: true
-    property :updated_at, read_only: true
+    property :iab_categories, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
-                          'targeting_criteria/behavior_taxonomies' # @api private
+    # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/advertiser_business_categories"
 
     def initialize(account)
       @account = account

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  class ContentCategories
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+
+    attr_reader :account
+
+    property :id, read_only: true
+    property :name, read_only: true
+    property :iab_categories, read_only: true
+
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/content_categories" # @api private
+
+    def initialize(account)
+      @account = account
+      self
+    end
+  end
+end

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

@@ -17,18 +17,20 @@ module TwitterAds
     property :updated_at, type: :time, read_only: true
 
     property :advertiser_domain
+    property :android_app_store_identifier
+    property :audience_expansion
     property :automatically_select_bid
     property :bid_amount_local_micro
-    property :bid_unit
+    property :bid_strategy
     property :campaign_id
     property :categories
-    property :charge_by
     property :end_time, type: :time
     property :entity_status
-    property :include_sentiment
+    property :goal
+    property :ios_app_store_identifier
     property :name
     property :objective
-    property :optimization
+    property :pay_by
     property :placements
     property :primary_web_event_tag
     property :product_type
@@ -37,9 +39,7 @@ module TwitterAds
 
     # beta (not yet generally available)
     property :advertiser_user_id
-    property :bid_type
     property :tracking_tags
-    property :audience_expansion
 
     # sdk only
     property :to_delete, type: :bool

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

@@ -21,6 +21,7 @@ module TwitterAds
     property :line_item_id
     property :targeting_type
     property :targeting_value
+    property :operator_type
     property :tailored_audience_expansion, type: :bool
     property :location_type