google-dfp-api 1.3.1 → 1.4.0

data/dfp_api.yml

@@ -1,51 +0,0 @@
----
-# This is an example configuration file for the Ruby DFP API client library.
-# Please fill in the required fields, and copy it over to your home directory.
-# Detailed descriptions of these properties can be found at:
-# https://developers.google.com/doubleclick-publishers/docs/soap_xml
-:authentication:
-  # Authentication method, methods currently supported:
-  # OAUTH2, OAUTH2_SERVICE_ACCOUNT
-  :method: OAUTH2_SERVICE_ACCOUNT
-
-  # Auth parameters for OAUTH2_SERVICE_ACCOUNT method. See:
-  #   https://developers.google.com/accounts/docs/OAuth2ServiceAccount
-  # You can provide path to a file with 'oauth2_keyfile' or the key itself with
-  # 'oauth2_key' option.
-  :oauth2_keyfile: INSERT_OAUTH2_KEYFILE_HERE
-  # Specify the issuer only if you are using a key directly with no key file.
-  #:oauth2_key: INSERT_OAUTH2_KEY_HERE
-  #:oauth2_issuer: INSERT_OAUTH2_ISSUER_HERE
-  # To impersonate a user set prn to an email address.
-  #:oauth2_prn: INSERT_OAUTH2_PRN_HERE
-
-  # Auth parameters for OAUTH2 method.
-  # Set the OAuth2 client id and secret. Register your application here to
-  # obtain these values:
-  #   https://console.developers.google.com/
-  #:oauth2_client_id: INSERT_OAUTH2_CLIENT_ID_HERE
-  #:oauth2_client_secret: INSERT_OAUTH2_CLIENT_SECRET_HERE
-  # Optional, see: https://developers.google.com/accounts/docs/OAuth2WebServer
-  #:oauth2_callback: INSERT_OAUTH2_CALLBACK_URL_HERE
-  #:oauth2_state: INSERT_OAUTH2_STATE_HERE
-  #:oauth2_access_type: INSERT_OAUTH2_ACCESS_TYPE_HERE
-  #:oauth2_prompt: INSERT_OAUTH2_PROMPT_HERE
-  # You can define extra scopes so that you can reuse your refresh token for
-  # other APIs.
-  #:oauth2_extra_scopes: [INSERT_EXTRA_SCOPES_HERE]
-
-  # Other parameters.
-  :application_name: INSERT_APPLICATION_NAME_HERE
-
-  # Required for all calls other than GetAllNetworks and MakeTestNetwork.
-  :network_code: INSERT_NETWORK_CODE_HERE
-:connection:
-  # Enable to request all responses to be compressed.
-  :enable_gzip: false
-  # If your proxy connection requires authentication, make sure to include it in
-  # the URL, e.g.: http://user:password@proxy_hostname:8080
-  #:proxy: INSERT_PROXY_HERE
-:library:
-  :log_level: INFO
-  # Optional: uncomment to disable user agent showing used utilities.
-  #:include_utilities_in_user_agent: false

data/lib/dfp_api.rb

@@ -1,107 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Contains the main classes for the client library.
-
-require 'ads_common/api'
-require 'ads_common/savon_headers/oauth_header_handler'
-require 'dfp_api/api_config'
-require 'dfp_api/credential_handler'
-require 'dfp_api/errors'
-require 'dfp_api/dfp_api_statement'
-require 'dfp_api/dfp_api_datetime'
-require 'dfp_api/pql_statement_utils'
-require 'dfp_api/utils_reporter'
-
-# Main namespace for all the client library's modules and classes.
-module DfpApi
-
-  # Wrapper class that serves as the main point of access for all the API usage.
-  #
-  # Holds all the services, as well as login credentials.
-  #
-  class Api < AdsCommon::Api
-    attr_reader :utils_reporter
-
-    # Constructor for API.
-    def initialize(provided_config = nil)
-      super(provided_config)
-      @credential_handler = DfpApi::CredentialHandler.new(@config)
-      @utils_reporter = DfpApi::UtilsReporter.new(@credential_handler)
-    end
-
-    # Getter for the API service configurations.
-    def api_config
-      DfpApi::ApiConfig
-    end
-
-    # Returns an instance of StatementBuilder object.
-    def new_statement_builder(&block)
-      return DfpApi::StatementBuilder.new(self, &block)
-    end
-
-    def new_report_statement_builder(&block)
-      statement = DfpApi::StatementBuilder.new(self) do |sb|
-        sb.limit = nil
-        sb.offset = nil
-      end
-      statement.configure(&block)
-      return statement
-    end
-
-    # Returns an instance of DfpDate.
-    def date(*args)
-      return DfpApi::DfpDate.new(self, *args)
-    end
-
-    # Returns an instance of DfpDate representing the current day.
-    def today(*args)
-      return DfpApi::DfpDate.today(self, *args)
-    end
-
-    # Returns an instance of DfpDateTime.
-    def datetime(*args)
-      return DfpApi::DfpDateTime.new(self, *args)
-    end
-
-    # Returns an instance of DfpDateTime representing the current time.
-    def now(*args)
-      return DfpApi::DfpDateTime.now(self, *args)
-    end
-
-    # Returns an instance of DfpDateTime in the UTC timezone.
-    def utc(*args)
-      return DfpApi::DfpDateTime.utc(self, *args)
-    end
-
-    private
-
-    # Retrieve DFP HeaderHandler per credential.
-    def soap_header_handler(auth_handler, version, header_ns, default_ns)
-      auth_method = @config.read('authentication.method', :OAUTH2)
-      handler_class  = case auth_method
-        when :OAUTH2, :OAUTH2_SERVICE_ACCOUNT
-          AdsCommon::SavonHeaders::OAuthHeaderHandler
-        else
-          raise AdsCommon::Errors::AuthError,
-              "Unknown auth method: %s" % auth_method
-      end
-      return handler_class.new(@credential_handler, auth_handler, header_ns,
-                               default_ns, version)
-    end
-  end
-end

data/lib/dfp_api/api_config.rb

@@ -1,182 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# Helper methods for loading and managing the available services in the DFP API.
-
-require 'ads_common/api_config'
-
-require 'dfp_api/version'
-
-module DfpApi
-
-  # Contains helper methods for loading and managing the available services.
-  module ApiConfig
-
-    class << ApiConfig
-      include AdsCommon::ApiConfig
-    end
-
-    # Set defaults
-    DEFAULT_VERSION = :v201805
-    LATEST_VERSION = :v201805
-
-    # Set other constants
-    API_NAME = 'DfpApi'
-    DEFAULT_CONFIG_FILENAME = 'dfp_api.yml'
-
-    # Configure the services available to each version
-    @@service_config = {
-      :v201708 => [:ActivityGroupService, :ActivityService,
-                   :AdExclusionRuleService, :AdRuleService,
-                   :AudienceSegmentService, :BaseRateService, :CompanyService,
-                   :ContactService, :ContentBundleService,
-                   :ContentMetadataKeyHierarchyService, :ContentService,
-                   :CreativeService, :CreativeSetService,
-                   :CreativeTemplateService, :CreativeWrapperService,
-                   :CustomFieldService, :CustomTargetingService,
-                   :ExchangeRateService, :ForecastService, :InventoryService,
-                   :LabelService, :LineItemCreativeAssociationService,
-                   :LineItemService, :LineItemTemplateService,
-                   :LiveStreamEventService, :MobileApplicationService,
-                   :NativeStyleService, :NetworkService, :OrderService,
-                   :PackageService, :ProductPackageService,
-                   :ProductPackageItemService, :PlacementService,
-                   :PremiumRateService, :ProductService,
-                   :ProductTemplateService, :ProposalLineItemService,
-                   :ProposalService, :PublisherQueryLanguageService,
-                   :RateCardService, :ReconciliationOrderReportService,
-                   :ReconciliationLineItemReportService,
-                   :ReconciliationReportRowService,
-                   :ReconciliationReportService, :ReportService,
-                   :SuggestedAdUnitService, :TeamService, :UserService,
-                   :UserTeamAssociationService, :WorkflowRequestService],
-      :v201711 => [:ActivityGroupService, :ActivityService,
-                   :AdExclusionRuleService, :AdRuleService,
-                   :AudienceSegmentService, :BaseRateService, :CompanyService,
-                   :CdnConfigurationService, :ContactService,
-                   :ContentBundleService, :ContentMetadataKeyHierarchyService,
-                   :ContentService, :CreativeService, :CreativeSetService,
-                   :CreativeTemplateService, :CreativeWrapperService,
-                   :CustomFieldService, :CustomTargetingService,
-                   :ExchangeRateService, :ForecastService, :InventoryService,
-                   :LabelService, :LineItemCreativeAssociationService,
-                   :LineItemService, :LineItemTemplateService,
-                   :LiveStreamEventService, :MobileApplicationService,
-                   :NativeStyleService, :NetworkService, :OrderService,
-                   :PackageService, :ProductPackageService,
-                   :ProductPackageItemService, :PlacementService,
-                   :PremiumRateService, :ProductService,
-                   :ProductTemplateService, :ProposalLineItemService,
-                   :ProposalService, :PublisherQueryLanguageService,
-                   :RateCardService, :ReconciliationOrderReportService,
-                   :ReconciliationLineItemReportService,
-                   :ReconciliationReportRowService,
-                   :ReconciliationReportService, :ReportService,
-                   :SuggestedAdUnitService, :TeamService, :UserService,
-                   :UserTeamAssociationService, :WorkflowRequestService],
-      :v201802 => [:ActivityGroupService, :ActivityService,
-                   :AdExclusionRuleService, :AdRuleService,
-                   :AudienceSegmentService, :BaseRateService, :CompanyService,
-                   :CdnConfigurationService, :ContactService,
-                   :ContentBundleService, :ContentMetadataKeyHierarchyService,
-                   :ContentService, :CreativeService, :CreativeSetService,
-                   :CreativeTemplateService, :CreativeWrapperService,
-                   :CustomFieldService, :CustomTargetingService,
-                   :ExchangeRateService, :ForecastService, :InventoryService,
-                   :LabelService, :LineItemCreativeAssociationService,
-                   :LineItemService, :LineItemTemplateService,
-                   :LiveStreamEventService, :MobileApplicationService,
-                   :NativeStyleService, :NetworkService, :OrderService,
-                   :PackageService, :ProductPackageService,
-                   :ProductPackageItemService, :PlacementService,
-                   :PremiumRateService, :ProductService,
-                   :ProductTemplateService, :ProposalLineItemService,
-                   :ProposalService, :PublisherQueryLanguageService,
-                   :RateCardService, :ReconciliationOrderReportService,
-                   :ReconciliationLineItemReportService,
-                   :ReconciliationReportRowService,
-                   :ReconciliationReportService, :ReportService,
-                   :SuggestedAdUnitService, :TeamService, :UserService,
-                   :UserTeamAssociationService, :WorkflowRequestService],
-      :v201805 => [:ActivityGroupService, :ActivityService,
-                   :AdExclusionRuleService, :AdRuleService,
-                   :AudienceSegmentService, :BaseRateService, :CompanyService,
-                   :CdnConfigurationService, :ContactService,
-                   :ContentBundleService, :ContentMetadataKeyHierarchyService,
-                   :ContentService, :CreativeService, :CreativeSetService,
-                   :CreativeTemplateService, :CreativeWrapperService,
-                   :CustomFieldService, :CustomTargetingService,
-                   :DaiAuthenticationKeyService, :ExchangeRateService,
-                   :ForecastService, :InventoryService, :LabelService,
-                   :LineItemCreativeAssociationService, :LineItemService,
-                   :LineItemTemplateService, :LiveStreamEventService,
-                   :MobileApplicationService, :NativeStyleService,
-                   :NetworkService, :OrderService, :PackageService,
-                   :ProductPackageService, :ProductPackageItemService,
-                   :PlacementService, :PremiumRateService, :ProductService,
-                   :ProductTemplateService, :ProposalLineItemService,
-                   :ProposalService, :PublisherQueryLanguageService,
-                   :RateCardService, :ReconciliationOrderReportService,
-                   :ReconciliationLineItemReportService,
-                   :ReconciliationReportRowService,
-                   :ReconciliationReportService, :ReportService,
-                   :SuggestedAdUnitService, :TeamService, :UserService,
-                   :UserTeamAssociationService, :WorkflowRequestService]
-    }
-
-    # Configure the base URL for each version and scope.
-    @@config = {
-      :oauth_scope => 'https://www.googleapis.com/auth/dfp',
-      :header_ns => 'https://www.google.com/apis/ads/publisher/',
-      :v201708 => 'https://ads.google.com/apis/ads/publisher/',
-      :v201711 => 'https://ads.google.com/apis/ads/publisher/',
-      :v201802 => 'https://ads.google.com/apis/ads/publisher/',
-      :v201805 => 'https://ads.google.com/apis/ads/publisher/'
-    }
-
-    public
-
-    # Getters for constants and module variables.
-    def self.default_version
-      DEFAULT_VERSION
-    end
-
-    def self.latest_version
-      LATEST_VERSION
-    end
-
-    def self.api_name
-      API_NAME
-    end
-
-    def self.service_config
-      @@service_config
-    end
-
-    def self.config(key)
-      @@config[key]
-    end
-
-    def self.subdir_config
-      nil
-    end
-
-    def self.default_config_filename
-      DEFAULT_CONFIG_FILENAME
-    end
-  end
-end

data/lib/dfp_api/credential_handler.rb

@@ -1,73 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# DFP-specific credential handler.
-
-require 'ads_common/credential_handler'
-require 'dfp_api/api_config'
-require 'dfp_api/utils'
-
-module DfpApi
-
-  LEGACY_DEFAULT_APPLICATION_NAME = 'dfp_ruby_examples'
-  DEFAULT_APPLICATION_NAME = 'INSERT_APPLICATION_NAME_HERE'
-
-  class CredentialHandler < AdsCommon::CredentialHandler
-    # Create the list of credentials to be used by the auth handler for header
-    # generation.
-    def credentials(credentials_override = nil)
-      result = super(credentials_override)
-      validate_headers_for_server(result)
-      include_utils = @config.read('library.include_utilities_in_user_agent',
-          true)
-      result[:extra_headers] = {
-          'applicationName' => generate_user_agent([], include_utils),
-          'networkCode' => result[:network_code]
-      }
-      return result
-    end
-
-    # Generates string to use as user agent in headers.
-    def generate_user_agent(extra_ids = [], include_utilities = true)
-      agent_app = @config.read('authentication.application_name')
-      extra_ids << ["DfpApi-Ruby/%s" % DfpApi::ApiConfig::CLIENT_LIB_VERSION]
-      utility_registry = DfpApi::Utils::UtilityRegistry.instance
-      extra_ids += utility_registry.extract!.to_a if include_utilities
-      super(extra_ids, agent_app)
-    end
-
-    # Returns the network code specified in the current credentials.
-    def identifier()
-      return credentials[:extra_headers]['networkCode']
-    end
-
-    private
-
-    # Validates that the right credentials are being used for the chosen
-    # environment.
-    def validate_headers_for_server(credentials)
-      application_name = credentials[:application_name]
-      if (application_name.nil? or application_name.empty? or
-          application_name.include?(DEFAULT_APPLICATION_NAME) or
-          application_name.include?(LEGACY_DEFAULT_APPLICATION_NAME))
-        raise AdsCommon::Errors::AuthError, (
-            'Application name must be specified and cannot be the default')
-      end
-      return nil
-    end
-  end
-end

data/lib/dfp_api/dfp_api_datetime.rb

@@ -1,182 +0,0 @@
-# Encoding: utf-8
-#
-# Copyright:: Copyright 2017, Google Inc. All Rights Reserved.
-#
-# License:: Licensed under the Apache License, Version 2.0 (the "License");
-#           you may not use this file except in compliance with the License.
-#           You may obtain a copy of the License at
-#
-#           http://www.apache.org/licenses/LICENSE-2.0
-#
-#           Unless required by applicable law or agreed to in writing, software
-#           distributed under the License is distributed on an "AS IS" BASIS,
-#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-#           implied.
-#           See the License for the specific language governing permissions and
-#           limitations under the License.
-#
-# DfpDate and DfpDateTime convert between native ruby Date and Time objects and
-# the DFP API's Date and DateTime objects.
-
-require 'date'
-require 'tzinfo'
-
-
-module DfpApi
-  class DfpDate
-    # Create a new DfpDate, a utility class that allows for interoperability
-    # between the DFP API's Date objects and ruby's Date class.
-    #
-    # Args:
-    #   - args:
-    #     - ([year, [month, [day]]]), integer values, uses Date defaults
-    #     - (date), a native ruby Date object
-    #     - (dfp_date), a DFP Date hash representation
-    # Returns:
-    #   - dfp_date: an instance of DfpDate
-    def initialize(api, *args)
-      @api = api
-      @api.utils_reporter.dfp_date_used()
-
-      case args.first
-      when Hash
-        hash = args.first
-        date_args = [hash[:year], hash[:month], hash[:day]]
-      when Date
-        date = args.first
-        date_args = [date.year, date.month, date.day]
-      else
-        date_args = args
-      end
-      @date = Date.new(*date_args)
-    end
-
-    # Creates a DfpDate object denoting the present day.
-    def self.today(api, *args)
-      self.new(api, Date.today(*args))
-    end
-
-    # When an unrecognized method is applied to DfpDate, pass it through to the
-    # internal ruby Date.
-    def method_missing(name, *args, &block)
-      result = @date.send(name, *args, &block)
-      return self.class.new(@api, result) if result.is_a? Date
-      return result
-    end
-
-    # Convert DfpDate into a hash representation which can be consumed by
-    # the DFP API. E.g., a hash that can be passed as PQL Date variables.
-    #
-    # Returns:
-    #   - dfp_datetime: a DFP Date hash representation
-    def to_h()
-      return {:year => @date.year, :month => @date.month, :day => @date.day}
-    end
-  end
-
-  class DfpDateTime
-    attr_accessor :timezone
-
-    # Create a new DfpDateTime, a utility class that allows for interoperability
-    # between the DFP API's DateTime objects and ruby's Time class. The last
-    # argument must be a valid timezone identifier, e.g. "America/New_York".
-    #
-    # Args:
-    #   - args:
-    #     - ([year, [month, [day, [hour, [minute, [second,]]]]]] timezone)
-    #     - (time, timezone), a native Time object and a timezone identifier
-    #     - (dfp_datetime), a DFP DateTime hash representation
-    #
-    # Returns:
-    #   - dfp_datetime: an instance of DfpDateTime
-    def initialize(api, *args)
-      @api = api
-      @api.utils_reporter.dfp_date_time_used()
-
-      # Handle special cases when a DFP DateTime hash or ruby Time instance are
-      # passed as the first argument to the constructor.
-      case args.first
-      when Hash
-        hash = args.first
-        datetime_args = [hash[:date][:year], hash[:date][:month],
-            hash[:date][:day], hash[:hour], hash[:minute], hash[:second],
-            hash[:time_zone_id]]
-      when DfpDateTime, Time, DateTime
-        time = args.first
-        datetime_args = [args.last]
-        [:sec, :min, :hour, :day, :month, :year].each do |duration|
-          datetime_args.unshift(time.send(duration))
-        end
-      else
-        datetime_args = args
-      end
-      # Check the validity of the timezone parameter, which is required.
-      if not TZInfo::Timezone.all_identifiers.include?(datetime_args.last)
-        raise "Last argument to DfpDateTime constructor must be valid timezone"
-      end
-      # Set timezone attribute and pass its utc offset into the Time
-      # constructor.
-      @timezone = TZInfo::Timezone.get(datetime_args.pop)
-      @time = Time.new(*datetime_args,
-          utc_offset=@timezone.current_period.utc_offset)
-    end
-
-    # Create a DfpDateTime for the current time in the specified timezone.
-    #
-    # Args:
-    #   - timezone: a valid timezone identifier, e.g. "America/New_York"
-    #
-    # Returns:
-    #   - dfp_datetime: an instance of DfpDateTime
-    def self.now(api, timezone)
-      new(api, TZInfo::Timezone.get(timezone).now, timezone)
-    end
-
-    # Create a DfpDateTime in the "UTC" timezone. Calls the DfpDateTime
-    # contstructor with timezone identifier "UTC".
-    #
-    # Args:
-    #   - ([year, [month, [day, [hour, [minute, [second]]]]]])
-    #
-    # Returns:
-    #   - dfp_datetime: an instance of DfpDateTime
-    def self.utc(api, *args)
-      new(api, *args + ['UTC'])
-    end
-
-    # Convert DfpDateTime into a hash representation which can be consumed by
-    # the DFP API. E.g., a hash that can be passed as PQL DateTime variables.
-    #
-    # Returns:
-    #   - dfp_datetime_hash: a hash representation of a DfpDateTime
-    def to_h
-      {
-        :date => DfpApi::DfpDate.new(
-            @api, @time.year, @time.month, @time.day
-        ).to_h,
-        :hour => @time.hour,
-        :minute => @time.min,
-        :second => @time.sec,
-        :time_zone_id => @timezone.identifier
-      }
-    end
-
-    # When an unrecognized method is applied to DfpDateTime, pass it through to
-    # the internal ruby Time.
-    def method_missing(name, *args, &block)
-      # Restrict time zone related functions from being passed to internal ruby
-      # Time attribute, since DfpDateTime handles timezones its own way
-      restricted_functions = [:dst?, :getgm, :getlocal, :getutc, :gmt,
-          :gmtime, :gmtoff, :isdst, :localtime, :utc]
-      if restricted_functions.include? name
-        raise NoMethodError, 'undefined method %s for %s' % [name, self]
-      end
-      result = @time.send(name, *args, &block)
-      if result.is_a? Time
-        return self.class.new(@api, result, @timezone.identifier)
-      else
-        return result
-      end
-    end
-  end
-end