type OrderError (v202408)
Stay organized with collections
Save and categorize content based on your preferences.
Lists all errors associated with orders.
- 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.
|
OrderError
|
reason
|
OrderError.Reason
The error reason represented by an enum.
Enumerations
-
UPDATE_CANCELED_ORDER_NOT_ALLOWED
- Updating a canceled order is not allowed.
-
UPDATE_PENDING_APPROVAL_ORDER_NOT_ALLOWED
- Updating an order that has its approval pending is not allowed.
-
UPDATE_ARCHIVED_ORDER_NOT_ALLOWED
- Updating an archived order is not allowed.
-
CANNOT_MODIFY_PROPOSAL_ID
- DSM can set the proposal ID only at the time of creation of order.
Setting or changing proposal ID at the time of order update is not
allowed.
-
PRIMARY_USER_REQUIRED
- Cannot have secondary user without a primary user.
-
PRIMARY_USER_CANNOT_BE_SECONDARY
- Primary user cannot be added as a secondary user too.
-
ORDER_TEAM_NOT_ASSOCIATED_WITH_ADVERTISER
- A team associated with the order must also be associated with the
advertiser.
-
USER_NOT_ON_ORDERS_TEAMS
- The user assigned to the order, like salesperson or trafficker, must
be on one of the order's teams.
-
AGENCY_NOT_ON_ORDERS_TEAMS
- The agency assigned to the order must belong to one of the order's teams.
-
INVALID_FIELDS_SET_FOR_NON_PROGRAMMATIC_ORDER
- Programmatic info fields should not be set for a non-programmatic order.
-
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\u003e\u003ccode\u003eOrderError\u003c/code\u003e objects detail errors encountered when interacting with orders in Google Ad Manager.\u003c/p\u003e\n"],["\u003cp\u003eThese errors often relate to order status (e.g., canceled, pending approval), user permissions, and team associations.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ereason\u003c/code\u003e field provides a specific code indicating the nature of the error.\u003c/p\u003e\n"],["\u003cp\u003eErrors can arise from invalid data, such as missing required fields or incorrect formatting.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eOrderError\u003c/code\u003e inherits from \u003ccode\u003eApiError\u003c/code\u003e, which provides additional context about the error.\u003c/p\u003e\n"]]],["The core content outlines service-related errors in an API, focusing on `OrderError` within various services like `ForecastService`, `LineItemService`, and `OrderService`. It details the `ApiError` inheritance structure and specifies `OrderError` reasons, including restrictions on updating canceled, pending, or archived orders. Other error reasons involve proposal ID modification, user roles, team associations, and field validation. It also provides details on error message fields such as `fieldPath`, `trigger`, and `errorString`. The namespace for this API is also given.\n"],null,[]]