type TokenError (v202502)

  • TokenError represents an error specifically for exceptions related to using a token within the UserService.

  • TokenError inherits properties from ApiError, including fieldPath, fieldPathElements, trigger, and errorString, which help identify the cause and details of the error.

  • TokenError includes a specific reason field with possible enumeration values like INVALID, EXPIRED, and UNKNOWN to indicate why the token error occurred.
Service
UserService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError CustomFieldValueError EntityLimitReachedError FeatureError InternalApiError InvalidEmailError NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TeamError TimeZoneError TokenError TypeError UniqueError

An error for an exception that occurred when using a token.

Namespace
https://www.google.com/apis/ads/publisher/v202502

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.

TokenError

reason

TokenError.Reason

Enumerations
INVALID
EXPIRED
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.