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 Google Ad Manager API provides a \u003ccode\u003eLiveStreamEventService\u003c/code\u003e for managing live stream events.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCommonError\u003c/code\u003e is a base error type used across various services, including the \u003ccode\u003eLiveStreamEventService\u003c/code\u003e, with reasons like \u003ccode\u003eNOT_FOUND\u003c/code\u003e, \u003ccode\u003eALREADY_EXISTS\u003c/code\u003e, and others.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eLiveStreamEventService\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e and includes specific errors related to live stream event management like \u003ccode\u003eLiveStreamEventDateTimeError\u003c/code\u003e, \u003ccode\u003eLiveStreamEventSlateError\u003c/code\u003e, and \u003ccode\u003eVideoAdTagError\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can utilize the \u003ccode\u003efieldPath\u003c/code\u003e, \u003ccode\u003etrigger\u003c/code\u003e, and \u003ccode\u003eerrorString\u003c/code\u003e properties of errors for debugging purposes.\u003c/p\u003e\n"]]],["The document outlines various services and their associated error types within the Ad Manager API (v202411), including `AdRuleService`, `AdjustmentService`, `LiveStreamEventService` and many more. `LiveStreamEventService` errors are detailed, inheriting from `ApiError`. These errors encompass issues like invalid URLs, API versions, authentication, feature limitations, and various LiveStream-specific errors. `CommonError` is shared across services, specifying reasons like `NOT_FOUND`, `ALREADY_EXISTS`, and `UNSUPPORTED_OPERATION`. The provided fields `fieldPath`, `trigger`, and `errorString`, help to identify the root cause of the errors.\n"],null,[]]