Starting
September 8, 2025, every new line item will need to declare whether or not they will serve Eurpoean Union (EU) political ads. Display & Video 360 API and SDF uploads that don't provide declarations will fail. See our
deprecations page for more details on how to update your integration to make this declaration.
Method: guaranteedOrders.get
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://displayvideo.googleapis.com/v4/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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[],["The Display & Video 360 API v4, currently in beta, allows fetching a guaranteed order via a GET request. The request URL includes a required `guaranteedOrderId` path parameter and an `accessor` query parameter that identifies the DV360 entity (either `partnerId` or `advertiserId`) accessing the order. The request body must be empty. Successful requests return a `GuaranteedOrder` instance in the response body and use the scope of `https://www.googleapis.com/auth/display-video`.\n"],null,["# Method: guaranteedOrders.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nGets a guaranteed order.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/guaranteedOrders/{guaranteedOrderId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `guaranteedOrderId` | `string` Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange}-{legacyGuaranteedOrderId}` |\n\n### Query parameters\n\n| Parameters ||\n|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| 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: ||\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the partner that has access to the guaranteed order. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the advertiser that has access to the guaranteed order. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [GuaranteedOrder](/display-video/api/reference/rest/v4/guaranteedOrders#GuaranteedOrder).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
