AuthenticationErrorReason (AdWords AppEngine components 4.21.0 API)

java.lang.Object
- java.lang.Enum<AuthenticationErrorReason>
- - com.google.api.ads.adwords.jaxws.v201809.cm.AuthenticationErrorReason

All Implemented Interfaces:: Serializable, Comparable<AuthenticationErrorReason>

public enum AuthenticationErrorReason
extends Enum<AuthenticationErrorReason>

Java class for AuthenticationError.Reason.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="AuthenticationError.Reason">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="AUTHENTICATION_FAILED"/>
     <enumeration value="CLIENT_CUSTOMER_ID_IS_REQUIRED"/>
     <enumeration value="CLIENT_EMAIL_REQUIRED"/>
     <enumeration value="CLIENT_CUSTOMER_ID_INVALID"/>
     <enumeration value="CLIENT_EMAIL_INVALID"/>
     <enumeration value="CLIENT_EMAIL_FAILED_TO_AUTHENTICATE"/>
     <enumeration value="CUSTOMER_NOT_FOUND"/>
     <enumeration value="GOOGLE_ACCOUNT_DELETED"/>
     <enumeration value="GOOGLE_ACCOUNT_COOKIE_INVALID"/>
     <enumeration value="FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT"/>
     <enumeration value="GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH"/>
     <enumeration value="LOGIN_COOKIE_REQUIRED"/>
     <enumeration value="NOT_ADS_USER"/>
     <enumeration value="OAUTH_TOKEN_INVALID"/>
     <enumeration value="OAUTH_TOKEN_EXPIRED"/>
     <enumeration value="OAUTH_TOKEN_DISABLED"/>
     <enumeration value="OAUTH_TOKEN_REVOKED"/>
     <enumeration value="OAUTH_TOKEN_HEADER_INVALID"/>
     <enumeration value="LOGIN_COOKIE_INVALID"/>
     <enumeration value="FAILED_TO_RETRIEVE_LOGIN_COOKIE"/>
     <enumeration value="USER_ID_INVALID"/>
   </restriction>
 </simpleType>

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AUTHENTICATION_FAILED` Authentication of the request failed.
`CLIENT_CUSTOMER_ID_INVALID` Client customer Id is not a number.
`CLIENT_CUSTOMER_ID_IS_REQUIRED` Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID.
`CLIENT_EMAIL_FAILED_TO_AUTHENTICATE` Client email is not a valid customer email.
`CLIENT_EMAIL_INVALID` Client customer Id is not a number.
`CLIENT_EMAIL_REQUIRED` Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
`CUSTOMER_NOT_FOUND` No customer found for the customer id provided in the header.
`FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT` problem occurred during Google account authentication.
`FAILED_TO_RETRIEVE_LOGIN_COOKIE` Failed to decrypt the login cookie.
`GOOGLE_ACCOUNT_COOKIE_INVALID` Google account login token in the cookie is invalid.
`GOOGLE_ACCOUNT_DELETED` Client's Google Account is deleted.
`GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH` The user in the google account login token does not match the UserId in the cookie.
`LOGIN_COOKIE_INVALID` Login cookie is not valid.
`LOGIN_COOKIE_REQUIRED` Login cookie is required for authentication.
`NOT_ADS_USER` User in the cookie is not a valid Ads user.
`OAUTH_TOKEN_DISABLED` Oauth token in the header has been disabled.
`OAUTH_TOKEN_EXPIRED` Oauth token in the header has expired.
`OAUTH_TOKEN_HEADER_INVALID` Oauth token HTTP header is malformed.
`OAUTH_TOKEN_INVALID` Oauth token in the header is not valid.
`OAUTH_TOKEN_REVOKED` Oauth token in the header has been revoked.
`USER_ID_INVALID` User Id in the header is not a valid id.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AuthenticationErrorReason`	`fromValue(String v)`
`String`	`value()`
`static AuthenticationErrorReason`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AuthenticationErrorReason[]`	`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
  - AUTHENTICATION_FAILED
```
public static final AuthenticationErrorReason AUTHENTICATION_FAILED
```
    Authentication of the request failed.
  - CLIENT_CUSTOMER_ID_IS_REQUIRED
```
public static final AuthenticationErrorReason CLIENT_CUSTOMER_ID_IS_REQUIRED
```
    Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService#get
  - CLIENT_EMAIL_REQUIRED
```
public static final AuthenticationErrorReason CLIENT_EMAIL_REQUIRED
```
    Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
  - CLIENT_CUSTOMER_ID_INVALID
```
public static final AuthenticationErrorReason CLIENT_CUSTOMER_ID_INVALID
```
    Client customer Id is not a number.
  - CLIENT_EMAIL_INVALID
```
public static final AuthenticationErrorReason CLIENT_EMAIL_INVALID
```
    Client customer Id is not a number.
  - CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
```
public static final AuthenticationErrorReason CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
```
    Client email is not a valid customer email.
  - CUSTOMER_NOT_FOUND
```
public static final AuthenticationErrorReason CUSTOMER_NOT_FOUND
```
    No customer found for the customer id provided in the header.
  - GOOGLE_ACCOUNT_DELETED
```
public static final AuthenticationErrorReason GOOGLE_ACCOUNT_DELETED
```
    Client's Google Account is deleted.
  - GOOGLE_ACCOUNT_COOKIE_INVALID
```
public static final AuthenticationErrorReason GOOGLE_ACCOUNT_COOKIE_INVALID
```
    Google account login token in the cookie is invalid.
  - FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
```
public static final AuthenticationErrorReason FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
```
    problem occurred during Google account authentication.
  - GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
```
public static final AuthenticationErrorReason GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
```
    The user in the google account login token does not match the UserId in the cookie.
  - LOGIN_COOKIE_REQUIRED
```
public static final AuthenticationErrorReason LOGIN_COOKIE_REQUIRED
```
    Login cookie is required for authentication.
  - NOT_ADS_USER
```
public static final AuthenticationErrorReason NOT_ADS_USER
```
    User in the cookie is not a valid Ads user.
  - OAUTH_TOKEN_INVALID
```
public static final AuthenticationErrorReason OAUTH_TOKEN_INVALID
```
    Oauth token in the header is not valid.
  - OAUTH_TOKEN_EXPIRED
```
public static final AuthenticationErrorReason OAUTH_TOKEN_EXPIRED
```
    Oauth token in the header has expired.
  - OAUTH_TOKEN_DISABLED
```
public static final AuthenticationErrorReason OAUTH_TOKEN_DISABLED
```
    Oauth token in the header has been disabled.
  - OAUTH_TOKEN_REVOKED
```
public static final AuthenticationErrorReason OAUTH_TOKEN_REVOKED
```
    Oauth token in the header has been revoked.
  - OAUTH_TOKEN_HEADER_INVALID
```
public static final AuthenticationErrorReason OAUTH_TOKEN_HEADER_INVALID
```
    Oauth token HTTP header is malformed.
  - LOGIN_COOKIE_INVALID
```
public static final AuthenticationErrorReason LOGIN_COOKIE_INVALID
```
    Login cookie is not valid.
  - FAILED_TO_RETRIEVE_LOGIN_COOKIE
```
public static final AuthenticationErrorReason FAILED_TO_RETRIEVE_LOGIN_COOKIE
```
    Failed to decrypt the login cookie.
  - USER_ID_INVALID
```
public static final AuthenticationErrorReason USER_ID_INVALID
```
    User Id in the header is not a valid id.
- Method Detail
  - values
```
public static AuthenticationErrorReason[] 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 (AuthenticationErrorReason c : AuthenticationErrorReason.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AuthenticationErrorReason 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
  - value
```
public String value()
```
  - fromValue
```
public static AuthenticationErrorReason fromValue(String v)
```

Enum AuthenticationErrorReason

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AUTHENTICATION_FAILED

CLIENT_CUSTOMER_ID_IS_REQUIRED

CLIENT_EMAIL_REQUIRED

CLIENT_CUSTOMER_ID_INVALID

CLIENT_EMAIL_INVALID

CLIENT_EMAIL_FAILED_TO_AUTHENTICATE

CUSTOMER_NOT_FOUND

GOOGLE_ACCOUNT_DELETED

GOOGLE_ACCOUNT_COOKIE_INVALID

FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT

GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH

LOGIN_COOKIE_REQUIRED

NOT_ADS_USER

OAUTH_TOKEN_INVALID

OAUTH_TOKEN_EXPIRED

OAUTH_TOKEN_DISABLED

OAUTH_TOKEN_REVOKED

OAUTH_TOKEN_HEADER_INVALID

LOGIN_COOKIE_INVALID

FAILED_TO_RETRIEVE_LOGIN_COOKIE

USER_ID_INVALID

Method Detail

values

valueOf

value

fromValue