twitter-ads 5.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd47b38d08667bf292088700123342cf46e6576a3cb9a315ae9011517f85db4
-  data.tar.gz: d8d0de8d946a946c483373d0a01cfbd716a0c43e2c48932e3dc77a091d4bdfeb
+  metadata.gz: ffe2cf6607163db38e5a09d5cc26e6bd38e700ac5a9a63be8bfaac8837f15725
+  data.tar.gz: 58becc51cdae11dbb55f40f7bc5aaccb024efb250e6f34d3020cc310cfeb3cdb
 SHA512:
-  metadata.gz: 5e9298f7816c6a34f72d57ec64a36ca867bd226601486a41de01716283139ac3142788a7b4506567f097e143ebd39ff54bddd34db64bd84599815dd98a4a3a81
-  data.tar.gz: fb148af4796eaad730508ea7a4b3e63d5bcb36f56270e305707df52c36b96dbb485093bf2998684dcaaa8550e3a3ef8cf80294f1dee740ebc4c931b16d27b31d
+  metadata.gz: 49bec3d898f35d4b0b9e8a95244910230f0c580f6eaf1b111ce71661ea247df2ec5f698600b8a86537889bfe4f4cf2be7a34745f9ffef04be99ad6a9c789f67f
+  data.tar.gz: 34c513a59fd03118f3c9273401867c1d5e1a8d81dfcb0a9a9891549350639d68d86dd1670e6822aaa3aab171d474c70b28f161350680ed767f702f39dcbe63cc

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,22 +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(id, opts = {})
-      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]
-    end
-
     def authenticated_user_access
       params = {}
       resource = AUTHENTICATED_USER_ACCESS % { id: @id }

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

@@ -20,6 +20,7 @@ module TwitterAds
     property :audience_size, read_only: true
     property :audience_type, read_only: true
     property :metadata, read_only: true
+    property :owner_account_id, read_only: true
     property :partner_source, read_only: true
     property :reasons_not_targetable, read_only: true
     property :targetable, type: :bool, read_only: true
@@ -91,7 +92,7 @@ module TwitterAds
       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.
@@ -137,6 +138,60 @@ 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

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

@@ -21,8 +21,8 @@ module TwitterAds
     property :line_item_id
     property :targeting_type
     property :targeting_value
+    property :operator_type
     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 = '8'
 
   # 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