abstract type ApiError (v202502)
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/v202502
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."],[],["The core content details various services within an ad management API, such as AdRuleService, AudienceSegmentService, and ForecastService. It also outlines dependencies, specifically the ApiException and its subclasses, which include errors like AuthenticationError and InternalApiError. The API error base class, `ApiError`, contains attributes `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`, which identify the location and cause of errors encountered during service requests. The namespace for these services is provided as well.\n"],null,["# abstract type ApiError (v202502)\n\n**Service** \n[AdRuleService](/ad-manager/api/reference/v202502/AdRuleService.ApiError) [AdjustmentService](/ad-manager/api/reference/v202502/AdjustmentService.ApiError) [AdsTxtService](/ad-manager/api/reference/v202502/AdsTxtService.ApiError) [AudienceSegmentService](/ad-manager/api/reference/v202502/AudienceSegmentService.ApiError) [CdnConfigurationService](/ad-manager/api/reference/v202502/CdnConfigurationService.ApiError) [CmsMetadataService](/ad-manager/api/reference/v202502/CmsMetadataService.ApiError) [CompanyService](/ad-manager/api/reference/v202502/CompanyService.ApiError) [ContactService](/ad-manager/api/reference/v202502/ContactService.ApiError) [ContentBundleService](/ad-manager/api/reference/v202502/ContentBundleService.ApiError) [ContentService](/ad-manager/api/reference/v202502/ContentService.ApiError) [CreativeService](/ad-manager/api/reference/v202502/CreativeService.ApiError) [CreativeSetService](/ad-manager/api/reference/v202502/CreativeSetService.ApiError) [CreativeTemplateService](/ad-manager/api/reference/v202502/CreativeTemplateService.ApiError) [CreativeWrapperService](/ad-manager/api/reference/v202502/CreativeWrapperService.ApiError) [CustomFieldService](/ad-manager/api/reference/v202502/CustomFieldService.ApiError) [CustomTargetingService](/ad-manager/api/reference/v202502/CustomTargetingService.ApiError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202502/DaiAuthenticationKeyService.ApiError) [DaiEncodingProfileService](/ad-manager/api/reference/v202502/DaiEncodingProfileService.ApiError) [ForecastService](/ad-manager/api/reference/v202502/ForecastService.ApiError) [InventoryService](/ad-manager/api/reference/v202502/InventoryService.ApiError) [LabelService](/ad-manager/api/reference/v202502/LabelService.ApiError) [LineItemCreativeAssociationService](/ad-manager/api/reference/v202502/LineItemCreativeAssociationService.ApiError) [LineItemService](/ad-manager/api/reference/v202502/LineItemService.ApiError) [LineItemTemplateService](/ad-manager/api/reference/v202502/LineItemTemplateService.ApiError) [LiveStreamEventService](/ad-manager/api/reference/v202502/LiveStreamEventService.ApiError) **MobileApplicationService** [NativeStyleService](/ad-manager/api/reference/v202502/NativeStyleService.ApiError) [NetworkService](/ad-manager/api/reference/v202502/NetworkService.ApiError) [OrderService](/ad-manager/api/reference/v202502/OrderService.ApiError) [PlacementService](/ad-manager/api/reference/v202502/PlacementService.ApiError) [ProposalLineItemService](/ad-manager/api/reference/v202502/ProposalLineItemService.ApiError) [ProposalService](/ad-manager/api/reference/v202502/ProposalService.ApiError) [PublisherQueryLanguageService](/ad-manager/api/reference/v202502/PublisherQueryLanguageService.ApiError) [ReportService](/ad-manager/api/reference/v202502/ReportService.ApiError) [SegmentPopulationService](/ad-manager/api/reference/v202502/SegmentPopulationService.ApiError) [SiteService](/ad-manager/api/reference/v202502/SiteService.ApiError) [StreamActivityMonitorService](/ad-manager/api/reference/v202502/StreamActivityMonitorService.ApiError) [SuggestedAdUnitService](/ad-manager/api/reference/v202502/SuggestedAdUnitService.ApiError) [TargetingPresetService](/ad-manager/api/reference/v202502/TargetingPresetService.ApiError) [TeamService](/ad-manager/api/reference/v202502/TeamService.ApiError) [UserService](/ad-manager/api/reference/v202502/UserService.ApiError) [UserTeamAssociationService](/ad-manager/api/reference/v202502/UserTeamAssociationService.ApiError) [YieldGroupService](/ad-manager/api/reference/v202502/YieldGroupService.ApiError) **Dependencies** \n[ApiException](/ad-manager/api/reference/v202502/MobileApplicationService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202502/MobileApplicationService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202502/MobileApplicationService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202502/MobileApplicationService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202502/MobileApplicationService.CommonError) [FeatureError](/ad-manager/api/reference/v202502/MobileApplicationService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202502/MobileApplicationService.InternalApiError) [MobileApplicationActionError](/ad-manager/api/reference/v202502/MobileApplicationService.MobileApplicationActionError) [MobileApplicationError](/ad-manager/api/reference/v202502/MobileApplicationService.MobileApplicationError) [NotNullError](/ad-manager/api/reference/v202502/MobileApplicationService.NotNullError) [NullError](/ad-manager/api/reference/v202502/MobileApplicationService.NullError) [ParseError](/ad-manager/api/reference/v202502/MobileApplicationService.ParseError) [PermissionError](/ad-manager/api/reference/v202502/MobileApplicationService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202502/MobileApplicationService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202502/MobileApplicationService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202502/MobileApplicationService.QuotaError) [RequiredCollectionError](/ad-manager/api/reference/v202502/MobileApplicationService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202502/MobileApplicationService.RequiredError) [ServerError](/ad-manager/api/reference/v202502/MobileApplicationService.ServerError) [StatementError](/ad-manager/api/reference/v202502/MobileApplicationService.StatementError) [StringFormatError](/ad-manager/api/reference/v202502/MobileApplicationService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202502/MobileApplicationService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202502/MobileApplicationService.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/v202502`\n\n| Field ----- ||\n|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ### `fieldPath` | ` `xsd:`string` The OGNL field path to identify cause of error. |\n| ### `fieldPathElements` | ` `[FieldPathElement](/ad-manager/api/reference/v202502/MobileApplicationService.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. |"]]
