twitter-ads 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4483287f7e16d023a370c9352880877081d823a0
-  data.tar.gz: 3a37f0d133d886db3e41766b52f3364123e210d4
+SHA256:
+  metadata.gz: 66b5f0101e9a3bb56a76274588cc25949cd5427a6993cf545934472013c019c1
+  data.tar.gz: 74f5b1183e980d2793ba90af482b70fdfdd8c6b47dfbd80a99c0208c77f42289
 SHA512:
-  metadata.gz: 898ecdf5405dbb342ddf5b40d77904d854cdf9f0e284144142bcdcb594dbd4c01d7a0ed324c9f71bfcc3d6a6b55b73121076a2815314037d3f0a9c0464da57d0
-  data.tar.gz: 4a22e9b421c345b52e476a6d528454a3b790b46b462fa0017a389efbe36e45ec81cc30004cb8336af34158216d6d5f1a76b73fc76e10455ffef3773aad9c72fd
+  metadata.gz: 627d24d41572df3ecbd8078ab336da7008d3e9ffed57a3af1ac03d41c7c44014eee2d9da920b50505e2b24c866a80049825574cff377532c5146a5515857214b
+  data.tar.gz: 03e79e1ce3c97d62a7bc9aae41b94bfd0709fc7899e4c248f403e652e6d7bd51c060d32466f392162ed5bd62853c61ff2e1ca4c39a2debe19cecef0fc80e218b

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (C) 2015 Twitter, Inc.
+Copyright (C) 2019 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

data/README.md

@@ -48,12 +48,11 @@ For more help please see our [Examples and Guides](https://github.com/twitterdev
 
 ## Compatibility & Versioning
 
-This project is designed to work with Ruby 2.0.0 or greater. While it may work on other version of Ruby, below are the platform and runtime versions we officially support and regularly test against.
+This project is designed to work with Ruby 2.4.0 or greater. While it may work on other version of Ruby, below are the platform and runtime versions we officially support and regularly test against.
 
 Platform | Versions
 -------- | --------
-MRI | 2.0.0, 2.1.x, 2.2.x, 2.3.x
-JRuby | 1.7.x, 9.0.0.0 (JDK7, JDK8, OpenJDK)
+MRI | 2.4.x, 2.5.x, 2.6.x
 Rubinius | 2.4.x, 2.5.x
 
 All releases adhere to strict [semantic versioning](http://semver.org). For Example, major.minor.patch-pre (aka. stick.carrot.oops-peek).
@@ -90,7 +89,7 @@ Like the [Response](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/mast
 
 The MIT License (MIT)
 
-Copyright (C) 2015 Twitter, Inc.
+Copyright (C) 2019 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

data/Rakefile

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 require 'rubygems'
 
@@ -46,7 +46,6 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 unless ENV['CI']
-
   # Release and Deployment
   desc 'Builds the latest SDK docs locally'
   task :docs do

data/lib/twitter-ads.rb

@@ -1,7 +1,7 @@
-# rubocop:disable Style/FileName
+# rubocop:disable Naming/FileName
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
-# rubocop:enable Style/FileName
+# Copyright (C) 2019 Twitter, Inc.
+# rubocop:enable Naming/FileName
 
 require 'time'
 require 'oauth'
@@ -12,20 +12,20 @@ require 'logger'
 require 'twitter-ads/version'
 require 'twitter-ads/utils'
 require 'twitter-ads/error'
-
+require 'twitter-ads/enum'
 require 'twitter-ads/resources/dsl'
-require 'twitter-ads/resources/resource'
-require 'twitter-ads/resources/persistence'
-require 'twitter-ads/resources/analytics'
-require 'twitter-ads/resources/batch'
 
 require 'twitter-ads/client'
 require 'twitter-ads/cursor'
 require 'twitter-ads/account'
 
+require 'twitter-ads/resources/resource'
+require 'twitter-ads/resources/persistence'
+require 'twitter-ads/resources/analytics'
+require 'twitter-ads/resources/batch'
+
 require 'twitter-ads/http/request'
 require 'twitter-ads/http/response'
-require 'twitter-ads/http/ton_upload'
 
 require 'twitter-ads/audiences/audience_intelligence'
 require 'twitter-ads/audiences/tailored_audience'
@@ -40,8 +40,6 @@ require 'twitter-ads/campaign/tweet'
 require 'twitter-ads/campaign/organic_tweet'
 require 'twitter-ads/campaign/iab_category'
 
-require 'twitter-ads/enum'
-
 require 'twitter-ads/targeting_criteria/tv_market'
 require 'twitter-ads/targeting_criteria/tv_show'
 require 'twitter-ads/targeting_criteria/event'
@@ -70,6 +68,7 @@ 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/targeting/reach_estimate'
 

data/lib/twitter-ads/account.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Account
@@ -17,16 +17,16 @@ module TwitterAds
     property :updated_at, type: :time, read_only: true
     property :deleted, type: :bool, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts'.freeze # @api private
-    RESOURCE            = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{id}'.freeze # @api private
-    FEATURES            = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{id}/features'.freeze # @api private
-    SCOPED_TIMELINE     = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{id}/scoped_timeline'.freeze # @api private
-    AUTHENTICATED_USER_ACCESS = "/#{TwitterAds::API_VERSION}/" +
-                                'accounts/%{id}/authenticated_user_access'.freeze # @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     = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{id}/scoped_timeline' # @api private
+    AUTHENTICATED_USER_ACCESS = "/#{TwitterAds::API_VERSION}/" \
+                                'accounts/%{id}/authenticated_user_access' # @api private
 
     def initialize(client)
       @client = client
@@ -77,7 +77,7 @@ module TwitterAds
     #
     # @return [String] The object instance detail.
     def inspect
-      str = String.new("#<#{self.class.name}:0x#{object_id}")
+      str = +"#<#{self.class.name}:0x#{object_id}"
       str << " id=\"#{@id}\"" if @id
       str << '>'
     end

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class AudienceIntelligence
@@ -26,10 +26,10 @@ module TwitterAds
 
     RESOURCE_CONVERSATIONS  = "/#{TwitterAds::API_VERSION}/" \
                               'accounts/%{account_id}/audience_intelligence/' \
-                              'conversations'.freeze # @api private
+                              'conversations' # @api private
     RESOURCE_DEMOGRAPHICS   = "/#{TwitterAds::API_VERSION}/" \
                               'accounts/%{account_id}/audience_intelligence/' \
-                              'demographics'.freeze # @api private
+                              'demographics' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class TailoredAudience
@@ -25,20 +25,13 @@ module TwitterAds
     property :targetable, type: :bool, read_only: true
     property :targetable_types, read_only: true
 
-    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/tailored_audiences'.freeze # @api private
-    RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/tailored_audiences/%{id}'.freeze # @api private
-    RESOURCE_UPDATE      = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/tailored_audience_changes'.freeze # @api private
-    RESOURCE_MEMBERSHIPS = "/#{TwitterAds::API_VERSION}/" +
-                           'tailored_audience_memberships'.freeze # @api private
-    RESOURCE_USERS       = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/tailored_audiences/' +
-                           '%{id}/users'.freeze # @api private
-    # @api private
-    GLOBAL_OPT_OUT = "/#{TwitterAds::API_VERSION}/" +
-                     'accounts/%{account_id}/tailored_audiences/global_opt_out'.freeze
+    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
+                           '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
 
     LIST_TYPES = %w(
       EMAIL
@@ -64,35 +57,7 @@ module TwitterAds
       # Creates a new tailored audience.
       #
       # @example
-      #   audience = TailoredAudience.create(account, '/path/to/file', 'my list', 'EMAIL')
-      #
-      # @param account [Account] The account object instance.
-      # @param file_path [String] The path to the file to be uploaded.
-      # @param name [String] The tailored audience name.
-      # @param list_type [String] The tailored audience list type.
-      #
-      # @since 0.3.0
-      #
-      # @return [TailoredAudience] The newly created tailored audience instance.
-      def create(account, file_path, name, list_type)
-        upload = TwitterAds::TONUpload.new(account.client, file_path)
-
-        audience = new(account)
-        audience.send(:create_audience, name, list_type)
-
-        begin
-          audience.send(:update_audience, audience, upload.perform, list_type, 'ADD')
-          audience.reload!
-        rescue TwitterAds::ClientError => e
-          audience.delete!
-          raise e
-        end
-      end
-
-      # Creates a new tailored audience.
-      #
-      # @example
-      #   audience = TailoredAudience.create_instance(account, 'my list')
+      #   audience = TailoredAudience.create(account, 'my list')
       #
       # @param account [Account] The account object instance.
       # @param name [String] The tailored audience name.
@@ -100,7 +65,7 @@ module TwitterAds
       # @since 4.0
       #
       # @return [TailoredAudience] The newly created tailored audience instance.
-      def create_instance(account, name)
+      def create(account, name)
         audience = new(account)
         params = { name: name }
         resource = RESOURCE_COLLECTION % { account_id: account.id }
@@ -108,45 +73,6 @@ module TwitterAds
         audience.from_response(response.body[:data])
       end
 
-      # Updates the global opt-out list for the specified advertiser account.
-      #
-      # @example
-      #   TailoredAudience.opt_out(account, '/path/to/file', 'EMAIL')
-      #
-      # @param account [Account] The account object instance.
-      # @param file_path [String] The path to the file to be uploaded.
-      # @param list_type [String] The tailored audience list type.
-      #
-      # @since 0.3.0
-      #
-      # @return [Boolean] The result of the opt-out update.
-      def opt_out(account, file_path, list_type)
-        upload   = TwitterAds::TONUpload.new(account.client, file_path)
-        params   = { input_file_path: upload.perform, list_type: list_type }
-        resource = GLOBAL_OPT_OUT % { account_id: account.id }
-        Request.new(account.client, :put, resource, params: params).perform
-        true
-      end
-
-    end
-
-    # Updates the current tailored audience instance.
-    #
-    # @example
-    #   audience = account.tailored_audiences('xyz')
-    #   audience.update('/path/to/file', 'EMAIL', 'REPLACE')
-    #
-    # @param file_path [String] The path to the file to be uploaded.
-    # @param list_type [String] The tailored audience list type.
-    # @param operation [String] The update operation type (Default: 'ADD').
-    #
-    # @since 0.3.0
-    #
-    # @return [TailoredAudience] [description]
-    def update(file_path, list_type, operation = 'ADD')
-      upload = TwitterAds::TONUpload.new(account.client, file_path)
-      update_audience(self, upload.perform, list_type, operation)
-      reload!
     end
 
     # Deletes the current tailored audience instance.
@@ -165,57 +91,6 @@ module TwitterAds
       from_response(response.body[:data])
     end
 
-    # Returns the status of all changes for the current tailored audience instance.
-    #
-    # @example
-    #   audience.status
-    #
-    # @since 0.3.0
-    #
-    # @return [Hash] Returns a hash object representing the tailored audience status.
-    def status
-      return nil unless id
-      resource = RESOURCE_UPDATE % { account_id: account.id }
-      request = Request.new(account.client, :get, resource, params: to_params)
-      Cursor.new(nil, request).to_a.select { |change| change[:tailored_audience_id] == id }
-    end
-
-    # This is a private API and requires whitelisting from Twitter.
-    #
-    # This real-time API will enable partners to upload batched tailored audience information
-    # to Twitter for processing in real-time
-    #
-    # @example
-    #   TailoredAudience.memberships(
-    #     account,
-    #     [
-    #       {
-    #         "operation_type" => "Update",
-    #         "params" => {
-    #           "user_identifier" => "IUGKJHG-UGJHVHJ",
-    #           "user_identifier_type" => "TAWEB_PARTNER_USER_ID",
-    #           "audience_names" => "Recent Site Visitors, Recent Sign-ups",
-    #           "advertiser_account_id" => "43853bhii879"
-    #         }
-    #       },
-    #     ]
-    #   )
-    #
-    # @return success_count, total_count
-    def self.memberships(account, params)
-      resource = RESOURCE_MEMBERSHIPS
-      headers = { 'Content-Type' => 'application/json' }
-      response = TwitterAds::Request.new(account.client,
-                                         :post,
-                                         resource,
-                                         headers: headers,
-                                         body: params.to_json).perform
-      success_count = response.body[:data][0][:success_count]
-      total_count = response.body[:request][0][:total_count]
-
-      [success_count, total_count]
-    end
-
     # This is a private API and requires whitelisting from Twitter.
     #
     # This endpoint will allow partners to add, update and remove users from a given
@@ -243,6 +118,8 @@ module TwitterAds
     #     ]
     #   )
     #
+    # @param params [JSON object] A hash containing the list of users to be added/removed/updated
+    #
     # @since 4.0
     #
     # @return success_count, total_count
@@ -260,26 +137,5 @@ module TwitterAds
       [success_count, total_count]
     end
 
-    private
-
-    def create_audience(name, list_type)
-      params = { name: name, list_type: list_type }
-      resource = RESOURCE_COLLECTION % { account_id: account.id }
-      response = Request.new(account.client, :post, resource, params: params).perform
-      from_response(response.body[:data])
-    end
-
-    def update_audience(audience, location, list_type, operation)
-      params = {
-        tailored_audience_id: audience.id,
-        input_file_path: location,
-        list_type: list_type,
-        operation: operation
-      }
-
-      resource = RESOURCE_UPDATE % { account_id: audience.account.id }
-      Request.new(audience.account.client, :post, resource, params: params).perform
-    end
-
   end
 end

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

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

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Campaign
@@ -32,16 +32,12 @@ module TwitterAds
     # sdk only
     property :to_delete, type: :bool
 
-    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/campaigns'.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}/campaigns'.freeze # @api private
-    RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
-                           'accounts/%{account_id}/campaigns/%{id}'.freeze # @api private
+    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/campaigns' # @api private
+    RESOURCE_BATCH       = "/#{TwitterAds::API_VERSION}/" \
+                           'batch/accounts/%{account_id}/campaigns' # @api private
+    RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/campaigns/%{id}' # @api private
 
     def initialize(account)
       @account = account