Ads API .NET library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Google.Api.Ads.Common.Lib.AppConfig Interface Reference

Interface for common configuration properties. More...

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

Public Member Functions

string GetDefaultOAuth2Scope ()
 Gets the default OAuth2 scope. More...
 
string GetUserAgent ()
 Gets the user agent text. More...
 

Properties

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...
 

Events

PropertyChangedEventHandler PropertyChanged
 Occurs when a property is changed. More...
 

Detailed Description

Interface for common configuration properties.

Member Function Documentation

string Google.Api.Ads.Common.Lib.AppConfig.GetDefaultOAuth2Scope ( )
string Google.Api.Ads.Common.Lib.AppConfig.GetUserAgent ( )

Property Documentation

bool Google.Api.Ads.Common.Lib.AppConfig.EnableGzipCompression
getset

Gets or sets whether gzip compression should be turned on for SOAP requests and responses.

Referenced by Google.Api.Ads.Common.Util.HttpUtilities.BuildRequest().

bool Google.Api.Ads.Common.Lib.AppConfig.IncludeUtilitiesInUserAgent
getset

Gets or sets whether usage information of various client library features should be included in the user agent.

bool Google.Api.Ads.Common.Lib.AppConfig.MaskCredentials
get

Gets whether the credentials in the log file should be masked.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2AccessToken
getset

Gets or sets the OAuth2 access token.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2ClientId
getset

Gets or sets the OAuth2 client id.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2ClientSecret
getset

Gets or sets the OAuth2 client secret.

OAuth2Flow Google.Api.Ads.Common.Lib.AppConfig.OAuth2Mode
getset

Gets or sets the OAuth2 mode.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2PrivateKey
get

Gets the OAuth2 private key for service account flow.

This setting is applicable only when using OAuth2 service accounts. This setting is read directly from the file referred to in OAuth2SecretsJsonPath setting.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2PrnEmail
getset

Gets or sets the OAuth2 prn email.

This setting is applicable only when using OAuth2 service accounts.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2RedirectUri
getset

Gets or sets the OAuth2 redirect URI.

This setting is applicable only when using OAuth2 web flow.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2RefreshToken
getset

OAuth2 refresh token.

This setting is applicable only when using OAuth2 web / application flow in offline mode.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2Scope
getset

Gets or sets the OAuth2 scope.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2SecretsJsonPath
getset

Gets or sets the OAuth2 secrets JSON file.

This setting is applicable only when using OAuth2 service accounts.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2ServerUrl
getset

Gets or sets the OAuth2 server URL.

This property is primarily used only for testing purposes.

string Google.Api.Ads.Common.Lib.AppConfig.OAuth2ServiceAccountEmail
get

Gets the OAuth2 service account email.

This setting is applicable only when using OAuth2 service accounts. This property is read directly from the file pointed to by OAuth2SecretsJsonPath property.

IWebProxy Google.Api.Ads.Common.Lib.AppConfig.Proxy
getset

Gets the web proxy to be used with the services.

int Google.Api.Ads.Common.Lib.AppConfig.RetryCount
getset

Gets or sets the number of times to retry a call if an API call fails and can be retried.

string Google.Api.Ads.Common.Lib.AppConfig.Signature
get

Gets the signature for this library.

int Google.Api.Ads.Common.Lib.AppConfig.Timeout
getset

Gets or sets the timeout for Ads services in milliseconds.

long Google.Api.Ads.Common.Lib.AppConfig.UnixTimestamp
get

Gets the number of seconds after Jan 1, 1970, 00:00:00

Event Documentation

PropertyChangedEventHandler Google.Api.Ads.Common.Lib.AppConfig.PropertyChanged

Occurs when a property is changed.


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