- Resource: ProposalLineItem
- ProposalLineItemStats
- ProposalLineItemReservationStatus
- ProgrammaticCreativeSource
- ProposalLineItemMakegoodInfo
- ProposalNegotiationRole
- Methods
Resource: ProposalLineItem
A ProposalLineItem is added to a programmatic Proposal and is similar to a delivery LineItem. It contains delivery details including information like impression goal or quantity, start and end times, and targeting.
| JSON representation |
|---|
{ "name": string, "secondaryGoals": [ { object ( |
| Fields | |
|---|---|
name |
Identifier. The resource name of the Format: |
secondaryGoals[] |
Optional. The secondary goals that this ProposalLineItem is associated with. For a |
frequencyCaps[] |
Optional. The set of |
creativePlaceholders[] |
Required. Details about the creatives that are expected to serve through the ProposalLineItem. |
customFieldValues[] |
Optional. The values of the custom fields associated with the ProposalLineItem. |
appliedLabels[] |
Optional. The set of labels applied directly to the ProposalLineItem. |
effectiveAppliedLabels[] |
Output only. The set of labels applied directly to the proposal as well as inherited ones. If a label has been negated only the negated label is returned. |
allowedFormats[] |
Optional. The set of allowed formats for this ProposalLineItem. If empty, all formats are allowed. This property only applies to video ProposalLineItems. |
proposal |
Required. Immutable. The resource name of the Proposal to which the ProposalLineItem belongs. Format: |
displayName |
Required. The display name of the ProposalLineItem which should be unique under the same Proposal. This attribute has a maximum length of 255 characters. |
startTime |
Required. The time at which the LineItem associated with the ProposalLineItem is enabled to begin serving. This attribute becomes readonly once the ProposalLineItem has started delivering. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
endTime |
Optional. The time at which the LineItem associated with the ProposalLineItem stops serving. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
notes |
Optional. Provides any additional notes that may annotate the ProposalLineItem. |
archived |
Output only. The archival status of the ProposalLineItem. |
goal |
Optional. The goal (i.e. contracted quantity, quantity, or limit) that this ProposalLineItem is associated with which is used in its pacing and budgeting. |
contractedUnitsBought |
Optional. The contracted number of daily minimum impressions used for |
deliveryRateType |
Optional. The strategy for delivering ads over the course of the ProposalLineItem's duration. For a |
roadblockingType |
Optional. The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page. |
buyerPermissionType |
Required. The options for allowing buyers to transact on the deal. - |
companionDeliveryOption |
Optional. The delivery option for companions. This is only valid if the |
maxVideoCreativeDuration |
Optional. The max duration of a video creative associated with this ProposalLineItem. This attribute is only meaningful if the A duration in seconds with up to nine fractional digits, ending with ' |
skippableAdType |
Optional. The ProposalLineItem's creatives' skippability. It defaults to |
lineItem |
Output only. The resource name of corresponding LineItem. This will be unset if the Proposal has not been finalized. Format: |
lineItemType |
Required. The corresponding LineItemType of the ProposalLineItem. The supported values are: - |
lineItemPriority |
Output only. The priority for the corresponding LineItem of the ProposalLineItem. Defaults to the default priority of the LineItem type. |
costType |
Required. The method used for billing the ProposalLineItem. |
targeting |
Optional. |
enabledForSameAdvertiserException |
Optional. Non-empty default. If a LineItem has a series of competitive exclusions on it, it could be blocked from serving with LineItems from the same advertiser. Setting this to true will allow LineItems from the same advertiser to serve regardless of the other competitive exclusion labels being applied. This attribute defaults to false. |
sold |
Output only. Whether this ProposalLineItem has been sold. |
netRate |
Optional. The rate per unit (for example, impression or click). The value supports precision up to four decimal places. When represented as the standard Money type, the |
deliveryIndicator |
Output only. Indicates how well the corresponding LineItem generated from this ProposalLineItem has been performing. This will be unset if the delivery indicator information is not available due to one of the following reasons: - The ProposalLineItem is not finalized. - The LineItem is not delivering - The LineItem has an unlimited goal or cap - The LineItem has a percentage based goal or cap. |
stats |
Output only. Trafficking statistics for the ProposalLineItem. |
computedStatus |
Output only. The status of the LineItem generated from this ProposalLineItem. This will be unset if the ProposalLineItem is not finalized. |
reservationStatus |
Output only. The reservation status of the ProposalLineItem. |
lastReservationTime |
Output only. The last time when the ProposalLineItem reserved inventory. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
environmentType |
Optional. Non-empty default. The environment that the ProposalLineItem is targeting. The default value is |
additionalTerms |
Optional. Additional terms shown to the buyer in Marketplace. |
programmaticCreativeSource |
Optional. Non-empty default. |
grpSettings |
Optional. GRP information for the ProposalLineItem. |
estimatedMinimumImpressions |
Optional. The estimated minimum impressions that should be delivered for the current ProposalLineItem. |
thirdPartyMeasurementSettings |
Optional. Third party measurement settings for cross-sell partners |
makegoodInfo |
Optional. Makegood info for this ProposalLineItem. Unset if this ProposalLineItem is not a makegood. Only the |
pauseRole |
Output only. The NegotiationRole that paused the ProposalLineItem, i.e. |
pauseReason |
Output only. The reason for pausing the ProposalLineItem provided by the |
updateTime |
Output only. The time this ProposalLineItem was last modified. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
ProposalLineItemStats
Stats for a ProposalLineItem.
| JSON representation |
|---|
{ "lastSevenDayImpressions": [ string ] } |
| Fields | |
|---|---|
lastSevenDayImpressions[] |
Output only. Impressions delivered for the last 7 days. This field is expected to contain exactly 7 elements which are ordered chronologically, with the index 0 being the oldest day (7 days ago) and index 6 being the most recent day (yesterday). |
ProposalLineItemReservationStatus
Defines the different reservation statuses of a proposal line item.
| Enums | |
|---|---|
PROPOSAL_LINE_ITEM_RESERVATION_STATUS_UNSPECIFIED |
No value specified |
RESERVED |
Indicates that inventory has been reserved for the proposal line item. |
NOT_RESERVED |
Indicates that inventory has not been reserved for the proposal line item. |
CHECK_LINE_ITEM_RESERVATION_STATUS |
Indicates that the reservation status of the proposal line item is ignored and the reservation status of the parent proposal line item is used. |
RELEASED |
Indicates that the inventory was previously reserved and has been released. |
ProgrammaticCreativeSource
Types of programmatic creative sources.
| Enums | |
|---|---|
PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED |
Default value. This value is unused. |
ADVERTISER |
Indicates that the programmatic line item is associated with creatives provided by the advertiser. |
PUBLISHER |
Indicates that the programmatic line item is associated with creatives provided by the publisher. |
ProposalLineItemMakegoodInfo
Makegood info for a ProposalLineItem.
| JSON representation |
|---|
{ "originalProposalLineItem": string, "reason": string } |
| Fields | |
|---|---|
originalProposalLineItem |
Required. Immutable. The resource name of the original ProposalLineItem on which this makegood is based. Format: |
reason |
Optional. The publisher-provided reason why this makegood was initiated. This is free form text. The following predefined values can be used to render predefined options in the UI. - UNDERDELIVERY: 'Impression underdelivery', - SECONDARY_DELIVERY_TERMS: 'Did not meet secondary delivery terms ', - PERFORMANCE: 'Performance issues', |
ProposalNegotiationRole
The role (buyer or seller) that performed an action in the negotiation of a Proposal.
| Enums | |
|---|---|
PROPOSAL_NEGOTIATION_ROLE_UNSPECIFIED |
Default value. This value is unused. |
BUYER |
The buyer performed the action. |
SELLER |
The seller performed the action. |
Methods |
|
|---|---|
|
Batch archives ProposalLineItem objects. |
|
Creates ProposalLineItem objects. |
|
Batch pauses ProposalLineItem objects. |
|
Batch releases ProposalLineItem objects. |
|
Batch reserves ProposalLineItem objects. |
|
Batch resumes ProposalLineItem objects. |
|
Batch unarchives ProposalLineItem objects. |
|
Batch updates ProposalLineItem objects. |
|
Creates a ProposalLineItem object. |
|
Retrieves a ProposalLineItem object. |
|
Lists ProposalLineItem objects. |
|
Updates a ProposalLineItem object. |