AdQuoteLine

Represents the details of a line item in an advertisement campaign quote. This object is available in API version 51.0 and later.

Supported Calls

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

Fields

AdBleedAmount

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

AdBleedAmountUom

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

AdCreativeSizeTypes

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Lists user selected, semicolon separated creative size types 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: The URL of the ad creative. It may or may not be hosted in Salesforce.

AdPlacementPriorityType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the priority type of an ad placement.
  • Possible values:
    • Sponsorship
    • Standard

AdQuoteId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The ID of the quote that the ad quote line is a part of. This is a relationship field.
  • Relationship Name: QuoteId__r
  • Relationship Type: Master-detail
  • Refers To: Quote (the master object)

AdRequestedEndDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The requested end date and time for the line item.

AdRequestedStartDate

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

AdServerFees

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

AdServerId

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The ID of the ad server associated with the ad quote line. This field is a relationship field.
  • Relationship Name: AdServer
  • Refers To: AdServer

AdServerProposalIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unique identifier of the ad quote line item proposal in the ad server.

AdServerProposalLineIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unique identifier of the ad quote line item proposal in the ad server.

AdServerProposalLineStatus

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

AdSpaceSpecificationAdServer

  • Type: string
  • Properties: Filter, Nillable, Sort
  • Description: The ad server responsible to serve the ad creative. This is a calculated field.

AdSpaceSpecificationId

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

AdSpaceSpecificationMediaChannel

  • Type: string
  • Properties: Filter, Nillable, Sort
  • Description: The media channel of the related ad space specification. This is a calculated field.

AdSpaceSpecificationType

  • Type: picklist
  • Properties: Filter, Nillable, Sort
  • Description: Specifies the type of the related ad space specification. This is a calculated field.

AdTimePerEpisode

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

AvailabilityStatus

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the availability status of the item in the ad server.
  • Possible values:
    • Available
    • Full
    • Half
    • Not Available

AvailableAdServerUnits

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The number of units of the item available in the ad server.

BillingCycle

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

BillingMode

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

BonusAdTime

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The bonus ad time in seconds provided to the customer.

BreakPlacement

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The placement of an ad spot during a commercial break.
  • Possible values:
    • First
    • Last
    • Second

Budget

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The budget provided for the ad quote line.

ConfigurationStatus

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies whether the ad quite line is configured.

ContractedQuantity

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

CostPerRatingPoint

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The cost per rating point calculated on the basis of QuoteLineItem.Implied Rate / AdSpaceSpec.Audience Size rating.

CustomerDayPart

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Specifies the ad space specification slot.
  • 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 item is delivered.
  • Possible values:
    • As fast as possible
    • Evenly
    • Frontloaded

EstimatedQuantity

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The estimated quantity of the ad quote line.

GrossRatingPoint

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The gross rating of the ad quote line calculated on the basis of AdSpaceSpec.Audience Size Rating * Paid Commercial Time per TimeSlot.

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 implied rate 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.

ImpressionLimit

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

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.
  • Default value: false

IsBudgetBasedQuantity

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

LastAvailabilityCheck

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the item availability was last checked on the ad server.

LastConfigured

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the ad quote line was last updated.

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 LastReferenceDate is 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 quote line.

MaximumFrequency

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

MaximumFrequencyInterval

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

MaximumUserFrequency

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Indicates 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 maximum user frequency interval.
  • Possible values:
    • Day
    • Hour
    • Minute
    • Second

MediaChannelId

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The ID of the media channel associated with the ad quote line. This field is a relationship field.
  • Relationship Name: MediaChannel
  • Refers To: MediaChannel

MediaType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the media type of a 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 quote line.

PaidAdTime

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total Ad Time slots customer is paying for in seconds.

ParentAdQuoteLineId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the parent ad quote that the quote is a part of. This field is a relationship field.
  • Relationship Name: ParentAdQuoteLine
  • Refers To: AdQuoteLine

PercentageAdTime

  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The percentage of the commercial time slot the placement represents in the whole deal.

PricingModel

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

PrimaryCostPerMille

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update

PrimaryDemographicCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the primary demographic code associated with the ad quote 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 quote line.

PrimaryImpressions

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

PrimaryImpsPercentage

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

PrimaryRating

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

PrimaryTotalImps

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

PriorAdQuoteLineId

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

Product2Id

  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: The ID of the product associated with the ad quote line. This field is a relationship field.
  • Relationship Name: Product2
  • Refers To: Product2

QuoteLineItemId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. The quote line item for which the extension record is created. This is a relationship field.
  • Relationship Name: QuoteLineItemId__r
  • Relationship Type: Lookup
  • Refers To: QuoteLineItem

QuoteLineItemProductCode

  • Type: string
  • Properties: Filter, Nillable, Sort
  • Description: The product code of the quote line item's related product. This is a calculated field.

QuoteLineItemQuantity

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: The quantity of the related quote line item. This is a calculated field.

RadioSpotType

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

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 quote line.

SecondaryCostPerMille

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

SecondaryCostPerRatingPoint

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

SecondaryDemographicCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the secondary demographic code of the ad quote line. 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 quote line.

SecondaryGrpPercentage

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

SecondaryImpressions

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

SecondaryImpsPercentage

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

SecondaryRating

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

SecondaryTotalImps

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

Skippable

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

SponsorshipType

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the type of sponsorship.
  • Possible values:
    • Co Presented By
    • Presented By
    • Sponsored By

TargetingParameters

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

TaskStatus

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the status of the task executed for the ad quote line.
  • Default value: Successful
  • Possible values:
    • Failed
    • In_Progress—In Progress
    • Partially_Successful—Partially Successful
    • Spot_Generation_Failed—Spot Generation Failed
    • Spot_Generation_In_Progress—Spot Generation In Progress
    • Successful

TaskType

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The type of task executed for the ad quote line item.

TotAdQuotLineUnitSpltPrc

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The value of total price for the ad quote line units splits associated with the ad quote line. This field is a calculated field.

TotAdQuotLineUnitSpltQty

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Description: The number of total ad quote line units split quantities associated with the ad quote line. This field is a calculated field.

TotalAdServerUnits

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

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 goal of the ad quote line.

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.

UserEngagementGoalUnit

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

UserEngagementGoalUnitType

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

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.

AdQuoteLineFeed
Feed tracking is available for the object.
AdQuoteLineHistory
History is available for tracked fields of the object.