AdOrderItem

AdBleedAmount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The distance from the edge.

AdBleedAmountUom

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies bleed height and width measurement.
• Possible values:
  • Inches
  • Pixels
  • mm

AdCreativeSizeTypes

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The list of semicolon separated creative size types.

AdCreativeUrl

• Type: url
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The URL of the ad creative.

AdPlacementPriorityType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the placement priority type chosen from the ad server's ad priority type.
• Possible values:
  • Standard
  • Sponsorship

AdRequestedEndDate

• Type: dateTime
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The requested end date for the LineItem.

AdRequestedQuantity

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The requested units of the ad order item.

AdRequestedStartDate

• Type: dateTime
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The requested start date for the placement.

AdServerFees

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The ad server fees for the ad order item.

AdServerOrderIdentifier

• Type: string
• Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
• Description: The order ID generated from the ad server.

AdServerOrderLineIdentifier

• Type: string
• Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
• Description: The order line item ID generated at the ad server.

AdServerProposalLineStatus

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the status of an ad order line item proposal in the ad server.
• Possible values:
  • Completed
  • Delivering
  • Draft
  • Paused
  • Ready

AdSpaceSpecificationId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the ad space specification related to the ad order item. This is a relationship field.
• Relationship Name: AdSpaceSpecificationId__r
• Relationship Type: Lookup
• Refers To: AdSpaceSpecification

AdTimePerEpisode

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The ad time in seconds for each episode.

BillingCycle

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the billing cycle for an order line item.
• Possible values:
  • Broadcast
  • Calendar
  • End Of Flight

BillingMode

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the billing mode for an order line item.
• Possible values:
  • Fractional
  • Retail
  • Threshold
  • Usage

BonusAdTime

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: Bonus commercial times in seconds provided to the customers.

Budget

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The budget of the ad order item.

ContractedQuantity

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The contracted quantity of the ad order item.

CostPerRatingPoint

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The cost per rating point calculated on the basis of QuoteLineItem.ImpliedRate / AdSpaceSpecification.AudienceSizeRating.

CustomerDayPart

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The customer prime time that depends on the combination of genre of the show, audience interest, demographics..
• Possible values:
  • Non Prime Time
  • Prime Time

DeliveryFrequency

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the frequency at which the ad order item is delivered.
• Possible values:
  • As fast as possible
  • Evenly
  • Frontloaded

EstimatedQuantity

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The contracted quantity of the ad order item.

GrossRatingPoint

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The gross rating point calculated on the basis of AdSpaceSpecification.AudienceSizeRating * Paid Commercial Time per 'Linear Commercial Time Slot Unit of the Org'.

ImpliedRate

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The implied rate of the ad order item.

ImpliedTotal

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The calculated from the implied rate and is used by publishers to organize the revenue structure within the deal.

ImpressionLimit

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The number of impressions that must be delivered for the ad order item.

IsAdBleedEnabled

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the ad extends all the way to the edge of the page on at least one side.
• Default value: false

IsBudgetBasedQuantity

• Type: boolean
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: Indicates whether the budget is calcualted based on the quantity.
• Default value: false

LastReferencedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

• Type: dateTime
• Properties: Filter, Nillable, Sort
• Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly.

MaxDuration

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The maximum duration of the ad order item.

MaximumFrequency

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The maximum number of times the ad is served for frequency capping.

MaximumFrequencyInterval

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: The maximum frequency unit used for frequency capping.
• Possible values:
  • Day
  • Hour
  • Minute
  • Second

MaximumUserFrequency

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The maximum number of times a unique user sees the ad over a given time period.

MaximumUserFrequencyInterval

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the maximum user frequency interval used for frequency capping.
• Possible values:
  • Day
  • Hour
  • Minute
  • Second

MediaType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the media type of the placement.
• Possible values:
  • Digital
  • Other
  • Outdoor
  • Print
  • Radio
  • TV

Name

• Type: string
• Properties: Create, Filter, Group, idLookup, Sort, Update
• Description: The name of the ad order item.

OrderId

• Type: reference
• Properties: Create, Filter, Group, Sort
• Description: Refers to the Order record. This is a relationship field.
• Relationship Name: OrderId__r
• Relationship Type: Master-detail
• Refers To: Order (the master object)

OrderItemId

• Type: reference
• Properties: Create, Filter, Group, Sort, Update
• Description: Required. The ID of the order item associated with the ad order item. This is a relationship field.
• Relationship Name: OrderItemId__r
• Relationship Type: Lookup
• Refers To: OrderItem

PaidAdTime

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: Indicates total commercial time slots customer are paying for in seconds.

PricingModel

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the pricing model of the ad order item.
• Possible values:
  • CPC
  • CPM

PrimaryCostPerMille

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The cost per mile of the ad order item.

PrimaryDemographicCodeId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the primary demographic code associated with the ad order item. This field is a relationship field.
• Relationship Name: PrimaryDemographicCode
• Refers To: AdDemographicCode

PrimaryGrpPercentage

• Type: percent
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The primary group percentage of the ad order item.

PrimaryImpressions

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The primary impressions of the ad order item.

PrimaryImpsPercentage

• Type: percent
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The primary impression percentage of the ad order item.

PrimaryRating

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The primary rating of the ad order item.

PrimaryTotalImps

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The primary total impressions of the ad order item.

PriorOrderLineItemId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The prior order item in case of existing or changed order item, for new it will be blank. This field is a relationship field.
• Relationship Name: PriorOrderLineItem
• Relationship Type: Lookup
• Refers To: OrderItem

PriorUsedAmount

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The amount billed in prior orders in case of modified order, for new orders it will be zero.

QuoteLineItemId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Captures the Quote LineItem if the order is to be created for a Quote. This is a relationship field.
• Relationship Name: QuoteLineItemId__r
• Relationship Type: Lookup
• Refers To: QuoteLineItem

RadioSpotType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the type of radio spot.

RequestedIssues

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The issues selected for a placement or line item for which the selected or defined ad creatives are to be inserted.

RequestedSplits

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The break-up of the requested units for each placement or line item, based on the selected frequency, whether daily or weekly.

RevisedPrice

• Type: currency
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The revised price of the ad order item.

SecondaryCostPerMille

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The secondary cost per mile of the ad order item.

SecondaryCostPerRatingPoint

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The secondary cost per rating point of the ad order item.

SecondaryDemographicCodeId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The ID of the secondary demographic code of the ad order item. This field is a relationship field.
• Relationship Name: SecondaryDemographicCode
• Refers To: AdDemographicCode

SecondaryGrossRatingPoint

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The secondary gross rating point of the ad order item.

SecondaryGrpPercentage

• Type: percent
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The secondary group percentage of the ad order item.

SecondaryImpressions

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The secondary impressions of the ad order item.

SecondaryImpsPercentage

• Type: percent
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The secondary impression percentage of the ad order item.

SecondaryRating

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The secondary rating of the ad order item.

SecondaryTotalImps

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The secondary total impressions of the ad order item.

Skippable

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Indicates whether the ad order item can be skipped.
• Possible values:
  • Any
  • Disable
  • Enable

SponsorshipType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Captures advertiser's sponsorship interests for the Ad Space Specification.
• Possible values:
  • Co Presented By
  • Presented By
  • Sponsored By

TargetingParameters

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The ad creative targeting parameters stored in JSON format.

TotalAdTime

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The sum of bonus and paid ad time or ad time per episode multiplied by number of episodes on media content title of ad space specification.

UserEngagementGoalPct

• Type: percent
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The percentage of impressions or clicks for the ad order item.

UserEngagementGoalType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the user engagement goal defined in terms of clicks, impressions, and so on. This is derived from ad space available goal type.
• Possible values:
  • LIFETIME
  • DAILY

UserEngagementGoalUnit

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The number or percentage of impressions or clicks for the ad creative.

UserEngagementGoalUnitType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: Specifies the type of goal unit.
• Possible values:
  • IMPRESSIONS
  • CLICKS

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

AdOrderItemConfigFeed

Feed tracking is available for the object.

AdOrderItemHistory

History is available for tracked fields of the object.