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 outlines \u003ccode\u003eCommonError\u003c/code\u003e in Google Ad Manager API, detailing the common errors that can occur across various services.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCommonError\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e and includes the \u003ccode\u003ereason\u003c/code\u003e field to provide specific details about the error.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field is an enumeration with values like \u003ccode\u003eNOT_FOUND\u003c/code\u003e, \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e, \u003ccode\u003eNOT_APPLICABLE\u003c/code\u003e, and more, offering insight into the nature of the error.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the information provided by \u003ccode\u003eCommonError\u003c/code\u003e to troubleshoot and resolve issues encountered when interacting with the Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCommonError\u003c/code\u003e includes information about the field path and trigger that caused the error, providing context for debugging.\u003c/p\u003e\n"]]],["This document outlines services and error handling within an ad management API (v202408). It lists various services like AdRuleService, AdjustmentService, and others, each with potential errors. The `CommonError` details shared error `reasons` such as `NOT_FOUND`, `ALREADY_EXISTS`, and `CANNOT_UPDATE`. It also defines an `ApiError`, including information on the error's `fieldPath`, `trigger`, and a descriptive `errorString`. These errors are used across the listed services.\n"],null,[]]