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 within the Google Ad Manager API, specifically for the ContentService.\u003c/p\u003e\n"],["\u003cp\u003eIt arises when a required field is missing during an API request.\u003c/p\u003e\n"],["\u003cp\u003eThe error provides information such as the location of the missing field (\u003ccode\u003efieldPath\u003c/code\u003e) and a reason code (\u003ccode\u003ereason\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should ensure all required fields are populated before making API calls to avoid this error.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including `AdRuleService`, `ContentService`, and `ForecastService`, among others. It details potential `ApiError` types, with a focus on `RequiredError`, triggered by missing fields. `RequiredError` indicates a missing required field and provides a reason. The document defines a namespace and includes fields like `fieldPath`, `trigger`, and `errorString` for identifying and describing errors. All errors follow an `ApiError` inheritance.\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** [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/ContentService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/ContentService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/ContentService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/ContentService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/ContentService.CommonError) [FeatureError](/ad-manager/api/reference/v202408/ContentService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/ContentService.InternalApiError) [InvalidUrlError](/ad-manager/api/reference/v202408/ContentService.InvalidUrlError) [NotNullError](/ad-manager/api/reference/v202408/ContentService.NotNullError) [ParseError](/ad-manager/api/reference/v202408/ContentService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/ContentService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/ContentService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/ContentService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/ContentService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/ContentService.RequiredCollectionError) **RequiredError** [RequiredNumberError](/ad-manager/api/reference/v202408/ContentService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202408/ContentService.ServerError) [StatementError](/ad-manager/api/reference/v202408/ContentService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/ContentService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/ContentService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/ContentService.TypeError)\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/ContentService.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/ContentService.RequiredError.Reason)` ` The error reason represented by an enum. *** ** * ** *** **Enumerations** `REQUIRED` : Missing required field. \u003cbr /\u003e |"]]