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,
  "customFieldValues": [
    {
      object (CustomFieldValue)
    }
  ],
  "order": string,
  "displayName": string,
  "startTime": string,
  "endTime": string,
  "lineItemType": enum (LineItemType),
  "rate": {
    object (Money)
  },
  "budget": {
    object (Money)
  },
  "goal": {
    object (Goal)
  }
}
Fields
name

string

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

object (CustomFieldValue)

Optional. The values of the custom fields associated with this line item.
order

string

Output only. The ID of the Order to which the LineItem belongs. This attribute is required. Format: networks/{networkCode}/orders/{order}
displayName

string

Required. The name of the line item. This attribute is required and has a maximum length of 255 characters.
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".
endTime

string (Timestamp format)

Output only. The timestamp when the LineItem will stop serving. This attribute is read-only and 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".
lineItemType

enum (LineItemType)

Required. Indicates the line item type of a LineItem. This attribute is required. 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.
rate

object (Money)

Required. The amount of money to spend per impression or click.
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.
goal

object (Goal)

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

LineItemType

Indicates the priority of a LineItem, determined by the way in which impressions are reserved to be served for it.

Enums
LINE_ITEM_TYPE_UNSPECIFIED Not specified value.
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. Uses daily percentage of unsold impressions or clicks.
BULK The type of LineItem for which a fixed quantity of impressions or clicks will be delivered at a priority lower than the 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. Uses fixed quantity percentage of unsold impressions or clicks.
HOUSE The type of LineItem typically used for ads that promote products and services chosen by the publisher.
CLICK_TRACKING The type of LineItem used for ads that track ads being served externally of Ad Manager.
ADSENSE Targets the LineItem to specific inventory available to AdSense buyers.
AD_EXCHANGE Targets the LineItem to specific inventory available to Authorized Buyers and the Open Auction.
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.
PREFERRED_DEAL The type of LineItem for which there are no impressions reserved, and will serve for a second price bid.
AUDIENCE_EXTENSION The type of LineItem used for configuring audience extension campaigns.

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.

Methods

get

 API to retrieve a LineItem object.

list

 API to retrieve a list of LineItem objects.