Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.AdManager.Lib.AdManagerAppConfig Class Reference

This class reads the configuration keys from App.config. More...

Inheritance diagram for Google.Api.Ads.AdManager.Lib.AdManagerAppConfig:
Google.Api.Ads.Common.Lib.AppConfigBase Google.Api.Ads.Common.Lib.AppConfig

Public Member Functions

override string GetUserAgent ()
 Gets a useragent string that can be used with the library. More...
 
 AdManagerAppConfig ()
 Public constructor. Loads the configuration from the More...
 
 AdManagerAppConfig (IConfigurationRoot configurationRoot)
 Public constructor. Loads the configuration from an IConfigurationRoot. More...
 
 AdManagerAppConfig (IConfigurationSection configurationSection)
 Public constructor. Loads the configuration from a IConfigurationSection. More...
 
override string GetDefaultOAuth2Scope ()
 Gets the default OAuth2 scope. More...
 
- Public Member Functions inherited from Google.Api.Ads.Common.Lib.AppConfigBase
 AppConfigBase ()
 The default constructor. More...
 
 AppConfigBase (IConfigurationRoot configurationRoot)
 Initializes a new instance of the AppConfigBase class. More...
 
 AppConfigBase (IConfigurationSection configurationSection)
 Initializes a new instance of the AppConfigBase class. More...
 
virtual object Clone ()
 Creates a new object that is a copy of the current instance. More...
 

Public Attributes

const string DEFAULT_APPLICATION_NAME = "INSERT_YOUR_APPLICATION_NAME_HERE"
 The default value for application name. More...
 

Protected Member Functions

override void ReadSettings (Dictionary< string, string > settings)
 Read all settings from App.config. More...
 
- Protected Member Functions inherited from Google.Api.Ads.Common.Lib.AppConfigBase
void LoadFromConfiguration (IConfiguration configuration, string sectionName)
 Initializes a new instance of the AppConfigBase class. More...
 
void LoadFromAppConfigSection (string sectionName)
 Attempts to load the configuration section with the given name. More...
 
void ReadSetting (Dictionary< string, string > settings, ConfigSetting settingField)
 Reads a setting from a given dictionary. More...
 
void SetPropertyAndNotify< T > (ConfigSetting< T > field, T newValue, [CallerMemberName] String propertyName="")
 Sets the specified property and notify any listeners. More...
 

Properties

string NetworkCode [get, set]
 Gets or sets networkCode to be used in SOAP headers. More...
 
string ApplicationName [get, set]
 Gets or sets application name to be used in SOAP headers. More...
 
string AdManagerApiServer [get, set]
 Gets or sets URL for Ad Manager API. More...
 
AdManagerAuthorizationMethod AuthorizationMethod [get, set]
 Gets or sets the authorization method to be used when making API calls. More...
 
- Properties inherited from Google.Api.Ads.Common.Lib.AppConfigBase
bool MaskCredentials [get, set]
 Gets or sets whether the credentials in the log file should be masked. More...
 
IWebProxy Proxy [get, set]
 Gets or sets the web proxy to be used with the services. More...
 
int Timeout [get, set]
 Gets or sets the timeout for Ads services in milliseconds. More...
 
int RetryCount [get, set]
 Gets or sets the number of times to retry a call if an API call fails and can be retried. More...
 
bool EnableGzipCompression [get, set]
 Gets or sets whether gzip compression should be turned on for SOAP requests and responses. More...
 
string OAuth2ServerUrl [get, set]
 Gets or sets the OAuth2 server URL. More...
 
string OAuth2ClientId [get, set]
 Gets or sets the OAuth2 client ID. More...
 
string OAuth2ClientSecret [get, set]
 Gets or sets the OAuth2 client secret. More...
 
string OAuth2AccessToken [get, set]
 Gets or sets the OAuth2 access token. More...
 
string OAuth2RefreshToken [get, set]
 Gets or sets the OAuth2 refresh token. More...
 
string OAuth2Scope [get, set]
 Gets or sets the OAuth2 scope. More...
 
string OAuth2RedirectUri [get, set]
 Gets or sets the OAuth2 redirect URI. More...
 
OAuth2Flow OAuth2Mode [get, set]
 Gets or sets the OAuth2 mode. More...
 
string OAuth2PrnEmail [get, set]
 Gets or sets the OAuth2 prn email. More...
 
string OAuth2ServiceAccountEmail [get, set]
 Gets the OAuth2 service account email. More...
 
string OAuth2PrivateKey [get, set]
 Gets the OAuth2 private key for service account flow. More...
 
string OAuth2SecretsJsonPath [get, set]
 Gets or sets the OAuth2 secrets JSON file path. More...
 
bool IncludeUtilitiesInUserAgent [get, set]
 Gets or sets whether usage of various client library features should be tracked. More...
 
string Signature [get]
 Gets the signature for this library. More...
 
virtual long UnixTimestamp [get]
 Gets the number of seconds after Jan 1, 1970, 00:00:00 More...
 
- Properties inherited from Google.Api.Ads.Common.Lib.AppConfig
bool MaskCredentials [get]
 Gets whether the credentials in the log file should be masked. More...
 
string OAuth2ServerUrl [get, set]
 Gets or sets the OAuth2 server URL. More...
 
OAuth2Flow OAuth2Mode [get, set]
 Gets or sets the OAuth2 mode. More...
 
string OAuth2AccessToken [get, set]
 Gets or sets the OAuth2 access token. More...
 
string OAuth2ClientId [get, set]
 Gets or sets the OAuth2 client id. More...
 
string OAuth2ClientSecret [get, set]
 Gets or sets the OAuth2 client secret. More...
 
string OAuth2RedirectUri [get, set]
 Gets or sets the OAuth2 redirect URI. More...
 
string OAuth2RefreshToken [get, set]
 OAuth2 refresh token. More...
 
string OAuth2Scope [get, set]
 Gets or sets the OAuth2 scope. More...
 
string OAuth2PrnEmail [get, set]
 Gets or sets the OAuth2 prn email. More...
 
string OAuth2SecretsJsonPath [get, set]
 Gets or sets the OAuth2 secrets JSON file. More...
 
string OAuth2PrivateKey [get]
 Gets the OAuth2 private key for service account flow. More...
 
string OAuth2ServiceAccountEmail [get]
 Gets the OAuth2 service account email. More...
 
bool IncludeUtilitiesInUserAgent [get, set]
 Gets or sets whether usage information of various client library features should be included in the user agent. More...
 
IWebProxy Proxy [get, set]
 Gets the web proxy to be used with the services. More...
 
int RetryCount [get, set]
 Gets or sets the number of times to retry a call if an API call fails and can be retried. More...
 
string Signature [get]
 Gets the signature for this library. More...
 
int Timeout [get, set]
 Gets or sets the timeout for Ads services in milliseconds. More...
 
bool EnableGzipCompression [get, set]
 Gets or sets whether gzip compression should be turned on for SOAP requests and responses. More...
 
long UnixTimestamp [get]
 Gets the number of seconds after Jan 1, 1970, 00:00:00 More...
 

Additional Inherited Members

- Events inherited from Google.Api.Ads.Common.Lib.AppConfigBase
PropertyChangedEventHandler PropertyChanged
 Occurs when a property value changes. More...
 
- Events inherited from Google.Api.Ads.Common.Lib.AppConfig
PropertyChangedEventHandler PropertyChanged
 Occurs when a property is changed. More...
 

Detailed Description

This class reads the configuration keys from App.config.

Constructor & Destructor Documentation

Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.AdManagerAppConfig ( )
inline

Public constructor. Loads the configuration from the

AdManagerApi section of the App.config / Web.config.

Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.AdManagerAppConfig ( IConfigurationRoot  configurationRoot)
inline

Public constructor. Loads the configuration from an IConfigurationRoot.

Parameters
configurationRootThe configuration root.
Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.AdManagerAppConfig ( IConfigurationSection  configurationSection)
inline

Public constructor. Loads the configuration from a IConfigurationSection.

Parameters
configurationSectionThe configuration section.

Member Function Documentation

override string Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.GetDefaultOAuth2Scope ( )
inlinevirtual

Gets the default OAuth2 scope.

Reimplemented from Google.Api.Ads.Common.Lib.AppConfigBase.

override string Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.GetUserAgent ( )
inlinevirtual

Gets a useragent string that can be used with the library.

Reimplemented from Google.Api.Ads.Common.Lib.AppConfigBase.

override void Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.ReadSettings ( Dictionary< string, string >  settings)
inlineprotectedvirtual

Read all settings from App.config.

Parameters
settingsThe parsed App.config settings.

Reimplemented from Google.Api.Ads.Common.Lib.AppConfigBase.

Member Data Documentation

const string Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.DEFAULT_APPLICATION_NAME = "INSERT_YOUR_APPLICATION_NAME_HERE"

The default value for application name.

Property Documentation

string Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.AdManagerApiServer
getset

Gets or sets URL for Ad Manager API.

Referenced by Google.Api.Ads.AdManager.Lib.AdManagerServiceFactory.CreateService().

string Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.ApplicationName
getset

Gets or sets application name to be used in SOAP headers.

AdManagerAuthorizationMethod Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.AuthorizationMethod
getset
string Google.Api.Ads.AdManager.Lib.AdManagerAppConfig.NetworkCode
getset

Gets or sets networkCode to be used in SOAP headers.


The documentation for this class was generated from the following file: