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/v201911
Field |
|
---|---|
|
The unique ID of the |
|
The unique ID of the Proposal, to which the This attribute is required.
|
|
The name of the This attribute is required.
|
|
The date and time at which the line item associated with the
|
|
The date and time at which the line item associated with the
|
|
The time zone ID in tz database format (e.g. "America/Los_Angeles") for this This attribute is read-only when:
|
|
Provides any additional notes that may annotate the |
|
The archival status of the |
|
The goal(i.e. contracted quantity, quantity or limit) that this This attribute is required.
|
|
The contracted number of impressions or clicks. If this is a
LineItemType.SPONSORSHIP
This attribute is required for percentage-based-goal proposal line items. It does not impact ad-serving and is for reporting purposes only. |
|
The strategy for delivering ads over the course of the Enumerations
|
|
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
Enumerations
|
|
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
|
|
The max duration of a video creative associated with this |
|
The set of frequency capping units for this |
|
The unique ID of corresponding LineItem. This will be |
|
The corresponding LineItemType of the Enumerations
This attribute is required.
|
|
The priority for the corresponding LineItem of the |
|
The method used for billing the Enumerations
This attribute is read-only when:
This attribute is required when:
|
|
Details about the creatives that are expected to serve through the
This attribute is required when:
|
|
Contains the targeting criteria for the |
|
The values of the custom fields associated with the |
|
The set of labels applied directly to the |
|
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. |
|
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 This attribute is optional and defaults to false. |
|
Indicates whether this |
|
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. |
|
The cost of the 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. |
|
Indicates how well the line item generated from this proposal line item has been performing.
This will be
|
|
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
|
|
The status of the LineItem generated from this proposal line item.
This will be Enumerations
|
|
The date and time this This attribute is assigned by Google when a |
|
The reservation status of the ProposalLineItem. This attribute is read-only. Enumerations
|
|
The last DateTime when the ProposalLineItem reserved inventory. This attribute is read-only. |
|
The environment that the This field can only be changed if the linkStatus is
Enumerations
|
|
The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats. Enumerations
|
|
Whether or not the Proposal for this |
|
The marketplace info if this proposal line item is programmatic, null otherwise. This attribute is applicable when:
This attribute is required when:
|
|
Additional terms shown to the buyer in Marketplace. This attribute is applicable when:
|
|
Indicates the ProgrammaticCreativeSource of the programmatic line item. Enumerations
This attribute is applicable when:
|
|
The estimated minimum impressions that should be delivered for a proposal line item. This attribute is applicable when:
|