twitter-ads 5.1.0 → 7.0.1

data/spec/twitter-ads/retry_count_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+require 'spec_helper'
+
+describe TwitterAds::Campaign do
+
+  before(:each) do
+    allow_any_instance_of(Object).to receive(:sleep)
+    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
+  end
+
+  let(:client) do
+    Client.new(
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      Faker::Lorem.characters(40),
+      options: {
+        retry_max: 1,
+        retry_delay: 3000,
+        retry_on_status: [404, 500, 503]
+      }
+    )
+  end
+  let(:account) { client.accounts('2iqph') }
+
+  it 'test retry count - success' do
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 404
+      },
+      {
+        body: fixture(:campaigns_all),
+        status: 200
+      }
+    )
+    cusor = described_class.all(account)
+    expect(cusor).to be_instance_of(Cursor)
+    expect(stub).to have_been_requested.times(2)
+  end
+
+  it 'test retry count - fail' do
+    stub = stub_request(:get, "#{ADS_API}/accounts/2iqph/campaigns").to_return(
+      {
+        body: fixture(:campaigns_all),
+        status: 404
+      }
+    ).times(2)
+
+    begin
+      cusor = described_class.all(account)
+    rescue NotFound => e
+      cusor = e
+    end
+    expect(cusor).to be_instance_of(NotFound)
+    expect(stub).to have_been_requested.times(2)
+  end
+
+end

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

@@ -3,11 +3,12 @@
 
 require 'spec_helper'
 
-describe TwitterAds::Creative::ImageAppDownloadCard do
+describe TwitterAds::AudienceSummary 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")
   end
 
   let(:client) do
@@ -20,24 +21,21 @@ describe TwitterAds::Creative::ImageAppDownloadCard do
   end
 
   let(:account) { client.accounts.first }
+  let(:params) {
+    {
+      targeting_criteria: [{
+        targeting_type: 'LOCATION',
+        targeting_value: '96683cc9126741d1'
+      }]
+    }
+  }
 
   # check model properties
-  subject { described_class.new(account) }
-  read  = %w(id created_at updated_at deleted)
-
-  write = %w(
-    name
-    country_code
-    iphone_app_id
-    iphone_deep_link
-    ipad_app_id
-    ipad_deep_link
-    googleplay_app_id
-    googleplay_deep_link
-    app_cta
-    wide_app_image_media_id
-  )
-
-  include_examples 'object property check', read, write
+  subject { described_class.fetch(account, params) }
+
+  it 'has all the correct properties' do
+    expect(subject[:audience_size][:min]).to eq(41133600)
+    expect(subject[:audience_size][:max]).to eq(50274400)
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter-ads
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 7.0.1
 platform: ruby
 authors:
 - John Babich
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -57,10 +57,11 @@ files:
 - bin/twitter-ads
 - lib/twitter-ads.rb
 - lib/twitter-ads/account.rb
-- lib/twitter-ads/audiences/audience_intelligence.rb
 - lib/twitter-ads/audiences/tailored_audience.rb
+- lib/twitter-ads/campaign/advertiser_business_categories.rb
 - lib/twitter-ads/campaign/app_list.rb
 - lib/twitter-ads/campaign/campaign.rb
+- lib/twitter-ads/campaign/content_categories.rb
 - lib/twitter-ads/campaign/funding_instrument.rb
 - lib/twitter-ads/campaign/iab_category.rb
 - lib/twitter-ads/campaign/line_item.rb
@@ -71,6 +72,7 @@ files:
 - lib/twitter-ads/client.rb
 - lib/twitter-ads/creative/account_media.rb
 - lib/twitter-ads/creative/cards_fetch.rb
+- lib/twitter-ads/creative/draft_tweet.rb
 - lib/twitter-ads/creative/image_app_download_card.rb
 - lib/twitter-ads/creative/image_conversation_card.rb
 - lib/twitter-ads/creative/media_creative.rb
@@ -80,6 +82,7 @@ files:
 - lib/twitter-ads/creative/promoted_tweet.rb
 - lib/twitter-ads/creative/scheduled_tweet.rb
 - lib/twitter-ads/creative/tweet_previews.rb
+- lib/twitter-ads/creative/tweets.rb
 - lib/twitter-ads/creative/video_app_download_card.rb
 - lib/twitter-ads/creative/video_conversation_card.rb
 - lib/twitter-ads/creative/video_website_card.rb
@@ -97,12 +100,12 @@ files:
 - lib/twitter-ads/resources/dsl.rb
 - lib/twitter-ads/resources/persistence.rb
 - lib/twitter-ads/resources/resource.rb
+- lib/twitter-ads/restapi.rb
 - lib/twitter-ads/settings/tax.rb
 - lib/twitter-ads/settings/user.rb
-- lib/twitter-ads/targeting/reach_estimate.rb
+- lib/twitter-ads/targeting/audience_summary.rb
 - lib/twitter-ads/targeting_criteria/app_store_category.rb
-- lib/twitter-ads/targeting_criteria/behavior.rb
-- lib/twitter-ads/targeting_criteria/behavior_taxonomy.rb
+- lib/twitter-ads/targeting_criteria/conversation.rb
 - lib/twitter-ads/targeting_criteria/device.rb
 - lib/twitter-ads/targeting_criteria/event.rb
 - lib/twitter-ads/targeting_criteria/interest.rb
@@ -120,6 +123,7 @@ files:
 - spec/fixtures/accounts_load.json
 - spec/fixtures/app_lists_all.json
 - spec/fixtures/app_lists_load.json
+- spec/fixtures/audience_summary.json
 - spec/fixtures/campaigns_all.json
 - spec/fixtures/campaigns_load.json
 - spec/fixtures/funding_instruments_all.json
@@ -135,7 +139,7 @@ files:
 - spec/fixtures/reach_estimate.json
 - spec/fixtures/tailored_audiences_all.json
 - spec/fixtures/tailored_audiences_load.json
-- spec/fixtures/tweet_preview.json
+- spec/fixtures/tweet_previews.json
 - spec/fixtures/videos_all.json
 - spec/fixtures/videos_load.json
 - spec/quality_spec.rb
@@ -146,21 +150,18 @@ files:
 - spec/twitter-ads/audiences/tailored_audience_spec.rb
 - spec/twitter-ads/campaign/app_list_spec.rb
 - spec/twitter-ads/campaign/line_item_spec.rb
-- spec/twitter-ads/campaign/reach_estimate_spec.rb
 - spec/twitter-ads/campaign/targeting_criteria_spec.rb
 - spec/twitter-ads/campaign/tweet_spec.rb
 - spec/twitter-ads/client_spec.rb
-- spec/twitter-ads/creative/account_media_spec.rb
-- spec/twitter-ads/creative/image_app_download_card_spec.rb
-- spec/twitter-ads/creative/image_conversation_card_spec.rb
 - spec/twitter-ads/creative/media_creative_spec.rb
 - spec/twitter-ads/creative/promoted_account_spec.rb
 - spec/twitter-ads/creative/promoted_tweet_spec.rb
-- spec/twitter-ads/creative/video_app_download_card_spec.rb
-- spec/twitter-ads/creative/video_conversation_card_spec.rb
-- spec/twitter-ads/creative/website_card_spec.rb
+- spec/twitter-ads/creative/tweet_previews_spec.rb
 - spec/twitter-ads/cursor_spec.rb
 - spec/twitter-ads/placements_spec.rb
+- spec/twitter-ads/rate_limit_spec.rb
+- spec/twitter-ads/retry_count_spec.rb
+- spec/twitter-ads/targeting/audience_summary_spec.rb
 - spec/twitter-ads/utils_spec.rb
 - twitter-ads.gemspec
 homepage: https://github.com/twitterdev/twitter-ruby-ads-sdk
@@ -187,50 +188,48 @@ signing_key:
 specification_version: 4
 summary: The officially supported Twitter Ads API SDK for Ruby.
 test_files:
-- spec/spec_helper.rb
-- spec/twitter-ads/audiences/tailored_audience_spec.rb
+- spec/support/helpers.rb
+- spec/quality_spec.rb
+- spec/shared/properties.rb
 - spec/twitter-ads/cursor_spec.rb
-- spec/twitter-ads/account_spec.rb
-- spec/twitter-ads/client_spec.rb
-- spec/twitter-ads/placements_spec.rb
-- spec/twitter-ads/campaign/targeting_criteria_spec.rb
-- spec/twitter-ads/campaign/app_list_spec.rb
-- spec/twitter-ads/campaign/reach_estimate_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/creative/account_media_spec.rb
-- spec/twitter-ads/creative/website_card_spec.rb
-- spec/twitter-ads/creative/video_app_download_card_spec.rb
-- spec/twitter-ads/creative/media_creative_spec.rb
+- spec/twitter-ads/campaign/app_list_spec.rb
 - spec/twitter-ads/creative/promoted_tweet_spec.rb
-- spec/twitter-ads/creative/image_conversation_card_spec.rb
-- spec/twitter-ads/creative/video_conversation_card_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/creative/image_app_download_card_spec.rb
+- spec/twitter-ads/account_spec.rb
 - spec/twitter-ads/utils_spec.rb
-- spec/shared/properties.rb
-- spec/support/helpers.rb
-- spec/fixtures/line_items_load.json
-- spec/fixtures/promotable_users_all.json
-- spec/fixtures/reach_estimate.json
-- spec/fixtures/tweet_preview.json
-- spec/fixtures/accounts_features.json
+- spec/twitter-ads/client_spec.rb
+- spec/twitter-ads/placements_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/fixtures/promoted_tweets_load.json
 - spec/fixtures/videos_all.json
+- spec/fixtures/accounts_load.json
 - spec/fixtures/line_items_all.json
-- spec/fixtures/placements.json
-- spec/fixtures/promotable_users_load.json
-- spec/fixtures/tailored_audiences_all.json
-- spec/fixtures/promoted_tweets_all.json
+- spec/fixtures/accounts_features.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/tailored_audiences_all.json
+- spec/fixtures/reach_estimate.json
 - spec/fixtures/app_lists_load.json
-- spec/fixtures/promoted_tweets_load.json
-- spec/fixtures/funding_instruments_all.json
-- spec/fixtures/campaigns_load.json
+- spec/fixtures/audience_summary.json
+- spec/fixtures/campaigns_all.json
 - spec/fixtures/app_lists_all.json
-- spec/fixtures/accounts_load.json
+- spec/fixtures/promotable_users_all.json
 - spec/fixtures/no_content.json
-- spec/fixtures/campaigns_all.json
 - spec/fixtures/accounts_all.json
-- spec/fixtures/videos_load.json
-- spec/quality_spec.rb
+- spec/fixtures/promotable_users_load.json

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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-module TwitterAds
-  class AudienceIntelligence
-
-    include TwitterAds::DSL
-    include TwitterAds::Resource::InstanceMethods
-
-    attr_reader :account
-
-    # writable
-    property :conversation_type
-    property :targeting_inputs
-    property :audience_definition
-
-    # demographics-only
-    property :start_time, type: :time
-    property :end_time, type: :time
-
-    # read
-    property :operator_type, read_only: true
-    property :targeting_type, read_only: true
-    property :targeting_value, read_only: true
-    property :localized, read_only: true
-
-    RESOURCE_CONVERSATIONS  = "/#{TwitterAds::API_VERSION}/" \
-                              'accounts/%{account_id}/audience_intelligence/' \
-                              'conversations' # @api private
-    RESOURCE_DEMOGRAPHICS   = "/#{TwitterAds::API_VERSION}/" \
-                              'accounts/%{account_id}/audience_intelligence/' \
-                              'demographics' # @api private
-
-    def initialize(account)
-      @account = account
-      self
-    end
-
-    def conversations
-      headers = { 'Content-Type' => 'application/json' }
-      params = {
-        conversation_type: conversation_type,
-        audience_definition: audience_definition,
-        targeting_inputs: targeting_inputs
-      }
-      resource = RESOURCE_CONVERSATIONS % { account_id: account.id }
-      request = Request.new(account.client, :post, resource, body: params.to_json, headers: headers)
-      Cursor.new(self.class, request, init_with: [account])
-    end
-
-    def demographics
-      headers = { 'Content-Type' => 'application/json' }
-      params = {
-        audience_definition: audience_definition,
-        targeting_inputs: targeting_inputs
-      }
-      resource = RESOURCE_DEMOGRAPHICS % { account_id: account.id }
-      response = Request.new(
-        account.client,
-        :post,
-        resource,
-        body: params.to_json,
-        headers: headers).perform
-      response.body[:data]
-      # cannot use cursor here given that the response "keys" are dynmaic based on input values
-    end
-  end
-end

data/lib/twitter-ads/targeting/reach_estimate.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2019 Twitter, Inc.
-
-module TwitterAds
-  module ReachEstimate
-
-    class << self
-
-      # Get a reach estimate for the specified line item details.
-      #
-      # @example
-      #   TwitterAds::ReachEstimate.fetch(
-      #     account,
-      #     'PROMOTED_TWEETS',
-      #     'WEBSITE_CLICKS',
-      #     5500000,
-      #     30000000,
-      #     similar_to_followers_of_user: 2153688540,
-      #     gender: 2
-      #   )
-      #
-      # @param client [Client] The Client object instance.
-      # @param product_type [String] The product type being targeted.
-      # @param objective [String] The objective being targeted.
-      # @param campaign_daily_budget_amount_local_micro [Long] Daily budget in micros.
-      # @param opts [Hash] A Hash of extended options.
-      #
-      # @option opts [Long] :bid_amount_local_micro Bid amount in local currency micros.
-      # @option opts [String] :bid_type The bidding mechanism.
-      # @option opts [String] :currency ISO-4217 Currency code for bid amount.
-      # @option opts [String] :followers_of_users Comma-separated user IDs.
-      # @option opts [String] :similar_to_followers_of_users Comma-separated user IDs.
-      # @option opts [String] :locations Comma-separated location IDs.
-      # @option opts [String] :interests Comma-seaprated interest IDs.
-      # @option opts [String] :gender Gender identifier.
-      # @option opts [String] :platforms Comma-separated platform IDs.
-      # @option opts [String] :tailored_audiences Comma-separated tailored audience IDs.
-      # @option opts [String] :tailored_audiences_expanded Comma-separated tailoerd audience IDs.
-      # @option opts [String] :languages Comma-separated language IDs.
-      # @option opts [String] :platform_versions Comma-separated platform version IDs.
-      # @option opts [String] :devices Comma-separated device IDs.
-      # @option opts [String] :behaviors Comma-separated behavior IDs.
-      # @option opts [String] :behaviors_expanded Comma-separated behaviors IDs.
-      # @option opts [String] :campaign engagement Campaign ID for Tweet Engager Retargeting.
-      # @option opts [String] :user_engagement Promoted User ID for Tweet Engager Retargeting.
-      # @option opts [String] :engagement_type engagement type for Tweet Engager Retargeting.
-      # @option opts [String] :network_operators Network operators to target
-      # @option opts [String] :app_store_categories App store categories to target.
-      # @option opts [String] :app_store_categories_expanded App store categories with lookalikes.
-      #
-      # @return [Hash] A hash containing count and infinite_bid_count.
-      #
-      # @since 1.0.0
-      # @see https://developer.twitter.com/en/docs/ads/campaign-management/api-reference/reach-estimate
-      def fetch(account, product_type, objective, campaign_daily_budget,
-                opts = {})
-        resource = "/#{TwitterAds::API_VERSION}/accounts/#{account.id}/reach_estimate"
-        params = {
-          product_type: product_type,
-          objective: objective,
-          campaign_daily_budget_amount_local_micro: campaign_daily_budget
-        }.merge!(opts)
-
-        # The response value count is "bid sensitive", we default to bid_type=AUTO here to preserve
-        # expected behavior despite an API change that occurred in December 2015.
-        unless params.keys.include?(:bid_type) || params.keys.include?(:bid_amount_local_micro)
-          params = { bid_type: 'AUTO' }.merge!(params)
-        end
-
-        response = TwitterAds::Request.new(account.client, :get,
-                                           resource, params: params).perform
-        response.body[:data]
-      end
-
-    end
-
-  end
-end

data/spec/fixtures/tweet_preview.json

@@ -1,24 +0,0 @@
-{
-  "data_type": "tweet_preview",
-  "data": [
-    {
-      "platform": "web",
-      "preview": "   <div><img><div><div><div><a>AdsAPI</a><a>@AdsAPI</a></div></div><div>Hello World!</div><div><div><img><div><div></div><div><span> Ratings/pricing not available for preview </span><span> Ratings/pricing not available for preview </span></div><div></div>  INSTALL  </div></div></div><a><img></a><div><div><span></span><span>Promoted by AdsAPI</span></div></div></div></div>"
-    },
-    {
-      "platform": "android",
-      "preview": "   <div><img><div><div><div><a>AdsAPI</a><a>@AdsAPI</a></div></div><div>Hello World!</div><div><div><img><div><div></div><div><span> Ratings/pricing not available for preview </span><span> Ratings/pricing not available for preview </span></div><div></div>  INSTALL  </div></div></div><a><img></a><div><div><span></span><span>Promoted by AdsAPI</span></div></div></div></div>"
-    },
-    {
-      "platform": "iphone",
-      "preview": "   <div><img><div><div><div><a>AdsAPI</a><a>@AdsAPI</a></div></div><div>Hello World!</div><div><div><img><div><div></div><div><span> Ratings/pricing not available for preview </span><span> Ratings/pricing not available for preview </span></div><div></div>  INSTALL  </div></div></div><a><img></a><div><div><span></span><span>Promoted by AdsAPI</span></div></div></div></div>"
-    }
-  ],
-  "request": {
-    "params": {
-      "status": "Hello World!",
-      "card_id": "pfs",
-      "account_id": "2iqph"
-    }
-  }
-}