type OrderActionError (v202411)
Stay organized with collections
Save and categorize content based on your preferences.
Lists all errors associated with performing actions on Order objects.
- 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.
|
OrderActionError
|
reason
|
OrderActionError.Reason
The error reason represented by an enum.
Enumerations
-
PERMISSION_DENIED
- The operation is not allowed due to lack of permissions.
-
NOT_APPLICABLE
- The operation is not applicable for the current state of the
Order.
-
IS_ARCHIVED
- The Order is archived, an OrderAction cannot be applied
to an archived order.
-
HAS_ENDED
- The Order is past its end date, An OrderAction cannot
be applied to a order that has ended.
-
CANNOT_APPROVE_WITH_UNRESERVED_LINE_ITEMS
- A Order cannot be approved if it contains reservable
LineItems that are unreserved.
-
CANNOT_DELETE_ORDER_WITH_DELIVERED_LINEITEMS
- Deleting an Order with delivered line items is not allowed
-
CANNOT_APPROVE_COMPANY_CREDIT_STATUS_NOT_ACTIVE
- Cannot approve because company credit status is not active.
-
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 documentation details \u003ccode\u003eOrderActionError\u003c/code\u003e, which lists errors encountered when performing actions on Google Ad Manager orders.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eOrderActionError\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e and includes a \u003ccode\u003ereason\u003c/code\u003e field indicating the specific error type.\u003c/p\u003e\n"],["\u003cp\u003eReasons for errors can include permission issues, order status (archived, ended), unreserved line items in orders, and company credit status.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field is represented by an enum with values such as \u003ccode\u003ePERMISSION_DENIED\u003c/code\u003e, \u003ccode\u003eNOT_APPLICABLE\u003c/code\u003e, \u003ccode\u003eIS_ARCHIVED\u003c/code\u003e, \u003ccode\u003eHAS_ENDED\u003c/code\u003e, and more.\u003c/p\u003e\n"],["\u003cp\u003eThis error is relevant to services like \u003ccode\u003eForecastService\u003c/code\u003e, \u003ccode\u003eLineItemService\u003c/code\u003e, \u003ccode\u003eLineItemTemplateService\u003c/code\u003e, \u003ccode\u003eOrderService\u003c/code\u003e, and \u003ccode\u003ePublisherQueryLanguageService\u003c/code\u003e.\u003c/p\u003e\n"]]],["The document details error handling within ad management services, specifically focusing on `OrderActionError`. Services like `ForecastService`, `LineItemService`, and `OrderService` are mentioned. `OrderActionError` lists reasons for failure when actions are performed on orders, including `PERMISSION_DENIED`, `NOT_APPLICABLE`, `IS_ARCHIVED`, `HAS_ENDED`, unreserved line items and more. `ApiError` has fields such as `fieldPath`, `fieldPathElements`, `trigger`, and `errorString` to help to identify the causes and representation of errors.\n"],null,[]]
