type ProposalLineItem (v201808)

A ProposalLineItem is an instance of sales Product. It belongs to a Proposal and is created according to a Product and RateCard. When the proposal is turned into an Order, this object is turned into a LineItem.


Namespace
https://www.google.com/apis/ads/publisher/v201808

Field

id

xsd:long

The unique ID of the ProposalLineItem. This attribute is read-only.

proposalId

xsd:long

The unique ID of the Proposal, to which the ProposalLineItem belongs. This attribute is required for creation and then is readonly.

This attribute is required.

packageId

xsd:long

The unique ID of the Package, to which the ProposalLineItem belongs. This attribute is assigned by Google when creating the ProposalLineItem by performing the package action CreateProposalLineItemsFromPackages.

This attribute is applicable when:
  • not using programmatic, using sales management.
This attribute is read-only when:
  • not using programmatic, using sales management.

rateCardId

xsd:long

The unique ID of the RateCard, based on which the ProposalLineItem is priced. The rate card must be associated with a rate belonging to the product. This attribute is required for creation and then is readonly.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is required when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

productId

xsd:long

The unique ID of the Product, which the ProposalLineItem is created from. This attribute is readonly after creation.

This attribute is read-only when:
  • using programmatic guaranteed, not using sales management.
This attribute is required when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

name

xsd:string

The name of the ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.

This attribute is required.

startDateTime

DateTime

The date and time at which the line item associated with the ProposalLineItem is enabled to begin serving. This attribute is optional during creation, but required and must be in the future when it turns into a line item. The DateTime.timeZoneID is required if start date time is not null. This attribute becomes readonly once the ProposalLineItem has started delivering.

endDateTime

DateTime

The date and time at which the line item associated with the ProposalLineItem stops beening served. This attribute is optional during creation, but required and must be after the startDateTime. The DateTime.timeZoneID is required if end date time is not null.

timeZoneId

xsd:string

The time zone ID in tz database format (e.g. "America/Los_Angeles") for this ProposalLineItem. The number of serving days is calculated in this time zone. So if rateType is RateType.CPD, it will affect the cost calculation. The startDateTime and endDateTime will be returned in this time zone. This attribute is optional and defaults to the network's time zone.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • using programmatic guaranteed, not using sales management.

internalNotes

xsd:string

Provides any additional notes that may annotate the ProposalLineItem. This attribute is optional and has a maximum length of 65,535 characters. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.

costAdjustment

CostAdjustment

The cost adjustment applied to the ProposalLineItem. This attribute is optional and default value is CostAdjustment.NONE.


Enumerations
NONE
Indicates that the ProposalLineItem has no cost adjustment.
MAKE_GOOD
Indicates that the cost adjustment of the ProposalLineItem is make good.
BARTER
Indicates that the cost adjustment of the ProposalLineItem is barter.
ADDED_VALUE
Indicates that the cost adjustment of the ProposalLineItem is added value.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.

isArchived

xsd:boolean

The archival status of the ProposalLineItem. This attribute is read-only.

goal

Goal

The goal(i.e. contracted quantity, quantity or limit) that this ProposalLineItem is associated with, which is used in its pacing and budgeting. Goal.units must be greater than 0 when the proposal line item turns into a line item, Goal.goalType and Goal.unitType are readonly. For a Preferred deal ProposalLineItem, the goal type can only be GoalType.NONE.

This attribute is required.

contractedQuantityBuffer

xsd:int

A percentage number to a STANDARD line item with CPM or CPC as the rate type, so that the scheduled delivery goal could be relaxed. This number is milli-percent based, i.e. 10% would be 10000.

This attribute is applicable when:
  • not using programmatic, using sales management.

scheduledQuantity

xsd:long

The scheduled number of impressions or clicks of a STANDARD line item with CPM or CPC as the rate type, so that the scheduled delivery goal could be relaxed. This attribute is calculated from Goal.units and contractedQuantityBuffer.

This attribute is applicable when:
  • not using programmatic, using sales management.
This attribute is read-only when:
  • not using programmatic, using sales management.

contractedUnitsBought

xsd:long

The contracted number of impressions or clicks. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is false, then this represents the lifetime minimum impression. If this is a LineItemType.SPONSORSHIP ProposalLineItem, has RateType.CPD as a rate type, and isProgrammatic is true, then this represents the daily minimum impression.

This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only.

deliveryRateType

DeliveryRateType

The strategy for delivering ads over the course of the ProposalLineItem's duration. This attribute is optional and default value is DeliveryRateType.EVENLY. For a Preferred deal ProposalLineItem, the value can only be DeliveryRateType.FRONTLOADED.


Enumerations
EVENLY
Line items are served as evenly as possible across the number of days specified in a line item's LineItem.duration.
FRONTLOADED
Line items are served more aggressively in the beginning of the flight date.
AS_FAST_AS_POSSIBLE
The booked impressions for a line item may be delivered well before the LineItem.endDateTime. Other lower-priority or lower-value line items will be stopped from delivering until this line item meets the number of impressions or clicks it is booked for.

roadblockingType

RoadblockingType

The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. This attribute is optional during creation and defaults to the product's roadblocking type, or RoadblockingType.ONE_OR_MORE if not specified by the product.


Enumerations
ONLY_ONE
Only one creative from a line item can serve at a time.
ONE_OR_MORE
Any number of creatives from a line item can serve together at a time.
AS_MANY_AS_POSSIBLE
As many creatives from a line item as can fit on a page will serve. This could mean anywhere from one to all of a line item's creatives given the size constraints of ad slots on a page.
ALL_ROADBLOCK
All or none of the creatives from a line item will serve. This option will only work if served to a GPT tag using SRA (single request architecture mode).
CREATIVE_SET
A master/companion CreativeSet roadblocking type. A LineItem.creativePlaceholders must be set accordingly.

companionDeliveryOption

CompanionDeliveryOption

The delivery option for companions. This is only valid if the roadblocking type is RoadblockingType.CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOption.OPTIONAL. The default value in other cases is CompanionDeliveryOption.UNKNOWN. Providing something other than CompanionDeliveryOption.UNKNOWN will cause an error.


Enumerations
OPTIONAL
Companions are not required to serve a creative set. The creative set can serve to inventory that has zero or more matching companions.
AT_LEAST_ONE
At least one companion must be served in order for the creative set to be used.
ALL
All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled.
UNKNOWN
The delivery type is unknown.

creativeRotationType

CreativeRotationType

The strategy used for displaying multiple Creative objects that are associated with the ProposalLineItem. This attribute is optional and default value is CreativeRotationType.OPTIMIZED.


Enumerations
EVEN
Creatives are displayed roughly the same number of times over the duration of the line item.
OPTIMIZED
Creatives are served roughly proportionally to their performance.
MANUAL
Creatives are served roughly proportionally to their weights, set on the LineItemCreativeAssociation.
SEQUENTIAL
Creatives are served exactly in sequential order, aka Storyboarding. Set on the LineItemCreativeAssociation.

This attribute is applicable when:
  • not using programmatic, using sales management.

videoMaxDuration

xsd:long

The max duration of a video creative associated with this ProposalLineItem in milliseconds. This attribute is optional, defaults to the Product.videoMaxDuration on the Product it was created with, and only meaningful if this is a video proposal line item.

frequencyCaps

FrequencyCap[]

The set of frequency capping units for this ProposalLineItem. This attribute is optional during creation and defaults to the product's frequency caps if Product.allowFrequencyCapsCustomization is false.

dfpLineItemId

xsd:long

The unique ID of corresponding LineItem. This will be null if the Proposal has not been pushed to Ad Manager. This attribute is read-only.

lineItemType

LineItemType

The corresponding LineItemType of the ProposalLineItem. For a programmatic ProposalLineItem, the value can only be one of:


Enumerations
SPONSORSHIP
The type of LineItem for which a percentage of all the impressions that are being sold are reserved.
STANDARD
The type of LineItem for which a fixed quantity of impressions or clicks are reserved.
NETWORK
The type of LineItem most commonly used to fill a site's unsold inventory if not contractually obligated to deliver a requested number of impressions. Users specify the daily percentage of unsold impressions or clicks when creating this line item.
BULK
The type of LineItem for which a fixed quantity of impressions or clicks will be delivered at a priority lower than the LineItemType.STANDARD type.
PRICE_PRIORITY
The type of LineItem most commonly used to fill a site's unsold inventory if not contractually obligated to deliver a requested number of impressions. Users specify the fixed quantity of unsold impressions or clicks when creating this line item.
HOUSE
The type of LineItem typically used for ads that promote products and services chosen by the publisher. These usually do not generate revenue and have the lowest delivery priority.
LEGACY_DFP
Represents a legacy LineItem that has been migrated from the DFP system. Such line items cannot be created any more. Also, these line items cannot be activated or resumed.
CLICK_TRACKING
The type of LineItem used for ads that track ads being served externally of Ad Manager, for example an email newsletter. The click through would reference this ad, and the click would be tracked via this ad.
ADSENSE
A LineItem using dynamic allocation backed by AdSense.
AD_EXCHANGE
A LineItem using dynamic allocation backed by the Google Ad Exchange.
BUMPER
Represents a non-monetizable video LineItem that targets one or more bumper positions, which are short house video messages used by publishers to separate content from ad breaks.
ADMOB
A LineItem using dynamic allocation backed by AdMob.
PREFERRED_DEAL
The type of LineItem for which there are no impressions reserved, and will serve for a second price bid. All LineItems of type LineItemType.PREFERRED_DEAL should be created via a ProposalLineItem with a matching type. When creating a LineItem of type LineItemType.PREFERRED_DEAL, the ProposalLineItem.estimatedMinimumImpressions field is required.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is required.

lineItemPriority

xsd:int

The priority for the corresponding LineItem of the ProposalLineItem. This attribute is optional during creation and defaults to the product's priority, or a default value assigned by Google. See LineItem.priority for more information.

rateType

RateType

The method used for billing the ProposalLineItem.


Enumerations
CPM
The rate applies to cost per mille (CPM) revenue.
CPC
The rate applies to cost per click (CPC) revenue.
CPD
The rate applies to cost per day (CPD) revenue.
CPU
The rate applies to cost per unit (CPU) revenue.
FLAT_FEE
The rate applies to flat fee revenue.
VCPM
The rate applies to Active View viewable cost per mille (vCPM) revenue.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is required when:
  • using programmatic guaranteed, not using sales management.

creativePlaceholders

CreativePlaceholder[]

Details about the creatives that are expected to serve through the ProposalLineItem. This attribute is optional during creation and defaults to the product's creative placeholders.

This attribute is required when:
  • using programmatic guaranteed, not using sales management.

targeting

Targeting

Contains the targeting criteria for the ProposalLineItem. This attribute is optional during creation and defaults to the product's targeting.

customFieldValues

  1. BaseCustomFieldValue[]
    1. CustomFieldValue
    2. DropDownCustomFieldValue

The values of the custom fields associated with the ProposalLineItem. This attribute is optional. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.

appliedLabels

AppliedLabel[]

The set of labels applied directly to the ProposalLineItem. This attribute is optional.

effectiveAppliedLabels

AppliedLabel[]

Contains the set of labels applied directly to the proposal as well as those inherited ones. If a label has been negated, only the negated label is returned. This attribute is read-only.

disableSameAdvertiserCompetitiveExclusion

xsd:boolean

If a line item has a series of competitive exclusions on it, it could be blocked from serving with line items from the same advertiser. Setting this to true will allow line items from the same advertiser to serve regardless of the other competitive exclusion labels being applied.

This attribute is optional and defaults to false.

productConstraints

ProposalLineItemConstraints

All the product constraints set for this ProposalLineItem.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

premiums

ProposalLineItemPremium[]

The premiums triggered by this ProposalLineItem and their statuses. For those triggered premiums whose statues are not specified, the default status is ProposalLineItemPremiumStatus.INCLUDED.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

isSold

xsd:boolean

Indicates whether this ProposalLineItem has been sold. This attribute is read-only.

baseRate

Money

The base rate of the ProposalLineItem in proposal currency.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

netRate

Money

The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 100. It doesn't include agency commission.

For example, if Proposal.currencyCode is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported.

When using sales management, at least one of the four fields ProposalLineItem.netRate, ProposalLineItem.grossRate, ProposalLineItem.netCost and ProposalLineItem.grossCost is required.

When not using sales management, at least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required.

grossRate

Money

The amount of money to spend per impression or click in proposal currency. It supports precision of 4 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 100. It includes agency commission.

For example, if Proposal.currencyCode is 'USD', then $123.4567 could be represented as 123456700, but further precision is not supported.

At least one of the four fields ProposalLineItem.netRate, ProposalLineItem.grossRate, ProposalLineItem.netCost and ProposalLineItem.grossCost is required.

This attribute is applicable when:
using programmatic guaranteed, using sales management.
not using programmatic, using sales management.

netCost

Money

The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 10000. It doesn't include agency commission.

For example, if Proposal.currencyCode is 'USD', then $123.45 could be represented as 123450000, but further precision is not supported.

When using sales management, at least one of the four fields ProposalLineItem.netRate, ProposalLineItem.grossRate, ProposalLineItem.netCost and ProposalLineItem.grossCost is required.

When not using sales management, at least one of the two fields ProposalLineItem.netRate and ProposalLineItem.netCost is required.

grossCost

Money

The cost of the ProposalLineItem in proposal currency. It supports precision of 2 decimal places in terms of the fundamental currency unit, so the Money.getAmountInMicros must be multiples of 10000. It includes agency commission.

At least one of the four fields ProposalLineItem.netRate, ProposalLineItem.grossRate, ProposalLineItem.netCost and ProposalLineItem.grossCost is required.

This attribute is applicable when:
using programmatic guaranteed, using sales management.
not using programmatic, using sales management.

deliveryIndicator

DeliveryIndicator

Indicates how well the line item generated from this proposal line item has been performing. This will be null if the delivery indicator information is not available due to one of the following reasons:

  1. The proposal line item has not pushed to Ad Manager.
  2. The line item is not delivering.
  3. The line item has an unlimited goal or cap.
  4. The line item has a percentage based goal or cap.
This attribute is read-only.

deliveryData

DeliveryData

Delivery data provides the number of clicks or impressions delivered for the LineItem generated from this proposal line item in the last 7 days. This will be null if the delivery data cannot be computed due to one of the following reasons:

  1. The proposal line item has not pushed to Ad Manager.
  2. The line item is not deliverable.
  3. The line item has completed delivering more than 7 days ago.
  4. The line item has an absolute-based goal. ProposalLineItem.deliveryIndicator should be used to track its progress in this case.
  5. This attribute is read-only.

computedStatus

ComputedStatus

The status of the LineItem generated from this proposal line item. This will be null if the proposal line item has not pushed to Ad Manager. This attribute is read-only.


Enumerations
DELIVERY_EXTENDED
The LineItem has past its LineItem.endDateTime with an auto extension, but hasn't met its goal.
DELIVERING
The LineItem has begun serving.
READY
The LineItem has been activated and is ready to serve.
PAUSED
The LineItem has been paused from serving.
INACTIVE
The LineItem is inactive. It is either caused by missing creatives or the network disabling auto-activation.
PAUSED_INVENTORY_RELEASED
The LineItem has been paused and its reserved inventory has been released. The LineItem will not serve.
PENDING_APPROVAL
The LineItem has been submitted for approval.
COMPLETED
The LineItem has completed its run.
DISAPPROVED
The LineItem has been disapproved and is not eligible to serve.
DRAFT
The LineItem is still being drafted.
CANCELED
The LineItem has been canceled and is no longer eligible to serve. This is a legacy status imported from Google Ad Manager orders.

billingCap

BillingCap

Overrides the billing cap of this ProposalLineItem. This attribute is optional. If this field is overridden, then other required billing fields (billingSource, or billingBase) also need to be overridden depending on the billingSource. That is, none of the billing fields will inherit from their Proposal object anymore. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.


Enumerations
NO_CAP
There is no cap for each billing month.
CAPPED_CUMULATIVE
Use a billing source of capped actuals with a billing cap of cumulative to bill your advertiser up to a campaign's capped amount, regardless of the number of impressions that are served each month.
CAPPED_PER_BILLING_CYCLE
Use a billing source of capped actuals with a billing cap of the billing cycle to bill your advertiser up to a capped amount for each billing cycle of a campaign, regardless of the number of impressions that are served.
CAPPED_CUMULATIVE_PER_BILLING_CYCLE
Use a billing source of capped actuals with a billing cap of cumulative per billing cycle to bill your advertiser up to a capped amount for each billing cycle of a campaign and carry forward the balance of over- or under-delivered impressions towards the number of impressions delivered in future billing cycles of the campaign.
CAPPED_WITH_ROLLOVER_PER_BILLING_CYCLE
Use a billing source of capped actuals with a billing cap of cumulative per billing cycle to bill your advertiser up to a capped amount for each cycle of a campaign and carry forward the balance of over- or under-delivered impressions towards the number of impressions delivered in future cycles of the campaign.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • not using programmatic, using sales management.

billingSchedule

BillingSchedule

Overrides the billing schedule of this ProposalLineItem. This attribute is optional. If this field is overridden, then other required billing fields (billingSource, or billingBase) also need to be overridden depending on the billingSource. That is, none of the billing fields will inherit from their Proposal object anymore. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.


Enumerations
PREPAID
Charged based on the contracted value after the first month of the campaign.
END_OF_THE_CAMPAIGN
Charged based on the contracted value after the last month of the campaign.
STRAIGHTLINE
Use a billing source of contracted with a billing schedule of straightline to bill your advertiser the same amount each month, regardless of the number of days in each month.
PRORATED
Use a billing source of contracted with a billing schedule of prorated to bill your advertiser proportionally based on the amount of days in each month.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • not using programmatic, using sales management.

billingSource

BillingSource

Overrides the billing source of this ProposalLineItem. This attribute is optional. If this field is overridden, then other required billing fields (billingCap, billingSchedule, or billingBase) also need to be overridden depending on this field. That is, none of the billing fields will inherit from their Proposal object anymore. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.


Enumerations
CONTRACTED
Charge based on the quantity of impressions, clicks, or days booked, regardless of what actually delivered.
DFP_VOLUME
Charge based on what actually delivered, as counted by Ad Manager.
THIRD_PARTY_VOLUME
Charge based on what actually delivered, as counted by the third party ads server.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • not using programmatic, using sales management.

billingBase

BillingBase

Overrides the billing base of this ProposalLineItem. This attribute is optional.

If this field is overridden, then other required billing fields (billingCap, billingSchedule, or billingSource) also need to be overridden depending on the billingSource. That is, none of the billing fields will inherit from their Proposal object anymore. This attribute can be configured as editable after the proposal has been submitted. Please check with your network administrator for editable fields configuration.


Enumerations
VOLUME
Billing calculation (eg. proration) should be based on volume.
REVENUE
Billing calculation (eg. proration) should be based on revenue.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
not using programmatic, using sales management.

lastModifiedDateTime

DateTime

The date and time this ProposalLineItem was last modified.

This attribute is assigned by Google when a ProposalLineItem is updated. This attribute is read-only.

reservationStatus

ReservationStatus

The reservation status of the ProposalLineItem. This attribute is read-only.


Enumerations
RESERVED
The inventory is reserved.
NOT_RESERVED
The proposal line item's inventory is never reserved.
RELEASED
The inventory is once reserved and now released.
CHECK_LINE_ITEM_RESERVATION_STATUS
The reservation status of the corresponding LineItem should be used for this ProposalLineItem.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

lastReservationDateTime

DateTime

The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only.

useThirdPartyAdServerFromProposal

xsd:boolean

Whether to use the corresponding proposal's third party ad server. If this field is true, thirdPartyAdServerId and customThirdPartyAdServerName will be ignored.

This attribute is applicable when:
  • not using programmatic, using sales management.

thirdPartyAdServerId

xsd:int

A predefined third party ad server, which will be used to fill in reconciliation. All predefined third party ad servers can be found in the Third_Party_Company PQL table. If actual third party ad server is not in the predefined list, this field is set to 0, and actual third party ad server name is set in customThirdPartyAdServerName.

This attribute is applicable when:
  • not using programmatic, using sales management.

customThirdPartyAdServerName

xsd:string

When actual third party ad server is not in the predefined list, thirdPartyAdServerId is set to 0, and actual third party ad server name is set here. When thirdPartyAdServerId is not 0, this field is ignored.

This attribute is applicable when:
  • not using programmatic, using sales management.

environmentType

EnvironmentType

The environment that the ProposalLineItem is targeting. The default value is EnvironmentType.BROWSER. If this value is EnvironmentType.VIDEO_PLAYER, then this ProposalLineItem can only target ad units that have sizes whose AdUnitSize.environmentType is also EnvironmentType.VIDEO_PLAYER.

This field can only be changed if the linkStatus is LinkStatus.UNLINKED. Otherwise its value is read-only and set to Product.environmentType of the product this proposal line item was created from.


Enumerations
BROWSER
A regular web browser.
VIDEO_PLAYER
Video players.

isProgrammatic

xsd:boolean

Whether or not the Proposal for this ProposalLineItem is a programmatic deal. This attribute is populated from Proposal.isProgrammatic. This attribute is read-only.

linkStatus

LinkStatus

The status of the link between this ProposalLineItem and its {link Product}.


Enumerations
LINKED
UNLINKED
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

marketplaceInfo

ProposalLineItemMarketplace...

The marketplace info if this proposal line item is programmatic, null otherwise.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • using programmatic guaranteed, not using sales management.
This attribute is required when:
  • using programmatic guaranteed, using sales management.
  • using programmatic guaranteed, not using sales management.

rateCardPricingModel

PricingModel

RateCard pricing model for the ProposalLineItem. When the pricing model is PricingModel.NET refer to the netCost and netRate fields. When the pricing model is PricingModel.GROSS refer to the grossCost and grossRate fields.


Enumerations
NET
Indicates using net pricing model to calculate the price.
GROSS
Indicates using gross pricing model to calculate the price.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.
This attribute is read-only when:
  • using programmatic guaranteed, using sales management.
  • not using programmatic, using sales management.

additionalTerms

xsd:string

Additional terms shown to the buyer in Marketplace.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • using programmatic guaranteed, not using sales management.

programmaticCreativeSource

ProgrammaticCreativeSource

Indicates the ProgrammaticCreativeSource of the programmatic line item.


Enumerations
PUBLISHER
Indicates that the programmatic line item is associated with creatives provided by the publisher.
ADVERTISER
Indicates that the programmatic line item is associated with creatives provided by the advertiser.
UNKNOWN
The value returned if the actual value is not exposed by the requested API version.

This attribute is applicable when:
  • using programmatic guaranteed, using sales management.
  • using programmatic guaranteed, not using sales management.

estimatedMinimumImpressions

xsd:long

The estimated minimum impressions that should be delivered for a proposal line item.

This attribute is applicable when:
  • using preferred deals, not using sales management.

Send feedback about...

Ad Manager API
Ad Manager API
Need help? Visit our support page.