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 documentation details the \u003ccode\u003eRequiredError\u003c/code\u003e for the LabelService within the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eRequiredError\u003c/code\u003e is triggered when there are missing mandatory fields during API calls.\u003c/p\u003e\n"],["\u003cp\u003eThe error provides information about the missing field through the \u003ccode\u003efieldPath\u003c/code\u003e and \u003ccode\u003ereason\u003c/code\u003e properties.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should ensure all required fields are included in their requests to avoid this error.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the provided table and enumeration details for a comprehensive understanding of the error and its properties.\u003c/p\u003e\n"]]],["The content details various services within an ad management API, including `AdRuleService`, `CreativeService`, `ForecastService`, and `UserService`, alongside many others. These services are used to manage ad rules, adjustments, creative elements, content, and various targeting parameters. It also outlines inheritance patterns, particularly the `ApiError` and its subtypes like `RequiredError` which signifies errors due to missing required fields, and details error properties such as `fieldPath`, `trigger`, and `errorString`. The `RequiredError` is further explained with the reason `REQUIRED` in its enumerations.\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](/ad-manager/api/reference/v202408/CmsMetadataService.RequiredError) [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** [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/LabelService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/LabelService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/LabelService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/LabelService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/LabelService.CommonError) [CreativeWrapperError](/ad-manager/api/reference/v202408/LabelService.CreativeWrapperError) [FeatureError](/ad-manager/api/reference/v202408/LabelService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/LabelService.InternalApiError) [LabelError](/ad-manager/api/reference/v202408/LabelService.LabelError) [NotNullError](/ad-manager/api/reference/v202408/LabelService.NotNullError) [NullError](/ad-manager/api/reference/v202408/LabelService.NullError) [ParseError](/ad-manager/api/reference/v202408/LabelService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/LabelService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/LabelService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/LabelService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/LabelService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/LabelService.RequiredCollectionError) **RequiredError** [ServerError](/ad-manager/api/reference/v202408/LabelService.ServerError) [StatementError](/ad-manager/api/reference/v202408/LabelService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/LabelService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/LabelService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/LabelService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/LabelService.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/LabelService.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/LabelService.RequiredError.Reason)` ` The error reason represented by an enum. *** ** * ** *** **Enumerations** `REQUIRED` : Missing required field. \u003cbr /\u003e |"]]
