Package com.google.ads.googleads.v18.errors

Enum Class AuthorizationErrorEnum.AuthorizationError

java.lang.Object
java.lang.Enum<AuthorizationErrorEnum.AuthorizationError>
com.google.ads.googleads.v18.errors.AuthorizationErrorEnum.AuthorizationError
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<AuthorizationErrorEnum.AuthorizationError>, Constable
Enclosing class:
AuthorizationErrorEnum
public static enum AuthorizationErrorEnum.AuthorizationError extends Enum<AuthorizationErrorEnum.AuthorizationError> implements com.google.protobuf.ProtocolMessageEnum
 Enum describing possible authorization errors.
Protobuf enum google.ads.googleads.v18.errors.AuthorizationErrorEnum.AuthorizationError

  • Enum Constant Details

    • UNSPECIFIED

      public static final AuthorizationErrorEnum.AuthorizationError UNSPECIFIED
       Enum unspecified.
      UNSPECIFIED = 0;

    • UNKNOWN

      public static final AuthorizationErrorEnum.AuthorizationError UNKNOWN
       The received error code is not known in this version.
      UNKNOWN = 1;

    • USER_PERMISSION_DENIED

      public static final AuthorizationErrorEnum.AuthorizationError USER_PERMISSION_DENIED
       User doesn't have permission to access customer. Note: If you're
 accessing a client customer, the manager's customer ID must be set in the
 `login-customer-id` header. Learn more at
 https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid
      USER_PERMISSION_DENIED = 2;

    • DEVELOPER_TOKEN_NOT_ON_ALLOWLIST

      public static final AuthorizationErrorEnum.AuthorizationError DEVELOPER_TOKEN_NOT_ON_ALLOWLIST
       The developer token is not on the allow-list.
      DEVELOPER_TOKEN_NOT_ON_ALLOWLIST = 13;

    • DEVELOPER_TOKEN_PROHIBITED

      public static final AuthorizationErrorEnum.AuthorizationError DEVELOPER_TOKEN_PROHIBITED
       The developer token is not allowed with the project sent in the request.
      DEVELOPER_TOKEN_PROHIBITED = 4;

    • PROJECT_DISABLED

      public static final AuthorizationErrorEnum.AuthorizationError PROJECT_DISABLED
       The Google Cloud project sent in the request does not have permission to
 access the api.
      PROJECT_DISABLED = 5;

    • AUTHORIZATION_ERROR

      public static final AuthorizationErrorEnum.AuthorizationError AUTHORIZATION_ERROR
       Authorization of the client failed.
      AUTHORIZATION_ERROR = 6;

    • ACTION_NOT_PERMITTED

      public static final AuthorizationErrorEnum.AuthorizationError ACTION_NOT_PERMITTED
       The user does not have permission to perform this action
 (for example, ADD, UPDATE, REMOVE) on the resource or call a method.
      ACTION_NOT_PERMITTED = 7;

    • INCOMPLETE_SIGNUP

      public static final AuthorizationErrorEnum.AuthorizationError INCOMPLETE_SIGNUP
       Signup not complete.
      INCOMPLETE_SIGNUP = 8;

    • CUSTOMER_NOT_ENABLED

      public static final AuthorizationErrorEnum.AuthorizationError CUSTOMER_NOT_ENABLED
       The customer account can't be accessed because it is not yet enabled or
 has been deactivated.
      CUSTOMER_NOT_ENABLED = 24;

    • MISSING_TOS

      public static final AuthorizationErrorEnum.AuthorizationError MISSING_TOS
       The developer must sign the terms of service. They can be found here:
 ads.google.com/aw/apicenter
      MISSING_TOS = 9;

    • DEVELOPER_TOKEN_NOT_APPROVED

      public static final AuthorizationErrorEnum.AuthorizationError DEVELOPER_TOKEN_NOT_APPROVED
       The developer token is only approved for use with test accounts. To
 access non-test accounts, apply for Basic or Standard access.
      DEVELOPER_TOKEN_NOT_APPROVED = 10;

    • INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION

      public static final AuthorizationErrorEnum.AuthorizationError INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION
       The login customer specified does not have access to the account
 specified, so the request is invalid.
      INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION = 11;

    • SERVICE_ACCESS_DENIED

      public static final AuthorizationErrorEnum.AuthorizationError SERVICE_ACCESS_DENIED
       The developer specified does not have access to the service.
      SERVICE_ACCESS_DENIED = 12;

    • ACCESS_DENIED_FOR_ACCOUNT_TYPE

      public static final AuthorizationErrorEnum.AuthorizationError ACCESS_DENIED_FOR_ACCOUNT_TYPE
       The customer (or login customer) isn't in Google Ads. It belongs to
 another ads system.
      ACCESS_DENIED_FOR_ACCOUNT_TYPE = 25;

    • METRIC_ACCESS_DENIED

      public static final AuthorizationErrorEnum.AuthorizationError METRIC_ACCESS_DENIED
       The developer does not have access to the metrics queried.
      METRIC_ACCESS_DENIED = 26;

    • CLOUD_PROJECT_NOT_UNDER_ORGANIZATION

      public static final AuthorizationErrorEnum.AuthorizationError CLOUD_PROJECT_NOT_UNDER_ORGANIZATION
       The Google Cloud project is not under the required organization.
      CLOUD_PROJECT_NOT_UNDER_ORGANIZATION = 27;

    • ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT

      public static final AuthorizationErrorEnum.AuthorizationError ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT
       The user does not have permission to perform this action on the resource
 or method because the Google Ads account is suspended.
      ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT = 28;

    • UNRECOGNIZED

      public static final AuthorizationErrorEnum.AuthorizationError UNRECOGNIZED

  • Field Details

    • UNSPECIFIED_VALUE

      public static final int UNSPECIFIED_VALUE
       Enum unspecified.
      UNSPECIFIED = 0;
      See Also:

    • UNKNOWN_VALUE

      public static final int UNKNOWN_VALUE
       The received error code is not known in this version.
      UNKNOWN = 1;
      See Also:

    • USER_PERMISSION_DENIED_VALUE

      public static final int USER_PERMISSION_DENIED_VALUE
       User doesn't have permission to access customer. Note: If you're
 accessing a client customer, the manager's customer ID must be set in the
 `login-customer-id` header. Learn more at
 https://developers.google.com/google-ads/api/docs/concepts/call-structure#cid
      USER_PERMISSION_DENIED = 2;
      See Also:

    • DEVELOPER_TOKEN_NOT_ON_ALLOWLIST_VALUE

      public static final int DEVELOPER_TOKEN_NOT_ON_ALLOWLIST_VALUE
       The developer token is not on the allow-list.
      DEVELOPER_TOKEN_NOT_ON_ALLOWLIST = 13;
      See Also:

    • DEVELOPER_TOKEN_PROHIBITED_VALUE

      public static final int DEVELOPER_TOKEN_PROHIBITED_VALUE
       The developer token is not allowed with the project sent in the request.
      DEVELOPER_TOKEN_PROHIBITED = 4;
      See Also:

    • PROJECT_DISABLED_VALUE

      public static final int PROJECT_DISABLED_VALUE
       The Google Cloud project sent in the request does not have permission to
 access the api.
      PROJECT_DISABLED = 5;
      See Also:

    • AUTHORIZATION_ERROR_VALUE

      public static final int AUTHORIZATION_ERROR_VALUE
       Authorization of the client failed.
      AUTHORIZATION_ERROR = 6;
      See Also:

    • ACTION_NOT_PERMITTED_VALUE

      public static final int ACTION_NOT_PERMITTED_VALUE
       The user does not have permission to perform this action
 (for example, ADD, UPDATE, REMOVE) on the resource or call a method.
      ACTION_NOT_PERMITTED = 7;
      See Also:

    • INCOMPLETE_SIGNUP_VALUE

      public static final int INCOMPLETE_SIGNUP_VALUE
       Signup not complete.
      INCOMPLETE_SIGNUP = 8;
      See Also:

    • CUSTOMER_NOT_ENABLED_VALUE

      public static final int CUSTOMER_NOT_ENABLED_VALUE
       The customer account can't be accessed because it is not yet enabled or
 has been deactivated.
      CUSTOMER_NOT_ENABLED = 24;
      See Also:

    • MISSING_TOS_VALUE

      public static final int MISSING_TOS_VALUE
       The developer must sign the terms of service. They can be found here:
 ads.google.com/aw/apicenter
      MISSING_TOS = 9;
      See Also:

    • DEVELOPER_TOKEN_NOT_APPROVED_VALUE

      public static final int DEVELOPER_TOKEN_NOT_APPROVED_VALUE
       The developer token is only approved for use with test accounts. To
 access non-test accounts, apply for Basic or Standard access.
      DEVELOPER_TOKEN_NOT_APPROVED = 10;
      See Also:

    • INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION_VALUE

      public static final int INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION_VALUE
       The login customer specified does not have access to the account
 specified, so the request is invalid.
      INVALID_LOGIN_CUSTOMER_ID_SERVING_CUSTOMER_ID_COMBINATION = 11;
      See Also:

    • SERVICE_ACCESS_DENIED_VALUE

      public static final int SERVICE_ACCESS_DENIED_VALUE
       The developer specified does not have access to the service.
      SERVICE_ACCESS_DENIED = 12;
      See Also:

    • ACCESS_DENIED_FOR_ACCOUNT_TYPE_VALUE

      public static final int ACCESS_DENIED_FOR_ACCOUNT_TYPE_VALUE
       The customer (or login customer) isn't in Google Ads. It belongs to
 another ads system.
      ACCESS_DENIED_FOR_ACCOUNT_TYPE = 25;
      See Also:

    • METRIC_ACCESS_DENIED_VALUE

      public static final int METRIC_ACCESS_DENIED_VALUE
       The developer does not have access to the metrics queried.
      METRIC_ACCESS_DENIED = 26;
      See Also:

    • CLOUD_PROJECT_NOT_UNDER_ORGANIZATION_VALUE

      public static final int CLOUD_PROJECT_NOT_UNDER_ORGANIZATION_VALUE
       The Google Cloud project is not under the required organization.
      CLOUD_PROJECT_NOT_UNDER_ORGANIZATION = 27;
      See Also:

    • ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT_VALUE

      public static final int ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT_VALUE
       The user does not have permission to perform this action on the resource
 or method because the Google Ads account is suspended.
      ACTION_NOT_PERMITTED_FOR_SUSPENDED_ACCOUNT = 28;
      See Also:

  • Method Details

    • values

      public static AuthorizationErrorEnum.AuthorizationError[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static AuthorizationErrorEnum.AuthorizationError valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static AuthorizationErrorEnum.AuthorizationError valueOf(int value)
      Deprecated.
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static AuthorizationErrorEnum.AuthorizationError forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<AuthorizationErrorEnum.AuthorizationError> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static AuthorizationErrorEnum.AuthorizationError valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null