Note: Version v201811 will be sunset soon. All users of those versions must migrate to a newer one.

type ProposalLineItem (v201905)

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/v201905

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