abstract type ApiError (v202408)
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/v202408
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\u003eThis page documents the \u003ccode\u003eApiError\u003c/code\u003e base class for the Google Ad Manager API's LineItemTemplateService.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eApiError\u003c/code\u003e objects provide details about errors encountered during service requests, including the cause and location within the request data.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eApiError\u003c/code\u003e include \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e, which offer insights into the nature and origin of the error.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003efieldPath\u003c/code\u003e and \u003ccode\u003efieldPathElements\u003c/code\u003e help pinpoint the specific data element responsible for the error.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the information in \u003ccode\u003eApiError\u003c/code\u003e objects to diagnose and resolve issues arising from interactions with the LineItemTemplateService.\u003c/p\u003e\n"]]],["This document outlines various services and associated errors within an ad management API, version 202408. It lists services like `AdRuleService`, `CreativeService`, and `LineItemService`. It details `ApiError`, the base class for errors, including the `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`, which are used to diagnose errors. It further specifies multiple specific error types inheriting from `ApiError`, such as `AuthenticationError` and `ForecastError`.\n"],null,[]]
