twitter-ads 9.0.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ab4c35b2b3ff9a24fb3475717b923563c484d80b2ac7e981c18570ddbaebdbc
-  data.tar.gz: e5f228604a745b96a063c59d80248bd976f27a4cc43243cd34a0f45a55548cb0
+  metadata.gz: 67928f3af10643b8b98513d2411b0f560103f8a6491d816fa25e99ffdd8362d9
+  data.tar.gz: '044490baf9cfab6e87b46a6d03a4b6b15bf44b3b5aa2e307bd9cd9137fdb72a9'
 SHA512:
-  metadata.gz: d17c433739bebd2d74a7c62c20e58819f5f4ea29e241b3dd53ec4baeba4e55213761a27f40833d497b356638a8057770ab7a16f73578df96732555f511ddd43c
-  data.tar.gz: 2aff371a6a36636f82adce64fa00766bcd6e5257a6c288ea58f06740df3bb879008bc1e2afe8b286c8b0b1e431ce5bf413a011562cae9e5594f65133f5d63752
+  metadata.gz: 395df768253f0f424c7d13c12004711aaae69c3b55f2c8a4f992b778b4fb7656dc41b2a79df9e00c3c31ec38851cc9a7059129c4b88b4717b86a8ba08bc7f5cd
+  data.tar.gz: 27d317c21e27631d3b09187c20c52934055f585a45e2e91af073abdfdf0c62c77d7ac9fe9b598a9583aad581dea944dd66eb265fddf7902c11dd701c539cc080

data/README.md

@@ -52,7 +52,7 @@ This project is designed to work with Ruby 2.4.0 or greater. While it may work o
 
 Platform | Versions
 -------- | --------
-MRI | 2.4.x, 2.5.x, 2.6.x
+MRI | 2.4.x, 2.5.x, 2.6.x, 2.7, 3.0
 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).
@@ -89,7 +89,7 @@ Like the [Response](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/mast
 
 The MIT License (MIT)
 
-Copyright (C) 2019 Twitter, Inc.
+Copyright (C) 2021 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/lib/twitter-ads/account.rb

@@ -10,7 +10,6 @@ module TwitterAds
 
     property :id, read_only: true
     property :name, read_only: true
-    property :salt, read_only: true
     property :timezone, read_only: true
     property :timezone_switch_at, type: :time, read_only: true
     property :created_at, type: :time, read_only: true
@@ -218,6 +217,23 @@ module TwitterAds
       load_resource(LineItem, id, opts)
     end
 
+    # Returns a collection of tracking tags available to the
+    # current account.
+    #
+    # @param id [String] The LineItem 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.
+    # @option opts [String] :line_item_ids The object param to sort the API response by.
+    # @option opts [String] :tracking_tag_ids The object param to sort the API response by.
+    #
+    # @return A Cursor or object instance.
+    #
+    # @since 10.0.0
+    def tracking_tags(id = nil, opts = {})
+      load_resource(TrackingTag, id, opts)
+    end
+
     # Returns a collection of app lists available to the current account.
     #
     # @param id [String] The AppList ID value.

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

@@ -20,13 +20,13 @@ module TwitterAds
 
     property :name
     property :funding_instrument_id
-    property :end_time, type: :time
-    property :start_time, type: :time
     property :entity_status
+    property :effective_status
     property :currency
     property :standard_delivery
     property :daily_budget_amount_local_micro
     property :total_budget_amount_local_micro
+    property :budget_optimization
 
     # sdk only
     property :to_delete, type: :bool

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

@@ -19,7 +19,6 @@ module TwitterAds
     property :advertiser_domain
     property :android_app_store_identifier
     property :audience_expansion
-    property :automatically_select_bid
     property :bid_amount_local_micro
     property :bid_strategy
     property :campaign_id
@@ -35,11 +34,9 @@ module TwitterAds
     property :primary_web_event_tag
     property :product_type
     property :start_time, type: :time
+    property :standard_delivery, type: :bool
     property :total_budget_amount_local_micro
-
-    # beta (not yet generally available)
     property :advertiser_user_id
-    property :tracking_tags
 
     # sdk only
     property :to_delete, type: :bool
@@ -94,5 +91,8 @@ module TwitterAds
       id ? TargetingCriteria.load(account, id, opts) : TargetingCriteria.all(account, @id, opts)
     end
 
+    def tracking_tags(id = nil, opts = {})
+      id ? TrackingTag.load(account, id, opts) : TrackingTag.all(account, @id, opts)
+    end
   end
 end

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  class TrackingTag
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+    include TwitterAds::Persistence
+
+    attr_reader :account
+
+    property :id, 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 :line_item_id
+    property :tracking_tag_type
+    property :tracking_tag_url
+
+    # sdk only
+    property :to_delete, type: :bool
+
+    RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/tracking_tags' # @api private
+    RESOURCE             = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/tracking_tags/%{id}' # @api private
+
+    def initialize(account)
+      @account = account
+      self
+    end
+
+    # Creates a new Tracking Tag
+    #
+    # @param line_item_id [String] The line item id to create tags for.
+    # @param tracking_tag_url [String] tracking tag URL.
+    #
+    # @return [self] Returns the instance refreshed from the API
+    def create(line_item_id, tracking_tag_url)
+      resource = self.class::RESOURCE_COLLECTION % { account_id: account.id }
+      params = to_params.merge!(
+        line_item_id: line_item_id,
+        tracking_tag_url: tracking_tag_url,
+        tracking_tag_type: 'IMPRESSION_TAG'
+      )
+      response = Request.new(account.client, :post, resource, params: params).perform
+      from_response(response.body[:data])
+    end
+
+    class << self
+
+      # Returns a Cursor instance for a given resource.
+      #
+      # @param account [Account] The Account object instance.
+      # @param line_item_ids [String] A String or String array of Line Item IDs.
+      # @param opts [Hash] An optional 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.
+      #
+      # @return [Cursor] A Cusor object ready to iterate through the API response.
+      #
+      # @since 0.3.1
+      # @see Cursor
+      # @see https://dev.twitter.com/ads/basics/sorting Sorting
+      def all(account, line_item_ids, opts = {})
+        if !line_item_ids.empty?
+          params = { line_item_ids: Array(line_item_ids).join(',') }.merge!(opts)
+        end
+        resource = RESOURCE_COLLECTION % { account_id: account.id }
+        request = Request.new(account.client, :get, resource, params: params)
+        Cursor.new(self, request, init_with: [account])
+      end
+
+      # Returns an object instance for a given resource.
+      #
+      # @param account [Account] The Account object instance.
+      # @param id [String] The ID of the specific object to be loaded.
+      # @param opts [Hash] An optional 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.
+      #
+      # @return [self] The object instance for the specified resource.
+      #
+      # @since 0.3.1
+      def load(account, id, opts = {})
+        params   = { with_deleted: true }.merge!(opts)
+        resource = RESOURCE % { account_id: account.id, id: id }
+        response = Request.new(account.client, :get, resource, params: params).perform
+        new(account).from_response(response.body[:data])
+      end
+
+    end
+
+  end
+end

data/lib/twitter-ads/client.rb

@@ -3,7 +3,7 @@
 
 module TwitterAds
 
-  API_VERSION = '9'
+  API_VERSION = '11'
 
   # The Ads API Client class which functions as a
   # container for basic API consumer information.

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

@@ -12,36 +12,46 @@ module TwitterAds
 
       attr_reader :account
 
+      property :id, read_only: true
+      property :card_type, read_only: true
       property :card_uri, read_only: true
       property :created_at, type: :time, read_only: true
       property :deleted, type: :bool, read_only: true
       property :updated_at, type: :time, read_only: true
       # these are writable, but not in the sense that they can be set on an object and then saved
-      property :name, read_only: true
-      property :components, read_only: true
+      property :name
+      property :components
 
       RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-                 'accounts/%{account_id}/cards' # @api private
+                 'accounts/%{account_id}/cards/%{id}' # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/cards' # @api private
 
-      def load(*)
-        raise ArgumentError.new(
-          "'Cards' object has no attribute 'load'")
-      end
-
-      def reload(*)
-        raise ArgumentError.new(
-          "'Cards' object has no attribute 'reload'")
-      end
-
-      def create(account, name, components)
-        resource = RESOURCE % { account_id: account.id }
-        params = { 'name': name, 'components': components }
+      def save
         headers = { 'Content-Type' => 'application/json' }
-        response = Request.new(account.client,
-                               :post,
-                               resource,
-                               headers: headers,
-                               body: params.to_json).perform
+        params = { 'name': name, 'components': components }
+        if @id
+          resource = RESOURCE % {
+            account_id: account.id,
+            id: id
+          }
+          request = Request.new(account.client,
+                                :put,
+                                resource,
+                                headers: headers,
+                                body: params.to_json)
+        else
+          resource = RESOURCE_COLLECTION % {
+            account_id: account.id
+          }
+          request = Request.new(account.client,
+                                :post,
+                                resource,
+                                headers: headers,
+                                body: params.to_json)
+        end
+
+        response = request.perform
         from_response(response.body[:data])
       end
 
@@ -49,7 +59,6 @@ module TwitterAds
         @account = account
         self
       end
-
     end
 
   end

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

@@ -35,10 +35,8 @@ module TwitterAds
       property :image, read_only: true
       property :image_display_height, read_only: true
       property :image_display_width, read_only: true
-      property :ipad_app_id, read_only: true
-      property :ipad_deep_link, read_only: true
-      property :iphone_app_id, read_only: true
-      property :iphone_deep_link, read_only: true
+      property :ios_app_store_identifier, read_only: true
+      property :ios_deep_link, read_only: true
       property :name, read_only: true
       property :recipient_user_id, read_only: true
       property :second_choice, read_only: true

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

@@ -14,7 +14,6 @@ module TwitterAds
 
       # read-only
       property :id, read_only: true
-      property :id_str, read_only: true
       property :created_at, type: :time, read_only: true
       property :updated_at, type: :time, read_only: true
       property :user_id, read_only: true

data/lib/twitter-ads/cursor.rb

@@ -56,13 +56,13 @@ module TwitterAds
     # @return [Cursor] The current Cursor instance.
     #
     # @since 0.1.0
-    def each(offset = 0)
+    def each(offset = 0, &block)
       return to_enum(:each, offset) unless block_given?
       @collection[offset..-1].each { |element| yield(element) }
       unless exhausted?
         offset = [@collection.size, offset].max
         fetch_next
-        each(offset, &Proc.new)
+        each(offset, &block)
       end
       self
     end

data/lib/twitter-ads/enum.rb

@@ -84,6 +84,7 @@ module TwitterAds
 
     module PayBy
       APP_CLICK = 'APP_CLICK'
+      IMPRESSION = 'IMPRESSION'
     end
 
     module MetricGroup
@@ -233,5 +234,9 @@ module TwitterAds
       NULLCAST = 'NULLCAST'
       ORGANIC = 'ORGANIC'
     end
+
+    module BudgetOptimization
+      CAMPAIGN = 'CAMPAIGN'
+    end
   end
 end

data/lib/twitter-ads/resources/analytics.rb

@@ -14,7 +14,6 @@ module TwitterAds
     attr_reader :account
 
     property :id, read_only: true
-    property :id_str, read_only: true
     property :status, read_only: true
     property :url, read_only: true
     property :created_at, type: :time, read_only: true
@@ -211,7 +210,7 @@ module TwitterAds
         tries = 0
         begin
           tries += 1
-          raw_file = open(data_url)
+          raw_file = URI.open(data_url)
           unzipped_file = Zlib::GzipReader.new(raw_file)
           response_data = unzipped_file.read
           response = JSON.parse(response_data)

data/lib/twitter-ads/targeting/{audience_summary.rb → audience_estimate.rb}

@@ -2,13 +2,13 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  module AudienceSummary
+  module AudienceEstimate
 
     include TwitterAds::DSL
     include TwitterAds::Resource
 
     RESOURCE = "/#{TwitterAds::API_VERSION}/" \
-                           'accounts/%{account_id}/audience_summary'
+                           'accounts/%{account_id}/audience_estimate'
 
     property :audience_size, read_only: true
 
@@ -17,7 +17,7 @@ module TwitterAds
       # Get an audience summary for the specified targeting criteria.
       #
       # @example
-      #   TwitterAds::AudienceSummary.fetch(
+      #   TwitterAds::AudienceEstimate.fetch(
       #     account,
       #     params: {targeting_criteria:[{targeting_type:'LOCATION',
       #             targeting_value:'96683cc9126741d1'}]}

data/lib/twitter-ads/version.rb

@@ -2,5 +2,5 @@
 # Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
-  VERSION = '9.0.0'
+  VERSION = '11.0.0'
 end

data/lib/twitter-ads.rb

@@ -37,6 +37,7 @@ require 'twitter-ads/campaign/funding_instrument'
 require 'twitter-ads/campaign/line_item'
 require 'twitter-ads/campaign/promotable_user'
 require 'twitter-ads/campaign/targeting_criteria'
+require 'twitter-ads/campaign/tracking_tags'
 require 'twitter-ads/campaign/tweet'
 require 'twitter-ads/campaign/organic_tweet'
 require 'twitter-ads/campaign/iab_category'
@@ -59,7 +60,6 @@ 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'
 require 'twitter-ads/creative/media_library'
@@ -67,15 +67,12 @@ 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/audience_summary'
+require 'twitter-ads/targeting/audience_estimate'
 
 require 'twitter-ads/measurement/web_event_tag'
 require 'twitter-ads/measurement/app_event_tag'

data/spec/fixtures/accounts_all.json

@@ -9,7 +9,6 @@
       "timezone_switch_at": "2014-11-17T08:00:00Z",
       "id": "2iqph",
       "created_at": "2015-03-04T10:50:42Z",
-      "salt": "5ab2pizq7qxjjqrx3z67f4wbko61o7xs",
       "updated_at": "2015-04-11T05:20:08Z",
       "approval_status": "ACCEPTED",
       "deleted": false
@@ -20,7 +19,6 @@
       "timezone_switch_at": "2014-11-17T08:00:00Z",
       "id": "pz6ec",
       "created_at": "2015-05-29T00:52:16Z",
-      "salt": "39ku32xvhdt0jax8thps2c70e2fv3yok",
       "updated_at": "2015-05-29T00:52:16Z",
       "approval_status": "ACCEPTED",
       "deleted": false
@@ -31,7 +29,6 @@
       "timezone_switch_at": "2014-11-17T08:00:00Z",
       "id": "j9ozo",
       "created_at": "2015-05-01T12:08:10Z",
-      "salt": "winwfne3y6oyikl4tm84bj9r50waxj37",
       "updated_at": "2015-05-01T12:08:10Z",
       "approval_status": "ACCEPTED",
       "deleted": false
@@ -42,7 +39,6 @@
       "timezone_switch_at": "2014-11-17T08:00:00Z",
       "id": "9ttgd",
       "created_at": "2015-06-24T18:51:20Z",
-      "salt": "tj9hmt5xylm5zztrq05w7hwh4mkpkg5r",
       "updated_at": "2015-06-26T06:13:24Z",
       "approval_status": "ACCEPTED",
       "deleted": false
@@ -53,7 +49,6 @@
       "timezone_switch_at": "2013-05-22T07:00:00Z",
       "id": "47d0v",
       "created_at": "2015-05-28T05:42:03Z",
-      "salt": "1ms1mq1nww7zl7169865gwqt89s9127m",
       "updated_at": "2015-05-28T05:42:03Z",
       "approval_status": "ACCEPTED",
       "deleted": false

data/spec/fixtures/accounts_load.json

@@ -6,7 +6,6 @@
     "timezone_switch_at": "2014-11-17T08:00:00Z",
     "id": "2iqph",
     "created_at": "2015-03-04T10:50:42Z",
-    "salt": "5ab2pizq7qxjjqrx3z67f4wbko61o7xs",
     "updated_at": "2015-04-11T05:20:08Z",
     "approval_status": "ACCEPTED",
     "deleted": false