Module: AdwordsApi::ApiConfig

Extended by:
AdsCommon::ApiConfig
Defined in:
lib/adwords_api/api_config.rb,
lib/adwords_api/version.rb

Overview

Contains helper methods for loading and managing the available services.

Constant Summary collapse

CLIENT_LIB_VERSION = 
'0.13.2'
DEFAULT_VERSION =

Set defaults

:v201409
DEFAULT_ENVIRONMENT = 
:PRODUCTION
LATEST_VERSION = 
:v201409
API_NAME =

Set other constants

'AdwordsApi'
DEFAULT_CONFIG_FILENAME = 
'adwords_api.yml'
@@service_config =

Configure the services available to each version

{
  :v201402 => [
      :AdGroupAdService,
      :AdGroupBidModifierService,
      :AdGroupCriterionService,
      :AdGroupFeedService,
      :AdGroupService,
      :AdParamService,
      :AdwordsUserListService,
      :AlertService,
      :BiddingStrategyService,
      :BudgetOrderService,
      :BudgetService,
      :CampaignAdExtensionService,
      :CampaignCriterionService,
      :CampaignFeedService,
      :CampaignService,
      :CampaignSharedSetService,
      :ConstantDataService,
      :ConversionTrackerService,
      :CustomerFeedService,
      :CustomerService,
      :CustomerSyncService,
      :DataService,
      :ExperimentService,
      :FeedItemService,
      :FeedMappingService,
      :FeedService,
      :GeoLocationService,
      :LocationCriterionService,
      :ManagedCustomerService,
      :MediaService,
      :MutateJobService,
      :OfflineConversionFeedService,
      :ReportDefinitionService,
      :SharedCriterionService,
      :SharedSetService,
      :TargetingIdeaService,
      :TrafficEstimatorService
  ],
  :v201406 => [
      :AdGroupAdService,
      :AdGroupBidModifierService,
      :AdGroupCriterionService,
      :AdGroupFeedService,
      :AdGroupService,
      :AdParamService,
      :AdwordsUserListService,
      :AlertService,
      :BiddingStrategyService,
      :BudgetOrderService,
      :BudgetService,
      :CampaignAdExtensionService,
      :CampaignCriterionService,
      :CampaignFeedService,
      :CampaignService,
      :CampaignSharedSetService,
      :ConstantDataService,
      :ConversionTrackerService,
      :CustomerFeedService,
      :CustomerService,
      :CustomerSyncService,
      :DataService,
      :ExperimentService,
      :FeedItemService,
      :FeedMappingService,
      :FeedService,
      :GeoLocationService,
      :LabelService,
      :LocationCriterionService,
      :ManagedCustomerService,
      :MediaService,
      :MutateJobService,
      :OfflineConversionFeedService,
      :ReportDefinitionService,
      :SharedCriterionService,
      :SharedSetService,
      :TargetingIdeaService,
      :TrafficEstimatorService
  ],
  :v201409 => [
      :AdGroupAdService,
      :AdGroupBidModifierService,
      :AdGroupCriterionService,
      :AdGroupFeedService,
      :AdGroupService,
      :AdParamService,
      :AdwordsUserListService,
      :BiddingStrategyService,
      :BudgetOrderService,
      :BudgetService,
      :CampaignAdExtensionService,
      :CampaignCriterionService,
      :CampaignFeedService,
      :CampaignService,
      :CampaignSharedSetService,
      :ConstantDataService,
      :ConversionTrackerService,
      :CustomerFeedService,
      :CustomerService,
      :CustomerSyncService,
      :DataService,
      :ExperimentService,
      :FeedItemService,
      :FeedMappingService,
      :FeedService,
      :GeoLocationService,
      :LabelService,
      :LocationCriterionService,
      :ManagedCustomerService,
      :MediaService,
      :MutateJobService,
      :OfflineConversionFeedService,
      :ReportDefinitionService,
      :SharedCriterionService,
      :SharedSetService,
      :TargetingIdeaService,
      :TrafficEstimatorService
  ]
}
@@environment_config =

Configure the different environments, with the base URL for each one

{
  :PRODUCTION => {
    :oauth_scope => 'https://www.googleapis.com/auth/adwords',
    :header_ns => 'https://adwords.google.com/api/adwords/cm/',
    :v201402 => 'https://adwords.google.com/api/adwords/',
    :v201406 => 'https://adwords.google.com/api/adwords/',
    :v201409 => 'https://adwords.google.com/api/adwords/'
  }
}
@@subdir_config =

Configure the subdirectories for each version / service pair. A missing pair means that only the base URL is used.

{
  # v201402
  [:v201402, :AdGroupAdService] => 'cm/',
  [:v201402, :AdGroupBidModifierService] => 'cm/',
  [:v201402, :AdGroupCriterionService] => 'cm/',
  [:v201402, :AdGroupFeedService] => 'cm/',
  [:v201402, :AdGroupService] => 'cm/',
  [:v201402, :AdParamService] => 'cm/',
  [:v201402, :AlertService] => 'mcm/',
  [:v201402, :BudgetOrderService] => 'billing/',
  [:v201402, :CampaignAdExtensionService] => 'cm/',
  [:v201402, :CampaignCriterionService] => 'cm/',
  [:v201402, :CampaignFeedService] => 'cm/',
  [:v201402, :CampaignService] => 'cm/',
  [:v201402, :CampaignSharedSetService] => 'cm/',
  [:v201402, :ConstantDataService] => 'cm/',
  [:v201402, :ConversionTrackerService] => 'cm/',
  [:v201402, :CustomerSyncService] => 'ch/',
  [:v201402, :DataService] => 'cm/',
  [:v201402, :ExperimentService] => 'cm/',
  [:v201402, :FeedItemService] => 'cm/',
  [:v201402, :FeedMappingService] => 'cm/',
  [:v201402, :FeedService] => 'cm/',
  [:v201402, :GeoLocationService] => 'cm/',
  [:v201402, :LocationCriterionService] => 'cm/',
  [:v201402, :MediaService] => 'cm/',
  [:v201402, :MutateJobService] => 'cm/',
  [:v201402, :OfflineConversionFeedService] => 'cm/',
  [:v201402, :ReportDefinitionService] => 'cm/',
  [:v201402, :SharedCriterionService] => 'cm/',
  [:v201402, :SharedSetService] => 'cm/',
  [:v201402, :TargetingIdeaService] => 'o/',
  [:v201402, :TrafficEstimatorService] => 'o/',
  [:v201402, :ManagedCustomerService] => 'mcm/',
  [:v201402, :CustomerService] => 'mcm/',
  [:v201402, :CustomerFeedService] => 'cm/',
  [:v201402, :BudgetService] => 'cm/',
  [:v201402, :BiddingStrategyService] => 'cm/',
  [:v201402, :AdwordsUserListService] => 'rm/',
  # v201406
  [:v201406, :AdGroupAdService] => 'cm/',
  [:v201406, :AdGroupBidModifierService] => 'cm/',
  [:v201406, :AdGroupCriterionService] => 'cm/',
  [:v201406, :AdGroupFeedService] => 'cm/',
  [:v201406, :AdGroupService] => 'cm/',
  [:v201406, :AdParamService] => 'cm/',
  [:v201406, :AlertService] => 'mcm/',
  [:v201406, :BudgetOrderService] => 'billing/',
  [:v201406, :CampaignAdExtensionService] => 'cm/',
  [:v201406, :CampaignCriterionService] => 'cm/',
  [:v201406, :CampaignFeedService] => 'cm/',
  [:v201406, :CampaignService] => 'cm/',
  [:v201406, :CampaignSharedSetService] => 'cm/',
  [:v201406, :ConstantDataService] => 'cm/',
  [:v201406, :ConversionTrackerService] => 'cm/',
  [:v201406, :CustomerSyncService] => 'ch/',
  [:v201406, :DataService] => 'cm/',
  [:v201406, :ExperimentService] => 'cm/',
  [:v201406, :FeedItemService] => 'cm/',
  [:v201406, :FeedMappingService] => 'cm/',
  [:v201406, :FeedService] => 'cm/',
  [:v201406, :GeoLocationService] => 'cm/',
  [:v201406, :LocationCriterionService] => 'cm/',
  [:v201406, :MediaService] => 'cm/',
  [:v201406, :MutateJobService] => 'cm/',
  [:v201406, :OfflineConversionFeedService] => 'cm/',
  [:v201406, :ReportDefinitionService] => 'cm/',
  [:v201406, :SharedCriterionService] => 'cm/',
  [:v201406, :SharedSetService] => 'cm/',
  [:v201406, :TargetingIdeaService] => 'o/',
  [:v201406, :TrafficEstimatorService] => 'o/',
  [:v201406, :ManagedCustomerService] => 'mcm/',
  [:v201406, :CustomerService] => 'mcm/',
  [:v201406, :CustomerFeedService] => 'cm/',
  [:v201406, :BudgetService] => 'cm/',
  [:v201406, :BiddingStrategyService] => 'cm/',
  [:v201406, :AdwordsUserListService] => 'rm/',
  [:v201406, :LabelService] => 'cm/',
  # v201409
  [:v201409, :AdGroupAdService] => 'cm/',
  [:v201409, :AdGroupBidModifierService] => 'cm/',
  [:v201409, :AdGroupCriterionService] => 'cm/',
  [:v201409, :AdGroupFeedService] => 'cm/',
  [:v201409, :AdGroupService] => 'cm/',
  [:v201409, :AdParamService] => 'cm/',
  [:v201409, :BudgetOrderService] => 'billing/',
  [:v201409, :CampaignAdExtensionService] => 'cm/',
  [:v201409, :CampaignCriterionService] => 'cm/',
  [:v201409, :CampaignFeedService] => 'cm/',
  [:v201409, :CampaignService] => 'cm/',
  [:v201409, :CampaignSharedSetService] => 'cm/',
  [:v201409, :ConstantDataService] => 'cm/',
  [:v201409, :ConversionTrackerService] => 'cm/',
  [:v201409, :CustomerSyncService] => 'ch/',
  [:v201409, :DataService] => 'cm/',
  [:v201409, :ExperimentService] => 'cm/',
  [:v201409, :FeedItemService] => 'cm/',
  [:v201409, :FeedMappingService] => 'cm/',
  [:v201409, :FeedService] => 'cm/',
  [:v201409, :GeoLocationService] => 'cm/',
  [:v201409, :LocationCriterionService] => 'cm/',
  [:v201409, :MediaService] => 'cm/',
  [:v201409, :MutateJobService] => 'cm/',
  [:v201409, :OfflineConversionFeedService] => 'cm/',
  [:v201409, :ReportDefinitionService] => 'cm/',
  [:v201409, :SharedCriterionService] => 'cm/',
  [:v201409, :SharedSetService] => 'cm/',
  [:v201409, :TargetingIdeaService] => 'o/',
  [:v201409, :TrafficEstimatorService] => 'o/',
  [:v201409, :ManagedCustomerService] => 'mcm/',
  [:v201409, :CustomerService] => 'mcm/',
  [:v201409, :CustomerFeedService] => 'cm/',
  [:v201409, :BudgetService] => 'cm/',
  [:v201409, :BiddingStrategyService] => 'cm/',
  [:v201409, :AdwordsUserListService] => 'rm/',
  [:v201409, :LabelService] => 'cm/'
}

Class Method Summary collapse

Class Method Details

.adhoc_report_download_url(environment, version) ⇒ Object

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)



356
357
358
359
360
361
362
 
# File 'lib/adwords_api/api_config.rb', line 356

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

.api_name ⇒ Object 



314
315
316
 
# File 'lib/adwords_api/api_config.rb', line 314

def self.api_name
  API_NAME
end

.client_login_config(key) ⇒ Object

Raises:

  • (AdsCommon::Errors::AuthError) 


331
332
333
334
335
336
337
 
# File 'lib/adwords_api/api_config.rb', line 331

def self.(key)
  raise AdsCommon::Errors::AuthError,
        "ClientLogin is not supported. " +
        "Please use OAuth2 instead. See here for details:\n\t\t" +
        "https://developers.google.com/adwords/api/" +
        "docs/guides/authentication"
end

.default_config_filename ⇒ Object 



339
340
341
 
# File 'lib/adwords_api/api_config.rb', line 339

def self.default_config_filename
  DEFAULT_CONFIG_FILENAME
end

.default_environment ⇒ Object 



306
307
308
 
# File 'lib/adwords_api/api_config.rb', line 306

def self.default_environment
  DEFAULT_ENVIRONMENT
end

.default_version ⇒ Object

Getters for constants and module variables.



302
303
304
 
# File 'lib/adwords_api/api_config.rb', line 302

def self.default_version
  DEFAULT_VERSION
end

.environment_config(environment, key) ⇒ Object 



322
323
324
325
 
# File 'lib/adwords_api/api_config.rb', line 322

def self.environment_config(environment, key)
  return @@environment_config.include?(environment) ?
      @@environment_config[environment][key] : nil
end

.headers_config ⇒ Object 



343
344
345
 
# File 'lib/adwords_api/api_config.rb', line 343

def self.headers_config
  @@headers_config
end

.latest_version ⇒ Object 



310
311
312
 
# File 'lib/adwords_api/api_config.rb', line 310

def self.latest_version
  LATEST_VERSION
end

.service_config ⇒ Object 



318
319
320
 
# File 'lib/adwords_api/api_config.rb', line 318

def self.service_config
  @@service_config
end

.subdir_config ⇒ Object 



327
328
329
 
# File 'lib/adwords_api/api_config.rb', line 327

def self.subdir_config
  @@subdir_config
end