com.google.api.ads.common.lib.auth

Class OfflineCredentials

java.lang.Object

com.google.api.ads.common.lib.auth.OfflineCredentials

public class OfflineCredentials
extends Object

OfflineCredentials offline OAuth2 provider.

Example usage:

 Credential credential = new OfflineCredentials.Builder()
     .forApi(OfflineCredentials.Api.ADWORDS)
     .fromFile()
     .build()
     .generateCredential();
 

This can be also used instead of service accounts. Generate a refresh token once and place it in your ads.properties file to be read by this utility.

Author:

Adam Rogal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OfflineCredentials.Api Enum representing the API that OfflineCredentials can be used for.
static class	OfflineCredentials.Builder Pre-builder for OfflineCredentials.
static class	OfflineCredentials.ForApiBuilder Builder for OfflineCredentials.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.auth.oauth2.Credential	generateCredential() Generates a new offline credential and immediately refreshes it.
String	getClientId()
String	getClientSecret()
com.google.api.client.http.HttpTransport	getHttpTransport()
String	getRefreshToken()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getHttpTransport

public com.google.api.client.http.HttpTransport getHttpTransport()

getRefreshToken

public String getRefreshToken()

getClientId

public String getClientId()

getClientSecret

public String getClientSecret()

generateCredential

public com.google.api.client.auth.oauth2.Credential generateCredential()
                                                                throws OAuthException

Generates a new offline credential and immediately refreshes it.

Returns:

a newly refreshed offline credential.

Throws:

OAuthException - if the credential could not be refreshed.