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 \u003ccode\u003eLiveStreamEventService.ApiError\u003c/code\u003e object provides details about errors encountered during service requests in Google Ad Manager.\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 to help identify the cause and context of the error.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003efieldPath\u003c/code\u003e uses OGNL notation to pinpoint the request data element that might have led to the error.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003efieldPathElements\u003c/code\u003e offers a parsed representation of the field path for easier programmatic access.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etrigger\u003c/code\u003e and \u003ccode\u003eerrorString\u003c/code\u003e fields give additional information about the error's origin and nature.\u003c/p\u003e\n"]]],["This document outlines various services and their associated API errors within the Ad Manager API (v202411). It lists services like AdRuleService, AdjustmentService, and LiveStreamEventService, among others. Each service can return specific errors like AuthenticationError or QuotaError. The base ApiError class provides details about request processing issues, including the `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to pinpoint the source of the error.\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](/ad-manager/api/reference/v202411/DaiEncodingProfileService.ApiError) [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** [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/LiveStreamEventService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[AdBreakMarkupError](/ad-manager/api/reference/v202411/LiveStreamEventService.AdBreakMarkupError) [ApiVersionError](/ad-manager/api/reference/v202411/LiveStreamEventService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/LiveStreamEventService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/LiveStreamEventService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/LiveStreamEventService.CommonError) [EntityLimitReachedError](/ad-manager/api/reference/v202411/LiveStreamEventService.EntityLimitReachedError) [FeatureError](/ad-manager/api/reference/v202411/LiveStreamEventService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/LiveStreamEventService.InternalApiError) [InvalidUrlError](/ad-manager/api/reference/v202411/LiveStreamEventService.InvalidUrlError) [LiveStreamEventActionError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventActionError) [LiveStreamEventCdnSettingsE...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventCdnSettingsError \"LiveStreamEventCdnSettingsError\") [LiveStreamEventConditioning...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventConditioningError \"LiveStreamEventConditioningError\") [LiveStreamEventCustomAssetK...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventCustomAssetKeyError \"LiveStreamEventCustomAssetKeyError\") [LiveStreamEventDateTimeError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventDateTimeError) [LiveStreamEventDvrWindowError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventDvrWindowError) [LiveStreamEventPrerollSetti...](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventPrerollSettingsError \"LiveStreamEventPrerollSettingsError\") [LiveStreamEventSlateError](/ad-manager/api/reference/v202411/LiveStreamEventService.LiveStreamEventSlateError) [NotNullError](/ad-manager/api/reference/v202411/LiveStreamEventService.NotNullError) [NullError](/ad-manager/api/reference/v202411/LiveStreamEventService.NullError) [ParseError](/ad-manager/api/reference/v202411/LiveStreamEventService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/LiveStreamEventService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/LiveStreamEventService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/LiveStreamEventService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/LiveStreamEventService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/LiveStreamEventService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202411/LiveStreamEventService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/LiveStreamEventService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/LiveStreamEventService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/LiveStreamEventService.ServerError) [StatementError](/ad-manager/api/reference/v202411/LiveStreamEventService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/LiveStreamEventService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/LiveStreamEventService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202411/LiveStreamEventService.UniqueError) [VideoAdTagError](/ad-manager/api/reference/v202411/LiveStreamEventService.VideoAdTagError)\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/LiveStreamEventService.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. |"]]
