Method: orders.lines.book

  • This page describes how to book an existing line using an HTTP POST request.

  • The request requires a specific URL format including the line's name as a path parameter.

  • An optional request body containing line terms can be provided.

  • A successful response returns the updated line, while errors can indicate the line doesn't exist, has invalid arguments, or is in the wrong state.

  • The request requires authorization with the https://www.googleapis.com/auth/doubleclickbidmanager OAuth scope.

Books an existing line.

  • Returns the updated line if successful.
  • Returns error code NOT_FOUND if the line does not exist.
  • Returns error code INVALID_ARGUMENT if lineTerms is not set.
  • Returns error code FAILED_PRECONDITION if lineState is not LINE_STATE_PENDING_BOOKING.

HTTP request

POST https://dv360outofhomeseller.googleapis.com/v1beta1/{name=orders/*/lines/*}:book

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

The field will contain name of the line to be booked, for example: "orders/123/lines/321"

Request body

The request body contains data with the following structure:

JSON representation 
{
  "lineTerms": {
    object (LineTerms)
  }
}
Fields
lineTerms

object (LineTerms)

Optional. The seller guaranteed terms for this line. Only have to be provided if the terms change after the line was reserved.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/doubleclickbidmanager

For more information, see the OAuth 2.0 Overview.