LineItem

import type { LineItem } from "https://googleapis.deno.dev/v1/displayvideo:v4.ts";

A single line item.

interface LineItem {

readonly advertiserId?: bigint;

bidStrategy?: BiddingStrategy;

budget?: LineItemBudget;

readonly campaignId?: bigint;

conversionCounting?: ConversionCountingConfig;

creativeIds?: bigint[];

displayName?: string;

entityStatus?:

| "ENTITY_STATUS_UNSPECIFIED"

| "ENTITY_STATUS_ACTIVE"

| "ENTITY_STATUS_ARCHIVED"

| "ENTITY_STATUS_DRAFT"

| "ENTITY_STATUS_PAUSED"

| "ENTITY_STATUS_SCHEDULED_FOR_DELETION";

excludeNewExchanges?: boolean;

flight?: LineItemFlight;

frequencyCap?: FrequencyCap;

insertionOrderId?: bigint;

integrationDetails?: IntegrationDetails;

readonly lineItemId?: bigint;

lineItemType?:

| "LINE_ITEM_TYPE_UNSPECIFIED"

| "LINE_ITEM_TYPE_DISPLAY_DEFAULT"

| "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL"

| "LINE_ITEM_TYPE_VIDEO_DEFAULT"

| "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL"

| "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY"

| "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY"

| "LINE_ITEM_TYPE_AUDIO_DEFAULT"

| "LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY"

| "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW"

| "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME"

| "LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME";

mobileApp?: MobileApp;

readonly name?: string;

pacing?: Pacing;

partnerCosts?: PartnerCost[];

partnerRevenueModel?: PartnerRevenueModel;

readonly reservationType?:

| "RESERVATION_TYPE_UNSPECIFIED"

| "RESERVATION_TYPE_NOT_GUARANTEED"

| "RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED"

| "RESERVATION_TYPE_TAG_GUARANTEED"

| "RESERVATION_TYPE_PETRA_VIRAL"

| "RESERVATION_TYPE_INSTANT_RESERVE";

targetingExpansion?: TargetingExpansionConfig;

readonly updateTime?: Date;

readonly warningMessages?:

| "LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED"

| "INVALID_FLIGHT_DATES"

| "EXPIRED"

| "PENDING_FLIGHT"

| "ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED"

| "INVALID_INVENTORY_SOURCE"

| "APP_INVENTORY_INVALID_SITE_TARGETING"

| "APP_INVENTORY_INVALID_AUDIENCE_LISTS"

| "NO_VALID_CREATIVE"

| "PARENT_INSERTION_ORDER_PAUSED"

| "PARENT_INSERTION_ORDER_EXPIRED"[];

readonly youtubeAndPartnersSettings?: YoutubeAndPartnersSettings;

}

§Properties

readonly advertiserId?: bigint

[src]

Output only. The unique ID of the advertiser the line item belongs to.

bidStrategy?: BiddingStrategy

[src]

Required. The bidding strategy of the line item.

budget?: LineItemBudget

[src]

Required. The budget allocation setting of the line item.

readonly campaignId?: bigint

[src]

Output only. The unique ID of the campaign that the line item belongs to.

conversionCounting?: ConversionCountingConfig

[src]

The conversion tracking setting of the line item. Warning: Starting April 1, 2025, the floodlight_activity_configs field will no longer be writable while a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm. Read more about this announced change.

creativeIds?: bigint[]

[src]

The IDs of the creatives associated with the line item.

displayName?: string

[src]

Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.

[src]

Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only ENTITY_STATUS_DRAFT is allowed. To activate a line item, use UpdateLineItem method and update the status to ENTITY_STATUS_ACTIVE after creation. * A line item cannot be changed back to ENTITY_STATUS_DRAFT status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is ENTITY_STATUS_ACTIVE.

excludeNewExchanges?: boolean

[src]

Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.

flight?: LineItemFlight

[src]

Required. The start and end time of the line item's flight.

frequencyCap?: FrequencyCap

[src]

Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap.

insertionOrderId?: bigint

[src]

Required. Immutable. The unique ID of the insertion order that the line item belongs to.

integrationDetails?: IntegrationDetails

[src]

Integration details of the line item.

readonly lineItemId?: bigint

[src]

Output only. The unique ID of the line item. Assigned by the system.

lineItemType?: "LINE_ITEM_TYPE_UNSPECIFIED" | "LINE_ITEM_TYPE_DISPLAY_DEFAULT" | "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL" | "LINE_ITEM_TYPE_VIDEO_DEFAULT" | "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL" | "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY" | "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY" | "LINE_ITEM_TYPE_AUDIO_DEFAULT" | "LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY" | "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW" | "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME" | "LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME"

[src]

Required. Immutable. The type of the line item.

mobileApp?: MobileApp

[src]

The mobile app promoted by the line item. This is applicable only when line_item_type is either LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL or LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.

readonly name?: string

[src]

Output only. The resource name of the line item.

pacing?: Pacing

[src]

Required. The budget spending speed setting of the line item.

partnerCosts?: PartnerCost[]

[src]

The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.

partnerRevenueModel?: PartnerRevenueModel

[src]

Required. The partner revenue model setting of the line item.

[src]

Output only. The reservation type of the line item.

targetingExpansion?: TargetingExpansionConfig

[src]

The optimized targeting settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.

readonly updateTime?: Date

[src]

Output only. The timestamp when the line item was last updated. Assigned by the system.

[src]

Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.

readonly youtubeAndPartnersSettings?: YoutubeAndPartnersSettings

[src]

Output only. Settings specific to YouTube and Partners line items.