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."],[[["This documentation details `OrderError` within the LineItemTemplateService, encompassing potential errors when interacting with orders in Google Ad Manager."],["`OrderError` is a subclass of `ApiError` and provides an `OrderError.Reason` enum to categorize specific order-related issues."],["These errors can arise from various scenarios like attempting to update canceled, pending approval, or archived orders; modifying proposal IDs after order creation; or user/agency team misconfigurations."],["It also includes programmatic-specific errors, like setting irrelevant fields for non-programmatic orders."],["The provided namespace indicates the API version and context for these errors."]]],["The content outlines services and errors within an API, specifically version v202408. Services include Forecast, LineItemCreativeAssociation, LineItem, LineItemTemplate, Order, PublisherQueryLanguage, and Team. It details various error types under `ApiError` inheritance, and also the error reason `OrderError`, listing specific causes such as updating canceled/pending/archived orders, invalid user roles, team/agency associations, and programmatic order issues. Each error includes a description and a potential reason.\n"]]