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 document outlines the \u003ccode\u003eApiError\u003c/code\u003e base class in Google Ad Manager's API, detailing errors during service requests.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e provides information such as the field path causing the error, parsed elements of the path, the triggering data, and an error description.\u003c/p\u003e\n"],["\u003cp\u003eThe OGNL field path helps identify the problematic data, and \u003ccode\u003efieldPathElements\u003c/code\u003e offers a parsed representation for easier analysis.\u003c/p\u003e\n"],["\u003cp\u003eDetails like the data that caused the error (\u003ccode\u003etrigger\u003c/code\u003e) and an error summary (\u003ccode\u003eerrorString\u003c/code\u003e) are also included within \u003ccode\u003eApiError\u003c/code\u003e objects.\u003c/p\u003e\n"],["\u003cp\u003eThis class acts as a foundation for more specific error types within the Google Ad Manager API, enabling detailed error handling.\u003c/p\u003e\n"]]],["The content details numerous services within an ad management API, including AdRule, Adjustment, AdsTxt, AudienceSegment, and many others. It outlines dependencies like `ApiException`, and `ApiError`, and lists specific error types under the `ApiError` inheritance. `ApiError` describes issues during service requests, specifying the `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to identify error causes, providing an OGNL path to data elements that might be at fault.\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** [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/InventoryService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[AdSenseAccountError](/ad-manager/api/reference/v202411/InventoryService.AdSenseAccountError) [AdUnitCodeError](/ad-manager/api/reference/v202411/InventoryService.AdUnitCodeError) [AdUnitHierarchyError](/ad-manager/api/reference/v202411/InventoryService.AdUnitHierarchyError) [ApiVersionError](/ad-manager/api/reference/v202411/InventoryService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/InventoryService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/InventoryService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/InventoryService.CommonError) [CompanyError](/ad-manager/api/reference/v202411/InventoryService.CompanyError) [CreativeWrapperError](/ad-manager/api/reference/v202411/InventoryService.CreativeWrapperError) [CrossSellError](/ad-manager/api/reference/v202411/InventoryService.CrossSellError) [EntityChildrenLimitReachedE...](/ad-manager/api/reference/v202411/InventoryService.EntityChildrenLimitReachedError \"EntityChildrenLimitReachedError\") [EntityLimitReachedError](/ad-manager/api/reference/v202411/InventoryService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/InventoryService.FeatureError) [FrequencyCapError](/ad-manager/api/reference/v202411/InventoryService.FrequencyCapError) [InternalApiError](/ad-manager/api/reference/v202411/InventoryService.InternalApiError) [InvalidColorError](/ad-manager/api/reference/v202411/InventoryService.InvalidColorError) [InvalidUrlError](/ad-manager/api/reference/v202411/InventoryService.InvalidUrlError) [InventoryUnitError](/ad-manager/api/reference/v202411/InventoryService.InventoryUnitError) [InventoryUnitRefreshRateError](/ad-manager/api/reference/v202411/InventoryService.InventoryUnitRefreshRateError) [InventoryUnitSizesError](/ad-manager/api/reference/v202411/InventoryService.InventoryUnitSizesError) [LabelEntityAssociationError](/ad-manager/api/reference/v202411/InventoryService.LabelEntityAssociationError) [NotNullError](/ad-manager/api/reference/v202411/InventoryService.NotNullError) [NullError](/ad-manager/api/reference/v202411/InventoryService.NullError) [ParseError](/ad-manager/api/reference/v202411/InventoryService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/InventoryService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/InventoryService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/InventoryService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/InventoryService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/InventoryService.RangeError) [RegExError](/ad-manager/api/reference/v202411/InventoryService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202411/InventoryService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/InventoryService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/InventoryService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/InventoryService.ServerError) [StatementError](/ad-manager/api/reference/v202411/InventoryService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/InventoryService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/InventoryService.StringLengthError) [TeamError](/ad-manager/api/reference/v202411/InventoryService.TeamError) [TypeError](/ad-manager/api/reference/v202411/InventoryService.TypeError) [UniqueError](/ad-manager/api/reference/v202411/InventoryService.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/InventoryService.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. |"]]
