type RequiredCollectionError (v202411)

  • The RequiredCollectionError object in Google Ad Manager's API is used to identify size-related errors within collections.

  • It inherits properties from the ApiError object, including details about the error's location (fieldPath, fieldPathElements), cause (trigger), and description (errorString).

  • RequiredCollectionError has a reason property to indicate why a collection size validation failed, which can be one of REQUIRED, TOO_LARGE, TOO_SMALL, or UNKNOWN.

  • The namespace for this object is https://www.google.com/apis/ads/publisher/v202411.

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


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.

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.