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

Enum OfflineCredentials.Api

java.lang.Object

java.lang.Enum<OfflineCredentials.Api>

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

All Implemented Interfaces:

OfflineCredentials.OAuthConfig, Serializable, Comparable<OfflineCredentials.Api>

Enclosing class:

OfflineCredentials

public static enum OfflineCredentials.Api
extends Enum<OfflineCredentials.Api>
implements OfflineCredentials.OAuthConfig

Enum representing the API that OfflineCredentials can be used for.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADWORDS
DFP

Method Summary

Modifier and Type	Method and Description
Internals	getInternals() Returns the internals object for the API that has the OAuth helper.
String	getPropertyKeyPrefix() Returns the property key prefix.
String	getScope() Returns the API OAuth scope.
static OfflineCredentials.Api	valueOf(String name) Returns the enum constant of this type with the specified name.
static OfflineCredentials.Api[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADWORDS

public static final OfflineCredentials.Api ADWORDS

DFP

public static final OfflineCredentials.Api DFP

Method Detail

values

public static OfflineCredentials.Api[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OfflineCredentials.Api c : OfflineCredentials.Api.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OfflineCredentials.Api valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getPropertyKeyPrefix

public String getPropertyKeyPrefix()

Description copied from interface: OfflineCredentials.OAuthConfig

Returns the property key prefix. This is the prefix that is in the properties file e.g. api.adwords

Specified by:

getPropertyKeyPrefix in interface OfflineCredentials.OAuthConfig

getScope

public String getScope()

Description copied from interface: OfflineCredentials.OAuthConfig

Returns the API OAuth scope.

Specified by:

getScope in interface OfflineCredentials.OAuthConfig

getInternals

public Internals getInternals()

Description copied from interface: OfflineCredentials.OAuthConfig

Returns the internals object for the API that has the OAuth helper.

Specified by:

getInternals in interface OfflineCredentials.OAuthConfig