type RequiredCollectionError (v202508)

  • RequiredCollectionError is a type of ApiError used for validating sizes of collections.

  • RequiredCollectionError inherits fields such as fieldPath, fieldPathElements, trigger, and errorString from ApiError.

  • The RequiredCollectionError has a 'reason' field which can indicate if a required collection is missing, too large, too small, or if the value is unknown.

  • Several other service-specific errors are listed, all inheriting from ApiError, including errors related to ad units, authentication, inventory, and more.

A list of all errors to be used for validating sizes of collections.


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

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.

RequiredCollectionError

reason

RequiredCollectionError.Reason


Enumerations
REQUIRED
A required collection is missing.
TOO_LARGE
Collection size is too large.
TOO_SMALL
Collection size is too small.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.