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 within the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e provides detailed information 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 comprehensive error reporting.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this information to debug and resolve issues arising from API interactions.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including AdRule, Adjustment, AdsTxt, AudienceSegment, and many others. It details dependencies like `ApiException` and `ApiError`, focusing on the `CustomTargetingService`. `ApiError` provides details about errors during service requests, offering field paths, specific elements, the data causing the error, and a string representation of the error. It specifies the namespace and outlines the different fields.\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](/ad-manager/api/reference/v202408/CompanyService.ApiError) [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** [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/CustomTargetingService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/CustomTargetingService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/CustomTargetingService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/CustomTargetingService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/CustomTargetingService.CommonError) [CustomTargetingError](/ad-manager/api/reference/v202408/CustomTargetingService.CustomTargetingError) [EntityChildrenLimitReachedE...](/ad-manager/api/reference/v202408/CustomTargetingService.EntityChildrenLimitReachedError \"EntityChildrenLimitReachedError\") [EntityLimitReachedError](/ad-manager/api/reference/v202408/CustomTargetingService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/CustomTargetingService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/CustomTargetingService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/CustomTargetingService.NotNullError) [NullError](/ad-manager/api/reference/v202408/CustomTargetingService.NullError) [ParseError](/ad-manager/api/reference/v202408/CustomTargetingService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/CustomTargetingService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/CustomTargetingService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/CustomTargetingService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/CustomTargetingService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202408/CustomTargetingService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/CustomTargetingService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/CustomTargetingService.ServerError) [StatementError](/ad-manager/api/reference/v202408/CustomTargetingService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/CustomTargetingService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/CustomTargetingService.StringLengthError) [TypeError](/ad-manager/api/reference/v202408/CustomTargetingService.TypeError) [UniqueError](/ad-manager/api/reference/v202408/CustomTargetingService.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/CustomTargetingService.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. |"]]
