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\u003eThe Google Ad Manager API provides a CommonError object to handle frequent errors across various services.\u003c/p\u003e\n"],["\u003cp\u003eCommonError includes a reason field indicating the cause of the error like \u003ccode\u003eNOT_FOUND\u003c/code\u003e, \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e, \u003ccode\u003eNOT_APPLICABLE\u003c/code\u003e, \u003ccode\u003eDUPLICATE_OBJECT\u003c/code\u003e, \u003ccode\u003eCANNOT_UPDATE\u003c/code\u003e, \u003ccode\u003eUNSUPPORTED_OPERATION\u003c/code\u003e, and more.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the reason field to identify and handle specific error scenarios encountered while using the Ad Manager API.\u003c/p\u003e\n"],["\u003cp\u003eIt's part of the namespace \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e and inherits from the \u003ccode\u003eApiError\u003c/code\u003e object which provides additional error details.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCommonError\u003c/code\u003e object is crucial for troubleshooting and implementing robust error handling in Ad Manager API integrations.\u003c/p\u003e\n"]]],["The document outlines various services within an ad management API, including `AdRuleService`, `AdjustmentService`, and `CreativeService`. It details common error types like `ApiError`, with fields such as `fieldPath` and `errorString`, and `CommonError`, with reasons like `NOT_FOUND`, `ALREADY_EXISTS`, `DUPLICATE_OBJECT`, and `UNKNOWN`. These errors help identify issues when interacting with the API's services, ensuring data validity and operational integrity. This set of error is under the version v202408 and all the errors inherit from `ApiError`.\n"],null,[]]
