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.\u003c/p\u003e\n"],["\u003cp\u003eIt signifies errors due to missing mandatory fields when interacting with the API.\u003c/p\u003e\n"],["\u003cp\u003eThe error includes details like the problematic field path, trigger data, and a specific reason code.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eRequiredError\u003c/code\u003e is part of a broader error inheritance structure within the Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers should ensure all required fields are correctly populated to avoid this error.\u003c/p\u003e\n"]]],["The content details various services and errors within an ad management API (v202408). These services include managing ads, content, users, targeting, forecasts, and more, such as `AdRuleService`, `ContentService`, and `UserService`. It also lists several error types inheriting from `ApiError`, including `AuthenticationError` and `RequiredError`. `RequiredError` specifically signals missing required fields, with the `reason` field set to `REQUIRED` when a field is missing.\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](/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** [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.RequiredError) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.RequiredError) **Inheritance** \n[ApiError](/ad-manager/api/reference/v202408/UserService.ApiError) \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/UserService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/UserService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/UserService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/UserService.CommonError) [CustomFieldValueError](/ad-manager/api/reference/v202408/UserService.CustomFieldValueError) [EntityLimitReachedError](/ad-manager/api/reference/v202408/UserService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/UserService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/UserService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202408/UserService.InvalidEmailError) [NotNullError](/ad-manager/api/reference/v202408/UserService.NotNullError) [ParseError](/ad-manager/api/reference/v202408/UserService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/UserService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/UserService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/UserService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/UserService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/UserService.RequiredCollectionError) **RequiredError** [ServerError](/ad-manager/api/reference/v202408/UserService.ServerError) [StatementError](/ad-manager/api/reference/v202408/UserService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/UserService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/UserService.StringLengthError) [TeamError](/ad-manager/api/reference/v202408/UserService.TeamError) [TimeZoneError](/ad-manager/api/reference/v202408/UserService.TimeZoneError) [TokenError](/ad-manager/api/reference/v202408/UserService.TokenError) [TypeError](/ad-manager/api/reference/v202408/UserService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/UserService.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/UserService.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/UserService.RequiredError.Reason)` ` The error reason represented by an enum. *** ** * ** *** **Enumerations** `REQUIRED` : Missing required field. \u003cbr /\u003e |"]]