1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="authorizedbuyersmarketplace_v1.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1.buyers.auctionPackages.html">auctionPackages</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets an auction package given its name.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">List the auction packages subscribed by a buyer and its clients.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#subscribe">subscribe(name, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.</p> 92<p class="toc_element"> 93 <code><a href="#subscribeClients">subscribeClients(auctionPackage, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.</p> 95<p class="toc_element"> 96 <code><a href="#unsubscribe">unsubscribe(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.</p> 98<p class="toc_element"> 99 <code><a href="#unsubscribeClients">unsubscribeClients(auctionPackage, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="get">get(name, x__xgafv=None)</code> 109 <pre>Gets an auction package given its name. 110 111Args: 112 name: string, Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) 113 x__xgafv: string, V1 error format. 114 Allowed values 115 1 - v1 error format 116 2 - v2 error format 117 118Returns: 119 An object of the form: 120 121 { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. 122 "createTime": "A String", # Output only. Time the auction package was created. 123 "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` 124 "description": "A String", # Output only. A description of the auction package. 125 "displayName": "A String", # The display_name assigned to the auction package. 126 "name": "A String", # 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. 127 "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` 128 "A String", 129 ], 130 "updateTime": "A String", # 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. 131}</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 136 <pre>List the auction packages subscribed by a buyer and its clients. 137 138Args: 139 parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}` (required) 140 pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500. 141 pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147Returns: 148 An object of the form: 149 150 { # Response message for listing auction packages. 151 "auctionPackages": [ # The list of auction packages. 152 { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. 153 "createTime": "A String", # Output only. Time the auction package was created. 154 "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` 155 "description": "A String", # Output only. A description of the auction package. 156 "displayName": "A String", # The display_name assigned to the auction package. 157 "name": "A String", # 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. 158 "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` 159 "A String", 160 ], 161 "updateTime": "A String", # 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. 162 }, 163 ], 164 "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results. 165}</pre> 166</div> 167 168<div class="method"> 169 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 170 <pre>Retrieves the next page of results. 171 172Args: 173 previous_request: The request for the previous page. (required) 174 previous_response: The response from the request for the previous page. (required) 175 176Returns: 177 A request object that you can call 'execute()' on to request the next 178 page. Returns None if there are no more items in the collection. 179 </pre> 180</div> 181 182<div class="method"> 183 <code class="details" id="subscribe">subscribe(name, body=None, x__xgafv=None)</code> 184 <pre>Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer. 185 186Args: 187 name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) 188 body: object, The request body. 189 The object takes the form of: 190 191{ # Request message for SubscribeAuctionPackage. 192} 193 194 x__xgafv: string, V1 error format. 195 Allowed values 196 1 - v1 error format 197 2 - v2 error format 198 199Returns: 200 An object of the form: 201 202 { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. 203 "createTime": "A String", # Output only. Time the auction package was created. 204 "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` 205 "description": "A String", # Output only. A description of the auction package. 206 "displayName": "A String", # The display_name assigned to the auction package. 207 "name": "A String", # 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. 208 "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` 209 "A String", 210 ], 211 "updateTime": "A String", # 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. 212}</pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="subscribeClients">subscribeClients(auctionPackage, body=None, x__xgafv=None)</code> 217 <pre>Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect. 218 219Args: 220 auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) 221 body: object, The request body. 222 The object takes the form of: 223 224{ # Request message for SubscribeAuctionPackageClients. 225 "clients": [ # Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already. 226 "A String", 227 ], 228} 229 230 x__xgafv: string, V1 error format. 231 Allowed values 232 1 - v1 error format 233 2 - v2 error format 234 235Returns: 236 An object of the form: 237 238 { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. 239 "createTime": "A String", # Output only. Time the auction package was created. 240 "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` 241 "description": "A String", # Output only. A description of the auction package. 242 "displayName": "A String", # The display_name assigned to the auction package. 243 "name": "A String", # 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. 244 "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` 245 "A String", 246 ], 247 "updateTime": "A String", # 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. 248}</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="unsubscribe">unsubscribe(name, body=None, x__xgafv=None)</code> 253 <pre>Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer. 254 255Args: 256 name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) 257 body: object, The request body. 258 The object takes the form of: 259 260{ # Request message for UnsubscribeAuctionPackage. 261} 262 263 x__xgafv: string, V1 error format. 264 Allowed values 265 1 - v1 error format 266 2 - v2 error format 267 268Returns: 269 An object of the form: 270 271 { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. 272 "createTime": "A String", # Output only. Time the auction package was created. 273 "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` 274 "description": "A String", # Output only. A description of the auction package. 275 "displayName": "A String", # The display_name assigned to the auction package. 276 "name": "A String", # 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. 277 "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` 278 "A String", 279 ], 280 "updateTime": "A String", # 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. 281}</pre> 282</div> 283 284<div class="method"> 285 <code class="details" id="unsubscribeClients">unsubscribeClients(auctionPackage, body=None, x__xgafv=None)</code> 286 <pre>Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect. 287 288Args: 289 auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required) 290 body: object, The request body. 291 The object takes the form of: 292 293{ # Request message for UnsubscribeAuctionPackage. 294 "clients": [ # Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. 295 "A String", 296 ], 297} 298 299 x__xgafv: string, V1 error format. 300 Allowed values 301 1 - v1 error format 302 2 - v2 error format 303 304Returns: 305 An object of the form: 306 307 { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. 308 "createTime": "A String", # Output only. Time the auction package was created. 309 "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}` 310 "description": "A String", # Output only. A description of the auction package. 311 "displayName": "A String", # The display_name assigned to the auction package. 312 "name": "A String", # 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. 313 "subscribedClients": [ # Output only. The list of clients of the current buyer that are subscribed to the AuctionPackage. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` 314 "A String", 315 ], 316 "updateTime": "A String", # 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. 317}</pre> 318</div> 319 320</body></html>