Google.Api.Ads.Common.Lib.AdsOAuthProvider Interface Reference

Provides OAuth authorization mechanism for Ads services. More...

Inheritance diagram for Google.Api.Ads.Common.Lib.AdsOAuthProvider:

Public Member Functions
void	RefreshAccessToken ()
	Refreshes the access token if expiring. More...
void	RefreshAccessTokenIfExpiring ()
	Refreshes the access token if expiring. More...
string	GetAuthHeader ()
	Gets the OAuth authorization header to be used with HTTP requests. More...

Properties
string	ClientId [get, set]
	Gets or sets the client that is making the request. This value is obtained from the API console during application registration. More...
string	ClientSecret [get, set]
	Gets or sets the client secret obtained from the API console during application registration.during application registration. More...
string	Scope [get, set]
	Gets or sets the API access your application is requesting. This is space delimited. More...
string	State [get, set]
	Gets or sets a parameter that your application can use for keeping state. The OAuth Authorization Server roundtrips this parameter. More...
string	TokenType [get]
	Gets the type of token returned by the server. This field will always have the value Bearer for now. More...
string	AccessToken [get, set]
	Gets or sets the token that can be sent to a Google API for authentication. More...
DateTime	UpdatedOn [get, set]
	Gets or sets the time at which access token was retrieved. More...
int	ExpiresIn [get, set]
	Gets the remaining lifetime on the access token. More...
OAuthTokensObtainedCallback	OnOAuthTokensObtained [get]
	Callback triggered when this provider obtains a new access token or refresh token from the OAuth server. More...
Properties inherited from Google.Api.Ads.Common.Lib.Configurable
AppConfig	Config [get]
	Gets the application configuration class for this object. More...

Detailed Description

Provides OAuth authorization mechanism for Ads services.

Member Function Documentation

string Google.Api.Ads.Common.Lib.AdsOAuthProvider.GetAuthHeader

(

)

Gets the OAuth authorization header to be used with HTTP requests.

Returns

The authorization header.

Implemented in Google.Api.Ads.Common.OAuth.AdsOAuthProviderImpl.

void Google.Api.Ads.Common.Lib.AdsOAuthProvider.RefreshAccessToken

(

)

Refreshes the access token if expiring.

Implemented in Google.Api.Ads.Common.OAuth.AdsOAuthProviderImpl.

void Google.Api.Ads.Common.Lib.AdsOAuthProvider.RefreshAccessTokenIfExpiring

(

)

Refreshes the access token if expiring.

Implemented in Google.Api.Ads.Common.OAuth.AdsOAuthProviderImpl.

Property Documentation

string Google.Api.Ads.Common.Lib.AdsOAuthProvider.AccessToken

getset

Gets or sets the token that can be sent to a Google API for authentication.

string Google.Api.Ads.Common.Lib.AdsOAuthProvider.ClientId

getset

Gets or sets the client that is making the request. This value is obtained from the API console during application registration.

string Google.Api.Ads.Common.Lib.AdsOAuthProvider.ClientSecret

getset

Gets or sets the client secret obtained from the API console during application registration.during application registration.

int Google.Api.Ads.Common.Lib.AdsOAuthProvider.ExpiresIn

getset

Gets the remaining lifetime on the access token.

OAuthTokensObtainedCallback Google.Api.Ads.Common.Lib.AdsOAuthProvider.OnOAuthTokensObtained

get

Callback triggered when this provider obtains a new access token or refresh token from the OAuth server.

string Google.Api.Ads.Common.Lib.AdsOAuthProvider.Scope

getset

Gets or sets the API access your application is requesting. This is space delimited.

string Google.Api.Ads.Common.Lib.AdsOAuthProvider.State

getset

Gets or sets a parameter that your application can use for keeping state. The OAuth Authorization Server roundtrips this parameter.

string Google.Api.Ads.Common.Lib.AdsOAuthProvider.TokenType

get

Gets the type of token returned by the server. This field will always have the value Bearer for now.

DateTime Google.Api.Ads.Common.Lib.AdsOAuthProvider.UpdatedOn

getset

Gets or sets the time at which access token was retrieved.

---

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

• dist/github/src/Common/OAuth/AdsOAuthInterfaces.cs