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 \u003ccode\u003eCmsMetadataService\u003c/code\u003e allows management of CMS metadata in Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eCommon errors encountered when using the service include issues like entities not found, entities already existing, or unsupported operations.\u003c/p\u003e\n"],["\u003cp\u003eErrors are detailed with \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e providing context and debugging information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCommonError.Reason\u003c/code\u003e enum further categorizes errors for better understanding and troubleshooting.\u003c/p\u003e\n"],["\u003cp\u003eThe service utilizes a namespace of \u003ccode\u003ehttps://www.google.com/apis/ads/publisher/v202408\u003c/code\u003e for interactions within the Ad Manager API.\u003c/p\u003e\n"]]],["This document outlines services and common errors within an ad management API (v202408). It lists various services like `AdRuleService`, `AdjustmentService`, `CmsMetadataService`, and others. It defines `CommonError` and its possible reasons: `NOT_FOUND`, `ALREADY_EXISTS`, `NOT_APPLICABLE`, `DUPLICATE_OBJECT`, `CANNOT_UPDATE`, `UNSUPPORTED_OPERATION`, `CONCURRENT_MODIFICATION`, and `UNKNOWN`. The `ApiError` includes fields like `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` for detailed error information.\n"],null,[]]
