type CommonError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
A place for common errors that can be used across services.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202408
Field
|
ApiError (inherited)
|
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.
|
CommonError
|
reason
|
CommonError.Reason
Enumerations
-
NOT_FOUND
- Indicates that an attempt was made to retrieve an entity that does not
exist.
-
ALREADY_EXISTS
- Indicates that an attempt was made to create an entity that already
exists.
-
NOT_APPLICABLE
- Indicates that a value is not applicable for given use case.
-
DUPLICATE_OBJECT
- Indicates that two elements in the collection were identical.
-
CANNOT_UPDATE
- Indicates that an attempt was made to change an immutable field.
-
UNSUPPORTED_OPERATION
- Indicates that the requested operation is not supported.
-
CONCURRENT_MODIFICATION
- Indicates that another request attempted to update the same data in the same network
at about the same time. Please wait and try the request again.
-
UNKNOWN
- The value returned if the actual value is not exposed by the requested API version.
|
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 documentation details \u003ccode\u003eCommonError\u003c/code\u003e, a place for common errors used across Google Ad Manager services.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCommonError\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e and provides a \u003ccode\u003ereason\u003c/code\u003e field with specific error types like \u003ccode\u003eNOT_FOUND\u003c/code\u003e or \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field helps identify the cause of the error encountered within Ad Manager, offering insights for troubleshooting.\u003c/p\u003e\n"],["\u003cp\u003eThis error structure, using \u003ccode\u003eApiError\u003c/code\u003e as a base and detailing reasons via \u003ccode\u003eCommonError\u003c/code\u003e, promotes consistent error handling across services.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage the information provided in the \u003ccode\u003ereason\u003c/code\u003e field to understand and address common errors encountered when using Ad Manager APIs.\u003c/p\u003e\n"]]],["This document outlines the structure and details of various services and error types within an ad management API (v202408). It lists services like `AdRuleService`, `CompanyService`, `ForecastService`, and many others related to ad management operations. It also defines a set of `CommonError` types, including `NOT_FOUND`, `ALREADY_EXISTS`, and `UNSUPPORTED_OPERATION`, and a list of `ApiError` attributes. This information provides a framework for managing ads and handling potential errors during API interactions.\n"],null,[]]
