AdOrderItem

An extension to the Order LineItem and captures the details specific to an Ad Placement. This object is available in API version 54.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Fields

Field	Details
AdBleedAmountUom	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies bleed height and width measurement. Possible values are: `Inches` `Pixels` `mm`
AdBleedAmount	Type double Properties Create, Filter, Nillable, Sort, Update Description Captures the distance from the edge.
AdCreativeSizeTypes	Type textarea Properties Create, Nillable, Update Description Semicolon separated user-selected Creative SizeTypes from the possible choices presented by each Ad Space. For example: 720 X 350; 400 X 350.
AdCreativeUrl	Type url Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the URL of the Ad Creative. It may or may not be hosted by Salesforce platform.
AdPlacementPriorityType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the placement priority type chosen from the Ad Server's AdPriorityType record. Possible values are: `Standard` `Sponsorship`
AdRequestedEndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Captures the requested end date for the LineItem.
AdRequestedStartDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Captures the requested start date for the placement.
AdServerOrderIdentifier	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Captures the OrderId generated at the Ad Server.
AdServerOrderLineIdentifier	Type string Properties Create, Filter, Group, idLookup, Nillable, Sort, Update Description Captures the Order Line ItemId generated at the Ad Server.
AdSpaceSpecificationId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Lookup to the Ad Space Specification record. 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 Captures the Ad Time in seconds for each episode Customer will be paying for .
BonusAdTime	Type double Properties Create, Filter, Nillable, Sort, Update Description Bonus commercial times in seconds provided to the customers.
CostPerRatingPoint	Type double Properties Create, Filter, Nillable, Sort, Update Description Cost Per Rating Point calculated on the basis of `QuoteLineItem.ImpliedRate / AdSpaceSpecification.AudienceSizeRating`.
CustomerDayPart	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Customer PrimeTime depends on the combination of genre of the show, audience interest, demographics, and, so on. Possible values are: `Non Prime Time` `Prime Time`
GrossRatingPoint	Type double Properties Create, Filter, Nillable, Sort, Update Description 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 Used by publishers to organize the revenue structure within the deal. This value is often internal to the publisher organization and not customer facing.
ImpliedTotal	Type currency Properties Create, Filter, Nillable, Sort, Update Description Calculated from the ImpliedRate and is used by publishers to organize the revenue structure within the deal. This value is often internal to the publisher organization and not customer facing.
IsAdBleedEnabled	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates if the Ad extends all the way to the edge of the page on at least one side. The default value is 'false'.
MaximumFrequencyInterval	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Identifies the maximum frequency unit used for frequency capping. Possible values are: `Day` `Hour` `Minute` `Second`
MaximumFrequency	Type double Properties Create, Filter, Nillable, Sort, Update Description Identifies maximum number of times the Ad is served for frequency capping.
MaximumUserFrequencyInterval	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Identifies the maximum user frequency interval used for frequency capping. Possible values are: `Day` `Hour` `Minute` `Second`
MaximumUserFrequency	Type double Properties Create, Filter, Nillable, Sort, Update Description Maximum number of times a unique user sees the Ad over a given time period.
MediaType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Captures the Media Type of the Placement record. Possible values are: `Digital` `Other` `Outdoor` `Print` `Radio` `TV`
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 Captures the Order Product for which the extension record is to be created. 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.
PriorOrderLineItemId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Captures 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 This is 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
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.
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 are: `Co Presented By` `Presented By` `Sponsored By`
TargetingParameters	Type textarea Properties Create, Nillable, Update Description Ad Creative Targeting Parameters stored in JSON format.
TotalAdTime	Type double Properties Create, Filter, Nillable, Sort, Update Description Captures the Sum of Bonus and Paid Ad Time OR Ad Time Per Episode multiplied by No of Episodes on Media Content Title of Ad Space Specification.
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 GoalType. Possible values are: `LIFETIME` `DAILY`
UserEngagementGoalUnitType	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the type of Goal Unit. Possible values are: `IMPRESSIONS` `CLICKS`
UserEngagementGoalUnit	Type double Properties Create, Filter, Nillable, Sort, Update Description Represents the number or percentage of impressions or clicks for the Ad Creative.

Associated Objects

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.

AdOrderItemFeed: Feed tracking is available for the object.
AdOrderItemHistory: History is available for tracked fields of the object.

Object Reference for the Salesforce Platform

AdOrderItem

Supported Calls

Fields

Associated Objects