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\u003eThe DaiEncodingProfileService API handles encoding profiles for Dynamic Ad Insertion (DAI).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e is the base class for errors in the service, offering details like the error cause and location.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e provide specific information about the error encountered.\u003c/p\u003e\n"],["\u003cp\u003eThis service allows management and configuration of encoding profiles for optimizing DAI streams.\u003c/p\u003e\n"]]],["This document outlines various services and potential errors within an ad management API, version v202411. Services include managing ads, audiences, content, creatives, forecasts, inventory, users, and more. Errors are categorized and detailed, including `ApiError`, `AuthenticationError`, and `InternalApiError`. `ApiError` contains fields like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to pinpoint error locations and causes, along with the namespace for each.\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** [ForecastService](/ad-manager/api/reference/v202411/ForecastService.ApiError) [InventoryService](/ad-manager/api/reference/v202411/InventoryService.ApiError) [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/DaiEncodingProfileService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.CommonError) [DaiEncodingProfileAdMatchin...](/ad-manager/api/reference/v202411/DaiEncodingProfileService.DaiEncodingProfileAdMatchingError \"DaiEncodingProfileAdMatchingError\") [DaiEncodingProfileContainer...](/ad-manager/api/reference/v202411/DaiEncodingProfileService.DaiEncodingProfileContainerSettingsError \"DaiEncodingProfileContainerSettingsError\") [DaiEncodingProfileNameError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.DaiEncodingProfileNameError) [DaiEncodingProfileUpdateError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.DaiEncodingProfileUpdateError) [DaiEncodingProfileVariantSe...](/ad-manager/api/reference/v202411/DaiEncodingProfileService.DaiEncodingProfileVariantSettingsError \"DaiEncodingProfileVariantSettingsError\") [EntityLimitReachedError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.InternalApiError) [NotNullError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.NotNullError) [NullError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.NullError) [ParseError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/DaiEncodingProfileService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/DaiEncodingProfileService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.RequiredError) [ServerError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.ServerError) [StatementError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/DaiEncodingProfileService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202411/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/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/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. |"]]
