twitter-ads 5.0.0 → 5.1.0

data/lib/twitter-ads/error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
 
@@ -21,7 +21,7 @@ module TwitterAds
     end
 
     def inspect
-      str = String.new("#<#{self.class.name}:0x#{object_id}")
+      str = +"#<#{self.class.name}:0x#{object_id}"
       str << " code=#{@code}" if @code
       str << " details=\"#{@details}\"" if @details
       str << '>'

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
 
@@ -15,8 +15,8 @@ module TwitterAds
       delete: Net::HTTP::Delete
     }.freeze
 
-    DEFAULT_DOMAIN = 'https://ads-api.twitter.com'.freeze
-    SANDBOX_DOMAIN = 'https://ads-api-sandbox.twitter.com'.freeze
+    DEFAULT_DOMAIN = 'https://ads-api.twitter.com'
+    SANDBOX_DOMAIN = 'https://ads-api-sandbox.twitter.com'
 
     private_constant :DEFAULT_DOMAIN, :SANDBOX_DOMAIN, :HTTP_METHOD
 
@@ -80,6 +80,7 @@ module TwitterAds
 
     def http_request
       request_url = @resource
+
       if @options[:params] && !@options[:params].empty?
         request_url += "?#{URI.encode_www_form(@options[:params])}"
       end
@@ -87,7 +88,7 @@ module TwitterAds
       request      = HTTP_METHOD[@method].new(request_url)
       request.body = @options[:body] if @options[:body]
 
-      @options[:headers].each { |header, value| request[header] = value } if @options[:headers]
+      @options[:headers]&.each { |header, value| request[header] = value }
       request['user-agent'] = user_agent
 
       request
@@ -108,7 +109,7 @@ module TwitterAds
       object.each { |header| @client.logger.info("Header: #{header}: #{object[header]}") }
 
       # suppresses body content for non-Ads API domains (eg. upload.twitter.com)
-      if object.body && !object.body.empty?
+      unless object.body&.empty?
         if @domain == SANDBOX_DOMAIN || @domain == DEFAULT_DOMAIN
           @client.logger.info("Body: #{object.body}")
         else

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
 

data/lib/twitter-ads/legacy.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 # legacy namespace support, to be removed in v1.0.0 (next major)
 TwitterAds::Objective = TwitterAds::Enum::Objective

data/lib/twitter-ads/measurement/app_event_tag.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class AppEventTag
@@ -19,8 +19,8 @@ module TwitterAds
     property :post_view_attribution_window
     property :post_engagement_attribution_window
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/app_event_tags'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/app_event_tags' # @api private
 
     def initialize(account)
       @account = account

data/lib/twitter-ads/measurement/web_event_tag.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class WebEventTag
@@ -18,8 +18,8 @@ module TwitterAds
     property :embed_code, read_only: true
     property :click_window
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'accounts/%{account_id}/web_event_tags'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'accounts/%{account_id}/web_event_tags' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 require 'zlib'
 require 'open-uri'
@@ -7,14 +7,24 @@ require 'open-uri'
 module TwitterAds
   module Analytics
 
+    include TwitterAds::Enum
+
     ANALYTICS_MAP = {
-      'TwitterAds::Campaign' => 'CAMPAIGN'.freeze,
-      'TwitterAds::LineItem' => 'LINE_ITEM'.freeze,
-      'TwitterAds::OrganicTweet' => 'ORGANIC_TWEET'.freeze,
-      'TwitterAds::Creative::PromotedAccount' => 'ACCOUNT'.freeze,
-      'TwitterAds::Creative::PromotedTweet' => 'PROMOTED_TWEET'.freeze
+      'TwitterAds::Campaign' => Entity::CAMPAIGN,
+      'TwitterAds::LineItem' => Entity::LINE_ITEM,
+      'TwitterAds::OrganicTweet' => Entity::ORGANIC_TWEET,
+      'TwitterAds::Creative::PromotedAccount' => Entity::ACCOUNT,
+      'TwitterAds::Creative::PromotedTweet' => Entity::PROMOTED_TWEET,
+      'TwitterAds::Creative::MediaCreative' => Entity::MEDIA_CREATIVE
     }.freeze
 
+    RESOURCE_STATS            = "/#{TwitterAds::API_VERSION}/" +
+                                'stats/accounts/%{account_id}' # @api private
+    RESOURCE_ASYNC_STATS      = "/#{TwitterAds::API_VERSION}/" +
+                                'stats/jobs/accounts/%{account_id}' # @api private
+    RESOURCE_ACTIVE_ENTITIES  = "/#{TwitterAds::API_VERSION}/" +
+                                'stats/accounts/%{account_id}/active_entities' # @api private
+
     def self.included(klass)
       klass.send :include, InstanceMethods
       klass.extend ClassMethods
@@ -70,7 +80,7 @@ module TwitterAds
       def stats(account, ids, metric_groups, opts = {})
         # set default metric values
         end_time          = opts.fetch(:end_time, (Time.now - Time.now.sec - (60 * Time.now.min)))
-        start_time        = opts.fetch(:start_time, end_time - 604_800) # 7 days ago
+        start_time        = opts.fetch(:start_time, end_time - (60 * 60 * 24 * 7)) # 7 days ago
         granularity       = opts.fetch(:granularity, :hour)
         start_utc_offset  = opts[:start_utc_offset] || opts[:utc_offset]
         end_utc_offset    = opts[:end_utc_offset] || opts[:utc_offset]
@@ -199,7 +209,27 @@ module TwitterAds
         end
       end
 
-    end
+      def active_entities(account, start_time:, end_time:, **opts)
+        entity_type = name
+        granularity       = opts.fetch(:granularity, nil)
+        start_utc_offset  = opts[:start_utc_offset] || opts[:utc_offset]
+        end_utc_offset    = opts[:end_utc_offset] || opts[:utc_offset]
+
+        if entity_type == 'OrganicTweet'
+          raise "'OrganicTweet' not support with 'active_entities'"
+        end
 
+        params = {
+          entity: ANALYTICS_MAP[entity_type],
+          start_time: TwitterAds::Utils.to_time(start_time, granularity, start_utc_offset),
+          end_time: TwitterAds::Utils.to_time(end_time, granularity, end_utc_offset)
+        }.merge!(opts)
+
+        resource = self::RESOURCE_ACTIVE_ENTITIES % { account_id: account.id }
+        response = Request.new(account.client, :get, resource, params: params).perform
+        response.body[:data]
+      end
+
+    end
   end
 end

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

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Batch
 
     CLASS_ID_MAP = {
-      'TwitterAds::LineItem'                => 'LINE_ITEM'.freeze,
-      'TwitterAds::Campaign'                => 'CAMPAIGN'.freeze,
-      'TwitterAds::TargetingCriteria'       => 'TARGETING_CRITERION'.freeze
+      'TwitterAds::LineItem'                => 'LINE_ITEM',
+      'TwitterAds::Campaign'                => 'CAMPAIGN',
+      'TwitterAds::TargetingCriteria'       => 'TARGETING_CRITERION'
     }.freeze # @api private
 
     def self.included(klass)

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   # A light-wight DSL for building out Twitter Ads API resources.

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Persistence

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module Resource
@@ -40,7 +40,7 @@ module TwitterAds
       #
       # @since 0.1.0
       def inspect
-        str = String.new("#<#{self.class.name}:0x#{object_id}")
+        str = +"#<#{self.class.name}:0x#{object_id}"
         str << " id=\"#{@id}\"" if @id
         str << ' deleted="true"' if @deleted
         str << '>'

data/lib/twitter-ads/settings/tax.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class TaxSettings
@@ -40,8 +40,8 @@ module TwitterAds
     # sdk only
     property :to_delete, type: :bool
 
-    RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-               'accounts/%{account_id}/user_settings/%{id}'.freeze # @api private
+    RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+               'accounts/%{account_id}/user_settings/%{id}' # @api private
 
     def initialize(account)
       @account = account

data/lib/twitter-ads/settings/user.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class UserSettings
@@ -19,8 +19,8 @@ module TwitterAds
     # sdk only
     property :to_delete, type: :bool
 
-    RESOURCE = "/#{TwitterAds::API_VERSION}/" +
-               'accounts/%{account_id}/user_settings/%{id}'.freeze # @api private
+    RESOURCE = "/#{TwitterAds::API_VERSION}/" \
+               'accounts/%{account_id}/user_settings/%{id}' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   module ReachEstimate

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class AppStoreCategory
@@ -12,8 +12,8 @@ module TwitterAds
     property :targeting_type, read_only: true
     property :targeting_value, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/app_store_categories'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/app_store_categories' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Behavior
@@ -16,8 +16,8 @@ module TwitterAds
     property :partner_source, read_only: true
     property :targetable_type, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/behaviors'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/behaviors' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class BehaviorTaxonomy
@@ -13,8 +13,8 @@ module TwitterAds
     property :created_at, read_only: true
     property :updated_at, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/behavior_taxonomies'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/behavior_taxonomies' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Device
@@ -14,8 +14,8 @@ module TwitterAds
     property :platform, read_only: true
     property :manufacturer, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/devices'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/devices' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Event
@@ -22,8 +22,8 @@ module TwitterAds
     property :device_breakdown_percentage, read_only: true
     property :country_breakdown_percentage, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/events'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/events' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Interest
@@ -12,8 +12,8 @@ module TwitterAds
     property :targeting_value, read_only: true
     property :localized_name, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/interests'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/interests' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Language
@@ -11,8 +11,8 @@ module TwitterAds
     property :targeting_type, read_only: true
     property :targeting_value, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/languages'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/languages' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class Location
@@ -12,8 +12,8 @@ module TwitterAds
     property :targeting_value, read_only: true
     property :location_type, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/locations'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/locations' # @api private
 
     def initialize(account)
       @account = account

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
+# Copyright (C) 2019 Twitter, Inc.
 
 module TwitterAds
   class NetworkOperator
@@ -12,8 +12,8 @@ module TwitterAds
     property :targeting_value, read_only: true
     property :country_code, read_only: true
 
-    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
-                          'targeting_criteria/network_operators'.freeze # @api private
+    RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" \
+                          'targeting_criteria/network_operators' # @api private
 
     def initialize(account)
       @account = account