type OrderError (v202508)

  • The content provides details about various errors related to orders in the context of a Publisher Query Language Service.

  • The OrderError object includes a reason field which is an enumeration detailing specific reasons for order-related errors such as updating canceled or archived orders, invalid user assignments, or programmatic info issues.

  • The OrderError inherits from ApiError, which provides general error details including the field path, trigger data, and a simple error string.
Service
ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService PublisherQueryLanguageService TeamService
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 orders.

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

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.