type AuthenticationError (v202405)
An error for an exception that occurred when authenticating.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202405
Field
|
ApiError (inherited)
|
fieldPath
|
xsd:string
The OGNL field path to identify cause of error.
|
fieldPathElements
|
FieldPathElement[]
A parsed copy of the field path. For example, the field path "operations[1].operand"
corresponds to this list: {FieldPathElement(field = "operations", index = 1),
FieldPathElement(field = "operand", index = null)}.
|
trigger
|
xsd:string
The data that caused the error.
|
errorString
|
xsd:string
A simple string representation of the error and reason.
|
AuthenticationError
|
reason
|
AuthenticationError.Reason
Enumerations
-
AMBIGUOUS_SOAP_REQUEST_HEADER
- The SOAP message contains a request header with an ambiguous definition of the authentication
header fields. This means either the
authToken and oAuthToken fields were
both null or both were specified. Exactly one value should be specified with each request.
-
INVALID_EMAIL
- The login provided is invalid.
-
AUTHENTICATION_FAILED
- Tried to authenticate with provided information, but failed.
-
INVALID_OAUTH_SIGNATURE
- The OAuth provided is invalid.
-
INVALID_SERVICE
- The specified service to use was not recognized.
-
MISSING_SOAP_REQUEST_HEADER
- The SOAP message is missing a request header with an
authToken and optional networkCode.
-
MISSING_AUTHENTICATION_HTTP_HEADER
- The HTTP request is missing a request header with an
authToken
-
MISSING_AUTHENTICATION
- The request is missing an
authToken
-
NETWORK_API_ACCESS_DISABLED
- The network does not have API access enabled.
-
NO_NETWORKS_TO_ACCESS
- The user is not associated with any network.
-
NETWORK_NOT_FOUND
- No network for the given
networkCode was found.
-
NETWORK_CODE_REQUIRED
- The user has access to more than one network, but did not provide a
networkCode.
-
CONNECTION_ERROR
- An error happened on the server side during connection to authentication service.
-
GOOGLE_ACCOUNT_ALREADY_ASSOCIATED_WITH_NETWORK
- The user tried to create a test network using an account that already is associated with a
network.
-
UNDER_INVESTIGATION
- The account is blocked and under investigation by the collections team. Please contact Google
for more information.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-05-15 UTC.
[null,null,["Last updated 2024-05-15 UTC."],[[["This documentation outlines `AuthenticationError`, an error type within the Google Ad Manager API."],["`AuthenticationError` occurs when there are issues during the authentication process, such as invalid credentials or missing headers."],["Several reasons for `AuthenticationError` are listed, including invalid logins, missing authentication tokens, and network access problems."],["Developers can use the provided `reason` field to diagnose and resolve authentication issues in their Ad Manager integrations."],["The `AuthenticationError` is part of a larger error hierarchy inherited from `ApiError`, which provides additional context and details about the error."]]],["The content details various services and associated errors within an ad management API, version 202405. Services include AdRule, Adjustment, AudienceSegment, and many more. Core information includes the `AuthenticationError` class which inherits from `ApiError`. `AuthenticationError` includes a `reason` field, with enumerations for different error types like `INVALID_EMAIL`, `AUTHENTICATION_FAILED`, `MISSING_AUTHENTICATION`, and `NETWORK_NOT_FOUND`. `ApiError` contains fields such as `fieldPath`, `trigger`, and `errorString`.\n"]]
