AI-generated Key Takeaways
-
OrderError lists all errors associated with orders within the specified API namespace.
-
OrderError includes fields inherited from ApiError such as fieldPath, fieldPathElements, trigger, and errorString, which help identify the cause and details of an error.
-
The OrderError itself contains a 'reason' field, represented by an enum, detailing specific error conditions such as updating canceled or pending orders, invalid user assignments, or setting programmatic fields on non-programmatic orders.
-
The enumerations for OrderError.Reason provide specific details for various errors like
UPDATE_CANCELED_ORDER_NOT_ALLOWED,PRIMARY_USER_REQUIRED, andINVALID_FIELDS_SET_FOR_NON_PROGRAMMATIC_ORDER. -
An
UNKNOWNreason is returned if the actual error value is not exposed by the requested API version.
Lists all errors associated with orders.
- 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
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
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.
