type RequiredCollectionError (v202411)

  • This page documents the RequiredCollectionError in Google Ad Manager's API.

  • RequiredCollectionError is used to validate the size of collections, ensuring they are neither too large nor too small.

  • This error type inherits from ApiError and includes fields like fieldPath, trigger, and errorString for detailed error information.

  • It provides a specific reason field indicating why the collection size is invalid (e.g., REQUIRED, TOO_LARGE, TOO_SMALL).

  • Developers can use this information to troubleshoot issues related to collection sizes in their Ad Manager API integrations.
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
▼
AdRuleDateError AdRuleError AdRuleFrequencyCapError AdRulePriorityError AdRuleSlotError AdRuleTargetingError ApiVersionError AuthenticationError CollectionSizeError CommonError CustomTargetingError FeatureError GeoTargetingError InternalApiError InventoryTargetingError NotNullError ParseError PermissionError PoddingError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequiredCollectionError RequiredError RequiredNumberError ServerError StatementError StringFormatError StringLengthError 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.