twitter-ads 5.1.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66b5f0101e9a3bb56a76274588cc25949cd5427a6993cf545934472013c019c1
-  data.tar.gz: 74f5b1183e980d2793ba90af482b70fdfdd8c6b47dfbd80a99c0208c77f42289
+  metadata.gz: b42045b5ca461ee6f6a13ed129264351506089d23622ad2429a1a154e0b2b03f
+  data.tar.gz: 431d8797b1d1aa606c10672780708112053710b0e745e46e13bd602097c48ca9
 SHA512:
-  metadata.gz: 627d24d41572df3ecbd8078ab336da7008d3e9ffed57a3af1ac03d41c7c44014eee2d9da920b50505e2b24c866a80049825574cff377532c5146a5515857214b
-  data.tar.gz: 03e79e1ce3c97d62a7bc9aae41b94bfd0709fc7899e4c248f403e652e6d7bd51c060d32466f392162ed5bd62853c61ff2e1ca4c39a2debe19cecef0fc80e218b
+  metadata.gz: fb703d3ef21d673d313c7223474e5dabbdb0d64233b88550a1135773118273a71272a38b791c927139773de1b62e639f06075fd9a25a94668e9a7cefd9bd0f82
+  data.tar.gz: bcef25e9c1a7a4d3ac331bbf901dbaefbe00121a7f0ca6e66c484f0b93585d5d8e85d7d8e46d3bfe771cc5daa584735626300a3b56743e529e4de5031aff3a36

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

@@ -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'
@@ -39,19 +40,20 @@ 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'
 require 'twitter-ads/targeting_criteria/event'
 require 'twitter-ads/targeting_criteria/device'
+require 'twitter-ads/targeting_criteria/conversation'
 require 'twitter-ads/targeting_criteria/platform'
 require 'twitter-ads/targeting_criteria/platform_version'
 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'
@@ -63,14 +65,16 @@ 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'
+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

@@ -17,14 +17,12 @@ 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
     AUTHENTICATED_USER_ACCESS = "/#{TwitterAds::API_VERSION}/" \
                                 'accounts/%{id}/authenticated_user_access' # @api private
 
@@ -248,23 +246,6 @@ module TwitterAds
       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(ids, opts = {})
-      ids      = ids.join(',') if ids.is_a?(Array)
-      params   = { user_ids: ids }.merge!(opts)
-      resource = SCOPED_TIMELINE % { id: @id }
-      request  = Request.new(client, :get, resource, params: params)
-      response = request.perform
-      response.body[:data]
-    end
-
     def authenticated_user_access
       params = {}
       resource = AUTHENTICATED_USER_ACCESS % { id: @id }

data/lib/twitter-ads/audiences/tailored_audience.rb

@@ -29,9 +29,9 @@ module TwitterAds
                            'accounts/%{account_id}/tailored_audiences' # @api private
     RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
                            'accounts/%{account_id}/tailored_audiences/%{id}' # @api private
-    RESOURCE_USERS       = "/#{TwitterAds::API_VERSION}/ \
-                           accounts/%{account_id}/tailored_audiences/ \
-                           %{id}/users" # @api private
+    RESOURCE_USERS       = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/tailored_audiences/' \
+                           '%{id}/users' # @api private
 
     LIST_TYPES = %w(
       EMAIL
@@ -138,4 +138,99 @@ module TwitterAds
     end
 
   end
+
+  class TailoredAudiencePermission
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+
+    attr_reader :account
+
+    # read-only
+    property :created_at, type: :time, read_only: true
+    property :updated_at, type: :time, read_only: true
+    property :deleted, type: :bool, read_only: true
+
+    property :id
+    property :tailored_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
+    RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/tailored_audiences/' \
+                           '%{tailored_audience_id}/permissions/%{id}' # @api private
+
+    def initialize(account)
+      @account = account
+      self
+    end
+
+    class << self
+
+      # Retrieve details for some or
+      # all permissions associated with the specified tailored audience.
+      #
+      # @exapmle
+      #   permissions = TailoredAudiencePermission.all(account, '36n4f')
+      #
+      # @param account [Account] The account object instance.
+      # @param tailored_audience_id [String] The tailored audience id.
+      #
+      # @since 5.2.0
+      #
+      # @return [TailoredAudiencePermission] The tailored audience permission instance.
+      def all(account, tailored_audience_id, opts = {})
+        params = {}.merge!(opts)
+        resource = RESOURCE_COLLECTION % {
+          account_id: account.id,
+          tailored_audience_id: tailored_audience_id
+        }
+        request = Request.new(account.client, :get, resource, params: params)
+        Cursor.new(self, request, init_with: [account])
+      end
+
+    end
+
+    # Saves or updates the current object instance
+    # depending on the presence of `object.tailored_audience_id`.
+    #
+    # @exapmle
+    #   object.save
+    #
+    # @since 5.2.0
+    #
+    # @return [self] Returns the instance refreshed from the API.
+    def save
+      resource = RESOURCE_COLLECTION % {
+        account_id: account.id,
+        tailored_audience_id: tailored_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.
+    #
+    # @example
+    #   object.delete!
+    #
+    # Note: calls to this method are destructive and irreverisble.
+    #
+    # @since 5.2.0
+    #
+    # @return [self] Returns the instance refreshed from the API.
+    def delete!
+      resource = RESOURCE % {
+        account_id: account.id,
+        tailored_audience_id: tailored_audience_id,
+        id: @id
+      }
+      response = Request.new(account.client, :delete, resource).perform
+      from_response(response.body[:data])
+    end
+  end
 end

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/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/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/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
@@ -18,6 +17,7 @@ module TwitterAds
     property :updated_at, type: :time, read_only: true
 
     property :advertiser_domain
+    property :android_app_store_identifier
     property :automatically_select_bid
     property :bid_amount_local_micro
     property :bid_unit
@@ -26,7 +26,7 @@ module TwitterAds
     property :charge_by
     property :end_time, type: :time
     property :entity_status
-    property :include_sentiment
+    property :ios_app_store_identifier
     property :name
     property :objective
     property :optimization
@@ -40,7 +40,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.