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\u003eThis document provides an overview of various services and their associated common errors within the Google Ad Manager API, version 202411.\u003c/p\u003e\n"],["\u003cp\u003eThe services listed include AdRuleService, AdjustmentService, AdsTxtService, and many more, covering a wide range of functionalities from content management to forecasting and reporting.\u003c/p\u003e\n"],["\u003cp\u003eIt details the structure of the \u003ccode\u003eApiError\u003c/code\u003e, including fields such as \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003efieldPathElements\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e, which provide information about the cause of the error.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCommonError\u003c/code\u003e section lists the possible reasons for errors, such as \u003ccode\u003eNOT_FOUND\u003c/code\u003e, \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e, and \u003ccode\u003eUNSUPPORTED_OPERATION\u003c/code\u003e, along with brief explanations for each.\u003c/p\u003e\n"],["\u003cp\u003eThe document also presents the inheritance structure, showing that various error types, such as \u003ccode\u003eApiVersionError\u003c/code\u003e, \u003ccode\u003eAuthenticationError\u003c/code\u003e, and others, inherit from \u003ccode\u003eApiError\u003c/code\u003e.\u003c/p\u003e\n"]]],["The document outlines various services and their associated common errors within the Ad Manager API (v202411), including `AdRuleService`, `AdjustmentService`, `CustomTargetingService` and many others. The core focus details the `CommonError` type, which has fields like `reason`, `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` used for error handling. Specific reasons like `NOT_FOUND`, `ALREADY_EXISTS`, `CANNOT_UPDATE`, and `UNKNOWN` are defined for diagnosing issues across all listed services.\n"],null,[]]
