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.18.0'
- DEFAULT_VERSION =
Set defaults
:v201509
- DEFAULT_ENVIRONMENT =
:PRODUCTION
- LATEST_VERSION =
:v201509
- API_NAME =
Set other constants
'AdwordsApi'
- DEFAULT_CONFIG_FILENAME =
'adwords_api.yml'
- @@service_config =
Configure the services available to each version
{ :v201506 => [ :AccountLabelService, :AdCustomizerFeedService, :AdGroupAdService, :AdGroupBidModifierService, :AdGroupCriterionService, :AdGroupExtensionSettingService, :AdGroupFeedService, :AdGroupService, :AdParamService, :AdwordsUserListService, :BiddingStrategyService, :BudgetOrderService, :BudgetService, :CampaignCriterionService, :CampaignExtensionSettingService, :CampaignFeedService, :CampaignService, :CampaignSharedSetService, :ConstantDataService, :ConversionTrackerService, :CustomerExtensionSettingService, :CustomerFeedService, :CustomerService, :CustomerSyncService, :DataService, :ExperimentService, :FeedItemService, :FeedMappingService, :FeedService, :GeoLocationService, :LabelService, :LocationCriterionService, :ManagedCustomerService, :MediaService, :MutateJobService, :OfflineConversionFeedService, :ReportDefinitionService, :SharedCriterionService, :SharedSetService, :TargetingIdeaService, :TrafficEstimatorService ], :v201509 => [ :AccountLabelService, :AdCustomizerFeedService, :AdGroupAdService, :AdGroupBidModifierService, :AdGroupCriterionService, :AdGroupExtensionSettingService, :AdGroupFeedService, :AdGroupService, :AdParamService, :AdwordsUserListService, :BatchJobService, :BiddingStrategyService, :BudgetOrderService, :BudgetService, :CampaignCriterionService, :CampaignExtensionSettingService, :CampaignFeedService, :CampaignService, :CampaignSharedSetService, :ConstantDataService, :ConversionTrackerService, :CustomerExtensionSettingService, :CustomerFeedService, :CustomerService, :CustomerSyncService, :DataService, :ExperimentService, :FeedItemService, :FeedMappingService, :FeedService, :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/', :v201506 => 'https://adwords.google.com/api/adwords/', :v201509 => '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.
{ # v201506 [:v201506, :AccountLabelService] => 'mcm/', [:v201506, :AdCustomizerFeedService] => 'cm/', [:v201506, :AdGroupAdService] => 'cm/', [:v201506, :AdGroupBidModifierService] => 'cm/', [:v201506, :AdGroupCriterionService] => 'cm/', [:v201506, :AdGroupExtensionSettingService] => 'cm/', [:v201506, :AdGroupFeedService] => 'cm/', [:v201506, :AdGroupService] => 'cm/', [:v201506, :AdParamService] => 'cm/', [:v201506, :BudgetOrderService] => 'billing/', [:v201506, :CampaignCriterionService] => 'cm/', [:v201506, :CampaignExtensionSettingService] => 'cm/', [:v201506, :CampaignFeedService] => 'cm/', [:v201506, :CampaignService] => 'cm/', [:v201506, :CampaignSharedSetService] => 'cm/', [:v201506, :ConstantDataService] => 'cm/', [:v201506, :ConversionTrackerService] => 'cm/', [:v201506, :CustomerExtensionSettingService] => 'cm/', [:v201506, :CustomerSyncService] => 'ch/', [:v201506, :DataService] => 'cm/', [:v201506, :ExperimentService] => 'cm/', [:v201506, :FeedItemService] => 'cm/', [:v201506, :FeedMappingService] => 'cm/', [:v201506, :FeedService] => 'cm/', [:v201506, :GeoLocationService] => 'cm/', [:v201506, :LocationCriterionService] => 'cm/', [:v201506, :MediaService] => 'cm/', [:v201506, :MutateJobService] => 'cm/', [:v201506, :OfflineConversionFeedService] => 'cm/', [:v201506, :ReportDefinitionService] => 'cm/', [:v201506, :SharedCriterionService] => 'cm/', [:v201506, :SharedSetService] => 'cm/', [:v201506, :TargetingIdeaService] => 'o/', [:v201506, :TrafficEstimatorService] => 'o/', [:v201506, :ManagedCustomerService] => 'mcm/', [:v201506, :CustomerService] => 'mcm/', [:v201506, :CustomerFeedService] => 'cm/', [:v201506, :BudgetService] => 'cm/', [:v201506, :BiddingStrategyService] => 'cm/', [:v201506, :AdwordsUserListService] => 'rm/', [:v201506, :LabelService] => 'cm/', # v201509 [:v201509, :AccountLabelService] => 'mcm/', [:v201509, :AdCustomizerFeedService] => 'cm/', [:v201509, :AdGroupAdService] => 'cm/', [:v201509, :AdGroupBidModifierService] => 'cm/', [:v201509, :AdGroupCriterionService] => 'cm/', [:v201509, :AdGroupExtensionSettingService] => 'cm/', [:v201509, :AdGroupFeedService] => 'cm/', [:v201509, :AdGroupService] => 'cm/', [:v201509, :AdParamService] => 'cm/', [:v201509, :BatchJobService] => 'cm/', [:v201509, :BudgetOrderService] => 'billing/', [:v201509, :CampaignCriterionService] => 'cm/', [:v201509, :CampaignExtensionSettingService] => 'cm/', [:v201509, :CampaignFeedService] => 'cm/', [:v201509, :CampaignService] => 'cm/', [:v201509, :CampaignSharedSetService] => 'cm/', [:v201509, :ConstantDataService] => 'cm/', [:v201509, :ConversionTrackerService] => 'cm/', [:v201509, :CustomerExtensionSettingService] => 'cm/', [:v201509, :CustomerSyncService] => 'ch/', [:v201509, :DataService] => 'cm/', [:v201509, :ExperimentService] => 'cm/', [:v201509, :FeedItemService] => 'cm/', [:v201509, :FeedMappingService] => 'cm/', [:v201509, :FeedService] => 'cm/', [:v201509, :LocationCriterionService] => 'cm/', [:v201509, :MediaService] => 'cm/', [:v201509, :MutateJobService] => 'cm/', [:v201509, :OfflineConversionFeedService] => 'cm/', [:v201509, :ReportDefinitionService] => 'cm/', [:v201509, :SharedCriterionService] => 'cm/', [:v201509, :SharedSetService] => 'cm/', [:v201509, :TargetingIdeaService] => 'o/', [:v201509, :TrafficEstimatorService] => 'o/', [:v201509, :ManagedCustomerService] => 'mcm/', [:v201509, :CustomerService] => 'mcm/', [:v201509, :CustomerFeedService] => 'cm/', [:v201509, :BudgetService] => 'cm/', [:v201509, :BiddingStrategyService] => 'cm/', [:v201509, :AdwordsUserListService] => 'rm/', [:v201509, :LabelService] => 'cm/' }
Class Method Summary collapse
-
.adhoc_report_download_url(environment, version) ⇒ Object
Get the download URL for Ad Hoc reports.
- .api_name ⇒ Object
- .default_config_filename ⇒ Object
- .default_environment ⇒ Object
-
.default_version ⇒ Object
Getters for constants and module variables.
- .environment_config(environment, key) ⇒ Object
- .headers_config ⇒ Object
- .latest_version ⇒ Object
- .service_config ⇒ Object
- .subdir_config ⇒ Object
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)
282 283 284 285 286 287 288 |
# File 'lib/adwords_api/api_config.rb', line 282 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
248 249 250 |
# File 'lib/adwords_api/api_config.rb', line 248 def self.api_name API_NAME end |
.default_config_filename ⇒ Object
265 266 267 |
# File 'lib/adwords_api/api_config.rb', line 265 def self.default_config_filename DEFAULT_CONFIG_FILENAME end |
.default_environment ⇒ Object
240 241 242 |
# File 'lib/adwords_api/api_config.rb', line 240 def self.default_environment DEFAULT_ENVIRONMENT end |
.default_version ⇒ Object
Getters for constants and module variables.
236 237 238 |
# File 'lib/adwords_api/api_config.rb', line 236 def self.default_version DEFAULT_VERSION end |
.environment_config(environment, key) ⇒ Object
256 257 258 259 |
# File 'lib/adwords_api/api_config.rb', line 256 def self.environment_config(environment, key) return @@environment_config.include?(environment) ? @@environment_config[environment][key] : nil end |
.headers_config ⇒ Object
269 270 271 |
# File 'lib/adwords_api/api_config.rb', line 269 def self.headers_config @@headers_config end |
.latest_version ⇒ Object
244 245 246 |
# File 'lib/adwords_api/api_config.rb', line 244 def self.latest_version LATEST_VERSION end |
.service_config ⇒ Object
252 253 254 |
# File 'lib/adwords_api/api_config.rb', line 252 def self.service_config @@service_config end |
.subdir_config ⇒ Object
261 262 263 |
# File 'lib/adwords_api/api_config.rb', line 261 def self.subdir_config @@subdir_config end |