bing_ads_api_v9 0.0.6

data/lib/ads_common_for_bing_ads/savon_headers/base_header_handler.rb

@@ -0,0 +1,13 @@
+module AdsCommonForBingAds
+  module SavonHeaders
+
+    class BaseHeaderHandler
+
+      # Generates SOAP headers with the default request header element.
+      def generate_headers(request, soap)
+        soap.header.merge!(generate_request_header())
+      end
+
+    end
+  end
+end

data/lib/ads_common_for_bing_ads/savon_headers/client_login_header_handler.rb

@@ -0,0 +1,24 @@
+# Handles SOAP headers and namespaces definition for ClientLogin type header.
+
+module AdsCommonForBingAds
+  module SavonHeaders
+
+    class ClientLoginHeaderHandler < BaseHeaderHandler
+
+      private
+
+      # Generates Bing Ads API specific request header with ClientLogin data.
+      def generate_request_header()
+        request_header = super()
+        #puts "--------------- generate_request_header >> request_header >>\n#{request_header}"
+        credentials = @credential_handler.credentials
+        #puts "--------------- generate_request_header >> credentials >>\n#{credentials}"
+        #request_header['authToken'] = @auth_handler.get_token(credentials)
+        credentials.each {|k,v| request_header[prepend_namespace(k.to_s.camelize)] = v}
+        request_header.select!{|k,_| ['ApplicationToken', 'CustomerAccountId', 'CustomerId', 'DeveloperToken', 'UserName', 'Password'].map{|h| prepend_namespace(h)}.include?(k.to_s)}
+        #puts "--------------- generate_request_header >> request_header final >>\n#{request_header}"
+        return request_header
+      end
+    end
+  end
+end

data/lib/ads_common_for_bing_ads/savon_headers/oauth_header_handler.rb

@@ -0,0 +1,31 @@
+module AdsCommonForBingAds
+  module SavonHeaders
+
+    class OAuthHeaderHandler
+
+      private
+
+      # Generates SOAP request header with login credentials and namespace
+      # definition for OAuth authentication.
+      #
+      # Args:
+      #  - request: a HTTPI Request to generate headers for
+      #  - soap: a Savon soap object to fill fields in
+      #
+      # Returns:
+      #  - Hash containing a header with filled in credentials
+      #
+      def generate_headers(request, soap)
+        #super(request, soap)
+        credentials = @credential_handler.credentials
+
+        request.url = soap.endpoint
+
+        soap.header['wsdl:AuthenticationToken'] =  @auth_handler.auth_string(credentials)
+        soap.header['wsdl:DeveloperToken'] =  credentials[:developer_token]
+        soap.header['wsdl:CustomerAccountId'] =  credentials[:customer_account_id]
+
+      end
+    end
+  end
+end

data/lib/ads_common_for_bing_ads/savon_headers_base_header_handler.rb

@@ -0,0 +1,9 @@
+
+class AdsCommonForBingAds::SavonHeaders::BaseHeaderHandler
+
+  # Generates SOAP headers with the default request header element.
+  def generate_headers(request, soap)
+    soap.header.merge!(generate_request_header())
+  end
+
+end

data/lib/ads_common_for_bing_ads/savon_service.rb

@@ -0,0 +1,143 @@
+####### Overriden for Bing Ads #########
+
+class AdsCommonForBingAds::SavonService < AdsCommon::SavonService
+
+  private
+
+  # [CHANGES: 
+  # => ParametersValidator to AdsCommonForBingAds::ParametersValidator
+  # => ResultsExtractor    to AdsCommon::ResultsExtractor]
+  # Executes SOAP action specified as a string with given arguments.
+    def execute_action(action_name, args, &block)
+      registry = get_service_registry()
+      validator = AdsCommonForBingAds::ParametersValidator.new(registry)
+      args = validator.validate_args(action_name, args)
+      response = execute_soap_request(
+          action_name.to_sym, args, validator.extra_namespaces)
+      log_headers(response.http.headers)
+      handle_errors(response)
+      extractor = AdsCommon::ResultsExtractor.new(registry)
+      result = extractor.extract_result(response, action_name, &block)
+      run_user_block(extractor, response, result, &block) if block_given?
+      return result
+    end
+
+  # Adds namespace to the given string.
+  #
+  # Args:
+  #  - str: String to prepend with a namespace
+  #
+  # Returns:
+  #  - String with a namespace
+  #
+  def prepend_namespace(str, namespace = AdsCommonForBingAds::SavonHeaders::BaseHeaderHandler::DEFAULT_NAMESPACE)
+    return "%s:%s" % [namespace, str]
+  end
+
+  # Executes the SOAP request with original SOAP name.
+  def execute_soap_request(action, args, extra_namespaces)
+    ns = AdsCommonForBingAds::SavonHeaders::BaseHeaderHandler::DEFAULT_NAMESPACE
+    original_input_name = get_service_registry.get_method_signature(action)[:input][:name].to_s.camelize
+    original_action_name = get_service_registry.get_method_signature(action)[:original_name].to_s.camelize
+    original_action_name = action if original_action_name.nil?
+    args = args.first if args.is_a?(Array)
+    additional_headers = args.delete(:headers) unless args.nil?
+    prepend_namespace_to_hash(args, ns)
+    prepend_namespace_to_hash(additional_headers, ns)
+    puts "**************************************args = #{args}"
+    response = @client.request(ns, original_input_name) do |soap, wsdl, http|
+      http.headers["SOAPAction"] = %{"#{original_action_name}"}
+      soap.body = args
+      header_handler.prepare_request(http, soap)
+      soap.namespaces.merge!(extra_namespaces) unless extra_namespaces.nil?
+    end
+    return response
+  end
+  
+
+  def prepend_namespace_to_hash h, namespace
+    if h.is_a?(Hash)
+      h.dup.each do |k,v|
+        h.delete(k)
+        if k.to_s=~/!$/ || k.to_s=~/:/ #on ne transforme pas les noms finissant par ! ou contenant : (exemple: attributes! ou xsi:type)
+          h[k] = prepend_namespace_to_hash(v, namespace)
+        else
+          h[k.to_s=~ /^#{namespace}:/ ? k : prepend_namespace(k.to_s.camelize, namespace)] = prepend_namespace_to_hash(v, namespace)
+        end
+      end
+    elsif h.is_a?(Array) # e.g: h = {:campaigns => {:campaign => [{:name => 'foo'}, {:name => 'foofoo'}]}}
+      h.map!{|e| prepend_namespace_to_hash(e, namespace)}
+    end
+    return h
+  end
+
+  # Creates and sets up Savon client.
+  def create_savon_client(endpoint, namespace)
+    Nori.advanced_typecasting = false
+    client = Savon::Client.new do |wsdl, httpi|
+      wsdl.endpoint = endpoint
+      wsdl.namespace = namespace
+      wsdl.element_form_default = :qualified
+      AdsCommonForBingAds::Http.configure_httpi(@config, httpi)
+    end
+    client.config.raise_errors = false
+    client.config.logger.subject = get_logger()
+    return client
+  end
+
+  # Finds an exception object for a given response.
+  def exception_for_soap_fault(response)
+    begin
+      fault = response[:fault]
+      if fault[:detail] and fault[:detail][:api_exception_fault]
+        exception_fault = fault[:detail][:api_exception_fault]
+        exception_name = exception_fault[:application_exception_type]
+        exception_class = get_module().const_get(exception_name)
+        return exception_class.new(exception_fault)
+      # Specific to Bing Ads
+      elsif fault[:detail] and fault[:detail][:api_fault]
+        operation_error = fault[:detail][:api_fault][:operation_errors][:operation_error]
+        operation_error = operation_error.first if operation_error.is_a?(Array) # if we get several errors, we only raise the first one
+        if exception_name = BingAdsApi::Errors::CODES[operation_error[:code]]
+          exception_class = BingAdsApi::Errors.const_get(exception_name)
+        else
+          raise Exception.new("code #{operation_error[:code]}")
+        end
+        return exception_class.new("#{operation_error[:message]} (#{operation_error[:details]})")
+      # Specific to Bing Ads (batches)
+      elsif fault[:detail] and fault[:detail][:api_fault_detail]
+        operation_error = fault[:detail][:api_fault_detail][:batch_errors][:batch_error]
+        operation_error = operation_error.first if operation_error.is_a?(Array) # if we get several errors, we only raise the first one
+        if exception_name = BingAdsApi::Errors::CODES[operation_error[:code]]
+          exception_class = BingAdsApi::Errors.const_get(exception_name)
+        else
+          raise Exception.new("code #{operation_error[:code]}")
+        end
+        return exception_class.new("#{operation_error[:message]} (#{operation_error[:details]})")
+      # Specific to Bing Ads (ad api)
+      elsif fault[:detail] and fault[:detail][:ad_api_fault_detail]
+        operation_error = fault[:detail][:ad_api_fault_detail][:errors][:ad_api_error]
+        operation_error = operation_error.first if operation_error.is_a?(Array) # if we get several errors, we only raise the first one
+        if exception_name = BingAdsApi::Errors::CODES[operation_error[:code]]
+          exception_class = BingAdsApi::Errors.const_get(exception_name)
+        else
+          raise Exception.new("code #{operation_error[:code]}")
+        end
+        return exception_class.new("#{operation_error[:message]} (#{operation_error[:details]})")
+      elsif fault[:faultstring]
+        fault_message = fault[:faultstring]
+        return AdsCommonForBingAds::Errors::ApiException.new(
+            "Unknown exception with error: %s" % fault_message)
+      else
+        raise ArgumentError.new(fault.to_s)
+      end
+    rescue Exception => e
+      operation_error ||= response[:fault][:detail][:api_fault][:operation_errors][:operation_error] rescue {}
+      return AdsCommonForBingAds::Errors::ApiException.new(
+          "Failed to resolve exception (%s), details: %s, SOAP fault: %s" %
+          [e.message, "#{operation_error[:message]} (#{operation_error[:details]})", response.soap_fault])
+    end
+  end
+
+
+end

data/lib/bing_ads_api.rb

@@ -0,0 +1,215 @@
+require 'savon'
+require 'httpi'
+require 'active_support/inflector'
+
+require 'ads_common_for_bing_ads'
+require 'ads_common_for_bing_ads/api_config'
+require 'ads_common_for_bing_ads/parameters_validator'
+require 'ads_common_for_bing_ads/auth/client_login_handler'
+require 'ads_common_for_bing_ads/auth/oauth2_handler'
+require 'ads_common_for_bing_ads/savon_service'
+require 'ads_common_for_bing_ads/savon_headers/base_header_handler'
+require 'ads_common_for_bing_ads/savon_headers/client_login_header_handler'
+require 'ads_common_for_bing_ads/savon_headers/oauth_header_handler'
+require 'bing_ads_api/api_config'
+require 'bing_ads_api/credential_handler'
+require 'bing_ads_api/errors'
+require 'bing_ads_api/report_utils'
+
+module BingAdsApi
+
+  # 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 < AdsCommonForBingAds::Api
+
+    # Constructor for API.
+    def initialize(provided_config = nil)
+      super(provided_config)
+      @credential_handler = BingAdsApi::CredentialHandler.new(@config)
+    end
+
+    # Getter for the API service configurations
+    def api_config()
+      BingAdsApi::ApiConfig
+    end
+
+    # Auxiliary method to create an authentication handler.
+    #
+    # Returns:
+    # - auth handler
+    #
+    def create_auth_handler
+      auth_method = @config.read('authentication.method', :OAUTH2)
+      return case auth_method
+               when :CLIENTLOGIN
+                 @logger.warn("ClientLogin authentication method is now deprecated")
+                 AdsCommonForBingAds::Auth::ClientLoginHandler.new(
+                     @config,
+                     api_config.client_login_config(:AUTH_SERVER),
+                     api_config.client_login_config(:LOGIN_SERVICE_NAME)
+                 )
+               when :OAUTH
+                 raise AdsCommon::Errors::Error,
+                       'OAuth authorization method is deprecated, use OAuth2 instead.'
+               when :OAUTH2
+                 environment = @config.read('service.environment',
+                                            api_config.default_environment())
+                 AdsCommonForBingAds::Auth::OAuth2Handler.new(
+                     @config,
+                     api_config.environment_config(environment, :oauth_scope)
+                 )
+               when :OAUTH2_JWT
+                 environment = @config.read('service.environment',
+                                            api_config.default_environment())
+                 AdsCommon::Auth::OAuth2JwtHandler.new(
+                     @config,
+                     api_config.environment_config(environment, :oauth_scope)
+                 )
+               else
+                 raise AdsCommon::Errors::Error,
+                       "Unknown authentication method '%s'" % auth_method
+             end
+    end
+
+    # Retrieve correct soap_header_handler.
+    #
+    # Args:
+    # - auth_handler: instance of an AdsCommonForBingAds::Auth::BaseHandler subclass to
+    #   handle authentication
+    # - version: intended API version
+    # - header_ns: header namespace
+    # - default_ns: default namespace
+    #
+    # Returns:
+    # - SOAP header handler
+    #
+    def soap_header_handler(auth_handler, version, header_ns, default_ns)
+      auth_method = @config.read('authentication.method', :CLIENTLOGIN)
+      handler_class = case auth_method
+                        when :CLIENTLOGIN then AdsCommonForBingAds::SavonHeaders::ClientLoginHeaderHandler
+                        when :OAUTH,:OAUTH2 then AdsCommonForBingAds::SavonHeaders::OAuthHeaderHandler
+                      end
+      return handler_class.new(@credential_handler, auth_handler, header_ns, default_ns, version)
+    end
+
+    # Helper method to provide a simple way of doing an MCC-level operation
+    # without the need to change credentials. Executes a block of code as an
+    # MCC-level operation and/or returns the current status of the property.
+    #
+    # Args:
+    # - accepts a block, which it will execute as an MCC-level operation
+    #
+    # Returns:
+    # - block execution result, if block given
+    # - boolean indicating whether MCC-level operations are currently
+    #   enabled or disabled, if no block provided
+    #
+    def use_mcc(&block)
+      return (block_given?) ?
+          run_with_temporary_flag(:@use_mcc, true, block) :
+          @credential_handler.use_mcc
+    end
+
+    # Helper method to provide a simple way of doing an MCC-level operation
+    # without the need to change credentials. Sets the value of the property
+    # that controls whether MCC-level operations are enabled or disabled.
+    #
+    # Args:
+    # - value: the new value for the property (boolean)
+    #
+    def use_mcc=(value)
+      @credential_handler.use_mcc = value
+    end
+
+    # Helper method to provide a simple way of doing a validate-only operation
+    # without the need to change credentials. Executes a block of code as an
+    # validate-only operation and/or returns the current status of the property.
+    #
+    # Args:
+    # - accepts a block, which it will execute as a validate-only operation
+    #
+    # Returns:
+    # - block execution result, if block given
+    # - boolean indicating whether validate-only operations are currently
+    #   enabled or disabled, if no block provided
+    #
+    def validate_only(&block)
+      return (block_given?) ?
+          run_with_temporary_flag(:@validate_only, true, block) :
+          @credential_handler.validate_only
+    end
+
+    # Helper method to provide a simple way of performing validate-only
+    # operations. Sets the value of the property
+    # that controls whether validate-only operations are enabled or disabled.
+    #
+    # Args:
+    # - value: the new value for the property (boolean)
+    #
+    def validate_only=(value)
+      @credential_handler.validate_only = value
+    end
+
+    # Helper method to provide a simple way of performing requests with support
+    # for partial failures. Executes a block of code with partial failures
+    # enabled and/or returns the current status of the property.
+    #
+    # Args:
+    # - accepts a block, which it will execute as a partial failure operation
+    #
+    # Returns:
+    # - block execution result, if block given
+    # - boolean indicating whether partial failure operations are currently
+    # enabled or disabled, if no block provided
+    #
+    def partial_failure(&block)
+      return (block_given?) ?
+          run_with_temporary_flag(:@partial_failure, true, block) :
+          @credential_handler.partial_failure
+    end
+
+    # Helper method to provide a simple way of performing requests with support
+    # for partial failures.
+    #
+    # Args:
+    # - value: the new value for the property (boolean)
+    #
+    def partial_failure=(value)
+      @credential_handler.partial_failure = value
+    end
+
+    # Returns an instance of ReportUtils object with all utilities relevant to
+    # the reporting.
+    #
+    # Args:
+    # - version: version of the API to use (optional).
+    #
+    def report_utils(version = nil)
+      version = api_config.default_version if version.nil?
+      # Check if version exists.
+      if !api_config.versions.include?(version)
+        raise AdsCommonForBingAds::Errors::Error, "Unknown version '%s'" % version
+      end
+      return BingAdsApi::ReportUtils.new(self, version)
+    end
+
+    private
+
+    # Executes block with a temporary flag set to a given value. Returns block
+    # result.
+    def run_with_temporary_flag(flag_name, flag_value, block)
+      previous = @credential_handler.instance_variable_get(flag_name)
+      @credential_handler.instance_variable_set(flag_name, flag_value)
+      begin
+        return block.call
+      ensure
+        @credential_handler.instance_variable_set(flag_name, previous)
+      end
+    end
+
+  end
+
+
+end

data/lib/bing_ads_api/api_config.rb

@@ -0,0 +1,164 @@
+# encoding: utf-8
+# Helper methods for loading and managing the available services in the Bing Ads API.
+
+require 'bing_ads_api/version'
+
+module BingAdsApi
+
+  # Contains helper methods for loading and managing the available services.
+  module ApiConfig
+
+    # Inherit from AdsCommonForBingAds::ApiConfig
+    class << ApiConfig
+      include AdsCommonForBingAds::ApiConfig
+    end
+
+    # Set defaults
+    DEFAULT_VERSION = :v9
+    DEFAULT_ENVIRONMENT = :PRODUCTION
+    LATEST_VERSION = :v9
+
+    # Set other constants
+    API_NAME = 'BingAdsApi'
+    DEFAULT_CONFIG_FILENAME = 'bing_ads_api.yml'
+
+    # Configure the services available to each version
+    @@service_config = {
+      :v8 => [
+          :AdIntelligenceService,
+          :AdministrationService,
+          :BulkService,
+          :CampaignManagementService,
+          :CustomerBillingService,
+          :CustomerManagementService,
+          :NotificationService,
+          :OptimizerService,
+          :ReportingService
+      ],
+      :v9 => [
+          :AdIntelligenceService,
+          :BulkService,
+          :CampaignManagementService,
+          :CustomerBillingService,
+          :CustomerManagementService,
+          :OptimizerService,
+          :ReportingService
+      ]
+    }
+
+    # Configure the different environments, with the base URL for each one
+    @@environment_config = {
+      :PRODUCTION => {
+        :oauth_scope => '',
+        :header_ns => 'https://adcenter.microsoft.com/api/adcenter/',
+        :v8 => '',
+        :v9 => ''
+      },
+      :SANDBOX => {
+        :oauth_scope => '',
+        :header_ns => 'https://adcenter.microsoft.com/api/adcenter/',
+        :v8 => '',
+        :v9 => ''
+      }
+    }
+
+    # Configure the subdirectories for each version / service pair.
+    # A missing pair means that only the base URL is used.
+    @@subdir_config = {}
+
+    @@address_config = {
+        :v9 => {
+          :AdIntelligenceService     => {:PRODUCTION => "https://api.bingads.microsoft.com/Api/Advertiser/AdIntelligence/v9/AdIntelligenceService.svc?wsdl", :SANDBOX => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/AdIntelligence/v9/AdIntelligenceService.svc?wsdl"},
+          :BulkService               => {:PRODUCTION => "https://api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/BulkService.svc?wsdl",           :SANDBOX => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/BulkService.svc?wsdl"},
+          :CampaignManagementService => {:PRODUCTION => "https://api.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/CampaignManagementService.svc?wsdl", :SANDBOX => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/CampaignManagement/v9/CampaignManagementService.svc?wsdl"},
+          :CustomerBillingService    => {:PRODUCTION => "https://clientcenter.api.bingads.microsoft.com/Api/Billing/v9/CustomerBillingService.svc?wsdl",       :SANDBOX => ""},
+          :CustomerManagementService => {:PRODUCTION => "https://clientcenter.api.bingads.microsoft.com/Api/CustomerManagement/v9/CustomerManagementService.svc?wsdl", :SANDBOX => "https://clientcenter.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v9/CustomerManagementService.svc?wsdl"},
+          :OptimizerService          => {:PRODUCTION => "https://api.bingads.microsoft.com/Api/Advertiser/Optimizer/v9/OptimizerService.svc?wsdl",               :SANDBOX => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/Optimizer/v9/OptimizerService.svc?wsdl"},
+          :ReportingService          => {:PRODUCTION => "https://api.bingads.microsoft.com/Api/Advertiser/Reporting/v9/ReportingService.svc?wsdl",               :SANDBOX => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/Reporting/v9/ReportingService.svc?wsdl"}
+        },
+        :v8 => {
+          :AdIntelligenceService     => {:PRODUCTION => "https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/AdIntelligenceService.svc?wsdl", :SANDBOX => ""},
+          :AdministrationService     => {:PRODUCTION => "https://adcenterapi.microsoft.com/Api/Advertiser/v8/Administration/AdministrationService.svc?wsdl",     :SANDBOX => ""},
+          :BulkService               => {:PRODUCTION => "https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/BulkService.svc?wsdl",           :SANDBOX => ""},
+          :CampaignManagementService => {:PRODUCTION => "https://adcenterapi.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementService.svc?wsdl", :SANDBOX => "https://api.sandbox.bingads.microsoft.com/Api/Advertiser/v8/CampaignManagement/CampaignManagementService.svc?wsdl"},
+          :CustomerBillingService    => {:PRODUCTION => "https://sharedservices.adcenterapi.microsoft.com/Api/Billing/v8/CustomerBillingService.svc?wsdl",       :SANDBOX => ""},
+          :CustomerManagementService => {:PRODUCTION => "https://sharedservices.adcenterapi.microsoft.com/Api/CustomerManagement/v8/CustomerManagementService.svc?wsdl", :SANDBOX => "https://sharedservices.api.sandbox.bingads.microsoft.com/Api/CustomerManagement/v8/CustomerManagementService.svc?wsdl"},
+          :NotificationService       => {:PRODUCTION => "https://sharedservices.adcenterapi.microsoft.com/Api/Notification/v8/NotificationService.svc?wsdl",     :SANDBOX => ""},
+          :OptimizerService          => {:PRODUCTION => "https://adcenterapi.microsoft.com/Api/Advertiser/v8/Optimizer/OptimizerService.svc?wsdl",               :SANDBOX => ""},
+          :ReportingService          => {:PRODUCTION => "https://adcenterapi.microsoft.com/Api/Advertiser/v8/Reporting/ReportingService.svc?wsdl",               :SANDBOX => ""}
+        }
+    }
+
+    # Auth constants for ClientLogin method.
+    #TODO: remove client_login_config
+    @@client_login_config = {
+      :AUTH_SERVER => 'https://www.microsoft.com',
+      :LOGIN_SERVICE_NAME => 'adcenter'
+    }
+
+    public
+
+    # Getters for constants and module variables.
+    def self.default_version
+      DEFAULT_VERSION
+    end
+
+    def self.default_environment
+      DEFAULT_ENVIRONMENT
+    end
+
+    def self.latest_version
+      LATEST_VERSION
+    end
+
+    def self.api_name
+      API_NAME
+    end
+
+    def self.service_config
+      @@service_config
+    end
+
+    def self.environment_config(environment, key)
+      return @@environment_config.include?(environment) ?
+          @@environment_config[environment][key] : nil
+    end
+
+    def self.address_config
+      @@address_config
+    end
+
+    def self.subdir_config
+      @@subdir_config
+    end
+
+    def self.client_login_config(key)
+      return @@client_login_config[key]
+    end
+
+    def self.default_config_filename
+      DEFAULT_CONFIG_FILENAME
+    end
+
+    def self.headers_config
+      @@headers_config
+    end
+
+    # Get the download URL for Ad Hoc reports.
+    #
+    # Args:
+    # - environment: the service environment to be used
+    # - version: the API version (as a symbol)
+    #
+    # Returns:
+    # - The endpoint URL (as a string)
+    #
+    def self.adhoc_report_download_url(environment, version)
+      base = get_wsdl_base(environment, version)
+      if base
+        base += 'reportdownload/%s' % version.to_s
+      end
+      return base
+    end
+  end
+end