type CommonError (v202411)
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/v202411
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 AdRuleService and other services in Ad Manager share a set of common errors, which are documented here.\u003c/p\u003e\n"],["\u003cp\u003eThese errors, represented by the \u003ccode\u003eCommonError\u003c/code\u003e object, provide information about issues encountered during API operations, such as non-existent entities or unsupported actions.\u003c/p\u003e\n"],["\u003cp\u003eEach \u003ccode\u003eCommonError\u003c/code\u003e includes a \u003ccode\u003ereason\u003c/code\u003e field indicating the specific cause of the error, like \u003ccode\u003eNOT_FOUND\u003c/code\u003e or \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDetailed error information is provided through fields inherited from \u003ccode\u003eApiError\u003c/code\u003e, such as \u003ccode\u003efieldPath\u003c/code\u003e and \u003ccode\u003eerrorString\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis documentation helps developers understand and troubleshoot errors when using the Ad Manager API.\u003c/p\u003e\n"]]],["The content details various services within an ad management system, including `AdRuleService`, `AdsTxtService`, `AudienceSegmentService`, and others, totaling over 40 different services. Each service links to a potential `CommonError`. `CommonError` is described as a collection of standard errors across services, listing reasons such as `NOT_FOUND`, `ALREADY_EXISTS`, and `UNSUPPORTED_OPERATION`. It also outlines the inheritance structure and the `ApiError` class, including fields like `fieldPath`, `trigger`, and `errorString`.\n"],null,[]]
