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

type RequiredCollectionError (v202505)

AI-generated Key Takeaways

RequiredCollectionError is a type of ApiError used for validating sizes of collections.
RequiredCollectionError includes inherited fields like 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 reason is 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

▼

ApiVersionError AuthenticationError CollectionSizeError CommonError CustomTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError InternalApiError NotNullError NullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError 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.