abstract type ApiError (v202408)
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/v202408
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, which provides details about errors during service requests.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e includes information like the field path causing the error, a parsed field path, the data triggering the error, and an error description.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the provided \u003ccode\u003efieldPath\u003c/code\u003e and \u003ccode\u003etrigger\u003c/code\u003e information to identify and debug issues in their Ad Manager API integrations.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e serves as the foundation for various specific error types, each with additional details, as listed under "Inheritance".\u003c/p\u003e\n"]]],["This document outlines the services and error handling within the Ad Manager API (v202408). It details numerous services, including AdRule, Adjustment, AdsTxt, AudienceSegment, and Company services, among others, with each having a specific function. The document also details how errors are handled. It provides an `ApiError` class with fields like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to identify error causes within service requests, and a list of subclasses of errors.\n"],null,["# abstract type ApiError (v202408)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202408/AdRuleService.ApiError) [AdjustmentService](/ad-manager/api/reference/v202408/AdjustmentService.ApiError) [AdsTxtService](/ad-manager/api/reference/v202408/AdsTxtService.ApiError) [AudienceSegmentService](/ad-manager/api/reference/v202408/AudienceSegmentService.ApiError) [CdnConfigurationService](/ad-manager/api/reference/v202408/CdnConfigurationService.ApiError) [CmsMetadataService](/ad-manager/api/reference/v202408/CmsMetadataService.ApiError) **CompanyService** [ContactService](/ad-manager/api/reference/v202408/ContactService.ApiError) [ContentBundleService](/ad-manager/api/reference/v202408/ContentBundleService.ApiError) [ContentService](/ad-manager/api/reference/v202408/ContentService.ApiError) [CreativeService](/ad-manager/api/reference/v202408/CreativeService.ApiError) [CreativeSetService](/ad-manager/api/reference/v202408/CreativeSetService.ApiError) [CreativeTemplateService](/ad-manager/api/reference/v202408/CreativeTemplateService.ApiError) [CreativeWrapperService](/ad-manager/api/reference/v202408/CreativeWrapperService.ApiError) [CustomFieldService](/ad-manager/api/reference/v202408/CustomFieldService.ApiError) [CustomTargetingService](/ad-manager/api/reference/v202408/CustomTargetingService.ApiError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202408/DaiAuthenticationKeyService.ApiError) [DaiEncodingProfileService](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ApiError) [ForecastService](/ad-manager/api/reference/v202408/ForecastService.ApiError) [InventoryService](/ad-manager/api/reference/v202408/InventoryService.ApiError) [LabelService](/ad-manager/api/reference/v202408/LabelService.ApiError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202408/LineItemCreativeAssociationService.ApiError) [LineItemService](/ad-manager/api/reference/v202408/LineItemService.ApiError) [LineItemTemplateService](/ad-manager/api/reference/v202408/LineItemTemplateService.ApiError) [LiveStreamEventService](/ad-manager/api/reference/v202408/LiveStreamEventService.ApiError) [MobileApplicationService](/ad-manager/api/reference/v202408/MobileApplicationService.ApiError) [NativeStyleService](/ad-manager/api/reference/v202408/NativeStyleService.ApiError) [NetworkService](/ad-manager/api/reference/v202408/NetworkService.ApiError) [OrderService](/ad-manager/api/reference/v202408/OrderService.ApiError) [PlacementService](/ad-manager/api/reference/v202408/PlacementService.ApiError) [ProposalLineItemService](/ad-manager/api/reference/v202408/ProposalLineItemService.ApiError) [ProposalService](/ad-manager/api/reference/v202408/ProposalService.ApiError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202408/PublisherQueryLanguageService.ApiError) [ReportService](/ad-manager/api/reference/v202408/ReportService.ApiError) [SegmentPopulationService](/ad-manager/api/reference/v202408/SegmentPopulationService.ApiError) [SiteService](/ad-manager/api/reference/v202408/SiteService.ApiError) [StreamActivityMonitorService](/ad-manager/api/reference/v202408/StreamActivityMonitorService.ApiError) [SuggestedAdUnitService](/ad-manager/api/reference/v202408/SuggestedAdUnitService.ApiError) [TargetingPresetService](/ad-manager/api/reference/v202408/TargetingPresetService.ApiError) [TeamService](/ad-manager/api/reference/v202408/TeamService.ApiError) [UserService](/ad-manager/api/reference/v202408/UserService.ApiError) [UserTeamAssociationService](/ad-manager/api/reference/v202408/UserTeamAssociationService.ApiError) [YieldGroupService](/ad-manager/api/reference/v202408/YieldGroupService.ApiError) **Dependencies** \n[ApiException](/ad-manager/api/reference/v202408/CompanyService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CompanyService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CompanyService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CompanyService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CompanyService.CommonError) [CompanyCreditStatusError](/ad-manager/api/reference/v202408/CompanyService.CompanyCreditStatusError) [CompanyError](/ad-manager/api/reference/v202408/CompanyService.CompanyError) [CrossSellError](/ad-manager/api/reference/v202408/CompanyService.CrossSellError) [CustomFieldValueError](/ad-manager/api/reference/v202408/CompanyService.CustomFieldValueError) [ExchangeSignupApiError](/ad-manager/api/reference/v202408/CompanyService.ExchangeSignupApiError) [FeatureError](/ad-manager/api/reference/v202408/CompanyService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CompanyService.InternalApiError) [InvalidEmailError](/ad-manager/api/reference/v202408/CompanyService.InvalidEmailError) [InvalidUrlError](/ad-manager/api/reference/v202408/CompanyService.InvalidUrlError) [InventoryClientApiError](/ad-manager/api/reference/v202408/CompanyService.InventoryClientApiError) [LabelEntityAssociationError](/ad-manager/api/reference/v202408/CompanyService.LabelEntityAssociationError) [McmError](/ad-manager/api/reference/v202408/CompanyService.McmError) [NetworkError](/ad-manager/api/reference/v202408/CompanyService.NetworkError) [NotNullError](/ad-manager/api/reference/v202408/CompanyService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CompanyService.NullError) [ParseError](/ad-manager/api/reference/v202408/CompanyService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CompanyService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CompanyService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CompanyService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CompanyService.QuotaError) [RegExError](/ad-manager/api/reference/v202408/CompanyService.RegExError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CompanyService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CompanyService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202408/CompanyService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202408/CompanyService.ServerError) [SiteError](/ad-manager/api/reference/v202408/CompanyService.SiteError) [StatementError](/ad-manager/api/reference/v202408/CompanyService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CompanyService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CompanyService.StringLengthError) [TeamError](/ad-manager/api/reference/v202408/CompanyService.TeamError) [TypeError](/ad-manager/api/reference/v202408/CompanyService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/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/v202408`\n\n| Field ----- ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202408/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. |"]]
