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\u003eThe \u003ccode\u003ePublisherQueryLanguageService.ApiError\u003c/code\u003e object provides details about errors during service requests, including the cause and location of the error.\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 and understand the error.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003efieldPath\u003c/code\u003e uses OGNL notation to pinpoint the error's origin within the request data.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003efieldPathElements\u003c/code\u003e offers a parsed, structured representation of the \u003ccode\u003efieldPath\u003c/code\u003e for easier programmatic access.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003etrigger\u003c/code\u003e and \u003ccode\u003eerrorString\u003c/code\u003e fields provide further context by revealing the specific data that caused the error and a human-readable explanation.\u003c/p\u003e\n"]]],["This document outlines various services and error types within an ad management API, version 202408. Services include managing ads, content, targeting, forecasts, and reporting. Dependencies list `ApiException`, which contains the error `ApiError`, its inheritance, and specific error types like `AuthenticationError`, `QuotaError`, and `ServerError`. `ApiError` details include `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`, pinpointing error locations within requests.\n"],null,[]]
