REST Resource: networks.proposalLineItems

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 (Goal)
    }
  ],
  "frequencyCaps": [
    {
      object (FrequencyCap)
    }
  ],
  "creativePlaceholders": [
    {
      object (CreativePlaceholder)
    }
  ],
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ],
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "effectiveAppliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "allowedFormats": [
    enum (LineItemAllowedFormat)
  ],
  "proposal": string,
  "displayName": string,
  "startTime": string,
  "endTime": string,
  "notes": string,
  "archived": boolean,
  "goal": {
    object (Goal)
  },
  "contractedUnitsBought": string,
  "deliveryRateType": enum (LineItemDeliveryRateType),
  "roadblockingType": enum (RoadblockingType),
  "buyerPermissionType": enum (DealBuyerPermissionType),
  "companionDeliveryOption": enum (CompanionDeliveryOption),
  "maxVideoCreativeDuration": string,
  "skippableAdType": enum (SkippableAdType),
  "lineItem": string,
  "lineItemType": enum (LineItemType),
  "lineItemPriority": integer,
  "costType": enum (LineItemCostType),
  "targeting": {
    object (Targeting)
  },
  "enabledForSameAdvertiserException": boolean,
  "sold": boolean,
  "netRate": {
    object (Money)
  },
  "deliveryIndicator": {
    object (DeliveryIndicator)
  },
  "stats": {
    object (ProposalLineItemStats)
  },
  "computedStatus": enum (LineItemComputedStatus),
  "reservationStatus": enum (ProposalLineItemReservationStatus),
  "lastReservationTime": string,
  "environmentType": enum (EnvironmentType),
  "additionalTerms": string,
  "programmaticCreativeSource": enum (ProgrammaticCreativeSource),
  "grpSettings": {
    object (GrpSettings)
  },
  "estimatedMinimumImpressions": string,
  "thirdPartyMeasurementSettings": {
    object (ThirdPartyMeasurementSettings)
  },
  "makegoodInfo": {
    object (ProposalLineItemMakegoodInfo)
  },
  "pauseRole": enum (ProposalNegotiationRole),
  "pauseReason": string,
  "updateTime": string
}
Fields
name

string

Identifier. The resource name of the ProposalLineItem.

Format: networks/{networkCode}/proposalLineItems/{proposal_line_item_id}

secondaryGoals[]

object (Goal)

Optional. The secondary goals that this ProposalLineItem is associated with. For a LineItemTypeEnum.LineItemType.SPONSORSHIP ProposalLineItem with a cost type of CPM, this field will have one goal which describes the impressions cap. For other cases this field will be empty.

frequencyCaps[]

object (FrequencyCap)

Optional. The set of FrequencyCaps for this ProposalLineItem.

creativePlaceholders[]

object (CreativePlaceholder)

Required. Details about the creatives that are expected to serve through the ProposalLineItem.

customFieldValues[]

object (CustomFieldValue)

Optional. The values of the custom fields associated with the ProposalLineItem.

appliedLabels[]

object (AppliedLabel)

Optional. The set of labels applied directly to the ProposalLineItem.

effectiveAppliedLabels[]

object (AppliedLabel)

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[]

enum (LineItemAllowedFormat)

Optional. The set of allowed formats for this ProposalLineItem. If empty, all formats are allowed. This property only applies to video ProposalLineItems.

proposal

string

Required. Immutable. The resource name of the Proposal to which the ProposalLineItem belongs.

Format: networks/{networkCode}/proposals/{proposal_id}

displayName

string

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

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

notes

string

Optional. Provides any additional notes that may annotate the ProposalLineItem.

archived

boolean

Output only. The archival status of the ProposalLineItem.

goal

object (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. units must be greater than 0 when the ProposalLineItem turns into a LineItem, goalType and unitType are readonly and inferred from the reservation type. For a LineItemTypeEnum.LineItemType.PREFERRED_DEAL the goal type can only be GoalTypeEnum.GoalType.NONE.

contractedUnitsBought

string (int64 format)

Optional. The contracted number of daily minimum impressions used for LineItemTypeEnum.LineItemType.SPONSORSHIP ProposalLineItem deals with a cost type of CPD. This does not impact ad-serving and is for reporting purposes only.

deliveryRateType

enum (LineItemDeliveryRateType)

Optional. The strategy for delivering ads over the course of the ProposalLineItem's duration. For a LineItemTypeEnum.LineItemType.PREFERRED_DEAL the value can only be LineItemDeliveryRateTypeEnum.LineItemDeliveryRateType.FRONTLOADED.

roadblockingType

enum (RoadblockingType)

Optional. The strategy for serving roadblocked creatives, i.e. instances where multiple creatives must be served together on a single web page.

buyerPermissionType

enum (DealBuyerPermissionType)

Required. The options for allowing buyers to transact on the deal. - DealBuyerPermissionTypeEnum.DealBuyerPermissionType.NEGOTIATOR_ONLY means that only the buyer listed on the deal can bid on the deal. - DealBuyerPermissionTypeEnum.DealBuyerPermissionType.BIDDER means that all buyers under the listed buyer's bidder can bid on the deal.

companionDeliveryOption

enum (CompanionDeliveryOption)

Optional. The delivery option for companions. This is only valid if the roadblockingType is CREATIVE_SET. The default value for roadblocking creatives is CompanionDeliveryOptionEnum.CompanionDeliveryOption.OPTIONAL.

maxVideoCreativeDuration

string (Duration format)

Optional. The max duration of a video creative associated with this ProposalLineItem. This attribute is only meaningful if the environmentType is VIDEO_PLAYER.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

skippableAdType

enum (SkippableAdType)

Optional. The ProposalLineItem's creatives' skippability. It defaults to SkippableAdTypeEnum.SkippableAdType.DISABLED and is only applicable when the environmentType is VIDEO_PLAYER.

lineItem

string

Output only. The resource name of corresponding LineItem. This will be unset if the Proposal has not been finalized.

Format: networks/{networkCode}/lineItems/{lineItemId}

lineItemType

enum (LineItemType)

Required. The corresponding LineItemType of the ProposalLineItem. The supported values are: - LineItemTypeEnum.LineItemType.SPONSORSHIP - LineItemTypeEnum.LineItemType.STANDARD - LineItemTypeEnum.LineItemType.PREFERRED_DEAL

lineItemPriority

integer

Output only. The priority for the corresponding LineItem of the ProposalLineItem. Defaults to the default priority of the LineItem type.

costType

enum (LineItemCostType)

Required. The method used for billing the ProposalLineItem.

targeting

object (Targeting)

Optional. Targeting for the ProposalLineItem.

enabledForSameAdvertiserException

boolean

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

boolean

Output only. Whether this ProposalLineItem has been sold.

netRate

object (Money)

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 google.type.Money.nanos must be a multiple of 100,000. For example, a rate of 123.4567 units of a currency would have google.type.Money.units as 123 and google.type.Money.nanos as 456,700,000.

deliveryIndicator

object (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

object (ProposalLineItemStats)

Output only. Trafficking statistics for the ProposalLineItem.

computedStatus

enum (LineItemComputedStatus)

Output only. The status of the LineItem generated from this ProposalLineItem. This will be unset if the ProposalLineItem is not finalized.

reservationStatus

enum (ProposalLineItemReservationStatus)

Output only. The reservation status of the ProposalLineItem.

lastReservationTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

environmentType

enum (EnvironmentType)

Optional. Non-empty default. The environment that the ProposalLineItem is targeting. The default value is EnvironmentTypeEnum.EnvironmentType.BROWSER. If this value is EnvironmentTypeEnum.EnvironmentType.VIDEO_PLAYER, then this ProposalLineItem can only target AdUnits that have sizes with AdUnitSize.environmentType also set to EnvironmentTypeEnum.EnvironmentType.VIDEO_PLAYER.

additionalTerms

string

Optional. Additional terms shown to the buyer in Marketplace.

programmaticCreativeSource

enum (ProgrammaticCreativeSource)

Optional. Non-empty default. ProgrammaticCreativeSource of the ProposalLineItem.

grpSettings

object (GrpSettings)

Optional. GRP information for the ProposalLineItem.

estimatedMinimumImpressions

string (int64 format)

Optional. The estimated minimum impressions that should be delivered for the current ProposalLineItem.

thirdPartyMeasurementSettings

object (ThirdPartyMeasurementSettings)

Optional. Third party measurement settings for cross-sell partners

makegoodInfo

object (ProposalLineItemMakegoodInfo)

Optional. Makegood info for this ProposalLineItem. Unset if this ProposalLineItem is not a makegood. Only the reason of an existing makegood can be updated.

pauseRole

enum (ProposalNegotiationRole)

Output only. The NegotiationRole that paused the ProposalLineItem, i.e. ProposalNegotiationRoleEnum.ProposalNegotiationRole.SELLER or ProposalNegotiationRoleEnum.ProposalNegotiationRole.BUYER, or unset when the proposal is not paused.

pauseReason

string

Output only. The reason for pausing the ProposalLineItem provided by the pauseRole. It is unset when the ProposalLineItem is not paused.

updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

ProposalLineItemStats

Stats for a ProposalLineItem.

JSON representation
{
  "lastSevenDayImpressions": [
    string
  ]
}
Fields
lastSevenDayImpressions[]

string (int64 format)

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

string

Required. Immutable. The resource name of the original ProposalLineItem on which this makegood is based.

Format: networks/{networkCode}/proposalLineItems/{proposal_line_item_id}

reason

string

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

batchArchive

Batch archives ProposalLineItem objects.

batchCreate

Creates ProposalLineItem objects.

batchPause

Batch pauses ProposalLineItem objects.

batchRelease

Batch releases ProposalLineItem objects.

batchReserve

Batch reserves ProposalLineItem objects.

batchResume

Batch resumes ProposalLineItem objects.

batchUnarchive

Batch unarchives ProposalLineItem objects.

batchUpdate

Batch updates ProposalLineItem objects.

create

Creates a ProposalLineItem object.

get

Retrieves a ProposalLineItem object.

list

Lists ProposalLineItem objects.

patch

Updates a ProposalLineItem object.