twitter-ads 7.0.1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42045b5ca461ee6f6a13ed129264351506089d23622ad2429a1a154e0b2b03f
-  data.tar.gz: 431d8797b1d1aa606c10672780708112053710b0e745e46e13bd602097c48ca9
+  metadata.gz: ffe2cf6607163db38e5a09d5cc26e6bd38e700ac5a9a63be8bfaac8837f15725
+  data.tar.gz: 58becc51cdae11dbb55f40f7bc5aaccb024efb250e6f34d3020cc310cfeb3cdb
 SHA512:
-  metadata.gz: fb703d3ef21d673d313c7223474e5dabbdb0d64233b88550a1135773118273a71272a38b791c927139773de1b62e639f06075fd9a25a94668e9a7cefd9bd0f82
-  data.tar.gz: bcef25e9c1a7a4d3ac331bbf901dbaefbe00121a7f0ca6e66c484f0b93585d5d8e85d7d8e46d3bfe771cc5daa584735626300a3b56743e529e4de5031aff3a36
+  metadata.gz: 49bec3d898f35d4b0b9e8a95244910230f0c580f6eaf1b111ce71661ea247df2ec5f698600b8a86537889bfe4f4cf2be7a34745f9ffef04be99ad6a9c789f67f
+  data.tar.gz: 34c513a59fd03118f3c9273401867c1d5e1a8d81dfcb0a9a9891549350639d68d86dd1670e6822aaa3aab171d474c70b28f161350680ed767f702f39dcbe63cc

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/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
 

data/lib/twitter-ads/client.rb

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

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

@@ -48,7 +48,7 @@ module TwitterAds
 
         # convert to `tweet_ids` param
         params = to_params
-        params[:tweet_ids] = *params.delete(:tweet_id) if params.key?(:tweet_id)
+        params[:tweet_ids] = params.delete(:tweet_id) if params.key?(:tweet_id)
 
         if @id
           raise TwitterAds::NotFound.new(nil, 'Method PUT not allowed.', 404)

data/lib/twitter-ads/enum.rb

@@ -9,13 +9,12 @@ module TwitterAds
     module Objective
       APP_ENGAGEMENTS     = 'APP_ENGAGEMENTS'
       APP_INSTALLS        = 'APP_INSTALLS'
+      ENGAGEMENTS         = 'ENGAGEMENTS'
       FOLLOWERS           = 'FOLLOWERS'
-      LEAD_GENERATION     = 'LEAD_GENERATION'
-      TWEET_ENGAGEMENTS   = 'TWEET_ENGAGEMENTS'
+      PREROLL_VIEWS       = 'PREROLL_VIEWS'
+      REACH               = 'REACH'
       VIDEO_VIEWS         = 'VIDEO_VIEWS'
       WEBSITE_CLICKS      = 'WEBSITE_CLICKS'
-      WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'
-
     end
 
     module Product

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

@@ -21,6 +21,7 @@ module TwitterAds
     property :gender_breakdown_percentage, read_only: true
     property :device_breakdown_percentage, read_only: true
     property :country_breakdown_percentage, read_only: true
+    property :targeting_value, read_only: true
 
     RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
                           'targeting_criteria/events' # @api private

data/lib/twitter-ads/version.rb

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

data/spec/fixtures/tailored_audiences_all.json

@@ -14,6 +14,7 @@
       ],
       "audience_type": "WEB",
       "id": "abc2",
+      "owner_account_id": "18ce54uhdu0",
       "reasons_not_targetable": [
         "TOO_SMALL"
       ],
@@ -33,6 +34,7 @@
       ],
       "audience_type": "CRM",
       "id": "abc1",
+      "owner_account_id": "18ce54uhdu0",
       "reasons_not_targetable": [],
       "list_type": "DEVICE_ID",
       "created_at": "2014-05-22T17:37:12Z",
@@ -50,6 +52,7 @@
       ],
       "audience_type": "CRM",
       "id": "abc3",
+      "owner_account_id": "18ce54uhdu0",
       "reasons_not_targetable": [
         "TOO_SMALL"
       ],

data/spec/fixtures/targeted_audiences.json

@@ -0,0 +1,33 @@
+{
+    "request": {
+      "params": {
+        "account_id": "2iqph",
+        "tailored_audience_id": "abc2"
+      }
+    },
+    "next_cursor": null,
+    "data": [
+      {
+        "campaign_id": "59hod",
+        "campaign_name": "test-campaign",
+        "line_items": [
+          {
+            "id": "5gzog",
+            "name": "test-line-item",
+            "servable": true
+          }
+        ]
+      },
+      {
+        "campaign_id": "arja7",
+        "campaign_name": "Untitled campaign",
+        "line_items": [
+          {
+            "id": "bjw1q",
+            "name": null,
+            "servable": true
+          }
+        ]
+      }
+    ]
+}  

data/spec/twitter-ads/audiences/tailored_audience_spec.rb

@@ -7,7 +7,12 @@ describe TwitterAds::TailoredAudience do
 
   before(:each) do
     stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+    stub_fixture(:get,
+                 :tailored_audiences_load,
+                 "#{ADS_API}/accounts/2iqph/tailored_audiences/abc2?with_deleted=true")
+    stub_fixture(:get,
+                 :targeted_audiences,
+                 "#{ADS_API}/accounts/2iqph/tailored_audiences/abc2/targeted")
   end
 
   let(:client) do
@@ -20,7 +25,7 @@ describe TwitterAds::TailoredAudience do
   end
 
   let(:account) { client.accounts.first }
-
+  let(:tailored_audience) { described_class.load(account, 'abc2') }
   # check model properties
   subject { described_class.new(account) }
 
@@ -29,6 +34,7 @@ describe TwitterAds::TailoredAudience do
     created_at
     updated_at
     deleted
+    owner_account_id
     audience_size
     audience_type
     metadata
@@ -42,4 +48,21 @@ describe TwitterAds::TailoredAudience do
 
   include_examples 'object property check', read, write
 
+  describe '#targeted' do
+
+    let(:cursor) { tailored_audience.targeted }
+
+    it 'has all the correct properties' do
+      result = cursor.first
+      expect(result).to eq(cursor.instance_variable_get('@collection').first)
+      expect(result).to be_instance_of(TwitterAds::TargetedTailoredAudience)
+      expect(cursor).to be_instance_of(Cursor)
+    end
+
+    it 'raises error when TailoredAudience is not loaded' do
+      result = TwitterAds::TailoredAudience.new(account)
+      expect(result).to receive(:validate_loaded).and_call_original
+      expect { result.targeted }.to raise_error(ArgumentError)
+    end
+  end
 end

data/spec/twitter-ads/campaign/targeting_criteria_spec.rb

@@ -30,6 +30,7 @@ describe TwitterAds::TargetingCriteria do
     line_item_id
     targeting_type
     targeting_value
+    operator_type
     tailored_audience_expansion
   )
 

data/spec/twitter-ads/creative/promoted_tweet_spec.rb

@@ -41,6 +41,24 @@ describe TwitterAds::Creative::PromotedTweet do
       expect { subject.save }.to raise_error(TwitterAds::ClientError)
     end
 
+    it 'sets params[:tweet_ids] from params[:tweet_id]' do
+      request = double('request')
+      response = double('response')
+      allow(response).to receive(:body).and_return({ data: [{}] })
+      allow(request).to receive(:perform).and_return(response)
+      expected_params = { params: { line_item_id: '12345', tweet_ids: 99999999999999999999 } }
+
+      expect(Request).to receive(:new).with(
+        client,
+        :post,
+        "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/promoted_tweets",
+        expected_params
+      ).and_return(request)
+
+      subject.line_item_id = '12345'
+      subject.tweet_id = 99999999999999999999
+      subject.save
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter-ads
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 8.0.0
 platform: ruby
 authors:
 - John Babich
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -139,6 +139,7 @@ files:
 - spec/fixtures/reach_estimate.json
 - spec/fixtures/tailored_audiences_all.json
 - spec/fixtures/tailored_audiences_load.json
+- spec/fixtures/targeted_audiences.json
 - spec/fixtures/tweet_previews.json
 - spec/fixtures/videos_all.json
 - spec/fixtures/videos_load.json
@@ -183,53 +184,54 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.6.0
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The officially supported Twitter Ads API SDK for Ruby.
 test_files:
-- spec/support/helpers.rb
 - spec/quality_spec.rb
+- spec/support/helpers.rb
 - spec/shared/properties.rb
-- spec/twitter-ads/cursor_spec.rb
-- spec/twitter-ads/rate_limit_spec.rb
 - spec/twitter-ads/audiences/tailored_audience_spec.rb
-- spec/twitter-ads/targeting/audience_summary_spec.rb
-- spec/twitter-ads/campaign/line_item_spec.rb
-- spec/twitter-ads/campaign/targeting_criteria_spec.rb
-- spec/twitter-ads/campaign/tweet_spec.rb
-- spec/twitter-ads/campaign/app_list_spec.rb
-- spec/twitter-ads/creative/promoted_tweet_spec.rb
+- spec/twitter-ads/creative/promoted_account_spec.rb
 - spec/twitter-ads/creative/tweet_previews_spec.rb
 - spec/twitter-ads/creative/media_creative_spec.rb
-- spec/twitter-ads/creative/promoted_account_spec.rb
-- spec/twitter-ads/account_spec.rb
-- spec/twitter-ads/utils_spec.rb
-- spec/twitter-ads/client_spec.rb
+- spec/twitter-ads/creative/promoted_tweet_spec.rb
+- spec/twitter-ads/rate_limit_spec.rb
+- spec/twitter-ads/cursor_spec.rb
 - spec/twitter-ads/placements_spec.rb
+- spec/twitter-ads/client_spec.rb
+- spec/twitter-ads/account_spec.rb
+- spec/twitter-ads/targeting/audience_summary_spec.rb
 - spec/twitter-ads/retry_count_spec.rb
-- spec/spec_helper.rb
-- spec/fixtures/promoted_tweets_all.json
-- spec/fixtures/campaigns_load.json
+- spec/twitter-ads/utils_spec.rb
+- spec/twitter-ads/campaign/app_list_spec.rb
+- spec/twitter-ads/campaign/targeting_criteria_spec.rb
+- spec/twitter-ads/campaign/tweet_spec.rb
+- spec/twitter-ads/campaign/line_item_spec.rb
+- spec/fixtures/promotable_users_load.json
 - spec/fixtures/promoted_tweets_load.json
-- spec/fixtures/videos_all.json
-- spec/fixtures/accounts_load.json
-- spec/fixtures/line_items_all.json
 - spec/fixtures/accounts_features.json
+- spec/fixtures/campaigns_all.json
 - spec/fixtures/line_items_load.json
-- spec/fixtures/funding_instruments_load.json
-- spec/fixtures/videos_load.json
-- spec/fixtures/funding_instruments_all.json
 - spec/fixtures/tweet_previews.json
-- spec/fixtures/tailored_audiences_load.json
-- spec/fixtures/placements.json
+- spec/fixtures/targeted_audiences.json
+- spec/fixtures/videos_all.json
 - spec/fixtures/tailored_audiences_all.json
-- spec/fixtures/reach_estimate.json
-- spec/fixtures/app_lists_load.json
-- spec/fixtures/audience_summary.json
-- spec/fixtures/campaigns_all.json
+- spec/fixtures/funding_instruments_load.json
+- spec/fixtures/accounts_load.json
+- spec/fixtures/line_items_all.json
 - spec/fixtures/app_lists_all.json
+- spec/fixtures/placements.json
+- spec/fixtures/app_lists_load.json
+- spec/fixtures/campaigns_load.json
+- spec/fixtures/accounts_all.json
 - spec/fixtures/promotable_users_all.json
+- spec/fixtures/tailored_audiences_load.json
+- spec/fixtures/promoted_tweets_all.json
+- spec/fixtures/videos_load.json
+- spec/fixtures/funding_instruments_all.json
+- spec/fixtures/reach_estimate.json
 - spec/fixtures/no_content.json
-- spec/fixtures/accounts_all.json
-- spec/fixtures/promotable_users_load.json
+- spec/fixtures/audience_summary.json
+- spec/spec_helper.rb