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 = 
'1.5.0'
DEFAULT_VERSION =

Set defaults

:v201809
LATEST_VERSION = 
:v201809
API_NAME =

Set other constants

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

Configure the services available to each version

{
  :v201809 => [
      :AccountLabelService,
      :AdCustomizerFeedService,
      :AdGroupAdService,
      :AdGroupBidModifierService,
      :AdGroupCriterionService,
      :AdGroupExtensionSettingService,
      :AdGroupFeedService,
      :AdGroupService,
      :AdParamService,
      :AdService,
      :AdwordsUserListService,
      :AssetService,
      :BatchJobService,
      :BiddingStrategyService,
      :BudgetOrderService,
      :BudgetService,
      :CampaignBidModifierService,
      :CampaignCriterionService,
      :CampaignExtensionSettingService,
      :CampaignFeedService,
      :CampaignGroupService,
      :CampaignGroupPerformanceTargetService,
      :CampaignService,
      :CampaignSharedSetService,
      :ConstantDataService,
      :ConversionTrackerService,
      :CustomAffinityService,
      :CustomerExtensionSettingService,
      :CustomerFeedService,
      :CustomerNegativeCriterionService,
      :CustomerService,
      :CustomerSyncService,
      :DataService,
      :DraftAsyncErrorService,
      :DraftService,
      :FeedItemService,
      :FeedItemTargetService,
      :FeedMappingService,
      :FeedService,
      :LabelService,
      :LocationCriterionService,
      :ManagedCustomerService,
      :MediaService,
      :OfflineCallConversionFeedService,
      :OfflineConversionAdjustmentFeedService,
      :OfflineConversionFeedService,
      :OfflineDataUploadService,
      :ReportDefinitionService,
      :SharedCriterionService,
      :SharedSetService,
      :TargetingIdeaService,
      :TrafficEstimatorService,
      :TrialAsyncErrorService,
      :TrialService
  ]
}
@@config =

Configure the base URL for each version and scope.

{
  :oauth_scope => 'https://www.googleapis.com/auth/adwords',
  :header_ns => 'https://adwords.google.com/api/adwords/cm/',
  :v201809 => '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.

{
  # v201809
  [:v201809, :AccountLabelService] => 'mcm/',
  [:v201809, :AdCustomizerFeedService] => 'cm/',
  [:v201809, :AdGroupAdService] => 'cm/',
  [:v201809, :AdGroupBidModifierService] => 'cm/',
  [:v201809, :AdGroupCriterionService] => 'cm/',
  [:v201809, :AdGroupExtensionSettingService] => 'cm/',
  [:v201809, :AdGroupFeedService] => 'cm/',
  [:v201809, :AdGroupService] => 'cm/',
  [:v201809, :AdParamService] => 'cm/',
  [:v201809, :AdService] => 'cm/',
  [:v201809, :AdwordsUserListService] => 'rm/',
  [:v201809, :AssetService] => 'cm/',
  [:v201809, :BatchJobService] => 'cm/',
  [:v201809, :BiddingStrategyService] => 'cm/',
  [:v201809, :BudgetOrderService] => 'billing/',
  [:v201809, :BudgetService] => 'cm/',
  [:v201809, :CampaignBidModifierService] => 'cm/',
  [:v201809, :CampaignCriterionService] => 'cm/',
  [:v201809, :CampaignExtensionSettingService] => 'cm/',
  [:v201809, :CampaignFeedService] => 'cm/',
  [:v201809, :CampaignGroupService] => 'cm/',
  [:v201809, :CampaignGroupPerformanceTargetService] => 'cm/',
  [:v201809, :CampaignService] => 'cm/',
  [:v201809, :CampaignSharedSetService] => 'cm/',
  [:v201809, :ConstantDataService] => 'cm/',
  [:v201809, :ConversionTrackerService] => 'cm/',
  [:v201809, :CustomAffinityService] => 'rm/',
  [:v201809, :CustomerExtensionSettingService] => 'cm/',
  [:v201809, :CustomerFeedService] => 'cm/',
  [:v201809, :CustomerNegativeCriterionService] => 'cm/',
  [:v201809, :CustomerService] => 'mcm/',
  [:v201809, :CustomerSyncService] => 'ch/',
  [:v201809, :DraftAsyncErrorService] => 'cm/',
  [:v201809, :DataService] => 'cm/',
  [:v201809, :DraftService] => 'cm/',
  [:v201809, :FeedItemService] => 'cm/',
  [:v201809, :FeedItemTargetService] => 'cm/',
  [:v201809, :FeedMappingService] => 'cm/',
  [:v201809, :FeedService] => 'cm/',
  [:v201809, :LabelService] => 'cm/',
  [:v201809, :LocationCriterionService] => 'cm/',
  [:v201809, :ManagedCustomerService] => 'mcm/',
  [:v201809, :MediaService] => 'cm/',
  [:v201809, :OfflineCallConversionFeedService] => 'cm/',
  [:v201809, :OfflineConversionAdjustmentFeedService] => 'cm/',
  [:v201809, :OfflineConversionFeedService] => 'cm/',
  [:v201809, :OfflineDataUploadService] => 'rm/',
  [:v201809, :ReportDefinitionService] => 'cm/',
  [:v201809, :SharedCriterionService] => 'cm/',
  [:v201809, :SharedSetService] => 'cm/',
  [:v201809, :TargetingIdeaService] => 'o/',
  [:v201809, :TrafficEstimatorService] => 'o/',
  [:v201809, :TrialAsyncErrorService] => 'cm/',
  [:v201809, :TrialService] => 'cm/'
}

Class Method Summary collapse

Class Method Details

.adhoc_report_download_url(version) ⇒ Object

Get the download URL for Ad Hoc reports.

Args:

  • version: the API version (as a symbol)

Returns:

  • The endpoint URL (as a string)



213
214
215
216
217
218
219
 
# File 'lib/adwords_api/api_config.rb', line 213

def self.adhoc_report_download_url(version)
  base = get_wsdl_base(version)
  if base
    base += 'reportdownload/%s' % version.to_s
  end
  return base
end

.api_name ⇒ Object 



181
182
183
 
# File 'lib/adwords_api/api_config.rb', line 181

def self.api_name
  API_NAME
end

.config(key) ⇒ Object 



189
190
191
 
# File 'lib/adwords_api/api_config.rb', line 189

def self.config(key)
  @@config[key]
end

.default_config_filename ⇒ Object 



197
198
199
 
# File 'lib/adwords_api/api_config.rb', line 197

def self.default_config_filename
  DEFAULT_CONFIG_FILENAME
end

.default_version ⇒ Object

Getters for constants and module variables.



173
174
175
 
# File 'lib/adwords_api/api_config.rb', line 173

def self.default_version
  DEFAULT_VERSION
end

.headers_config ⇒ Object 



201
202
203
 
# File 'lib/adwords_api/api_config.rb', line 201

def self.headers_config
  @@headers_config
end

.latest_version ⇒ Object 



177
178
179
 
# File 'lib/adwords_api/api_config.rb', line 177

def self.latest_version
  LATEST_VERSION
end

.service_config ⇒ Object 



185
186
187
 
# File 'lib/adwords_api/api_config.rb', line 185

def self.service_config
  @@service_config
end

.subdir_config ⇒ Object 



193
194
195
 
# File 'lib/adwords_api/api_config.rb', line 193

def self.subdir_config
  @@subdir_config
end