Module: AdManagerApi::ApiConfig

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

Overview

Contains helper methods for loading and managing the available services.

Constant Summary collapse

CLIENT_LIB_VERSION = 
'3.0.0'
DEFAULT_VERSION =

Set defaults

:v202402
LATEST_VERSION = 
:v202402
API_NAME =

Set other constants

'AdManagerApi'
DEFAULT_CONFIG_FILENAME = 
'ad_manager_api.yml'
@@service_config =

Configure the services available to each version

{
  :v202305 => [:ActivityGroupService, :ActivityService,
               :AdjustmentService, :AdRuleService, :AudienceSegmentService,
               :CompanyService, :CdnConfigurationService,
               :CmsMetadataService, :ContactService, :ContentBundleService,
               :ContentService, :CreativeReviewService, :CreativeService,
               :CreativeSetService, :CreativeTemplateService,
               :CreativeWrapperService, :CustomFieldService,
               :CustomTargetingService, :DaiAuthenticationKeyService,
               :DaiEncodingProfileService, :ForecastService,
               :InventoryService, :LabelService,
               :LineItemCreativeAssociationService, :LineItemService,
               :LineItemTemplateService, :LiveStreamEventService,
               :MobileApplicationService, :NativeStyleService,
               :NetworkService, :OrderService, :PlacementService,
               :ProposalLineItemService, :ProposalService,
               :PublisherQueryLanguageService, :ReportService,
               :SegmentPopulationService, :SiteService,
               :StreamActivityMonitorService, :SuggestedAdUnitService,
               :TargetingPresetService, :TeamService, :UserService,
               :UserTeamAssociationService ,:YieldGroupService],
  :v202308 => [:ActivityGroupService, :ActivityService,
               :AdjustmentService, :AdRuleService, :AudienceSegmentService,
               :CompanyService, :CdnConfigurationService,
               :CmsMetadataService, :ContactService, :ContentBundleService,
               :ContentService, :CreativeReviewService, :CreativeService,
               :CreativeSetService, :CreativeTemplateService,
               :CreativeWrapperService, :CustomFieldService,
               :CustomTargetingService, :DaiAuthenticationKeyService,
               :DaiEncodingProfileService, :ForecastService,
               :InventoryService, :LabelService,
               :LineItemCreativeAssociationService, :LineItemService,
               :LineItemTemplateService, :LiveStreamEventService,
               :MobileApplicationService, :NativeStyleService,
               :NetworkService, :OrderService, :PlacementService,
               :ProposalLineItemService, :ProposalService,
               :PublisherQueryLanguageService, :ReportService,
               :SegmentPopulationService, :SiteService,
               :StreamActivityMonitorService, :SuggestedAdUnitService,
               :TargetingPresetService, :TeamService, :UserService,
               :UserTeamAssociationService ,:YieldGroupService],
  :v202311 => [:ActivityGroupService, :ActivityService,
               :AdjustmentService, :AdRuleService, :AudienceSegmentService,
               :CompanyService, :CdnConfigurationService,
               :CmsMetadataService, :ContactService, :ContentBundleService,
               :ContentService, :CreativeReviewService, :CreativeService,
               :CreativeSetService, :CreativeTemplateService,
               :CreativeWrapperService, :CustomFieldService,
               :CustomTargetingService, :DaiAuthenticationKeyService,
               :DaiEncodingProfileService, :ForecastService,
               :InventoryService, :LabelService,
               :LineItemCreativeAssociationService, :LineItemService,
               :LineItemTemplateService, :LiveStreamEventService,
               :MobileApplicationService, :NativeStyleService,
               :NetworkService, :OrderService, :PlacementService,
               :ProposalLineItemService, :ProposalService,
               :PublisherQueryLanguageService, :ReportService,
               :SegmentPopulationService, :SiteService,
               :StreamActivityMonitorService, :SuggestedAdUnitService,
               :TargetingPresetService, :TeamService, :UserService,
               :UserTeamAssociationService ,:YieldGroupService],
  :v202402 => [:ActivityGroupService, :ActivityService,
               :AdjustmentService, :AdRuleService, :AudienceSegmentService,
               :CompanyService, :CdnConfigurationService,
               :CmsMetadataService, :ContactService, :ContentBundleService,
               :ContentService, :CreativeService,
               :CreativeSetService, :CreativeTemplateService,
               :CreativeWrapperService, :CustomFieldService,
               :CustomTargetingService, :DaiAuthenticationKeyService,
               :DaiEncodingProfileService, :ForecastService,
               :InventoryService, :LabelService,
               :LineItemCreativeAssociationService, :LineItemService,
               :LineItemTemplateService, :LiveStreamEventService,
               :MobileApplicationService, :NativeStyleService,
               :NetworkService, :OrderService, :PlacementService,
               :ProposalLineItemService, :ProposalService,
               :PublisherQueryLanguageService, :ReportService,
               :SegmentPopulationService, :SiteService,
               :StreamActivityMonitorService, :SuggestedAdUnitService,
               :TargetingPresetService, :TeamService, :UserService,
               :UserTeamAssociationService ,:YieldGroupService]
}
@@config =

Configure the base URL for each version and scope.

{
  :oauth_scope => 'https://www.googleapis.com/auth/dfp',
  :header_ns => 'https://www.google.com/apis/ads/publisher/',
  :v202305 => 'https://ads.google.com/apis/ads/publisher/',
  :v202308 => 'https://ads.google.com/apis/ads/publisher/',
  :v202311 => 'https://ads.google.com/apis/ads/publisher/',
  :v202402 => 'https://ads.google.com/apis/ads/publisher/',
}

Class Method Summary collapse

Class Method Details

.api_name ⇒ Object 



146
147
148
 
# File 'lib/ad_manager_api/api_config.rb', line 146

def self.api_name
  API_NAME
end

.config(key) ⇒ Object 



154
155
156
 
# File 'lib/ad_manager_api/api_config.rb', line 154

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

.default_config_filename ⇒ Object 



162
163
164
 
# File 'lib/ad_manager_api/api_config.rb', line 162

def self.default_config_filename
  DEFAULT_CONFIG_FILENAME
end

.default_version ⇒ Object

Getters for constants and module variables.



138
139
140
 
# File 'lib/ad_manager_api/api_config.rb', line 138

def self.default_version
  DEFAULT_VERSION
end

.latest_version ⇒ Object 



142
143
144
 
# File 'lib/ad_manager_api/api_config.rb', line 142

def self.latest_version
  LATEST_VERSION
end

.service_config ⇒ Object 



150
151
152
 
# File 'lib/ad_manager_api/api_config.rb', line 150

def self.service_config
  @@service_config
end

.subdir_config ⇒ Object 



158
159
160
 
# File 'lib/ad_manager_api/api_config.rb', line 158

def self.subdir_config
  nil
end