type ApiVersionError (v202411)

  • This documentation details the ApiVersionError within the ContentService of the Google Ad Manager API.

  • ApiVersionError occurs when there are issues related to the usage of API versions, such as using an outdated version for a specific operation.

  • The error provides information like the field path causing the error, the data that triggered the error, and a reason for the error.

  • ApiVersionError.Reason can be either UPDATE_TO_NEWER_VERSION suggesting an update is needed, or UNKNOWN if the reason is unspecified.

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.