REST Resource: networks.lineItems

Resource: LineItem

A LineItem contains information about how specific ad creatives are intended to serve to your website or app along with pricing and other delivery details.

JSON representation 
{
  "name": string,
  "frequencyCaps": [
    {
      object (FrequencyCap)
    }
  ],
  "creativePlaceholders": [
    {
      object (CreativePlaceholder)
    }
  ],
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "effectiveAppliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ],
  "secondaryGoals": [
    {
      object (Goal)
    }
  ],
  "viewabilityProviderCompanies": [
    string
  ],
  "creativeTargetings": [
    {
      object (CreativeTargeting)
    }
  ],
  "allowedFormats": [
    enum (LineItemAllowedFormat)
  ],
  "order": string,
  "displayName": string,
  "externalLineItemId": string,
  "orderDisplayName": string,
  "startTime": string,
  "targetEndTime": string,
  "endTime": string,
  "autoExtensionDays": integer,
  "endTimeUnlimited": boolean,
  "creativeRotationType": enum (CreativeRotationType),
  "deliveryRateType": enum (LineItemDeliveryRateType),
  "deliveryForecastSource": enum (LineItemDeliveryForecastSource),
  "customPacingCurve": {
    object (CustomPacingCurve)
  },
  "roadblockingType": enum (RoadblockingType),
  "skippableAdType": enum (SkippableAdType),
  "lineItemType": enum (LineItemType),
  "priority": integer,
  "rate": {
    object (Money)
  },
  "valueCpm": {
    object (Money)
  },
  "costType": enum (LineItemCostType),
  "discount": {
    object (LineItemDiscount)
  },
  "contractedUnitsBought": string,
  "environmentType": enum (EnvironmentType),
  "companionDeliveryOption": enum (CompanionDeliveryOption),
  "allowOverbook": boolean,
  "skipInventoryCheck": boolean,
  "skipCrossSellingRuleWarningChecks": boolean,
  "reserveOnCreation": boolean,
  "stats": {
    object (LineItemStats)
  },
  "deliveryIndicator": {
    object (DeliveryIndicator)
  },
  "budget": {
    object (Money)
  },
  "status": enum (LineItemComputedStatus),
  "reservationStatus": enum (LineItemReservationStatus),
  "archived": boolean,
  "webPropertyCode": string,
  "sameAdvertiserExceptionEnabled": boolean,
  "updateSource": string,
  "notes": string,
  "competitiveConstraintScope": enum (ExclusionScope),
  "updateTime": string,
  "createTime": string,
  "missingCreatives": boolean,
  "thirdPartyMeasurementSettings": {
    object (ThirdPartyMeasurementSettings)
  },
  "youtubeKidsRestricted": boolean,
  "maxVideoCreativeDuration": string,
  "goal": {
    object (Goal)
  },
  "grpSettings": {
    object (GrpSettings)
  },
  "dealInfo": {
    object (LineItemDealInfo)
  },
  "childContentEligibility": enum (ChildContentEligibility),
  "customVastExtension": string,
  "sponsorshipExclusivityEnabled": boolean,
  "repeatedCreativeServingEnabled": boolean,
  "targeting": {
    object (Targeting)
  }
}
Fields
name

string

Identifier. The resource name of the LineItem. Format: networks/{networkCode}/lineItems/{lineItemId}
frequencyCaps[]

object (FrequencyCap)

Optional. The set of frequency capping units for this LineItem.
creativePlaceholders[]

object (CreativePlaceholder)

Required. Details about the creatives that are expected to serve through this LineItem.
appliedLabels[]

object (AppliedLabel)

Optional. The set of labels applied directly to this line item.
effectiveAppliedLabels[]

object (AppliedLabel)

Output only. Contains the set of labels inherited from the order that contains this line item and the advertiser that owns the order. If a label has been negated, only the negated label is returned.
customFieldValues[]

object (CustomFieldValue)

Optional. The values of the custom fields associated with this line item.
secondaryGoals[]

object (Goal)

Optional. The secondary goals that this LineItem is associated with. This is required and meaningful only if the lineItemType is SPONSORSHIP and costType is CPM.
viewabilityProviderCompanies[]

string

Optional. Optional IDs of the Company that provide ad verification for this line item.
creativeTargetings[]

object (CreativeTargeting)

Optional. A list of CreativeTargeting objects that can be used to specify creative level targeting for this line item. Creative level targeting is specified in a CreativePlaceholder.creative_targeting_display_name field by referencing the [CreativeTargeting.display_name][] field. It also needs to be re-specified in the [LineItemCreativeAssociation.targeting_display_name][] field when associating a line item with a creative that fits into that placeholder.
allowedFormats[]

enum (LineItemAllowedFormat)

Optional. The set of allowed formats for this line item. If empty, all formats are allowed. This property only applies to programmatic video line items.
order

string

Required. Immutable. The ID of the Order to which the LineItem belongs. Format: networks/{networkCode}/orders/{order}
displayName

string

Required. The name of the line item. This attribute has a maximum length of 255 characters.
externalLineItemId

string

Optional. An identifier for the LineItem that is meaningful to the publisher. This attribute has a maximum length of 255 characters.
orderDisplayName

string

Output only. The name of the Order.
startTime

string (Timestamp format)

Required. The date and time on which the LineItem is enabled to begin serving. This attribute is required and must be in the future.

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

string (Timestamp format)

Optional. The target end time of the line item. This attribute is required unless endTimeUnlimited is set to true. If specified, it must be after the startTime. This does not include auto extension days.

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)

Output only. The timestamp when the LineItem will stop serving. This attribute includes auto extension days.

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

integer

Optional. The number of days to allow a line item to deliver past its targetEndTime. A maximum of 7 days is allowed. This is feature is only available for Ad Manager 360 accounts.
endTimeUnlimited

boolean

Optional. Non-empty default. Specifies whether or not the LineItem has an end time. This attribute defaults to false. It can be be set to true for only line items of type SPONSORSHIP, NETWORK, PRICE_PRIORITY and HOUSE.
creativeRotationType

enum (CreativeRotationType)

Required. The strategy used for displaying multiple Creative objects that are associated with the LineItem.
deliveryRateType

enum (LineItemDeliveryRateType)

Optional. Non-empty default. The strategy for delivering ads over the course of the line item's duration. This attribute defaults to EVENLY or FRONTLOADED depending on the network's configuration.
deliveryForecastSource

enum (LineItemDeliveryForecastSource)

Optional. Non-empty default. Strategy for choosing forecasted traffic shapes to pace line items. This field defaults to HISTORICAL.
customPacingCurve

object (CustomPacingCurve)

Optional. The curve that is used to pace the line item's delivery. This field is required if and only if the delivery forecast source is CUSTOM_PACING_CURVE.
roadblockingType

enum (RoadblockingType)

Optional. Non-empty default. The strategy for serving roadblocked creatives, that is, instances where multiple creatives must be served together on a single web page. This attribute defaults to ONE_OR_MORE.
skippableAdType

enum (SkippableAdType)

Optional. Non-empty default. The nature of the line item's creatives' skippability. This attribute is only applicable for video line items, and defaults to NOT_SKIPPABLE.
lineItemType

enum (LineItemType)

Required. Indicates the line item type of a LineItem. The line item type determines the default priority of the line item. More information can be found at https://support.google.com/admanager/answer/177279.
priority

integer

Optional. Non-empty default. The priority for the line item. Valid values range from 1 to 16. This field defaults to the default priority of the LineItemType. The following list shows the default, minimum, and maximum priority values are for each line item type: - LineItemType: default priority (minimum priority, maximum priority) - SPONSORSHIP: 4 (2, 5) - STANDARD: 8 (6, 10) - NETWORK: 12 (11, 14) - BULK: 12 (11, 14) - PRICE_PRIORITY: 12 (11, 14) - HOUSE: 16 (15, 16) - CLICK_TRACKING: 16 (1, 16) - AD_EXCHANGE: 12 (1, 16) - ADSENSE: 12 (1, 16) - BUMPER: 16 (15, 16) - ADMOB: 21 (1, 16) - PREFERRED_DEAL: 12 (12, 12) This field can only be edited by certain networks, otherwise a PermissionError will occur.
rate

object (Money)

Required. The amount of money to spend per impression or click.
valueCpm

object (Money)

Optional. Non-empty default. An amount to help the adserver rank inventory. valueCpm artificially raises the value of inventory over the rate but avoids raising the actual rate. This attribute defaults to a Money object in the local currency with units and nanos set to 0.
costType

enum (LineItemCostType)

Required. The method used for billing this LineItem.
discount

object (LineItemDiscount)

Optional. Discount information for the line item.
contractedUnitsBought

string (int64 format)

Optional. This attribute is only applicable for certain line item types and acts as an "FYI" or note, which does not impact adserving or other backend systems. For SPONSORSHIP line items, this represents the minimum quantity, which is a lifetime impression volume goal for reporting purposes only. For STANDARD line items, this represent the contracted quantity, which is the number of units specified in the contract the advertiser has bought for this LineItem. This field is just a "FYI" for traffickers to manually intervene with the LineItem when needed. This attribute is only available for STANDARD line items if you have this feature enabled on your network.
environmentType

enum (EnvironmentType)

Optional. Non-empty default. The environment that the LineItem is targeting. The default value is BROWSER. If this value is VIDEO_PLAYER, then this line item can only target AdUnits that have AdUnitSizes whose environmentType is also VIDEO_PLAYER.
companionDeliveryOption

enum (CompanionDeliveryOption)

Optional. The delivery option for companions. Setting this field is only meaningful if the following conditions are met: - The "Guaranteed roadblocks" feature is enabled on your network. - One of the following is true (both cannot be true, these are mutually exclusive). - The environmentType is VIDEO_PLAYER. - The roadblockingType is CREATIVE_SET. This field defaults to OPTIONAL if the conditions are met. In all other cases it defaults to UNKNOWN and is not meaningful.
allowOverbook

boolean

Input only. The flag indicates whether overbooking should be allowed when creating or updating reservations of line item types SPONSORSHIP and STANDARD. When true, operations on this line item will never trigger a ForecastError, which corresponds to an overbook warning in the UI. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
skipInventoryCheck

boolean

Input only. The flag indicates whether the inventory check should be skipped when creating or updating a line item. The default value is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
skipCrossSellingRuleWarningChecks

boolean

Input only. True to skip checks for warnings from rules applied to line items targeting inventory shared by a distributor partner for cross selling when performing an action on this line item. The default is false. Note: this field won't persist on the line item itself, and the value will only affect the current request.
reserveOnCreation

boolean

Input only. The flag indicates whether inventory should be reserved when creating a line item of types SPONSORSHIP and STANDARD in an unapproved Order. The default value is false.
stats

object (LineItemStats)

Output only. Contains trafficking statistics for the line item. This will be empty in case there are no statistics for a line item yet.
deliveryIndicator

object (DeliveryIndicator)

Output only. Indicates how well the line item has been performing. This will be empty if the delivery indicator information is not available due to one of the following reasons: - The line item is not delivering. - The line item has an unlimited goal or cap. - The line item has a percentage based goal or cap.
budget

object (Money)

Output only. The amount of money allocated to the LineItem. This attribute is readonly and is populated by Google. The currency code is readonly.
status

enum (LineItemComputedStatus)

Output only. The status of the LineItem.
reservationStatus

enum (LineItemReservationStatus)

Output only. Describes whether or not inventory has been reserved for the LineItem.
archived

boolean

Output only. The archival status of the LineItem.
webPropertyCode

string

Optional. The web property code used for dynamic allocation line items. This web property is only required with line item types AD_EXCHANGE and ADSENSE.
sameAdvertiserExceptionEnabled

boolean

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

string

Output only. The application that last modified this line item.
notes

string

Optional. Provides any additional notes that may annotate the LineItem. This attribute has a maximum length of 65,535 characters.
competitiveConstraintScope

enum (ExclusionScope)

Optional. Non-empty default. The CompetitiveConstraintScope for the competitive exclusion labels assigned to this line item. This field defaults to POD.
updateTime

string (Timestamp format)

Output only. The time this line item 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".
createTime

string (Timestamp format)

Output only. The time this line item was created.

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

boolean

Output only. Indicates if a LineItem is missing any Creative creatives for the creativePlaceholders specified. Creative Creatives can be considered missing for several reasons including: - Not enough Creative creatives of a certain size have been uploaded, as determined by expectedCreativeCount. For example a LineItem specifies 750x350, 400x200 but only a 750x350 was uploaded. Or LineItem specifies 750x350 with an expected count of 2, but only one was uploaded. - The [Creative.applied_labels][] of an associated Creative don't match the CreativePlaceholder.applied_labels of the LineItem. For example LineItem specifies 750x350 with a Foo AppliedLabel but a 750x350 creative without a AppliedLabel was uploaded.
thirdPartyMeasurementSettings

object (ThirdPartyMeasurementSettings)

Optional. Third party auto-pixeling settings for cross-sell Partners.
youtubeKidsRestricted

boolean

Optional. Designates this line item as intended for YT Kids app. If true, all creatives associated with this line item must be reviewed and approved. See the help center article for more information: https://support.google.com/yt-partner-sales/answer/10015534.
maxVideoCreativeDuration

string (Duration format)

Optional. The max duration of a video creative associated with this LineItem. This attribute is only meaningful for video line items. This attribute is required for video line items and must be greater than 0.

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

object (Goal)

Optional. The primary goal that this LineItem is associated with, which is used in its pacing and budgeting.
grpSettings

object (GrpSettings)

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

object (LineItemDealInfo)

Optional. The deal information associated with this line item, if it is programmatic.
childContentEligibility

enum (ChildContentEligibility)

Optional. Non-empty default. Child content eligibility designation for this line item. This field defaults to DISALLOWED.
customVastExtension

string

Optional. Custom XML to be rendered in a custom VAST response at serving time.
sponsorshipExclusivityEnabled

boolean

Optional. Whether the line item is enabled for sponsorship exclusivity. If true, only exclusive sponsorships can be served on inventory targeted by this LineItem. This control should only be available for 100% video sponsorships.
repeatedCreativeServingEnabled

boolean

Optional. Indicates whether repeated creative serving is enabled for this line item.
targeting

object (Targeting)

Required. Contains the targeting criteria for the ad campaign.

CreativeRotationType

The strategy to use for displaying multiple creatives that are associated with a line item.

Enums
CREATIVE_ROTATION_TYPE_UNSPECIFIED No value specified.
EVENLY Creatives are displayed approximately the same number of times over the duration of the line item.
OPTIMIZED Creatives are served approximately proportionally to their performance.
SEQUENTIAL Creatives are served exactly in sequential order, aka Storyboarding. Set on the LineItemCreativeAssociation.
WEIGHTED Creatives are served approximately proportionally to their weights, set on the LineItemCreativeAssociation.

LineItemDeliveryRateType

Possible delivery rates for a LineItem. It dictates the manner in which the LineItem is served.

Enums
LINE_ITEM_DELIVERY_RATE_TYPE_UNSPECIFIED No value specified.
AS_FAST_AS_POSSIBLE The booked impressions may delivered well before the end time. Other lower-priority or lower-value LineItems will be stopped from delivering until the LineItem meets the number of impressions or clicks it is booked for.
EVENLY LineItems are served as evenly as possible across the number of days specified in a LineItem's duration.
FRONTLOADED LineItems are served more aggressively in the beginning of the flight date.

LineItemDeliveryForecastSource

Strategies for choosing forecasted traffic shapes to pace line items.

Enums
LINE_ITEM_DELIVERY_FORECAST_SOURCE_UNSPECIFIED Default value. This value is unused.
CUSTOM_PACING_CURVE A user specified custom pacing curve will be used to pace line item delivery.
FORECASTING The line item's projected future traffic will be used to pace line item delivery.
HISTORICAL The line item's historical traffic shape will be used to pace line item delivery.

CustomPacingCurve

A curve consisting of CustomPacingGoal objects that is used to pace line item delivery.

JSON representation 
{
  "customPacingGoals": [
    {
      object (CustomPacingGoal)
    }
  ],
  "customPacingGoalUnit": enum (CustomPacingGoalUnit)
}
Fields
customPacingGoals[]

object (CustomPacingGoal)

Required. The list of goals that make up the custom pacing curve.
customPacingGoalUnit

enum (CustomPacingGoalUnit)

Required. The unit of the CustomPacingGoal.amount values.

CustomPacingGoalUnit

Options for the unit of the custom pacing goal amounts.

Enums
CUSTOM_PACING_GOAL_UNIT_UNSPECIFIED Default value. This value is unused.
ABSOLUTE The custom pacing goal amounts represent absolute numbers corresponding to the line item's [Goal.unitType][].
MILLI_PERCENT The custom pacing goal amounts represent a millipercent. For example, 15000 millipercent equals 15%.

CustomPacingGoal

An interval of a CustomPacingCurve. A custom pacing goal contains a start time and an amount. The goal will apply until either the next custom pacing goal's getStartTime or the line item's end time if it is the last goal.

JSON representation 
{
  "startTime": string,
  "useLineItemStartTime": boolean,
  "amount": string
}
Fields
startTime

string (Timestamp format)

Optional. The start date and time of the goal. This field is required unless useLineItemStartTime is true.

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

boolean

Optional. Input only. Whether the [LineItem.start_time] should be used for the start date and time of this goal. This field is not persisted and if it is set to true, the [startTime] field will be populated by the line item's start time.
amount

string (int64 format)

Optional. The amount associated with the goal. This field is required.

RoadblockingType

Describes the roadblocking types.

Enums
ROADBLOCKING_TYPE_UNSPECIFIED Default value. This value is unused.
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).
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.
CREATIVE_SET A master/companion creative set roadblocking type. A CreativePlaceholder must be set accordingly.
ONE_OR_MORE Any number of creatives from a line item can serve together at a time.
ONLY_ONE Only one creative from a line item can serve at a time.

SkippableAdType

The different types of skippable ads.

Enums
SKIPPABLE_AD_TYPE_UNSPECIFIED Default value. This value is unused.
ANY Any skippable or not skippable. This is only for programmatic case when the creative skippability is decided by the buyside.
DISABLED The ad is not skippable.
ENABLED The ad is skippable.
INSTREAM_SELECT The ad is an instream select ad.

LineItemCostType

Describes the LineItem actions that are billable.

Enums
LINE_ITEM_COST_TYPE_UNSPECIFIED Not specified value.
CPA

Starting February 22, 2024 the CPA LineItemCostType will only be read as part of Spotlight deprecation, learn more at: https://support.google.com/admanager/answer/7519021#spotlight

Cost per action. The line item type must be one of:
CPC

Cost per click. The line item type must be one of:
CPD

Cost per day. The line item type must be one of:
CPM

Cost per mille (thousand) impressions. The line item type must be one of:
VCPM

Cost per mille (thousand) Active View viewable impressions. The line item type must be one of:
CPM_IN_TARGET

Cost per millie (thousand) in-target impressions. The line item type must be one of:
CPF

Cost for the entire flight of the deal. The line item type must be must be one of:
CPCV

Cost per completed view. The line item type must be one of:

LineItemDiscount

Discount information for a LineItem.

JSON representation 
{
  "discountType": enum (DiscountType),
  "discount": number
}
Fields
discountType

enum (DiscountType)

Optional. The type of discount being applied to a LineItem, either percentage based or absolute. This attribute is optional and defaults to PERCENTAGE.
discount

number

Optional. The number here is either a percentage or an absolute value depending on the DiscountType. If the DiscountType is PERCENTAGE, then only non-fractional values are supported.

DiscountType

Describes the possible discount types on the cost of booking a line item.

Enums
DISCOUNT_TYPE_UNSPECIFIED No value specified
ABSOLUTE_VALUE An absolute value will be discounted from the line item's cost.
PERCENTAGE A percentage of the cost will be discounted for booking the line item.

CreativePlaceholder

Describes a slot that a creative is expected to fill. This is used in forecasting and to validate that the correct creatives are associated with the line item.

JSON representation 
{
  "size": {
    object (Size)
  },
  "companions": [
    {
      object (CreativePlaceholderCompanion)
    }
  ],
  "appliedLabels": [
    {
      object (AppliedLabel)
    }
  ],
  "expectedCreativeCount": integer,
  "ampOnly": boolean,
  "creativeTargetingDisplayName": string
}
Fields
size

object (Size)

Required. The size that the creative is expected to have.
companions[]

object (CreativePlaceholderCompanion)

Optional. The companions that the creative is expected to have. This attribute can only be set if the line item it belongs to has an EnvironmentType of VIDEO_PLAYER or roadblockingType of CREATIVE_SET.
appliedLabels[]

object (AppliedLabel)

Optional. Set of labels applied directly to this CreativePlaceholder.
expectedCreativeCount

integer

Optional. Non-empty default. Expected number of creatives that will be uploaded corresponding to this creative placeholder. This estimate is used to improve the accuracy of forecasting; for example, if label frequency capping limits the number of times a creative may be served. By default, the expected creative count is set to 1.
ampOnly

boolean

Optional. Non-empty default. Indicates if the expected creative of this placeholder has an AMP only variant. This is used to improve the accuracy of forecasting and has no effect on serving. By default, the value is false.
creativeTargetingDisplayName

string

Optional. The display name of the creative targeting that this CreativePlaceholder represents.

CreativePlaceholderCompanion

An individual companion to a CreativePlaceholder.

JSON representation 
{
  "size": {
    object (Size)
  }
}
Fields
size

object (Size)

Required. The size of the companion to a CreativePlaceholder.

CompanionDeliveryOption

Defines the different delivery types of a line item companion.

Enums
COMPANION_DELIVERY_OPTION_UNSPECIFIED No value specified.
OPTIONAL Companions are not required to serve a CreativeSet. 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.

LineItemStats

Contains trafficking statistics for LineItem.

JSON representation 
{
  "deliveryData": [
    string
  ],
  "impressionsDelivered": string,
  "clicksDelivered": string,
  "videoCompletionsDelivered": string,
  "videoStartsDelivered": string,
  "viewableImpressionsDelivered": string
}
Fields
deliveryData[]

string (int64 format)

Output only. Clicks or impressions delivered for each of the last 7 days. Values are in chronological order (oldest to newest).
impressionsDelivered

string (int64 format)

Output only. The number of impressions delivered.
clicksDelivered

string (int64 format)

Output only. The number of clicks delivered
videoCompletionsDelivered

string (int64 format)

Output only. The number of video completions delivered.
videoStartsDelivered

string (int64 format)

Output only. The number of video starts delivered.
viewableImpressionsDelivered

string (int64 format)

Output only. The number of viewable impressions delivered.

DeliveryIndicator

Indicates the delivery performance of the LineItem.

JSON representation 
{
  "expectedDeliveryPercentage": number,
  "actualDeliveryPercentage": number
}
Fields
expectedDeliveryPercentage

number

Output only. The expected delivery percentage of the LineItem.
actualDeliveryPercentage

number

Output only. The actual delivery percentage of the LineItem.

LineItemComputedStatus

Describes the computed LineItem status that is derived from the current state of the LineItem.

Enums
LINE_ITEM_COMPUTED_STATUS_UNSPECIFIED No value specified.
CANCELED The LineItem has been canceled and is no longer eligible to serve. This is a legacy status.
COMPLETED The LineItem has completed its run.
DELIVERING The LineItem has begun serving.
DELIVERY_EXTENDED The LineItem has past its endDateTime with an auto extension, but hasn't met its goal.
DISAPPROVED The LineItem has been disapproved and is not eligible to serve.
DRAFT The LineItem is still being drafted.
INACTIVE The LineItem is inactive. It is either caused by missing creatives or the network disabling auto-activation.
PAUSED The LineItem has been paused from serving.
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.
READY The LineItem has been activated and is ready to serve.

LineItemReservationStatus

Defines the different reservation statuses of a line item.

Enums
LINE_ITEM_RESERVATION_STATUS_UNSPECIFIED No value specified
RESERVED Indicates that inventory has been reserved for the line item.
UNRESERVED Indicates that inventory has not been reserved for the line item.

ExclusionScope

The scope to which the exclusion label applies.

Enums
EXCLUSION_SCOPE_UNSPECIFIED No value specified.
PAGE The exclusion label applies to the entire page.
STREAM The exclusion label applies to the entire stream of content.
POD The exclusion label applies to the entire pod (or group).

ThirdPartyMeasurementSettings

Contains third party auto-pixeling settings for cross-sell Partners.

JSON representation 
{
  "viewabilityPartner": enum (ViewabilityPartner),
  "viewabilityClientId": string,
  "viewabilityReportingId": string,
  "publisherViewabilityPartner": enum (ViewabilityPartner),
  "publisherViewabilityClientId": string,
  "publisherViewabilityReportingId": string,
  "brandLiftPartner": enum (BrandLiftPartner),
  "brandLiftClientId": string,
  "brandLiftReportingId": string,
  "reachPartner": enum (ReachPartner),
  "reachClientId": string,
  "reachReportingId": string,
  "publisherReachPartner": enum (ReachPartner),
  "publisherReachClientId": string,
  "publisherReachReportingId": string
}
Fields
viewabilityPartner

enum (ViewabilityPartner)

Optional. A field to determine the type of ViewabilityPartner. This field default is NONE.
viewabilityClientId

string

Optional. The third party partner ID for YouTube viewability verification.
viewabilityReportingId

string

Optional. The reporting ID that maps viewability partner data with a campaign (or a group of related campaigns) specific data.
publisherViewabilityPartner

enum (ViewabilityPartner)

Optional. A field to determine the type of publisher's viewability partner. This field default is NONE.
publisherViewabilityClientId

string

Optional. The third party partner ID for YouTube viewability verification for publisher.
publisherViewabilityReportingId

string

Optional. The reporting ID that maps viewability partner data with a campaign (or a group of related campaigns) specific data for publisher.
brandLiftPartner

enum (BrandLiftPartner)

Optional. A field to determine the type of BrandLiftPartner. This field default is NONE.
brandLiftClientId

string

Optional. The third party partner ID for YouTube brand lift verification.
brandLiftReportingId

string

Optional. The reporting ID that maps brand lift partner data with a campaign (or a group of related campaigns) specific data.
reachPartner

enum (ReachPartner)

Optional. A field to determine the type of advertiser's ReachPartner. This field default is UNKNOWN.
reachClientId

string

Optional. The third party partner ID for YouTube reach verification for advertiser.
reachReportingId

string

Optional. The reporting ID that maps reach partner data with a campaign (or a group of related campaigns) specific data for advertiser.
publisherReachPartner

enum (ReachPartner)

Optional. A field to determine the type of publisher's ReachPartner. This field default is UNKNOWN.
publisherReachClientId

string

Optional. The third party partner ID for YouTube reach verification for publisher.
publisherReachReportingId

string

Optional. The reporting ID that maps reach partner data with a campaign (or a group of related campaigns) specific data for publisher.

ViewabilityPartner

Possible options for viewabitility. The enum may receive new values in the future.

Enums
VIEWABILITY_PARTNER_UNSPECIFIED Default value. This value is unused.
COMSCORE Indicates viewability partner Comscore.
DOUBLE_VERIFY Indicates viewability partner Double Verify.
INTEGRAL_AD_SCIENCE Indicates viewability partner Integral Ad Science.
MOAT Indicates viewability partner Oracle Moat.
NONE Indicates there's no viewability partner.
TELEMETRY Indicates viewability partner Telemetry.

BrandLiftPartner

Possible options for brand lift.

Enums
BRAND_LIFT_PARTNER_UNSPECIFIED Default value. This value is unused.
DYNATA Indicates brand lift partner Dynata.
INTAGE Indicates brand lift partner Intage.
KANTAR_MILLWARD_BROWN Indicates brand lift partner Kantar.
MACROMILL Indicates brand lift partner Macromill.
NONE Indicates there's no brand lift partner.

ReachPartner

Possible options for third-party reach integration.

Enums
REACH_PARTNER_UNSPECIFIED Default value. This value is unused.
AUDIENCE_PROJECT Indicates third-party reach integration partner Audience Project
COMSCORE Indicates third-party reach integration partner Comscore.
GEMIUS Indicates third-party reach integration partner Gemius.
ISPOT_TV Indicates third-party reach integration partner iSpot.TV
KANTAR_MILLWARD_BROWN Indicates third-party reach integration partner Kantar.
NIELSEN Indicates third-party reach integration partner Nielsen.
NONE Indicates there's no third-party reach integration partner.
VIDEO_AMP Indicates third-party reach integration partner VideoAmp
VIDEO_RESEARCH Indicates third-party reach integration partner Video Research.

Goal

Defines the criteria a LineItem needs to satisfy to meet its delivery goal.

JSON representation 
{
  "goalType": enum (GoalType),
  "unitType": enum (UnitType),
  "units": string
}
Fields
goalType

enum (GoalType)

The type of the goal for the LineItem. It defines the period over which the goal should be reached.
unitType

enum (UnitType)

The type of the goal unit for the LineItem.
units

string (int64 format)

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved. If the line item is of type LineItemTypeEnum.LineItemType.SPONSORSHIP, it represents the percentage of available impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.BULK or LineItemTypeEnum.LineItemType.PRICE_PRIORITY, it represents the number of remaining impressions reserved. If the line item is of type LineItemTypeEnum.LineItemType.NETWORK or LineItemTypeEnum.LineItemType.HOUSE, it represents the percentage of remaining impressions reserved.

If this is an impression cap goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see [LineItem.impressions_cap][].

GoalType

Specifies the type of the goal for a LineItem.

Enums
GOAL_TYPE_UNSPECIFIED Default value. This value is unused.
NONE

No goal is specified for the number of ads delivered. The line item type must be one of:
LIFETIME

There is a goal on the number of ads delivered for this line item during its entire lifetime. The line item type must be one of:
DAILY

There is a daily goal on the number of ads delivered for this line item. The line item type must be one of:

UnitType

Indicates the type of unit used for defining a reservation. The LineItem.cost_type can differ from the UnitType - an ad can have an impression goal, but be billed by its click. Usually CostType and UnitType will refer to the same unit.

Enums
UNIT_TYPE_UNSPECIFIED Default value. This value is unused.
IMPRESSIONS The number of impressions served by creatives associated with the line item.
CLICKS

The number of clicks reported by creatives associated with the line item. The line item type must be one of:
CLICK_THROUGH_CPA_CONVERSIONS The number of click-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.cost_type must be [CostTypeEnum.CostType.CPA][].
VIEW_THROUGH_CPA_CONVERSIONS The number of view-through Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the LineItem.cost_type must be [CostTypeEnum.CostType.CPA}.
TOTAL_CPA_CONVERSIONS The number of total Cost-Per-Action (CPA) conversions from creatives associated with the line item. This is only supported as secondary goal and the [LineItem.cost_type} must be [CostTypeEnum.CostType.CPA}.
VIEWABLE_IMPRESSIONS The number of viewable impressions reported by creatives associated with the line item. The LineItem.line_item_type must be LineItemTypeEnum.LineItemType.STANDARD.
IN_TARGET_IMPRESSIONS The number of in-target impressions reported by third party measurements. The LineItem.line_item_type must be LineItemTypeEnum.LineItemType.STANDARD.
COMPLETED_VIEWS The number of completed views reported by creatives associated with the line item. A completed view is defined as having watched the entirety of the in-stream video ad and is only supported for standard reservation video line items. The LineItem.line_item_type must be LineItemTypeEnum.LineItemType.STANDARD.

GrpSettings

GrpSettings contains information for a line item that will have a target demographic when serving. This information will be used to set up tracking and enable reporting on the demographic information.

JSON representation 
{
  "minTargetAge": string,
  "maxTargetAge": string,
  "targetGender": enum (GrpTargetGender),
  "provider": enum (GrpProvider),
  "inTargetRatioEstimateMilliPercent": string,
  "nielsenCtvPacingType": enum (NielsenCtvPacing),
  "pacingDeviceCategorizationType": enum (PacingDeviceCategorization),
  "applyTrueCoview": boolean
}
Fields
minTargetAge

string (int64 format)

Optional. Specifies the minimum target age (in years) of the LineItem. This field is only applicable if provider is not null.
maxTargetAge

string (int64 format)

Optional. Specifies the maximum target age (in years) of the LineItem. This field is only applicable if provider is not null.
targetGender

enum (GrpTargetGender)

Optional. Specifies the target gender of the LineItem. This field is only applicable if provider is not null.
provider

enum (GrpProvider)

Optional. Specifies the GRP provider of the LineItem.
inTargetRatioEstimateMilliPercent

string (int64 format)

Optional. Estimate for the in-target ratio given the line item's audience targeting. This field is only applicable if provider is Nielsen, [LineItem.primary_goal.unit_type][] is in-target impressions, and [LineItemCostType] is in-target CPM. This field determines the in-target ratio to use for pacing Nielsen line items before Nielsen reporting data is available. Represented as a milli percent, so 55.7% becomes 55700.
nielsenCtvPacingType

enum (NielsenCtvPacing)

Optional. Specifies which pacing computation to apply in pacing to impressions from connected devices.
pacingDeviceCategorizationType

enum (PacingDeviceCategorization)

Optional. Specifies whether to use Google or Nielsen device breakdown in Nielsen Line Item auto pacing.
applyTrueCoview

boolean

Optional. Specifies whether to apply true coviewing in Nielsen Line Item auto pacing. This field can only be true if nielsenCtvPacingType is not NONE.

GrpTargetGender

Represents the target gender for a GRP demographic targeted line item.

Enums
GRP_TARGET_GENDER_UNSPECIFIED Default value. This value is unused.
BOTH Indicates that the GRP target gender is both male and female.
FEMALE Indicates that the GRP target gender is Female.
MALE Indicates that the GRP target gender is Male.

GrpProvider

Represents available GRP providers that a line item will have its target demographic measured by.

Enums
GRP_PROVIDER_UNSPECIFIED Default value. This value is unused.
GOOGLE Google's GRP provider.
NIELSEN Nielsen's GRP provider.

NielsenCtvPacing

Represents the pacing computation method for impressions on connected devices for a Nielsen measured line item. This only applies when Nielsen measurement is enabled for connected devices.

Enums
NIELSEN_CTV_PACING_UNSPECIFIED Default value. This value is unused.
COVIEW Indicates that Nielsen impressions on connected devices are included, and we apply coviewing in pacing.
NONE The value returned if Nielsen measurement is disabled for connected devices.
STRICT_COVIEW Indicates that Nielsen impressions on connected devices are included, and we apply strict coviewing in pacing.

PacingDeviceCategorization

Represents whose device categorization to use on Nielsen measured line item with auto-pacing enabled.

Enums
PACING_DEVICE_CATEGORIZATION_UNSPECIFIED Default value. This value is unused.
GOOGLE Use Google's device categorization in auto-pacing.
NIELSEN Use Nielsen device categorization in auto-pacing

LineItemDealInfo

Data transfer object for the exchange deal info of a line item.

JSON representation 
{
  "externalDealId": string
}
Fields
externalDealId

string (int64 format)

Optional. The external deal ID shared between seller and buyer. This field is only present if the deal has been finalized.

ChildContentEligibility

Child content eligibility designation.

Enums
CHILD_CONTENT_ELIGIBILITY_UNSPECIFIED Default value. This value is unused.
ALLOWED This line item is eligible to serve on requests that are child-directed.
DISALLOWED This line item is not eligible to serve on any requests that are child-directed.

CreativeTargeting

Represents the creative targeting criteria for a LineItem.

JSON representation 
{
  "creativeTargetingDisplayName": string,
  "targeting": {
    object (Targeting)
  }
}
Fields
creativeTargetingDisplayName

string

Required. The name of this creative targeting. This attribute is required.
targeting

object (Targeting)

Required. The Targeting criteria of this creative targeting. This attribute is required.

LineItemAllowedFormat

The formats that a publisher allows on their programmatic video LineItem or ProposalLineItem.

Enums
LINE_ITEM_ALLOWED_FORMAT_UNSPECIFIED Default value. This value is unused.
AUDIO Audio format.
VIDEO Video format.
DISPLAY Display format.

Methods

get

 Retrieves a LineItem object.

list

 Lists LineItem objects.