|
107 | 107 | "resources": { |
108 | 108 | "bidders": { |
109 | 109 | "resources": { |
| 110 | + "auctionPackages": { |
| 111 | + "methods": { |
| 112 | + "list": { |
| 113 | + "description": "List the auction packages. Buyers can use the URL path \"/v1/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", |
| 114 | + "flatPath": "v1/bidders/{biddersId}/auctionPackages", |
| 115 | + "httpMethod": "GET", |
| 116 | + "id": "authorizedbuyersmarketplace.bidders.auctionPackages.list", |
| 117 | + "parameterOrder": [ |
| 118 | + "parent" |
| 119 | + ], |
| 120 | + "parameters": { |
| 121 | + "filter": { |
| 122 | + "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", |
| 123 | + "location": "query", |
| 124 | + "type": "string" |
| 125 | + }, |
| 126 | + "pageSize": { |
| 127 | + "description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", |
| 128 | + "format": "int32", |
| 129 | + "location": "query", |
| 130 | + "type": "integer" |
| 131 | + }, |
| 132 | + "pageToken": { |
| 133 | + "description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", |
| 134 | + "location": "query", |
| 135 | + "type": "string" |
| 136 | + }, |
| 137 | + "parent": { |
| 138 | + "description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", |
| 139 | + "location": "path", |
| 140 | + "pattern": "^bidders/[^/]+$", |
| 141 | + "required": true, |
| 142 | + "type": "string" |
| 143 | + } |
| 144 | + }, |
| 145 | + "path": "v1/{+parent}/auctionPackages", |
| 146 | + "response": { |
| 147 | + "$ref": "ListAuctionPackagesResponse" |
| 148 | + }, |
| 149 | + "scopes": [ |
| 150 | + "https://www.googleapis.com/auth/authorized-buyers-marketplace" |
| 151 | + ] |
| 152 | + } |
| 153 | + } |
| 154 | + }, |
110 | 155 | "finalizedDeals": { |
111 | 156 | "methods": { |
112 | 157 | "list": { |
|
189 | 234 | ] |
190 | 235 | }, |
191 | 236 | "list": { |
192 | | - "description": "List the auction packages subscribed by a buyer and its clients.", |
| 237 | + "description": "List the auction packages. Buyers can use the URL path \"/v1/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", |
193 | 238 | "flatPath": "v1/buyers/{buyersId}/auctionPackages", |
194 | 239 | "httpMethod": "GET", |
195 | 240 | "id": "authorizedbuyersmarketplace.buyers.auctionPackages.list", |
|
198 | 243 | ], |
199 | 244 | "parameters": { |
200 | 245 | "filter": { |
201 | | - "description": "Optional. Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", |
| 246 | + "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", |
202 | 247 | "location": "query", |
203 | 248 | "type": "string" |
204 | 249 | }, |
|
214 | 259 | "type": "string" |
215 | 260 | }, |
216 | 261 | "parent": { |
217 | | - "description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`", |
| 262 | + "description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", |
218 | 263 | "location": "path", |
219 | 264 | "pattern": "^buyers/[^/]+$", |
220 | 265 | "required": true, |
|
1312 | 1357 | } |
1313 | 1358 | } |
1314 | 1359 | }, |
1315 | | - "revision": "20240417", |
| 1360 | + "revision": "20240418", |
1316 | 1361 | "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", |
1317 | 1362 | "schemas": { |
1318 | 1363 | "AcceptProposalRequest": { |
|
1420 | 1465 | "description": "The display_name assigned to the auction package.", |
1421 | 1466 | "type": "string" |
1422 | 1467 | }, |
| 1468 | + "eligibleSeatIds": { |
| 1469 | + "description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", |
| 1470 | + "items": { |
| 1471 | + "type": "string" |
| 1472 | + }, |
| 1473 | + "readOnly": true, |
| 1474 | + "type": "array" |
| 1475 | + }, |
1423 | 1476 | "name": { |
1424 | 1477 | "description": "Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.", |
1425 | 1478 | "type": "string" |
1426 | 1479 | }, |
| 1480 | + "subscribedBuyers": { |
| 1481 | + "description": "Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`", |
| 1482 | + "items": { |
| 1483 | + "type": "string" |
| 1484 | + }, |
| 1485 | + "readOnly": true, |
| 1486 | + "type": "array" |
| 1487 | + }, |
1427 | 1488 | "subscribedClients": { |
1428 | | - "description": "Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", |
| 1489 | + "description": "Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", |
1429 | 1490 | "items": { |
1430 | 1491 | "type": "string" |
1431 | 1492 | }, |
1432 | 1493 | "readOnly": true, |
1433 | 1494 | "type": "array" |
1434 | 1495 | }, |
| 1496 | + "subscribedMediaPlanners": { |
| 1497 | + "description": "Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.", |
| 1498 | + "items": { |
| 1499 | + "$ref": "MediaPlanner" |
| 1500 | + }, |
| 1501 | + "readOnly": true, |
| 1502 | + "type": "array" |
| 1503 | + }, |
1435 | 1504 | "updateTime": { |
1436 | 1505 | "description": "Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.", |
1437 | 1506 | "format": "google-datetime", |
|
0 commit comments