type RequiredCollectionError (v202411)

  • This documentation outlines the RequiredCollectionError in Google Ad Manager's Placement Service, used for validating the size of collections.

  • The error provides details such as the fieldPath, trigger, and the specific reason for the error (e.g., missing, too large, or too small).

  • Developers can utilize this information to troubleshoot and resolve issues related to collection sizes within their Ad Manager integrations.

  • RequiredCollectionError inherits properties like fieldPath, fieldPathElements, trigger, and errorString from its parent class, ApiError.

  • This error is part of the https://www.google.com/apis/ads/publisher/v202411 namespace.

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.