AI-generated Key Takeaways
-
CommonError provides a centralized place for error definitions used across different services.
-
It includes inherited fields like
fieldPath,fieldPathElements,trigger, anderrorStringfromApiErrorto help identify the cause of an error. -
CommonError defines a
reasonfield with various enumeration values indicating specific error types such asNOT_FOUND,ALREADY_EXISTS,CANNOT_UPDATE, andUNSUPPORTED_OPERATION.
A place for common errors that can be used across services.
- Namespace
-
https://www.google.com/apis/ads/publisher/v202411
Field
ApiError
(inherited) fieldPath
xsd:
string
The OGNL field path to identify cause of error.
fieldPathElements
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
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.
