type OrderActionError (v202505)

  • The OrderActionError lists errors related to performing actions on Order objects within the PublisherQueryLanguageService.

  • This error inherits from ApiError and includes fields like fieldPath, fieldPathElements, trigger, and errorString to provide details about the error.

  • The OrderActionError also has a specific reason field with various enumerated values explaining why the action on the Order failed, such as permission denied, order archived, or exceeding line item limits.

  • Multiple services like ForecastService, LineItemService, LineItemTemplateService, and OrderService are associated with this error type.
Service
ForecastService LineItemService LineItemTemplateService OrderService PublisherQueryLanguageService
Inheritance
ApiError
▼
AdUnitCodeError AdUnitHierarchyError ApiVersionError AudienceSegmentError AuthenticationError CollectionSizeError CommonError CreativeError DealError ExchangeRateError FeatureError FileError InternalApiError InvalidEmailError InvalidUrlError InventoryTargetingError InventoryUnitError LineItemFlightDateError LineItemOperationError NotNullError NullError OrderActionError OrderError ParseError PermissionError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError StatementError StringFormatError StringLengthError TypeError UniqueError

Lists all errors associated with performing actions on Order objects.

Namespace
https://www.google.com/apis/ads/publisher/v202505

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.
CANNOT_UPDATE_ORDER_OVER_LINE_ITEM_LIMIT
Cannot update an Order because it has more than the allowed number of LineItems.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.