type OrderError (v202411)

  • OrderError objects detail issues encountered when interacting with orders in Ad Manager.

  • These errors often relate to order status (canceled, pending, archived), user permissions, or team associations.

  • OrderError provides specific reasons for the error, like UPDATE_CANCELED_ORDER_NOT_ALLOWED or USER_NOT_ON_ORDERS_TEAMS, through the reason field.

  • The ApiError inheritance provides additional context, such as the field path causing the error and a detailed error string.
Service
ForecastService LineItemCreativeAssociationService LineItemService LineItemTemplateService OrderService PublisherQueryLanguageService TeamService
Inheritance
ApiError
▼
AdUnitCodeError ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidUrlError InventoryTargetingError InventoryUnitError LabelEntityAssociationError LineItemActivityAssociation... LineItemCreativeAssociation... LineItemError LineItemFlightDateError LineItemOperationError MobileApplicationTargetingE... NotNullError NullError OrderActionError OrderError ParseError PermissionError PrecisionError ProgrammaticError PublisherQueryLanguageConte... PublisherQueryLanguageSynta... QuotaError RangeError RegExError RequestPlatformTargetingError RequiredCollectionError RequiredError RequiredNumberError RequiredSizeError ReservationDetailsError ServerError SetTopBoxLineItemError StatementError StringFormatError StringLengthError TeamError TechnologyTargetingError TimeZoneError TranscodingError TypeError UniqueError UserDomainTargetingError VideoPositionTargetingError

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

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.