type ProposalLineItem (v202411)

    Service
    ForecastService ProposalLineItemService
    Dependencies
    ProspectiveLineItem
    ▼
    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.

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

    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.

    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 .

    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.

    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.

    secondaryGoals

    Goal []

    The secondary goals that this ProposalLineItem is associated with. For a programmatic line item with the properties RateType.CPM and LineItemType.SPONSORSHIP , this field will have one goal which describes the impressions cap. For other cases, this field is an empty list.

    contractedUnitsBought

    xsd: long

    The contracted number of daily minimum impressions used for LineItemType.SPONSORSHIP ProposalLineItem deals with a rate type of RateType.CPD .

    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 required. 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.

    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.

    videoCreativeSkippableAdType

    SkippableAdType

    The proposal line item's creatives' skippability. This attribute is optional, only applicable for video proposal line items, and defaults to SkippableAdType.NOT_SKIPPABLE .

    Enumerations
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    DISABLED
    Skippable ad type is disabled.
    ENABLED
    Skippable ad type is enabled.
    INSTREAM_SELECT
    Skippable in-stream ad type.
    ANY
    Any skippable or not skippable. This is only for programmatic case when the creative skippability is decided by the buyside.

    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 LineItem s 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 default priority of the lineItemType . For forecasting, this attribute is optional and has a default value assigned by Google. See LineItem.priority for more information.

    rateType

    RateType

    The method used for billing the ProposalLineItem . This attribute is read-only.

    Enumerations
    CPM
    The rate applies to cost per mille (CPM) revenue.
    CPD
    The rate applies to cost per day (CPD) revenue.
    VCPM
    The rate applies to Active View viewable cost per mille (vCPM) revenue.
    CPM_IN_TARGET
    The rate applies to cost per mille in-target (CPM In-Target).
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.
    This attribute is required.

    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.

    targeting

    Targeting

    Contains the targeting criteria for the ProposalLineItem .

    This attribute is required.

    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.

    isSold

    xsd: boolean

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

    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.

    The field ProposalLineItem.netRate is required, and used to calculate ProposalLineItem.netCost if unspecified.

    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.

    The field ProposalLineItem.netRate is required, and used to calculate ProposalLineItem.netCost if unspecified.

    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. 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.

    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.

    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 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.

    allowedFormats

    AllowedFormats []

    The set of AllowedFormats that this proposal line item can have. If the set is empty, this proposal line item allows all formats.

    Enumerations
    AUDIO
    Audio format. This is only relevant for programmatic video line items.
    UNKNOWN
    The value returned if the actual value is not exposed by the requested API version.

    additionalTerms

    xsd: string

    Additional terms shown to the buyer in Marketplace.

    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.

    grpSettings

    GrpSettings

    Contains the information for a proposal line item which has a target GRP demographic.

    estimatedMinimumImpressions

    xsd: long

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

    thirdPartyMeasurementSettings

    ThirdPartyMeasurementSettings

    Contains third party measurement settings for cross-sell Partners

    makegoodInfo

    ProposalLineItemMakegoodInfo

    Makegood info for this proposal line item. Immutable once created.

    Null if this proposal line item is not a makegood.

    hasMakegood

    xsd: boolean

    Whether this proposal line item has an associated makegood. This attribute is read-only.

    canCreateMakegood

    xsd: boolean

    Whether a new makegood associated with this line item can be created. This attribute is read-only.

    pauseRole

    NegotiationRole

    The NegotiationRole that paused the proposal line item, i.e. NegotiationRole.seller or NegotiationRole.buyer , or null when the proposal is not paused. This attribute is read-only.

    Enumerations
    BUYER
    SELLER
    UNKNOWN

    pauseReason

    xsd: string

    The reason for pausing the ProposalLineItem , provided by the pauseRole . It is null when the ProposalLineItem is not paused. This attribute is read-only.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: