twitter-ads 6.0.1 → 9.0.0

data/lib/twitter-ads/client.rb

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

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  module Creative
+
+    class Cards
+
+      include TwitterAds::DSL
+      include TwitterAds::Resource
+      include TwitterAds::Persistence
+
+      attr_reader :account
+
+      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
+
+      RESOURCE = "/#{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 }
+        headers = { 'Content-Type' => 'application/json' }
+        response = Request.new(account.client,
+                               :post,
+                               resource,
+                               headers: headers,
+                               body: params.to_json).perform
+        from_response(response.body[:data])
+      end
+
+      def initialize(account)
+        @account = account
+        self
+      end
+
+    end
+
+  end
+end

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

@@ -16,7 +16,7 @@ module TwitterAds
       property :created_at, type: :time, read_only: true
       property :deleted, type: :bool, read_only: true
       property :id, read_only: true
-      property :serving_status, read_only: true
+      property :entity_status, read_only: true
       property :updated_at, type: :time, read_only: true
 
       property :account_media_id

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
@@ -24,10 +23,15 @@ module TwitterAds
     end
 
     module Placement
-      ALL_ON_TWITTER    = 'ALL_ON_TWITTER'
-      TWITTER_SEARCH    = 'TWITTER_SEARCH'
-      TWITTER_TIMELINE  = 'TWITTER_TIMELINE'
-      PUBLISHER_NETWORK = 'PUBLISHER_NETWORK'
+      ALL_ON_TWITTER     = 'ALL_ON_TWITTER'
+      TWITTER_SEARCH     = 'TWITTER_SEARCH'
+      TWITTER_TIMELINE   = 'TWITTER_TIMELINE'
+      PUBLISHER_NETWORK  = 'PUBLISHER_NETWORK'
+      TAP_FULL           = 'TAP_FULL'
+      TAP_FULL_LANDSCAPE = 'TAP_FULL_LANDSCAPE'
+      TAP_BANNER         = 'TAP_BANNER'
+      TAP_NATIVE         = 'TAP_NATIVE'
+      TAP_MRECT          = 'TAP_MRECT'
     end
 
     module Placement
@@ -55,32 +59,31 @@ module TwitterAds
       end
     end
 
-    module BidUnit
-      APP_CLICK   = 'APP_CLICK'
-      APP_INSTALL = 'APP_INSTALL'
-      ENGAGEMENT  = 'ENGAGEMENT'
-      FOLLOW      = 'FOLLOW'
-      LEAD        = 'LEAD'
-      LINK_CLICK  = 'LINK_CLICK'
-      VIEW        = 'VIEW'
+    module Goal
+      APP_CLICKS = 'APP_CLICKS'
+      APP_INSTALLS = 'APP_INSTALLS'
+      ENGAGEMENT = 'ENGAGEMENT'
+      FOLLOWERS = 'FOLLOWERS'
+      LINK_CLICKS = 'LINK_CLICKS'
+      MAX_REACH = 'MAX_REACH'
+      PREROLL = 'PREROLL'
+      PREROLL_STARTS = 'PREROLL_STARTS'
+      REACH_WITH_ENGAGEMENT = 'REACH_WITH_ENGAGEMENT'
+      VIDEO_VIEW = 'VIDEO_VIEW'
       VIEW_3S_100PCT = 'VIEW_3S_100PCT'
+      VIEW_6S = 'VIEW_6S'
+      VIEW_15S = 'VIEW_15S'
+      WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'
     end
 
-    module BidType
+    module BidStrategy
       MAX    = 'MAX'
       AUTO   = 'AUTO'
       TARGET = 'TARGET'
     end
 
-    module ChargeBy
-      APP_CLICK   = 'APP_CLICK'
-      APP_INSTALL = 'APP_INSTALL'
-      ENGAGEMENT  = 'ENGAGEMENT'
-      FOLLOW      = 'FOLLOW'
-      LEAD        = 'LEAD'
-      LINK_CLICK  = 'LINK_CLICK'
-      VIEW        = 'VIEW'
-      VIEW_3S_100PCT = 'VIEW_3S_100PCT'
+    module PayBy
+      APP_CLICK = 'APP_CLICK'
     end
 
     module MetricGroup
@@ -143,14 +146,6 @@ module TwitterAds
       VIDEO = 'VIDEO'
     end
 
-    module Optimizations
-      APP_CLICKS          = 'APP_CLICKS'
-      APP_INSTALLS        = 'APP_INSTALLS'
-      DEFAULT             = 'DEFAULT'
-      ENGAGEMENTS         = 'ENGAGEMENTS'
-      WEBSITE_CONVERSIONS = 'WEBSITE_CONVERSIONS'
-    end
-
     module Granularity
       HOUR  = 'HOUR'
       DAY   = 'DAY'

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# Copyright (C) 2019 Twitter, Inc.
+
+module TwitterAds
+  module AudienceSummary
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+
+    RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+                           'accounts/%{account_id}/audience_summary'
+
+    property :audience_size, read_only: true
+
+    class << self
+
+      # Get an audience summary for the specified targeting criteria.
+      #
+      # @example
+      #   TwitterAds::AudienceSummary.fetch(
+      #     account,
+      #     params: {targeting_criteria:[{targeting_type:'LOCATION',
+      #             targeting_value:'96683cc9126741d1'}]}
+      #   )
+      #
+      # @param params [Hash] A hash of input targeting criteria values
+      #
+      # @return [Hash] A hash containing the min and max audience size.
+      #
+      # @since 7.0.0
+      # @see https://developer.twitter.com/en/docs/ads/campaign-management/api-reference/audience-summary
+      def fetch(account, params)
+        resource = RESOURCE % { account_id: account.id }
+        headers = { 'Content-Type' => 'application/json' }
+
+        response = TwitterAds::Request.new(account.client,
+                                           :post,
+                                           resource,
+                                           headers: headers,
+                                           body: params.to_json).perform
+        response.body[:data]
+      end
+
+    end
+
+  end
+end

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 = '6.0.1'
+  VERSION = '9.0.0'
 end

data/spec/fixtures/audience_summary.json

@@ -0,0 +1,14 @@
+{
+  "request": {
+    "params": {
+      "targeting_criteria": null,
+      "account_id": "2iqph"
+    }
+  },
+  "data": {
+    "audience_size": {
+      "min": 41133600,
+      "max": 50274400
+    }
+  }
+} 

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

@@ -29,7 +29,6 @@
       "currency": "USD",
       "created_at": "2011-07-11T20:36:11Z",
       "updated_at": "2011-09-04T19:39:51Z",
-      "include_sentiment": null,
       "campaign_id": "2wap7",
       "deleted": false
     },
@@ -57,7 +56,6 @@
       "currency": "USD",
       "created_at": "2011-07-13T20:56:39Z",
       "updated_at": "2011-09-04T19:39:04Z",
-      "include_sentiment": null,
       "campaign_id": "2wamv",
       "deleted": false
     },
@@ -85,7 +83,6 @@
       "currency": "USD",
       "created_at": "2011-07-14T00:04:47Z",
       "updated_at": "2011-09-04T19:39:39Z",
-      "include_sentiment": null,
       "campaign_id": "2wai9",
       "deleted": false
     },
@@ -113,7 +110,6 @@
       "currency": "USD",
       "created_at": "2011-08-22T22:42:18Z",
       "updated_at": "2011-09-04T19:40:02Z",
-      "include_sentiment": null,
       "campaign_id": "2of1n",
       "deleted": false
     },
@@ -141,7 +137,7 @@
       "currency": "JPY",
       "created_at": "2011-08-26T20:51:14Z",
       "updated_at": "2011-08-26T21:30:25Z",
-      "include_sentiment": "POSITIVE_ONLY",
+    
       "campaign_id": "2w9n1",
       "deleted": true
     },
@@ -169,7 +165,7 @@
       "currency": "USD",
       "created_at": "2011-08-26T21:38:51Z",
       "updated_at": "2011-08-26T22:24:37Z",
-      "include_sentiment": "POSITIVE_ONLY",
+    
       "campaign_id": "2vuug",
       "deleted": true
     },
@@ -197,7 +193,6 @@
       "currency": "JPY",
       "created_at": "2011-08-26T22:28:55Z",
       "updated_at": "2011-09-04T19:38:46Z",
-      "include_sentiment": null,
       "campaign_id": "2vuj3",
       "deleted": false
     },
@@ -225,7 +220,6 @@
       "currency": "USD",
       "created_at": "2011-09-01T17:25:04Z",
       "updated_at": "2011-09-16T02:56:55Z",
-      "include_sentiment": null,
       "campaign_id": "2v3c4",
       "deleted": true
     },
@@ -253,7 +247,6 @@
       "currency": "JPY",
       "created_at": "2011-09-06T17:42:52Z",
       "updated_at": "2011-09-30T18:54:18Z",
-      "include_sentiment": null,
       "campaign_id": "2ttv3",
       "deleted": false
     },
@@ -281,7 +274,6 @@
       "currency": "USD",
       "created_at": "2011-09-06T22:44:13Z",
       "updated_at": "2011-09-20T01:32:27Z",
-      "include_sentiment": null,
       "campaign_id": "2ttv3",
       "deleted": true
     }