Looking for a REST API? The Ad Manager API (Beta) is now available.

type RequiredCollectionError (v202508)

AI-generated Key Takeaways

RequiredCollectionError is used for validating the sizes of collections and is listed under Inheritance from ApiError.
The RequiredCollectionError has a field called reason, which is an enumeration indicating why the error occurred, such as missing or incorrectly sized collections.
The reason field can have values like REQUIRED, TOO_LARGE, TOO_SMALL, or UNKNOWN.

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

▼

AdSenseAccountError AdUnitCodeError AdUnitHierarchyError ApiVersionError AuthenticationError CollectionSizeError CommonError CompanyError CreativeWrapperError CrossSellError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError FrequencyCapError InternalApiError InvalidColorError InvalidUrlError InventoryUnitError InventoryUnitRefreshRateError InventoryUnitSizesError LabelEntityAssociationError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError TeamError TypeError UniqueError

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

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.