twitter-ads 7.0.0 → 10.0.0

data/lib/twitter-ads/http/request.rb

@@ -107,11 +107,17 @@ module TwitterAds
       Response.new(response.code, response.each {}, response.body)
     end
 
+    def escape_params(input)
+      input.map do |key, value|
+        "#{CGI.escape key.to_s}=#{CGI.escape value.to_s}"
+      end.join('&')
+    end
+
     def http_request
       request_url = @resource
 
       if @options[:params] && !@options[:params].empty?
-        request_url += "?#{URI.encode_www_form(@options[:params])}"
+        request_url += "?#{escape_params(@options[:params])}"
       end
 
       request      = HTTP_METHOD[@method].new(request_url)

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

@@ -30,6 +30,7 @@ module TwitterAds
     property :metric_groups, read_only: true
 
     ANALYTICS_MAP = {
+      'TwitterAds::Account' => Entity::ACCOUNT,
       'TwitterAds::Campaign' => Entity::CAMPAIGN,
       'TwitterAds::LineItem' => Entity::LINE_ITEM,
       'TwitterAds::OrganicTweet' => Entity::ORGANIC_TWEET,

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/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.0'
+  VERSION = '10.0.0'
 end

data/lib/twitter-ads.rb

@@ -29,7 +29,7 @@ require 'twitter-ads/http/response'
 
 require 'twitter-ads/restapi.rb'
 
-require 'twitter-ads/audiences/tailored_audience'
+require 'twitter-ads/audiences/custom_audience'
 
 require 'twitter-ads/campaign/app_list'
 require 'twitter-ads/campaign/campaign'
@@ -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'
@@ -58,6 +59,7 @@ 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'
@@ -74,7 +76,7 @@ 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

data/spec/fixtures/custom_audiences_all.json

@@ -0,0 +1,67 @@
+{
+  "request": {
+    "params": {
+      "account_id": "2iqph"
+    }
+  },
+  "data": [
+    {
+      "targetable": false,
+      "name": "TA #2",
+      "targetable_types": [
+        "WEB",
+        "EXCLUDED_WEB"
+      ],
+      "audience_type": "WEB",
+      "id": "abc2",
+      "reasons_not_targetable": [
+        "TOO_SMALL"
+      ],
+      "list_type": null,
+      "created_at": "2014-03-09T20:35:41Z",
+      "updated_at": "2014-06-11T09:38:06Z",
+      "partner_source": "OTHER",
+      "deleted": false,
+      "audience_size": null
+    },
+    {
+      "targetable": true,
+      "name": "TA #1",
+      "targetable_types": [
+        "CRM",
+        "EXCLUDED_CRM"
+      ],
+      "audience_type": "CRM",
+      "id": "abc1",
+      "reasons_not_targetable": [],
+      "list_type": "DEVICE_ID",
+      "created_at": "2014-05-22T17:37:12Z",
+      "updated_at": "2014-05-22T21:05:33Z",
+      "partner_source": "OTHER",
+      "deleted": false,
+      "audience_size": null
+    },
+    {
+      "targetable": false,
+      "name": "TA #3",
+      "targetable_types": [
+        "CRM",
+        "EXCLUDED_CRM"
+      ],
+      "audience_type": "CRM",
+      "id": "abc3",
+      "reasons_not_targetable": [
+        "TOO_SMALL"
+      ],
+      "list_type": "EMAIL",
+      "created_at": "2014-05-22T21:43:45Z",
+      "updated_at": "2014-05-23T02:27:31Z",
+      "partner_source": "OTHER",
+      "deleted": false,
+      "audience_size": null
+    }
+  ],
+  "data_type": "tailored_audiences",
+  "total_count": 3,
+  "next_cursor": null
+}

data/spec/fixtures/line_items_all.json

@@ -13,7 +13,6 @@
         "ALL_ON_TWITTER"
       ],
       "bid_amount_local_micro": 2000000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -40,7 +39,6 @@
         "ALL_ON_TWITTER"
       ],
       "bid_amount_local_micro": 2000000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -67,7 +65,6 @@
         "TWITTER_SEARCH"
       ],
       "bid_amount_local_micro": 100000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -94,7 +91,6 @@
         "TWITTER_SEARCH"
       ],
       "bid_amount_local_micro": 500000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -121,7 +117,6 @@
         "TWITTER_TIMELINE"
       ],
       "bid_amount_local_micro": 50000000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -149,7 +144,6 @@
         "TWITTER_TIMELINE"
       ],
       "bid_amount_local_micro": 50000000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -177,7 +171,6 @@
         "TWITTER_SEARCH"
       ],
       "bid_amount_local_micro": 50000000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -204,7 +197,6 @@
         "TWITTER_TIMELINE"
       ],
       "bid_amount_local_micro": 500000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -231,7 +223,6 @@
         "TWITTER_SEARCH"
       ],
       "bid_amount_local_micro": 50000000,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",
@@ -258,7 +249,6 @@
         "TWITTER_TIMELINE"
       ],
       "bid_amount_local_micro": 2009999,
-      "automatically_select_bid": false,
       "advertiser_domain": null,
       "primary_web_event_tag": null,
       "charge_by": "ENGAGEMENT",

data/spec/fixtures/line_items_load.json

@@ -8,7 +8,6 @@
       "ALL_ON_TWITTER"
     ],
     "bid_amount_local_micro": 2000000,
-    "automatically_select_bid": false,
     "advertiser_domain": null,
     "primary_web_event_tag": null,
     "charge_by": "ENGAGEMENT",

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/fixtures/tracking_tags_load.json

@@ -0,0 +1,17 @@
+{
+  "request": {
+    "params": {
+      "tracking_tag_id": "7035",
+      "account_id": "18ce54uhdu0"
+    }
+  },
+  "data": {
+    "line_item_id": "dmbc0",
+    "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
+    "tracking_tag_type": "IMPRESSION_TAG",
+    "id": "7035",
+    "created_at": "2021-11-16T00:12:26Z",
+    "updated_at": "2021-11-16T00:12:26Z",
+    "deleted": false
+  }
+}

data/spec/twitter-ads/account_spec.rb

@@ -240,22 +240,22 @@ describe TwitterAds::Account do
 
   end
 
-  describe '#tailored_audiences' do
+  describe '#custom_audiences' do
 
     before(:each) do
-      resource_collection = "#{ADS_API}/accounts/#{account.id}/tailored_audiences"
-      stub_fixture(:get, :tailored_audiences_all, resource_collection)
+      resource_collection = "#{ADS_API}/accounts/#{account.id}/custom_audiences"
+      stub_fixture(:get, :custom_audiences_all, resource_collection)
 
-      resource = "#{ADS_API}/accounts/#{account.id}/tailored_audiences/abc2"
-      stub_fixture(:get, :tailored_audiences_load, /#{resource}\?.*/)
+      resource = "#{ADS_API}/accounts/#{account.id}/custom_audiences/abc2"
+      stub_fixture(:get, :custom_audiences_load, /#{resource}\?.*/)
     end
 
     context 'with an id specified' do
 
-      it 'successfully loads the specified tailored audience' do
-        result = account.tailored_audiences('abc2')
+      it 'successfully loads the specified custom audience' do
+        result = account.custom_audiences('abc2')
         expect(result).not_to be_nil
-        expect(result.class).to eq(TwitterAds::TailoredAudience)
+        expect(result.class).to eq(TwitterAds::CustomAudience)
         expect(result.id).to eq('abc2')
       end
 
@@ -263,11 +263,11 @@ describe TwitterAds::Account do
 
     context 'without an id specified' do
 
-      it 'succesfully returns a cursor with all tailored audiences' do
-        result = account.tailored_audiences
+      it 'succesfully returns a cursor with all custom audiences' do
+        result = account.custom_audiences
         expect(result.to_a.size).to eq(3)
         expect(result.class).to eq(TwitterAds::Cursor)
-        expect(result.first.class).to eq(TwitterAds::TailoredAudience)
+        expect(result.first.class).to eq(TwitterAds::CustomAudience)
         expect(result.first.id).to eq('abc2')
       end
 

data/spec/twitter-ads/audiences/{tailored_audience_spec.rb → custom_audience_spec.rb}

@@ -3,7 +3,7 @@
 
 require 'spec_helper'
 
-describe TwitterAds::TailoredAudience do
+describe TwitterAds::CustomAudience do
 
   before(:each) do
     stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
@@ -31,11 +31,12 @@ describe TwitterAds::TailoredAudience do
     deleted
     audience_size
     audience_type
-    metadata
     partner_source
     reasons_not_targetable
     targetable
     targetable_types
+    permission_level
+    owner_account_id
   )
 
   write = %w(name list_type)

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

@@ -30,17 +30,20 @@ describe TwitterAds::LineItem do
     name
     campaign_id
     advertiser_domain
+    android_app_store_identifier
+    audience_expansion
     categories
-    charge_by
+    pay_by
     objective
     entity_status
     primary_web_event_tag
     product_type
     placements
-    bid_unit
-    automatically_select_bid
+    bid_strategy
     bid_amount_local_micro
     total_budget_amount_local_micro
+    goal
+    ios_app_store_identifier
   )
   include_examples 'object property check', read, write
 

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/campaign/tracking_tag_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::TrackingTag do
+
+  before(:each) do
+    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
+    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+  end
+
+  let(:client) do
+    Client.new(
+      Faker::Lorem.characters(15),
+      Faker::Lorem.characters(40),
+      "123456-#{Faker::Lorem.characters(40)}",
+      Faker::Lorem.characters(40)
+    )
+  end
+
+  let(:account) { client.accounts.first }
+
+  # check model properties
+  subject { described_class.new(account) }
+  read  = %w(id)
+  write = %w(line_item_id tracking_tag_type tracking_tag_url)
+  include_examples 'object property check', read, write
+
+  describe '#create' do
+
+    let(:tracking_tag) { TwitterAds::TrackingTag.new(account) }
+    let!(:resource) { "#{ADS_API}/accounts/#{account.id}/tracking_tags" }
+    let!(:rel_path) { "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/tracking_tags" }
+
+    before(:each) do
+      stub_fixture(:post, :tracking_tags_load, /#{resource}\?.*/)
+    end
+
+    it 'creates post request with line item ID and url' do
+      line_item_id = 'axe123'
+      tracking_tag_url = 'https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309'
+      tracking_tag_type = 'IMPRESSION_TAG'
+
+      params = {
+        line_item_id: line_item_id,
+        tracking_tag_url: tracking_tag_url,
+        tracking_tag_type: tracking_tag_type
+      }
+      args = [account.client, :post, rel_path, params: params]
+
+      expect(Request).to receive(:new).with(*args).and_call_original
+      tracking_tag.create(line_item_id, tracking_tag_url)
+    end
+
+  end
+
+end

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

data/spec/twitter-ads/targeting/{audience_summary_spec.rb → audience_estimate_spec.rb}

@@ -3,12 +3,12 @@
 
 require 'spec_helper'
 
-describe TwitterAds::AudienceSummary do
+describe TwitterAds::AudienceEstimate do
 
   before(:each) do
     stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
     stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-    stub_fixture(:post, :audience_summary, "#{ADS_API}/accounts/2iqph/audience_summary")
+    stub_fixture(:post, :audience_estimate, "#{ADS_API}/accounts/2iqph/audience_estimate")
   end
 
   let(:client) do