type OrderError (v202408)
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 2024-08-20 UTC.
[null,null,["Last updated 2024-08-20 UTC."],[[["`OrderError` objects encompass all errors related to orders in the system."],["This error type inherits from `ApiError`, providing standard error details like field paths and triggers."],["A key field, `reason`, categorizes the specific cause of the order error using the `OrderError.Reason` enum."],["Reasons cover issues such as updating canceled orders, modifying proposal IDs inappropriately, user and team inconsistencies, and programmatic order misconfigurations."],["The error details include a namespace for context and a table outlining the field structure and possible error reasons."]]],["The content details service-related errors and their inheritance structure, focusing on `OrderError`. Services include ForecastService, LineItemService, and OrderService. `ApiError` is the base, inherited by numerous specific error types, including `OrderError`. `OrderError` lists reasons such as `UPDATE_CANCELED_ORDER_NOT_ALLOWED`, `PRIMARY_USER_REQUIRED`, and `UNKNOWN`, indicating problems related to order updates, user roles, team associations, and programmatic settings. The field `ApiError` include `fieldPath`, `fieldPathElements`, `trigger`, and `errorString`.\n"]]