Package com.google.ads.googleads.lib
Enum GoogleAdsClient.Builder.AdsEnvironmentVariable
- java.lang.Object
-
- java.lang.Enum<GoogleAdsClient.Builder.AdsEnvironmentVariable>
-
- com.google.ads.googleads.lib.GoogleAdsClient.Builder.AdsEnvironmentVariable
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<GoogleAdsClient.Builder.AdsEnvironmentVariable>
- Enclosing class:
- GoogleAdsClient.Builder
public static enum GoogleAdsClient.Builder.AdsEnvironmentVariable extends java.lang.Enum<GoogleAdsClient.Builder.AdsEnvironmentVariable>
Enumeration of the environment variables that can be used to configure aGoogleAdsClient.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description GOOGLE_ADS_CLIENT_IDClient ID for installed app/web flow credentials.GOOGLE_ADS_CLIENT_SECRETClient secret for installed app/web flow credentials.GOOGLE_ADS_CONFIGURATION_FILE_PATHPath, including the file name, from which the client configuration file should be read.GOOGLE_ADS_DEVELOPER_TOKENGoogle Ads API developer token.GOOGLE_ADS_ENDPOINTGoogle Ads API endpoint.GOOGLE_ADS_IMPERSONATED_EMAILService account user to impersonate for service account credentials.GOOGLE_ADS_JSON_KEY_FILE_PATHPath to the JSON key (secrets) file for service account credentials.GOOGLE_ADS_LINKED_CUSTOMER_IDLinked customer ID.GOOGLE_ADS_LOGIN_CUSTOMER_IDLogin customer ID.GOOGLE_ADS_REFRESH_TOKENRefresh token for installed app/web flow credentials.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static GoogleAdsClient.Builder.AdsEnvironmentVariablevalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static GoogleAdsClient.Builder.AdsEnvironmentVariable[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
GOOGLE_ADS_CONFIGURATION_FILE_PATH
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_CONFIGURATION_FILE_PATH
Path, including the file name, from which the client configuration file should be read. Overrides the default location of the user's home directory and default file name of "ads.properties".
-
GOOGLE_ADS_CLIENT_ID
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_CLIENT_ID
Client ID for installed app/web flow credentials.
-
GOOGLE_ADS_CLIENT_SECRET
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_CLIENT_SECRET
Client secret for installed app/web flow credentials.
-
GOOGLE_ADS_REFRESH_TOKEN
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_REFRESH_TOKEN
Refresh token for installed app/web flow credentials.
-
GOOGLE_ADS_JSON_KEY_FILE_PATH
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_JSON_KEY_FILE_PATH
Path to the JSON key (secrets) file for service account credentials.
-
GOOGLE_ADS_IMPERSONATED_EMAIL
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_IMPERSONATED_EMAIL
Service account user to impersonate for service account credentials.
-
GOOGLE_ADS_DEVELOPER_TOKEN
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_DEVELOPER_TOKEN
Google Ads API developer token.
-
GOOGLE_ADS_LOGIN_CUSTOMER_ID
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_LOGIN_CUSTOMER_ID
Login customer ID.
-
GOOGLE_ADS_LINKED_CUSTOMER_ID
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_LINKED_CUSTOMER_ID
Linked customer ID.
-
GOOGLE_ADS_ENDPOINT
public static final GoogleAdsClient.Builder.AdsEnvironmentVariable GOOGLE_ADS_ENDPOINT
Google Ads API endpoint. Overrides the default endpoint of "googleads.googleapis.com:443".
-
-
Method Detail
-
values
public static GoogleAdsClient.Builder.AdsEnvironmentVariable[] 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 (GoogleAdsClient.Builder.AdsEnvironmentVariable c : GoogleAdsClient.Builder.AdsEnvironmentVariable.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static GoogleAdsClient.Builder.AdsEnvironmentVariable valueOf(java.lang.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:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
-