REST Resource: orders.lines

Resource: Line

A single order line which represents a configured product.

JSON representation 
{
  "name": string,
  "product": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "lineState": enum (LineState),
  "rejection": {
    object (Rejection)
  },
  "startTime": string,
  "endTime": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "budget": {
    object (Money)
  },
  "lineTerms": {
    object (LineTerms)
  },
  "pendingReservationExpirationTime": string,
  "reservationExpirationTime": string,
  "targeting": {
    object (Targeting)
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Output only. The resource name of the line in the format: orders/{order_id}/lines/{id}.
product

string

Output only. The name of the Product this line is configuring. Format = products/123
externalId

string

Optional. An id used to map this entity to external sources.
displayName

string

Output only. The display name of the line.
description

string

Output only. Additional freeform field to describe the line.
lineState

enum (LineState)

Output only. The state of the line. See LineState for the lifecycle of a Line.

Seller can use the following custom methods: Reserve, Book, and Reject to set to one of the following:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER.

All other line states are set by the buyer.
rejection

object (Rejection)

Optional. Rejection details for the line.
startTime
(deprecated)

string (Timestamp format)

Output only. When the line would start being served (inclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime
(deprecated)

string (Timestamp format)

Output only. When the line would stop being served (exclusive).

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
startDate

object (Date)

Output only. The date the line would start being served (inclusive). Same time zone as the ad unit.
endDate

object (Date)

Output only. The date the line would stop being served (inclusive). Same time zone as the ad unit.
budget

object (Money)

Output only. The budget of the line.
lineTerms

object (LineTerms)

Output only. The seller's guaranteed terms for this line.
pendingReservationExpirationTime

string (Timestamp format)

Output only. Expiration timestamp for the pending reservation. Seller needs to reserve or reject before a pending reservation expires or it will be treated as rejected.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
reservationExpirationTime

string (Timestamp format)

Output only. Expiration timestamp for the reservation. The buyer needs to book before a reservation expires or it will be treated as cancelled.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
targeting

object (Targeting)

Output only. The targeting for the line.
createTime

string (Timestamp format)

Output only. Creation timestamp for line.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. Last updated timestamp for line.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

LineState

State of a line.

Enums
LINE_STATE_UNSPECIFIED The default value when the line state has not been specified or is unknown in this version.
LINE_STATE_PENDING_RESERVATION The line has been created by the buyer and is requesting the products be reserved as well as updated with pricing and availability information.
LINE_STATE_RESERVED The line was reserved by the seller. This state is only possible if the previous state is pending reservation.
LINE_STATE_PENDING_BOOKING The buyer has accepted the reservation and is requesting the line to be booked.
LINE_STATE_BOOKED The seller has booked the line. This state is only possible if the previous state is pending booking. Rejections are not expected at this stage.
LINE_STATE_REJECTED_BY_SELLER The line was rejected by the seller. This state is only possible if the previous state is pending reservation.
LINE_STATE_CANCELLED_BY_BUYER The line was cancelled by buyer.
LINE_STATE_PENDING_RESERVATION_EXPIRED The line expired while pending reservation.
LINE_STATE_RESERVED_EXPIRED The line expired while reserved, waiting for buyer's response.

Methods

book

 Books an existing line.

get

 Retrieves an individual line for an order.

list

 Lists lines for an order.

patch

 Updates an existing line.

reject

 Rejects an existing line.

reserve

 Reserves an existing line.