Method: guaranteedOrders.get

AI-generated Key Takeaways

• Display & Video 360 API v1 has been sunset.

• This document details how to get a guaranteed order using an HTTP GET request.

• The request requires a guaranteedOrderId as a path parameter to identify the order.

• The request also requires an accessor query parameter, which can be either a partnerId or an advertiserId, to specify the DV360 entity accessing the order.

• The API call is authorized using the https://www.googleapis.com/auth/display-video OAuth scope.

Display & Video 360 API v1 has been sunset.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization Scopes
• Try it!

Gets a guaranteed order.

HTTP request

GET https://displayvideo.googleapis.com/v1/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.