Method: advertisers.lineItems.generateDefault

  • This resource allows you to create a new line item with settings inherited from its insertion order, initially in a draft status.

  • The default settings for the new line item are based on the insertion order's type and automation type, and the specified line item type.

  • Creating or updating YouTube & Partners line items is not supported via this API.

  • The request requires specifying the advertiser ID, insertion order ID, display name, and line item type in the request body.

  • A successful request returns the newly created line item and requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Creates a new line item with settings (including targeting) inherited from the insertion order and an ENTITY_STATUS_DRAFT entityStatus. Returns the newly created line item if successful. There are default values based on the three fields:

YouTube & Partners line items cannot be created or updated using the API.

HTTP request

POST https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/lineItems:generateDefault

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser this line item belongs to.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "insertionOrderId": string,
  "displayName": string,
  "lineItemType": enum (LineItemType),
  "mobileApp": {
    object (MobileApp)
  },
  "containsEuPoliticalAds": enum (EuPoliticalAdvertisingStatus)
}
Fields
insertionOrderId

string (int64 format)

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

string

Required. The display name of the line item.

Must be UTF-8 encoded with a maximum size of 240 bytes.
lineItemType

enum (LineItemType)

Required. The type of the line item.
mobileApp

object (MobileApp)

The mobile app promoted by the line item.

This is applicable only when lineItemType is either LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL or LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL.
containsEuPoliticalAds

enum (EuPoliticalAdvertisingStatus)

Whether this line item will serve European Union political ads.

If containsEuPoliticalAds has been set to DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING in the parent advertiser, then this field will be assigned DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files.

This field must be assigned when creating a new line item. Otherwise, the advertisers.lineItems.create request will fail.

Response body

If successful, the response body contains an instance of LineItem.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.