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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis page provides details about the \u003ccode\u003eApiError\u003c/code\u003e base class in the Google Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e objects offer information regarding errors encountered during service request processing, including the OGNL field path, data causing the error, and error reason.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e fields within \u003ccode\u003eApiError\u003c/code\u003e for debugging and troubleshooting purposes.\u003c/p\u003e\n"],["\u003cp\u003eThis class acts as the foundation for various specific error types within the Ad Manager API, enabling granular error handling and resolution.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including `AdRuleService`, `AudienceSegmentService`, and `CreativeService`, among many others. It details the `ApiError` structure, which serves as a base class for errors encountered during service requests. Key components of `ApiError` are `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`, used to pinpoint and describe the source and nature of the error. Several specific error types that extend from `ApiError` are also listed.\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](/ad-manager/api/reference/v202408/CustomTargetingService.ApiError) [DaiAuthenticationKeyService](/ad-manager/api/reference/v202408/DaiAuthenticationKeyService.ApiError) **DaiEncodingProfileService** [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/DaiEncodingProfileService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.CommonError) [DaiEncodingProfileAdMatchin...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileAdMatchingError \"DaiEncodingProfileAdMatchingError\") [DaiEncodingProfileContainer...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileContainerSettingsError \"DaiEncodingProfileContainerSettingsError\") [DaiEncodingProfileNameError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileNameError) [DaiEncodingProfileUpdateError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileUpdateError) [DaiEncodingProfileVariantSe...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.DaiEncodingProfileVariantSettingsError \"DaiEncodingProfileVariantSettingsError\") [EntityLimitReachedError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.NotNullError) [NullError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.NullError) [ParseError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ParseError) [PermissionError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202408/DaiEncodingProfileService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.QuotaError) [RangeError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.RequiredError) [ServerError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.ServerError) [StatementError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.StatementError) [StringFormatError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202408/DaiEncodingProfileService.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/DaiEncodingProfileService.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. |"]]
