type RequiredError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Errors due to missing required field.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
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.
|
RequiredError
|
reason
|
RequiredError.Reason
The error reason represented by an enum.
Enumerations
-
REQUIRED
- Missing required field.
|
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 page documents the \u003ccode\u003eRequiredError\u003c/code\u003e for the CmsMetadataService within the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eRequiredError\u003c/code\u003e is thrown when a required field is missing.\u003c/p\u003e\n"],["\u003cp\u003eIt includes details such as the error reason, field path, and a description of the error.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides a specific enum value (\u003ccode\u003eREQUIRED\u003c/code\u003e) indicating the nature of the error.\u003c/p\u003e\n"],["\u003cp\u003eThe namespace for this error is \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including `AdRuleService`, `AdjustmentService`, `AudienceSegmentService`, and many more. It details potential errors, focusing on `RequiredError`, which signifies a missing mandatory field. The API's namespace is `https://www.google.com/apis/ads/publisher/v202408`. Key components include error types like `ApiError` with properties such as `fieldPath`, `trigger` and `errorString`, and the `RequiredError` with a `reason` attribute to detail the error cause.\n"],null,["# type RequiredError (v202408)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202408/AdRuleService.RequiredError) [AdjustmentService](/ad-manager/api/reference/v202408/AdjustmentService.RequiredError) [AdsTxtService](/ad-manager/api/reference/v202408/AdsTxtService.RequiredError) [AudienceSegmentService](/ad-manager/api/reference/v202408/AudienceSegmentService.RequiredError) [CdnConfigurationService](/ad-manager/api/reference/v202408/CdnConfigurationService.RequiredError) **CmsMetadataService** [CompanyService](/ad-manager/api/reference/v202408/CompanyService.RequiredError) [ContactService](/ad-manager/api/reference/v202408/ContactService.RequiredError) [ContentBundleService](/ad-manager/api/reference/v202408/ContentBundleService.RequiredError) [ContentService](/ad-manager/api/reference/v202408/ContentService.RequiredError) [CreativeService](/ad-manager/api/reference/v202408/CreativeService.RequiredError) [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.RequiredError) [CreativeTemplateService](/ad-manager/api/reference/v202408/CreativeTemplateService.RequiredError) [CreativeWrapperService](/ad-manager/api/reference/v202408/CreativeWrapperService.RequiredError) [CustomFieldService](/ad-manager/api/reference/v202408/CustomFieldService.RequiredError) [CustomTargetingService](/ad-manager/api/reference/v202408/CustomTargetingService.RequiredError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202408/DaiAuthenticationKeyService.RequiredError) [DaiEncodingProfileService](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RequiredError) [ForecastService](/ad-manager/api/reference/v202408/ForecastService.RequiredError) [InventoryService](/ad-manager/api/reference/v202408/InventoryService.RequiredError) [LabelService](/ad-manager/api/reference/v202408/LabelService.RequiredError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.RequiredError) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.RequiredError) [LineItemTemplateService](/ad-manager/api/reference/v202408/LineItemTemplateService.RequiredError) [LiveStreamEventService](/ad-manager/api/reference/v202408/LiveStreamEventService.RequiredError) [MobileApplicationService](/ad-manager/api/reference/v202408/MobileApplicationService.RequiredError) [NativeStyleService](/ad-manager/api/reference/v202408/NativeStyleService.RequiredError) [NetworkService](/ad-manager/api/reference/v202408/NetworkService.RequiredError) [OrderService](/ad-manager/api/reference/v202408/OrderService.RequiredError) [PlacementService](/ad-manager/api/reference/v202408/PlacementService.RequiredError) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.RequiredError) [ProposalService](/ad-manager/api/reference/v202408/ProposalService.RequiredError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202408/PublisherQueryLanguageService.RequiredError) [ReportService](/ad-manager/api/reference/v202408/ReportService.RequiredError) [SegmentPopulationService](/ad-manager/api/reference/v202408/SegmentPopulationService.RequiredError) [SiteService](/ad-manager/api/reference/v202408/SiteService.RequiredError) [StreamActivityMonitorService](/ad-manager/api/reference/v202408/StreamActivityMonitorService.RequiredError) [SuggestedAdUnitService](/ad-manager/api/reference/v202408/SuggestedAdUnitService.RequiredError) [TargetingPresetService](/ad-manager/api/reference/v202408/TargetingPresetService.RequiredError) [TeamService](/ad-manager/api/reference/v202408/TeamService.RequiredError) [UserService](/ad-manager/api/reference/v202408/UserService.RequiredError) [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.RequiredError) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.RequiredError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/CmsMetadataService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CmsMetadataService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CmsMetadataService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CmsMetadataService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CmsMetadataService.CommonError) [FeatureError](/ad-manager/api/reference/v202408/CmsMetadataService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CmsMetadataService.InternalApiError) [MetadataMergeSpecError](/ad-manager/api/reference/v202408/CmsMetadataService.MetadataMergeSpecError) [NotNullError](/ad-manager/api/reference/v202408/CmsMetadataService.NotNullError) [ParseError](/ad-manager/api/reference/v202408/CmsMetadataService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CmsMetadataService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CmsMetadataService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CmsMetadataService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CmsMetadataService.QuotaError) [RangeError](/ad-manager/api/reference/v202408/CmsMetadataService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CmsMetadataService.RequiredCollectionError) **RequiredError** [ServerError](/ad-manager/api/reference/v202408/CmsMetadataService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CmsMetadataService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CmsMetadataService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CmsMetadataService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202408/CmsMetadataService.UniqueError)\n\nErrors due to missing required field.\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` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202408/CmsMetadataService.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)}. |\n| ### `trigger` | ` `xsd:`string` The data that caused the error. |\n| ### `errorString` | ` `xsd:`string` A simple string representation of the error and reason. |\n| **`RequiredError`** ||\n| ### `reason` | ` `[RequiredError.Reason](/ad-manager/api/reference/v202408/CmsMetadataService.RequiredError.Reason)` ` The error reason represented by an enum. *** ** * ** *** **Enumerations** `REQUIRED` : Missing required field. \u003cbr /\u003e |"]]