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 CreativeTemplateService API handles creative template operations within Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eThis documentation details the errors that can occur when using the CreativeTemplateService API.\u003c/p\u003e\n"],["\u003cp\u003eEach error object provides a field path, trigger, and a detailed error string.\u003c/p\u003e\n"],["\u003cp\u003eThis information helps developers to identify and resolve issues during API integration.\u003c/p\u003e\n"],["\u003cp\u003eErrors can be related to various aspects such as authentication, data formats, or permissions.\u003c/p\u003e\n"]]],["This document outlines various services within an ad management API, including `AdRuleService`, `CreativeService`, and `ForecastService`, among others. It details the structure of `ApiError`, an error-handling base class. This includes fields like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to specify error location and details within a service request. Also it contains the `ApiError` inheritance and related errors like `AuthenticationError`, `InternalApiError`, and `QuotaError`.\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** [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](/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/CreativeTemplateService.ApiException) \n▼\n**ApiError** **Inheritance** \n**ApiError** \n▼\n[ApiVersionError](/ad-manager/api/reference/v202411/CreativeTemplateService.ApiVersionError) [AuthenticationError](/ad-manager/api/reference/v202411/CreativeTemplateService.AuthenticationError) [CollectionSizeError](/ad-manager/api/reference/v202411/CreativeTemplateService.CollectionSizeError) [CommonError](/ad-manager/api/reference/v202411/CreativeTemplateService.CommonError) [CreativeTemplateError](/ad-manager/api/reference/v202411/CreativeTemplateService.CreativeTemplateError) [CreativeTemplateOperationError](/ad-manager/api/reference/v202411/CreativeTemplateService.CreativeTemplateOperationError) [FeatureError](/ad-manager/api/reference/v202411/CreativeTemplateService.FeatureError) [InternalApiError](/ad-manager/api/reference/v202411/CreativeTemplateService.InternalApiError) [InvalidUrlError](/ad-manager/api/reference/v202411/CreativeTemplateService.InvalidUrlError) [NotNullError](/ad-manager/api/reference/v202411/CreativeTemplateService.NotNullError) [NullError](/ad-manager/api/reference/v202411/CreativeTemplateService.NullError) [ParseError](/ad-manager/api/reference/v202411/CreativeTemplateService.ParseError) [PermissionError](/ad-manager/api/reference/v202411/CreativeTemplateService.PermissionError) [PublisherQueryLanguageConte...](/ad-manager/api/reference/v202411/CreativeTemplateService.PublisherQueryLanguageContextError \"PublisherQueryLanguageContextError\") [PublisherQueryLanguageSynta...](/ad-manager/api/reference/v202411/CreativeTemplateService.PublisherQueryLanguageSyntaxError \"PublisherQueryLanguageSyntaxError\") [QuotaError](/ad-manager/api/reference/v202411/CreativeTemplateService.QuotaError) [RangeError](/ad-manager/api/reference/v202411/CreativeTemplateService.RangeError) [RequiredCollectionError](/ad-manager/api/reference/v202411/CreativeTemplateService.RequiredCollectionError) [RequiredError](/ad-manager/api/reference/v202411/CreativeTemplateService.RequiredError) [RequiredNumberError](/ad-manager/api/reference/v202411/CreativeTemplateService.RequiredNumberError) [ServerError](/ad-manager/api/reference/v202411/CreativeTemplateService.ServerError) [StatementError](/ad-manager/api/reference/v202411/CreativeTemplateService.StatementError) [StringFormatError](/ad-manager/api/reference/v202411/CreativeTemplateService.StringFormatError) [StringLengthError](/ad-manager/api/reference/v202411/CreativeTemplateService.StringLengthError) [UniqueError](/ad-manager/api/reference/v202411/CreativeTemplateService.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/CreativeTemplateService.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. |"]]
