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 content focuses on the \u003ccode\u003eCommonError\u003c/code\u003e object in Google Ad Manager's API.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCommonError\u003c/code\u003e is a base error type used across various Ad Manager services and indicates common issues encountered during API operations.\u003c/p\u003e\n"],["\u003cp\u003eThis object includes fields like \u003ccode\u003ereason\u003c/code\u003e which provides specific details about the error, such as \u003ccode\u003eNOT_FOUND\u003c/code\u003e or \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt inherits from \u003ccode\u003eApiError\u003c/code\u003e providing additional context with fields like \u003ccode\u003efieldPath\u003c/code\u003e and \u003ccode\u003etrigger\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the information in \u003ccode\u003eCommonError\u003c/code\u003e to troubleshoot and resolve issues in their Ad Manager API integrations.\u003c/p\u003e\n"]]],["This document outlines various services and associated errors within the Google Ad Manager API (v202408). It lists numerous services like AdRuleService, AdjustmentService, AudienceSegmentService, and others. The document also details a hierarchy of common error types, including ApiError, ApiVersionError, and CommonError. CommonError contains error `reasons` such as `NOT_FOUND`, `ALREADY_EXISTS`, `CANNOT_UPDATE`, and `UNKNOWN`. The `ApiError` details the error by `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`.\n"],null,[]]
