type RequiredCollectionError (v202411)

  • The RequiredCollectionError object in Google Ad Manager's API is used to identify and handle errors related to the size of collections.

  • This error can be triggered if a required collection is missing, or if a collection is too large or too small.

  • It inherits from the ApiError object, which provides contextual information about the error, such as the field path and the triggering data.

  • The reason field in RequiredCollectionError provides specific details about why the error occurred.

  • This error is part of the TargetingPresetService and falls under the namespace https://www.google.com/apis/ads/publisher/v202411.
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 DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... FeatureError GenericTargetingError GeoTargetingError InternalApiError InventoryTargetingError MobileApplicationTargetingE... NotNullError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RequestPlatformTargetingError RequiredCollectionError RequiredError ServerError StatementError StringFormatError StringLengthError TechnologyTargetingError UniqueError UserDomainTargetingError VideoPositionTargetingError

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.