abstract type ApiError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
The API error base class that provides details about an error that occurred
while processing a service request.
The OGNL field path is provided for parsers to identify the request data
element that may have caused the error.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
Field
|
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.
|
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 provides details about the \u003ccode\u003eApiError\u003c/code\u003e base class in Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e objects offer information about errors during service requests, including the cause and location within the request data.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eApiError\u003c/code\u003e include \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for debugging and troubleshooting.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize this information to identify and resolve issues encountered while interacting with the Ad Manager API.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including `AdRuleService`, `AdjustmentService`, and `CompanyService`, among others. These services manage aspects like ad rules, adjustments, audiences, content, creatives, forecasts, inventory, and reporting. It also details `ApiError` handling, a base class for errors during service requests, providing details like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to pinpoint the issue's cause and location. Several types of specific errors are listed as well.\n"],null,["# abstract type ApiError (v202411)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202411/AdRuleService.ApiError) [AdjustmentService](/ad-manager/api/reference/v202411/AdjustmentService.ApiError) [AdsTxtService](/ad-manager/api/reference/v202411/AdsTxtService.ApiError) [AudienceSegmentService](/ad-manager/api/reference/v202411/AudienceSegmentService.ApiError) [CdnConfigurationService](/ad-manager/api/reference/v202411/CdnConfigurationService.ApiError) [CmsMetadataService](/ad-manager/api/reference/v202411/CmsMetadataService.ApiError) **CompanyService** [ContactService](/ad-manager/api/reference/v202411/ContactService.ApiError) [ContentBundleService](/ad-manager/api/reference/v202411/ContentBundleService.ApiError) [ContentService](/ad-manager/api/reference/v202411/ContentService.ApiError) [CreativeService](/ad-manager/api/reference/v202411/CreativeService.ApiError) [CreativeSetService](/ad-manager/api/reference/v202411/CreativeSetService.ApiError) [CreativeTemplateService](/ad-manager/api/reference/v202411/CreativeTemplateService.ApiError) [CreativeWrapperService](/ad-manager/api/reference/v202411/CreativeWrapperService.ApiError) [CustomFieldService](/ad-manager/api/reference/v202411/CustomFieldService.ApiError) [CustomTargetingService](/ad-manager/api/reference/v202411/CustomTargetingService.ApiError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202411/DaiAuthenticationKeyService.ApiError) [DaiEncodingProfileService](/ad-manager/api/reference/v202411/DaiEncodingProfileService.ApiError) [ForecastService](/ad-manager/api/reference/v202411/ForecastService.ApiError) [InventoryService](/ad-manager/api/reference/v202411/InventoryService.ApiError) [LabelService](/ad-manager/api/reference/v202411/LabelService.ApiError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202411/LineItemCreativeAssociationService.ApiError) [LineItemService](/ad-manager/api/reference/v202411/LineItemService.ApiError) [LineItemTemplateService](/ad-manager/api/reference/v202411/LineItemTemplateService.ApiError) [LiveStreamEventService](/ad-manager/api/reference/v202411/LiveStreamEventService.ApiError) [MobileApplicationService](/ad-manager/api/reference/v202411/MobileApplicationService.ApiError) [NativeStyleService](/ad-manager/api/reference/v202411/NativeStyleService.ApiError) [NetworkService](/ad-manager/api/reference/v202411/NetworkService.ApiError) [OrderService](/ad-manager/api/reference/v202411/OrderService.ApiError) [PlacementService](/ad-manager/api/reference/v202411/PlacementService.ApiError) [ProposalLineItemService](/ad-manager/api/reference/v202411/ProposalLineItemService.ApiError) [ProposalService](/ad-manager/api/reference/v202411/ProposalService.ApiError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202411/PublisherQueryLanguageService.ApiError) [ReportService](/ad-manager/api/reference/v202411/ReportService.ApiError) [SegmentPopulationService](/ad-manager/api/reference/v202411/SegmentPopulationService.ApiError) [SiteService](/ad-manager/api/reference/v202411/SiteService.ApiError) [StreamActivityMonitorService](/ad-manager/api/reference/v202411/StreamActivityMonitorService.ApiError) [SuggestedAdUnitService](/ad-manager/api/reference/v202411/SuggestedAdUnitService.ApiError) [TargetingPresetService](/ad-manager/api/reference/v202411/TargetingPresetService.ApiError) [TeamService](/ad-manager/api/reference/v202411/TeamService.ApiError) [UserService](/ad-manager/api/reference/v202411/UserService.ApiError) [UserTeamAssociationService](/ad-manager/api/reference/v202411/UserTeamAssociationService.ApiError) [YieldGroupService](/ad-manager/api/reference/v202411/YieldGroupService.ApiError) **Dependencies** \n[ApiException](/ad-manager/api/reference/v202411/CompanyService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/CompanyService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/CompanyService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/CompanyService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/CompanyService.CommonError) [CompanyCreditStatusError](/ad-manager/api/reference/v202411/CompanyService.CompanyCreditStatusError) [CompanyError](/ad-manager/api/reference/v202411/CompanyService.CompanyError) [CrossSellError](/ad-manager/api/reference/v202411/CompanyService.CrossSellError) [CustomFieldValueError](/ad-manager/api/reference/v202411/CompanyService.CustomFieldValueError) [ExchangeSignupApiError](/ad-manager/api/reference/v202411/CompanyService.ExchangeSignupApiError) [FeatureError](/ad-manager/api/reference/v202411/CompanyService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/CompanyService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202411/CompanyService.InvalidEmailError) [InvalidUrlError](/ad-manager/api/reference/v202411/CompanyService.InvalidUrlError) [InventoryClientApiError](/ad-manager/api/reference/v202411/CompanyService.InventoryClientApiError) [LabelEntityAssociationError](/ad-manager/api/reference/v202411/CompanyService.LabelEntityAssociationError) [McmError](/ad-manager/api/reference/v202411/CompanyService.McmError) [NetworkError](/ad-manager/api/reference/v202411/CompanyService.NetworkError) [NotNullError](/ad-manager/api/reference/v202411/CompanyService.NotNullError) [NullError](/ad-manager/api/reference/v202411/CompanyService.NullError) [ParseError](/ad-manager/api/reference/v202411/CompanyService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/CompanyService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/CompanyService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/CompanyService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/CompanyService.QuotaError) [RegExError](/ad-manager/api/reference/v202411/CompanyService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202411/CompanyService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/CompanyService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/CompanyService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/CompanyService.ServerError) [SiteError](/ad-manager/api/reference/v202411/CompanyService.SiteError) [StatementError](/ad-manager/api/reference/v202411/CompanyService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/CompanyService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/CompanyService.StringLengthError) [TeamError](/ad-manager/api/reference/v202411/CompanyService.TeamError) [TypeError](/ad-manager/api/reference/v202411/CompanyService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/CompanyService.UniqueError)\n\nThe API error base class that provides details about an error that occurred\nwhile processing a service request.\n\nThe OGNL field path is provided for parsers to identify the request data\nelement that may have caused the error.\n\n*** ** * ** ***\n\nNamespace\n:\n `https://www.google.com/apis/ads/publisher/v202411`\n\n| Field ----- ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202411/CompanyService.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. |"]]
