type ApiVersionError (v202411)

  • This documentation focuses on ApiVersionError, which are errors related to the usage of API versions in Google Ad Manager.

  • ApiVersionError objects provide information about the error, including the reason for the error, the field path where the error occurred, and a simple error string.

  • The reason field in an ApiVersionError object can indicate that the operation is not allowed in the requested API version or that the value returned is not exposed by the requested API version.

  • These errors belong to the https://www.google.com/apis/ads/publisher/v202411 namespace.

  • ApiVersionError inherits from the ApiError object and includes fields such as fieldPath, fieldPathElements, trigger, and errorString for detailed error information.

Errors related to the usage of API versions.


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

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.

ApiVersionError

reason

ApiVersionError.Reason


Enumerations
UPDATE_TO_NEWER_VERSION
Indicates that the operation is not allowed in the version the request was made in.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.