type RequiredCollectionError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
Field
|
ApiError (inherited)
|
fieldPath
|
xsd:string
|
fieldPathElements
|
FieldPathElement[]
|
trigger
|
xsd:string
|
errorString
|
xsd:string
|
RequiredCollectionError
|
reason
|
RequiredCollectionError.Reason
Enumerations
-
REQUIRED
-
TOO_LARGE
-
TOO_SMALL
-
UNKNOWN
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-06 UTC.
[null,null,["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis documentation details the \u003ccode\u003eRequiredCollectionError\u003c/code\u003e within the context of the Google Ad Manager API's SiteService.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eRequiredCollectionError\u003c/code\u003e is a type of \u003ccode\u003eApiError\u003c/code\u003e indicating an issue with a required collection, such as its size or missing elements.\u003c/p\u003e\n"],["\u003cp\u003eThis error includes information about the field path, error reason (like \u003ccode\u003eREQUIRED\u003c/code\u003e, \u003ccode\u003eTOO_LARGE\u003c/code\u003e, or \u003ccode\u003eTOO_SMALL\u003c/code\u003e), and a descriptive error string.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers using the Ad Manager API should be aware of this error and handle it appropriately to ensure successful site operations.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, version v202408, including AdRuleService, AdjustmentService, and others totaling over 30. It also specifies error handling, detailed within `ApiError` and `RequiredCollectionError`. `ApiError` contains properties like `fieldPath`, `trigger`, and `errorString`. `RequiredCollectionError` defines `reason`, which can be `REQUIRED`, `TOO_LARGE`, `TOO_SMALL`, or `UNKNOWN`, in relation to collection size or specific requirements.\n"],null,["# type RequiredCollectionError (v202408)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202408/AdRuleService.RequiredCollectionError) [AdjustmentService](/ad-manager/api/reference/v202408/AdjustmentService.RequiredCollectionError) [AdsTxtService](/ad-manager/api/reference/v202408/AdsTxtService.RequiredCollectionError) [AudienceSegmentService](/ad-manager/api/reference/v202408/AudienceSegmentService.RequiredCollectionError) [CdnConfigurationService](/ad-manager/api/reference/v202408/CdnConfigurationService.RequiredCollectionError) [CmsMetadataService](/ad-manager/api/reference/v202408/CmsMetadataService.RequiredCollectionError) [CompanyService](/ad-manager/api/reference/v202408/CompanyService.RequiredCollectionError) [ContactService](/ad-manager/api/reference/v202408/ContactService.RequiredCollectionError) [ContentBundleService](/ad-manager/api/reference/v202408/ContentBundleService.RequiredCollectionError) [ContentService](/ad-manager/api/reference/v202408/ContentService.RequiredCollectionError) [CreativeService](/ad-manager/api/reference/v202408/CreativeService.RequiredCollectionError) [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.RequiredCollectionError) [CreativeTemplateService](/ad-manager/api/reference/v202408/CreativeTemplateService.RequiredCollectionError) [CreativeWrapperService](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredCollectionError) [CustomFieldService](/ad-manager/api/reference/v202408/CustomFieldService.RequiredCollectionError) [CustomTargetingService](/ad-manager/api/reference/v202408/CustomTargetingService.RequiredCollectionError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202408/DaiAuthenticationKeyService.RequiredCollectionError) [DaiEncodingProfileService](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RequiredCollectionError) [ForecastService](/ad-manager/api/reference/v202408/ForecastService.RequiredCollectionError) [InventoryService](/ad-manager/api/reference/v202408/InventoryService.RequiredCollectionError) [LabelService](/ad-manager/api/reference/v202408/LabelService.RequiredCollectionError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.RequiredCollectionError) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.RequiredCollectionError) [LineItemTemplateService](/ad-manager/api/reference/v202408/LineItemTemplateService.RequiredCollectionError) [LiveStreamEventService](/ad-manager/api/reference/v202408/LiveStreamEventService.RequiredCollectionError) [MobileApplicationService](/ad-manager/api/reference/v202408/MobileApplicationService.RequiredCollectionError) [NativeStyleService](/ad-manager/api/reference/v202408/NativeStyleService.RequiredCollectionError) [NetworkService](/ad-manager/api/reference/v202408/NetworkService.RequiredCollectionError) [OrderService](/ad-manager/api/reference/v202408/OrderService.RequiredCollectionError) [PlacementService](/ad-manager/api/reference/v202408/PlacementService.RequiredCollectionError) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.RequiredCollectionError) [ProposalService](/ad-manager/api/reference/v202408/ProposalService.RequiredCollectionError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202408/PublisherQueryLanguageService.RequiredCollectionError) [ReportService](/ad-manager/api/reference/v202408/ReportService.RequiredCollectionError) [SegmentPopulationService](/ad-manager/api/reference/v202408/SegmentPopulationService.RequiredCollectionError) **SiteService** [StreamActivityMonitorService](/ad-manager/api/reference/v202408/StreamActivityMonitorService.RequiredCollectionError) [SuggestedAdUnitService](/ad-manager/api/reference/v202408/SuggestedAdUnitService.RequiredCollectionError) [TargetingPresetService](/ad-manager/api/reference/v202408/TargetingPresetService.RequiredCollectionError) [TeamService](/ad-manager/api/reference/v202408/TeamService.RequiredCollectionError) [UserService](/ad-manager/api/reference/v202408/UserService.RequiredCollectionError) [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.RequiredCollectionError) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.RequiredCollectionError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/SiteService.ApiError) \n▼\n[AdSenseAccountError](/ad-manager/api/reference/v202408/SiteService.AdSenseAccountError) [ApiVersionError](/ad-manager/api/reference/v202408/SiteService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/SiteService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/SiteService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/SiteService.CommonError) [EntityLimitReachedError](/ad-manager/api/reference/v202408/SiteService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/SiteService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/SiteService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/SiteService.NotNullError) [NullError](/ad-manager/api/reference/v202408/SiteService.NullError) [ParseError](/ad-manager/api/reference/v202408/SiteService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/SiteService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/SiteService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/SiteService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/SiteService.QuotaError) **RequiredCollectionError** [RequiredError](/ad-manager/api/reference/v202408/SiteService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/SiteService.ServerError) [SiteError](/ad-manager/api/reference/v202408/SiteService.SiteError) [StatementError](/ad-manager/api/reference/v202408/SiteService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/SiteService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/SiteService.StringLengthError) [UrlError](/ad-manager/api/reference/v202408/SiteService.UrlError)\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202408`\n\n| Field ----- ||\n|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **`ApiError` (inherited)** ||\n| ### `fieldPath` | ` `xsd:`string` \u003cbr /\u003e |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202408/SiteService.FieldPathElement)`[]` \u003cbr /\u003e |\n| ### `trigger` | ` `xsd:`string` \u003cbr /\u003e |\n| ### `errorString` | ` `xsd:`string` \u003cbr /\u003e |\n| **`RequiredCollectionError`** ||\n| ### `reason` | ` `[RequiredCollectionError.Reason](/ad-manager/api/reference/v202408/SiteService.RequiredCollectionError.Reason)` ` *** ** * ** *** **Enumerations** `REQUIRED` : `TOO_LARGE` : `TOO_SMALL` : `UNKNOWN` : \u003cbr /\u003e |"]]