Method: guaranteedOrders.get

  • Retrieves a specific guaranteed order using its unique identifier, formatted as {exchange}-{legacyGuaranteedOrderId}.

  • Requires specifying an accessor in the query parameters to identify the DV360 entity (partner or advertiser) with access to the order.

  • The request body should be empty, and a successful response returns a GuaranteedOrder object.

  • Authorization requires the https://www.googleapis.com/auth/display-video OAuth scope.

Gets a guaranteed order.

HTTP request

GET https://displayvideo.googleapis.com/v3/guaranteedOrders/{guaranteedOrderId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
guaranteedOrderId

string

Required. The ID of the guaranteed order to fetch.

The ID is of the format {exchange}-{legacyGuaranteedOrderId}

Query parameters

Parameters

Union parameter accessor. Required.

Identifies which DV360 entity the request is being made within. The GET request will only return guaranteed order that is accessible to the DV360 entity identified within the accessor. accessor can be only one of the following:
partnerId

string (int64 format)

The ID of the partner that has access to the guaranteed order.
advertiserId

string (int64 format)

The ID of the advertiser that has access to the guaranteed order.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.