1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="authorizedbuyersmarketplace_v1alpha.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1alpha.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html">auctionPackages</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an auction package given its name.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#subscribe">subscribe(name, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#subscribeClients">subscribeClients(auctionPackage, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#unsubscribe">unsubscribe(name, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#unsubscribeClients">unsubscribeClients(auctionPackage, body=None, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets an auction package given its name.
Args:
name: string, Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
"createTime": "A String", # Output only. Time the auction package was created.
"creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
"dealOwnerSeatId": "A String", # Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.
"description": "A String", # Output only. A description of the auction package.
"displayName": "A String", # The display_name assigned to the auction package.
"eligibleSeatIds": [ # Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.
"A String",
],
"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.
"subscribedBuyers": [ # 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}`
"A String",
],
"subscribedClients": [ # 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}`
"A String",
],
"subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
{ # Describes a single Media Planner account.
"accountId": "A String", # Output only. Account ID of the media planner.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
Args:
parent: string, 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}`. (required)
filter: string, 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
orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing auction packages.
"auctionPackages": [ # The list of auction packages.
{ # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
"createTime": "A String", # Output only. Time the auction package was created.
"creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
"dealOwnerSeatId": "A String", # Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.
"description": "A String", # Output only. A description of the auction package.
"displayName": "A String", # The display_name assigned to the auction package.
"eligibleSeatIds": [ # Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.
"A String",
],
"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.
"subscribedBuyers": [ # 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}`
"A String",
],
"subscribedClients": [ # 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}`
"A String",
],
"subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
{ # Describes a single Media Planner account.
"accountId": "A String", # Output only. Account ID of the media planner.
},
],
"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.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="subscribe">subscribe(name, body=None, x__xgafv=None)</code>
<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.
Args:
name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for SubscribeAuctionPackage.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
"createTime": "A String", # Output only. Time the auction package was created.
"creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
"dealOwnerSeatId": "A String", # Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.
"description": "A String", # Output only. A description of the auction package.
"displayName": "A String", # The display_name assigned to the auction package.
"eligibleSeatIds": [ # Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.
"A String",
],
"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.
"subscribedBuyers": [ # 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}`
"A String",
],
"subscribedClients": [ # 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}`
"A String",
],
"subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
{ # Describes a single Media Planner account.
"accountId": "A String", # Output only. Account ID of the media planner.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="subscribeClients">subscribeClients(auctionPackage, body=None, x__xgafv=None)</code>
<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.
Args:
auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for SubscribeAuctionPackageClients.
"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.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
"createTime": "A String", # Output only. Time the auction package was created.
"creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
"dealOwnerSeatId": "A String", # Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.
"description": "A String", # Output only. A description of the auction package.
"displayName": "A String", # The display_name assigned to the auction package.
"eligibleSeatIds": [ # Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.
"A String",
],
"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.
"subscribedBuyers": [ # 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}`
"A String",
],
"subscribedClients": [ # 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}`
"A String",
],
"subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
{ # Describes a single Media Planner account.
"accountId": "A String", # Output only. Account ID of the media planner.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="unsubscribe">unsubscribe(name, body=None, x__xgafv=None)</code>
<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.
Args:
name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for UnsubscribeAuctionPackage.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
"createTime": "A String", # Output only. Time the auction package was created.
"creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
"dealOwnerSeatId": "A String", # Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.
"description": "A String", # Output only. A description of the auction package.
"displayName": "A String", # The display_name assigned to the auction package.
"eligibleSeatIds": [ # Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.
"A String",
],
"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.
"subscribedBuyers": [ # 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}`
"A String",
],
"subscribedClients": [ # 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}`
"A String",
],
"subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
{ # Describes a single Media Planner account.
"accountId": "A String", # Output only. Account ID of the media planner.
},
],
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="unsubscribeClients">unsubscribeClients(auctionPackage, body=None, x__xgafv=None)</code>
<pre>Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
Args:
auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for UnsubscribeAuctionPackage.
"clients": [ # Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
"createTime": "A String", # Output only. Time the auction package was created.
"creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
"dealOwnerSeatId": "A String", # Output only. If set, this field contains the DSP specific seat id set by the media planner account that is considered the owner of this deal. The seat ID is in the calling DSP's namespace.
"description": "A String", # Output only. A description of the auction package.
"displayName": "A String", # The display_name assigned to the auction package.
"eligibleSeatIds": [ # Output only. If set, this field identifies a seat that the media planner selected as the owner of this auction package. This is a seat ID in the DSP's namespace that was provided to the media planner.
"A String",
],
"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.
"subscribedBuyers": [ # 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}`
"A String",
],
"subscribedClients": [ # 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}`
"A String",
],
"subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
{ # Describes a single Media Planner account.
"accountId": "A String", # Output only. Account ID of the media planner.
},
],
"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.
}</pre>
</div>
</body></html>
|
