type RequiredCollectionError (v202411)

  • The RequiredCollectionError object in Google Ad Manager API is used to validate the size of collections.

  • It extends the ApiError object and inherits its properties for identifying the error cause.

  • There are four potential reasons for the error: REQUIRED, TOO_LARGE, TOO_SMALL, and UNKNOWN, which indicate missing, exceeding maximum, below minimum, and unspecified size issues, respectively.

  • The reason field clarifies the specific reason why the collection error was triggered.
Service
AdRuleService AdjustmentService AdsTxtService AudienceSegmentService CdnConfigurationService CmsMetadataService CompanyService ContactService ContentBundleService ContentService CreativeService CreativeSetService CreativeTemplateService CreativeWrapperService CustomFieldService CustomTargetingService DaiAuthenticationKeyService DaiEncodingProfileService ForecastService InventoryService LabelService LineItemCreativeAssociationService LineItemService LineItemTemplateService LiveStreamEventService MobileApplicationService NativeStyleService NetworkService OrderService PlacementService ProposalLineItemService ProposalService PublisherQueryLanguageService ReportService SegmentPopulationService SiteService StreamActivityMonitorService SuggestedAdUnitService TargetingPresetService TeamService UserService UserTeamAssociationService YieldGroupService
Inheritance
ApiError
▼
ApiVersionError AuthenticationError CollectionSizeError CommonError CompanyCreditStatusError CompanyError CrossSellError CustomFieldValueError ExchangeSignupApiError FeatureError InternalApiError InvalidEmailError InvalidUrlError InventoryClientApiError LabelEntityAssociationError McmError NetworkError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RegExError RequiredCollectionError RequiredError RequiredNumberError ServerError SiteError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

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.