Method: sellers.orders.lines.reserve
Stay organized with collections
Save and categorize content based on your preferences.
Reserves 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 state is not STATE_PENDING_RESERVATION.
HTTP request
POST https://dv360outofhomeseller.googleapis.com/v1/{name=sellers/*/orders/*/lines/*}:reserve
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The field will contain name of the line to be reserved, for example: "sellers/789/orders/123/lines/321"
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"lineTerms": {
object (LineTerms)
},
"reservationExpirationTime": string
} |
| Fields |
lineTerms |
object (LineTerms)
Required. The seller guaranteed terms for this line.
|
reservationExpirationTime |
string (Timestamp format)
Required. Expiration timestamp for the reservation. The buyer needs to book before a reservation expires. 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".
|
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.
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 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThis documentation provides links to different versions of the \u003ccode\u003eIndexDatapoint.CrowdingTagOrBuilder\u003c/code\u003e interface in Google Cloud AI Platform's Java library.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eIndexDatapoint.CrowdingTagOrBuilder\u003c/code\u003e extends \u003ccode\u003eMessageOrBuilder\u003c/code\u003e and provides methods for accessing crowding tag information.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetCrowdingAttribute()\u003c/code\u003e method retrieves the attribute used for crowding in nearest neighbor searches.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetCrowdingAttributeBytes()\u003c/code\u003e method returns the same attribute as a \u003ccode\u003eByteString\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eCrowding ensures diversity in search results by limiting the number of neighbors with the same attribute value.\u003c/p\u003e\n"]]],["This describes how to reserve an existing line using a `POST` request to the specified URL. The request requires the line's `name` in the path and includes a JSON body with `lineTerms` and `reservationExpirationTime`. Successful requests return the updated line; otherwise, it returns error codes: `NOT_FOUND` (line does not exist), `INVALID_ARGUMENT` (`lineTerms` is not set), or `FAILED_PRECONDITION` (state is not `STATE_PENDING_RESERVATION`). The process requires OAuth scope `https://www.googleapis.com/auth/doubleclickbidmanager`.\n"],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n- [Examples](#examples)\n\nReserves an existing line.\n\n- Returns the updated line if successful.\n- Returns error code `NOT_FOUND` if the line does not exist.\n- Returns error code `INVALID_ARGUMENT` if lineTerms is not set.\n- Returns error code `FAILED_PRECONDITION` if state is not `STATE_PENDING_RESERVATION`.\n\nHTTP request\n\n`POST https://dv360outofhomeseller.googleapis.com/v1/{name=sellers/*/orders/*/lines/*}:reserve`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The field will contain name of the line to be reserved, for example: \"sellers/789/orders/123/lines/321\" |\n\nRequest body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"lineTerms\": { object (/display-video/out-of-home-seller/reference/rest/v1/LineTerms) }, \"reservationExpirationTime\": string } ``` |\n\n| Fields ||\n|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `lineTerms` | `object (`[LineTerms](/display-video/out-of-home-seller/reference/rest/v1/LineTerms)`)` Required. The seller guaranteed terms for this line. |\n| `reservationExpirationTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Timestamp)` format)` Required. Expiration timestamp for the reservation. The buyer needs to book before a reservation expires. 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\"`. |\n\nResponse body\n\nIf successful, the response body contains an instance of [Line](/display-video/out-of-home-seller/reference/rest/v1/sellers.orders.lines#Line).\n\nAuthorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclickbidmanager`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
