Looking for a REST API? The Ad Manager API (Beta) is now available.

type OrderActionError (v202411)

AI-generated Key Takeaways

OrderActionError lists all errors associated with performing actions on Order objects.
OrderActionError inherits from ApiError and includes fields like fieldPath, trigger, and errorString.
OrderActionError has a specific reason field indicating the cause of the error, such as permission denied, not applicable, or unknown.
Enumerated reasons for OrderActionError include issues with archived or ended orders, inability to approve orders with unreserved line items, or restrictions based on company credit status.

Service

ForecastService LineItemService LineItemTemplateService OrderService PublisherQueryLanguageService

Inheritance

ApiError

▼

ApiVersionError AssetError AudienceExtensionError AudienceSegmentError AuthenticationError ClickTrackingLineItemError CollectionSizeError CommonError CompanyCreditStatusError CreativeError CrossSellError CurrencyCodeError CustomFieldValueError CustomTargetingError DateTimeRangeTargetingError DayPartTargetingError EntityChildrenLimitReachedE... EntityLimitReachedError FeatureError ForecastError FrequencyCapError GenericTargetingError GeoTargetingError GrpSettingsError ImageError InternalApiError InvalidUrlError InventoryTargetingError 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 performing actions on Order objects.

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. `UNKNOWN` The value returned if the actual value is not exposed by the requested API version.