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 documents the \u003ccode\u003eApiError\u003c/code\u003e base class for the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e provides details about errors during service requests, including the cause and location of the error.\u003c/p\u003e\n"],["\u003cp\u003eIt includes fields like \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e for debugging.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003efieldPath\u003c/code\u003e helps identify the problematic data element, while \u003ccode\u003etrigger\u003c/code\u003e shows the specific data causing the issue.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the information in \u003ccode\u003eApiError\u003c/code\u003e to understand and resolve errors in their Ad Manager integrations.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including `AdRuleService`, `AdjustmentService`, and `AudienceSegmentService`, among many others. It details the `ApiError` base class, which provides information on errors that occur during service requests. Key details include the `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`. These elements help to identify the error location and nature. Several specific error types are also listed, such as `AuthenticationError` and `QuotaError`.\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](/ad-manager/api/reference/v202411/CompanyService.ApiError) [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** [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/LabelService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/LabelService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/LabelService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/LabelService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/LabelService.CommonError) [CreativeWrapperError](/ad-manager/api/reference/v202411/LabelService.CreativeWrapperError) [FeatureError](/ad-manager/api/reference/v202411/LabelService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/LabelService.InternalApiError) [LabelError](/ad-manager/api/reference/v202411/LabelService.LabelError) [NotNullError](/ad-manager/api/reference/v202411/LabelService.NotNullError) [NullError](/ad-manager/api/reference/v202411/LabelService.NullError) [ParseError](/ad-manager/api/reference/v202411/LabelService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/LabelService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/LabelService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/LabelService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/LabelService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202411/LabelService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/LabelService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/LabelService.ServerError) [StatementError](/ad-manager/api/reference/v202411/LabelService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/LabelService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/LabelService.StringLengthError) [TypeError](/ad-manager/api/reference/v202411/LabelService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/LabelService.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/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. |"]]
