type CommonError (v202411)
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 2024-11-19 UTC.
[null,null,["Last updated 2024-11-19 UTC."],[[["This webpage lists various services available in the Ad Manager API v202411, including AdRuleService, AdjustmentService, and many others related to ad management, targeting, and reporting."],["It provides detailed information on `CommonError`, a class used to handle errors across multiple services, defining its properties like `fieldPath`, `trigger`, and `reason` with a link for further exploration."],["The `CommonError` class defines a set of error reasons via enumeration, such as `NOT_FOUND`, `ALREADY_EXISTS`, `CANNOT_UPDATE`, and `UNSUPPORTED_OPERATION`, which are used to specify the cause of an error."],["The webpage includes an `ApiError` class, which can be inherited, outlining essential properties like `fieldPath` and `errorString` for identifying and describing the details of specific errors encountered during API interactions."],["The content covers several error types derived from `CommonError` such as `ApiVersionError`, `AssetError`, `AuthenticationError`, and many others, each representing distinct potential issues."]]],["This document outlines various services and common errors within an ad management API, version v202411. It lists numerous services like AdRuleService, CreativeService, OrderService, and ReportService, each with associated potential `CommonError` types. The `CommonError` section details possible issues, including `NOT_FOUND`, `ALREADY_EXISTS`, `CANNOT_UPDATE`, `DUPLICATE_OBJECT`, `UNSUPPORTED_OPERATION`, and `CONCURRENT_MODIFICATION`. `ApiError` inheritance is also present with properties such as `fieldPath`, and `errorString`.\n"]]
