Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(235)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis_beta/adexchangebuyer2__v2beta1.json

Issue 3006323002: Api-Roll 54: 2017-09-11 (Closed)
Patch Set: use 2.0.0-dev.infinity sdk constraint in pubspecs Created 3 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/youtubereporting__v1.json ('k') | discovery/googleapis_beta/appengine__v1beta.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/adexchange.buyer": { 5 "https://www.googleapis.com/auth/adexchange.buyer": {
6 "description": "Manage your Ad Exchange buyer account config uration" 6 "description": "Manage your Ad Exchange buyer account config uration"
7 } 7 }
8 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://adexchangebuyer.googleapis.com/", 12 "baseUrl": "https://adexchangebuyer.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "canonicalName": "AdExchangeBuyerII", 14 "canonicalName": "AdExchangeBuyerII",
15 "description": "Accesses the latest features for managing Ad Exchange accoun ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra mmatic deals.", 15 "description": "Accesses the latest features for managing Ad Exchange accoun ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra mmatic deals.",
16 "discoveryVersion": "v1", 16 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/r eference/rest/", 17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/r eference/rest/",
18 "icons": { 18 "icons": {
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", 19 "x16": "http://www.google.com/images/icons/product/search-16.gif",
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" 20 "x32": "http://www.google.com/images/icons/product/search-32.gif"
21 }, 21 },
22 "id": "adexchangebuyer2:v2beta1", 22 "id": "adexchangebuyer2:v2beta1",
23 "kind": "discovery#restDescription", 23 "kind": "discovery#restDescription",
24 "name": "adexchangebuyer2", 24 "name": "adexchangebuyer2",
25 "ownerDomain": "google.com", 25 "ownerDomain": "google.com",
26 "ownerName": "Google", 26 "ownerName": "Google",
27 "parameters": { 27 "parameters": {
28 "pp": {
29 "default": "true",
30 "description": "Pretty-print response.",
31 "location": "query",
32 "type": "boolean"
33 },
34 "bearer_token": {
35 "description": "OAuth bearer token.",
36 "location": "query",
37 "type": "string"
38 },
39 "oauth_token": {
40 "description": "OAuth 2.0 token for the current user.",
41 "location": "query",
42 "type": "string"
43 },
44 "upload_protocol": { 28 "upload_protocol": {
45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
46 "location": "query", 30 "location": "query",
47 "type": "string" 31 "type": "string"
48 }, 32 },
49 "prettyPrint": { 33 "prettyPrint": {
50 "default": "true", 34 "default": "true",
51 "description": "Returns response with indentations and line breaks." , 35 "description": "Returns response with indentations and line breaks." ,
52 "location": "query", 36 "location": "query",
53 "type": "boolean" 37 "type": "boolean"
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after
103 }, 87 },
104 "key": { 88 "key": {
105 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 89 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
106 "location": "query", 90 "location": "query",
107 "type": "string" 91 "type": "string"
108 }, 92 },
109 "quotaUser": { 93 "quotaUser": {
110 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 94 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
111 "location": "query", 95 "location": "query",
112 "type": "string" 96 "type": "string"
97 },
98 "pp": {
99 "default": "true",
100 "description": "Pretty-print response.",
101 "location": "query",
102 "type": "boolean"
103 },
104 "bearer_token": {
105 "description": "OAuth bearer token.",
106 "location": "query",
107 "type": "string"
108 },
109 "oauth_token": {
110 "description": "OAuth 2.0 token for the current user.",
111 "location": "query",
112 "type": "string"
113 } 113 }
114 }, 114 },
115 "protocol": "rest", 115 "protocol": "rest",
116 "resources": { 116 "resources": {
117 "accounts": { 117 "accounts": {
118 "resources": { 118 "resources": {
119 "creatives": { 119 "clients": {
120 "methods": { 120 "methods": {
121 "get": { 121 "list": {
122 "description": "Gets a creative.", 122 "description": "Lists all the clients for the curren t sponsor buyer.",
123 "httpMethod": "GET", 123 "httpMethod": "GET",
124 "id": "adexchangebuyer2.accounts.creatives.get", 124 "id": "adexchangebuyer2.accounts.clients.list",
125 "parameterOrder": [ 125 "parameterOrder": [
126 "accountId", 126 "accountId"
127 "creativeId"
128 ], 127 ],
129 "parameters": { 128 "parameters": {
130 "accountId": { 129 "pageToken": {
131 "description": "The account the creative bel ongs to.", 130 "description": "A token identifying a page o f results the server should return.\nTypically, this is the value of\nListClient sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client s.list method.",
132 "location": "path", 131 "location": "query",
133 "required": true,
134 "type": "string" 132 "type": "string"
135 }, 133 },
136 "creativeId": { 134 "pageSize": {
137 "description": "The ID of the creative to re trieve.", 135 "description": "Requested page size. The ser ver may return fewer clients than requested.\nIf unspecified, the server will pi ck an appropriate default.",
136 "format": "int32",
137 "location": "query",
138 "type": "integer"
139 },
140 "accountId": {
141 "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
142 "format": "int64",
138 "location": "path", 143 "location": "path",
139 "required": true, 144 "required": true,
140 "type": "string" 145 "type": "string"
141 } 146 }
142 }, 147 },
143 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}", 148 "path": "v2beta1/accounts/{accountId}/clients",
144 "response": { 149 "response": {
145 "$ref": "Creative" 150 "$ref": "ListClientsResponse"
146 }, 151 },
147 "scopes": [ 152 "scopes": [
148 "https://www.googleapis.com/auth/adexchange.buye r" 153 "https://www.googleapis.com/auth/adexchange.buye r"
149 ] 154 ]
150 }, 155 },
151 "watch": { 156 "get": {
152 "description": "Watches a creative. Will result in p ush notifications being sent to the\ntopic when the creative changes status.", 157 "description": "Gets a client buyer with a given cli ent account ID.",
153 "httpMethod": "POST", 158 "httpMethod": "GET",
154 "id": "adexchangebuyer2.accounts.creatives.watch", 159 "id": "adexchangebuyer2.accounts.clients.get",
155 "parameterOrder": [ 160 "parameterOrder": [
156 "accountId", 161 "accountId",
157 "creativeId" 162 "clientAccountId"
158 ], 163 ],
159 "parameters": { 164 "parameters": {
160 "accountId": { 165 "accountId": {
161 "description": "The account of the creative to watch.", 166 "description": "Numerical account ID of the client's sponsor buyer. (required)",
167 "format": "int64",
162 "location": "path", 168 "location": "path",
163 "required": true, 169 "required": true,
164 "type": "string" 170 "type": "string"
165 }, 171 },
166 "creativeId": { 172 "clientAccountId": {
167 "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\ nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.", 173 "description": "Numerical account ID of the client buyer to retrieve. (required)",
174 "format": "int64",
168 "location": "path", 175 "location": "path",
169 "required": true, 176 "required": true,
170 "type": "string" 177 "type": "string"
171 } 178 }
172 }, 179 },
173 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:watch", 180 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}",
174 "request": {
175 "$ref": "WatchCreativeRequest"
176 },
177 "response": { 181 "response": {
178 "$ref": "Empty" 182 "$ref": "Client"
179 }, 183 },
180 "scopes": [ 184 "scopes": [
181 "https://www.googleapis.com/auth/adexchange.buye r" 185 "https://www.googleapis.com/auth/adexchange.buye r"
182 ] 186 ]
183 }, 187 },
184 "update": { 188 "update": {
185 "description": "Updates a creative.", 189 "description": "Updates an existing client buyer.",
186 "httpMethod": "PUT", 190 "httpMethod": "PUT",
187 "id": "adexchangebuyer2.accounts.creatives.update", 191 "id": "adexchangebuyer2.accounts.clients.update",
188 "parameterOrder": [ 192 "parameterOrder": [
189 "accountId", 193 "accountId",
190 "creativeId" 194 "clientAccountId"
191 ], 195 ],
192 "parameters": { 196 "parameters": {
193 "accountId": { 197 "accountId": {
194 "description": "The account that this creati ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho d.", 198 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd ate a client for. (required)",
199 "format": "int64",
195 "location": "path", 200 "location": "path",
196 "required": true, 201 "required": true,
197 "type": "string" 202 "type": "string"
198 }, 203 },
199 "creativeId": { 204 "clientAccountId": {
200 "description": "The buyer-defined creative I D of this creative.\nCan be used to filter the response of the\ncreatives.list\n method.", 205 "description": "Unique numerical account ID of the client to update. (required)",
206 "format": "int64",
201 "location": "path", 207 "location": "path",
202 "required": true, 208 "required": true,
203 "type": "string" 209 "type": "string"
204 } 210 }
205 }, 211 },
206 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}", 212 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}",
207 "request": { 213 "request": {
208 "$ref": "Creative" 214 "$ref": "Client"
209 }, 215 },
210 "response": { 216 "response": {
211 "$ref": "Creative" 217 "$ref": "Client"
212 },
213 "scopes": [
214 "https://www.googleapis.com/auth/adexchange.buye r"
215 ]
216 },
217 "list": {
218 "description": "Lists creatives.",
219 "httpMethod": "GET",
220 "id": "adexchangebuyer2.accounts.creatives.list",
221 "parameterOrder": [
222 "accountId"
223 ],
224 "parameters": {
225 "pageToken": {
226 "description": "A token identifying a page o f results the server should return.\nTypically, this is the value of\nListCreati vesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
227 "location": "query",
228 "type": "string"
229 },
230 "pageSize": {
231 "description": "Requested page size. The ser ver may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an app ropriate default.\nAcceptable values are 1 to 1000, inclusive.",
232 "format": "int32",
233 "location": "query",
234 "type": "integer"
235 },
236 "accountId": {
237 "description": "The account to list the crea tives from.\nSpecify \"-\" to list all creatives the current user has access to. ",
238 "location": "path",
239 "required": true,
240 "type": "string"
241 },
242 "query": {
243 "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be retur ned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li> creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_ approved, disapproved,\n not_checked}\n<li>openAuctionStatus: {approved, conditionally_approved, disapproved,\n not_c hecked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>d isapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=1 2345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
244 "location": "query",
245 "type": "string"
246 }
247 },
248 "path": "v2beta1/accounts/{accountId}/creatives",
249 "response": {
250 "$ref": "ListCreativesResponse"
251 }, 218 },
252 "scopes": [ 219 "scopes": [
253 "https://www.googleapis.com/auth/adexchange.buye r" 220 "https://www.googleapis.com/auth/adexchange.buye r"
254 ] 221 ]
255 }, 222 },
256 "create": { 223 "create": {
257 "description": "Creates a creative.", 224 "description": "Creates a new client buyer.",
258 "httpMethod": "POST", 225 "httpMethod": "POST",
259 "id": "adexchangebuyer2.accounts.creatives.create", 226 "id": "adexchangebuyer2.accounts.clients.create",
260 "parameterOrder": [ 227 "parameterOrder": [
261 "accountId" 228 "accountId"
262 ], 229 ],
263 "parameters": { 230 "parameters": {
264 "accountId": { 231 "accountId": {
265 "description": "The account that this creati ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho d.", 232 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre ate a client for. (required)",
266 "location": "path", 233 "format": "int64",
267 "required": true,
268 "type": "string"
269 },
270 "duplicateIdMode": {
271 "description": "Indicates if multiple creati ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
272 "enum": [
273 "NO_DUPLICATES",
274 "FORCE_ENABLE_DUPLICATE_IDS"
275 ],
276 "location": "query",
277 "type": "string"
278 }
279 },
280 "path": "v2beta1/accounts/{accountId}/creatives",
281 "request": {
282 "$ref": "Creative"
283 },
284 "response": {
285 "$ref": "Creative"
286 },
287 "scopes": [
288 "https://www.googleapis.com/auth/adexchange.buye r"
289 ]
290 },
291 "stopWatching": {
292 "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status." ,
293 "httpMethod": "POST",
294 "id": "adexchangebuyer2.accounts.creatives.stopWatch ing",
295 "parameterOrder": [
296 "accountId",
297 "creativeId"
298 ],
299 "parameters": {
300 "accountId": {
301 "description": "The account of the creative to stop notifications for.",
302 "location": "path",
303 "required": true,
304 "type": "string"
305 },
306 "creativeId": {
307 "description": "The creative ID of the creat ive to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
308 "location": "path", 234 "location": "path",
309 "required": true, 235 "required": true,
310 "type": "string" 236 "type": "string"
311 } 237 }
312 }, 238 },
313 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:stopWatching", 239 "path": "v2beta1/accounts/{accountId}/clients",
314 "request": { 240 "request": {
315 "$ref": "StopWatchingCreativeRequest" 241 "$ref": "Client"
316 }, 242 },
317 "response": { 243 "response": {
318 "$ref": "Empty" 244 "$ref": "Client"
319 }, 245 },
320 "scopes": [ 246 "scopes": [
321 "https://www.googleapis.com/auth/adexchange.buye r" 247 "https://www.googleapis.com/auth/adexchange.buye r"
322 ] 248 ]
323 } 249 }
324 }, 250 },
325 "resources": { 251 "resources": {
252 "invitations": {
253 "methods": {
254 "list": {
255 "description": "Lists all the client users i nvitations for a client\nwith a given account ID.",
256 "httpMethod": "GET",
257 "id": "adexchangebuyer2.accounts.clients.inv itations.list",
258 "parameterOrder": [
259 "accountId",
260 "clientAccountId"
261 ],
262 "parameters": {
263 "pageToken": {
264 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stClientUserInvitationsResponse.nextPageToken\nreturned from the previous call t o the\nclients.invitations.list\nmethod.",
265 "location": "query",
266 "type": "string"
267 },
268 "pageSize": {
269 "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pi ck an appropriate default.",
270 "format": "int32",
271 "location": "query",
272 "type": "integer"
273 },
274 "accountId": {
275 "description": "Numerical account ID of the client's sponsor buyer. (required)",
276 "format": "int64",
277 "location": "path",
278 "required": true,
279 "type": "string"
280 },
281 "clientAccountId": {
282 "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either speci fy a string representation of a\nnumerical account identifier or the `-` charact er\nto list all the invitations for all the clients\nof a given sponsor buyer.",
283 "location": "path",
284 "required": true,
285 "type": "string"
286 }
287 },
288 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations",
289 "response": {
290 "$ref": "ListClientUserInvitationsRespon se"
291 },
292 "scopes": [
293 "https://www.googleapis.com/auth/adexcha nge.buyer"
294 ]
295 },
296 "get": {
297 "description": "Retrieves an existing client user invitation.",
298 "httpMethod": "GET",
299 "id": "adexchangebuyer2.accounts.clients.inv itations.get",
300 "parameterOrder": [
301 "accountId",
302 "clientAccountId",
303 "invitationId"
304 ],
305 "parameters": {
306 "invitationId": {
307 "description": "Numerical identifier of the user invitation to retrieve. (required)",
308 "format": "int64",
309 "location": "path",
310 "required": true,
311 "type": "string"
312 },
313 "accountId": {
314 "description": "Numerical account ID of the client's sponsor buyer. (required)",
315 "format": "int64",
316 "location": "path",
317 "required": true,
318 "type": "string"
319 },
320 "clientAccountId": {
321 "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated wit h. (required)",
322 "format": "int64",
323 "location": "path",
324 "required": true,
325 "type": "string"
326 }
327 },
328 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations/{invitationId}",
329 "response": {
330 "$ref": "ClientUserInvitation"
331 },
332 "scopes": [
333 "https://www.googleapis.com/auth/adexcha nge.buyer"
334 ]
335 },
336 "create": {
337 "description": "Creates and sends out an ema il invitation to access\nan Ad Exchange client buyer account.",
338 "httpMethod": "POST",
339 "id": "adexchangebuyer2.accounts.clients.inv itations.create",
340 "parameterOrder": [
341 "accountId",
342 "clientAccountId"
343 ],
344 "parameters": {
345 "accountId": {
346 "description": "Numerical account ID of the client's sponsor buyer. (required)",
347 "format": "int64",
348 "location": "path",
349 "required": true,
350 "type": "string"
351 },
352 "clientAccountId": {
353 "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
354 "format": "int64",
355 "location": "path",
356 "required": true,
357 "type": "string"
358 }
359 },
360 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations",
361 "request": {
362 "$ref": "ClientUserInvitation"
363 },
364 "response": {
365 "$ref": "ClientUserInvitation"
366 },
367 "scopes": [
368 "https://www.googleapis.com/auth/adexcha nge.buyer"
369 ]
370 }
371 }
372 },
373 "users": {
374 "methods": {
375 "get": {
376 "description": "Retrieves an existing client user.",
377 "httpMethod": "GET",
378 "id": "adexchangebuyer2.accounts.clients.use rs.get",
379 "parameterOrder": [
380 "accountId",
381 "clientAccountId",
382 "userId"
383 ],
384 "parameters": {
385 "clientAccountId": {
386 "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (require d)",
387 "format": "int64",
388 "location": "path",
389 "required": true,
390 "type": "string"
391 },
392 "userId": {
393 "description": "Numerical identifier of the user to retrieve. (required)",
394 "format": "int64",
395 "location": "path",
396 "required": true,
397 "type": "string"
398 },
399 "accountId": {
400 "description": "Numerical account ID of the client's sponsor buyer. (required)",
401 "format": "int64",
402 "location": "path",
403 "required": true,
404 "type": "string"
405 }
406 },
407 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users/{userId}",
408 "response": {
409 "$ref": "ClientUser"
410 },
411 "scopes": [
412 "https://www.googleapis.com/auth/adexcha nge.buyer"
413 ]
414 },
415 "list": {
416 "description": "Lists all the known client u sers for a specified\nsponsor buyer account ID.",
417 "httpMethod": "GET",
418 "id": "adexchangebuyer2.accounts.clients.use rs.list",
419 "parameterOrder": [
420 "accountId",
421 "clientAccountId"
422 ],
423 "parameters": {
424 "clientAccountId": {
425 "description": "The account ID of th e client buyer to list users for. (required)\nYou must specify either a string r epresentation of a\nnumerical account identifier or the `-` character\nto list a ll the client users for all the clients\nof a given sponsor buyer.",
426 "location": "path",
427 "required": true,
428 "type": "string"
429 },
430 "pageToken": {
431 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stClientUsersResponse.nextPageToken\nreturned from the previous call to the\nacc ounts.clients.users.list method.",
432 "location": "query",
433 "type": "string"
434 },
435 "pageSize": {
436 "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
437 "format": "int32",
438 "location": "query",
439 "type": "integer"
440 },
441 "accountId": {
442 "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
443 "format": "int64",
444 "location": "path",
445 "required": true,
446 "type": "string"
447 }
448 },
449 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users",
450 "response": {
451 "$ref": "ListClientUsersResponse"
452 },
453 "scopes": [
454 "https://www.googleapis.com/auth/adexcha nge.buyer"
455 ]
456 },
457 "update": {
458 "description": "Updates an existing client u ser.\nOnly the user status can be changed on update.",
459 "httpMethod": "PUT",
460 "id": "adexchangebuyer2.accounts.clients.use rs.update",
461 "parameterOrder": [
462 "accountId",
463 "clientAccountId",
464 "userId"
465 ],
466 "parameters": {
467 "userId": {
468 "description": "Numerical identifier of the user to retrieve. (required)",
469 "format": "int64",
470 "location": "path",
471 "required": true,
472 "type": "string"
473 },
474 "accountId": {
475 "description": "Numerical account ID of the client's sponsor buyer. (required)",
476 "format": "int64",
477 "location": "path",
478 "required": true,
479 "type": "string"
480 },
481 "clientAccountId": {
482 "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (require d)",
483 "format": "int64",
484 "location": "path",
485 "required": true,
486 "type": "string"
487 }
488 },
489 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users/{userId}",
490 "request": {
491 "$ref": "ClientUser"
492 },
493 "response": {
494 "$ref": "ClientUser"
495 },
496 "scopes": [
497 "https://www.googleapis.com/auth/adexcha nge.buyer"
498 ]
499 }
500 }
501 }
502 }
503 },
504 "creatives": {
505 "methods": {
506 "update": {
507 "description": "Updates a creative.",
508 "httpMethod": "PUT",
509 "id": "adexchangebuyer2.accounts.creatives.update",
510 "parameterOrder": [
511 "accountId",
512 "creativeId"
513 ],
514 "parameters": {
515 "accountId": {
516 "description": "The account that this creati ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho d.",
517 "location": "path",
518 "required": true,
519 "type": "string"
520 },
521 "creativeId": {
522 "description": "The buyer-defined creative I D of this creative.\nCan be used to filter the response of the\ncreatives.list\n method.",
523 "location": "path",
524 "required": true,
525 "type": "string"
526 }
527 },
528 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}",
529 "request": {
530 "$ref": "Creative"
531 },
532 "response": {
533 "$ref": "Creative"
534 },
535 "scopes": [
536 "https://www.googleapis.com/auth/adexchange.buye r"
537 ]
538 },
539 "list": {
540 "description": "Lists creatives.",
541 "httpMethod": "GET",
542 "id": "adexchangebuyer2.accounts.creatives.list",
543 "parameterOrder": [
544 "accountId"
545 ],
546 "parameters": {
547 "query": {
548 "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be retur ned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_string</i>\n<li> creativeId=<i>creative_id_string</i>\n<li>dealsStatus: {approved, conditionally_ approved, disapproved,\n not_checked}\n<li>openAuctionStatus: {approved, conditionally_approved, disapproved,\n not_c hecked}\n<li>attribute: {a numeric attribute from the list of attributes}\n<li>d isapprovalReason: {a reason from DisapprovalReason\n</ul>\nExample: 'accountId=1 2345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
549 "location": "query",
550 "type": "string"
551 },
552 "pageToken": {
553 "description": "A token identifying a page o f results the server should return.\nTypically, this is the value of\nListCreati vesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
554 "location": "query",
555 "type": "string"
556 },
557 "pageSize": {
558 "description": "Requested page size. The ser ver may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an app ropriate default.\nAcceptable values are 1 to 1000, inclusive.",
559 "format": "int32",
560 "location": "query",
561 "type": "integer"
562 },
563 "accountId": {
564 "description": "The account to list the crea tives from.\nSpecify \"-\" to list all creatives the current user has access to. ",
565 "location": "path",
566 "required": true,
567 "type": "string"
568 }
569 },
570 "path": "v2beta1/accounts/{accountId}/creatives",
571 "response": {
572 "$ref": "ListCreativesResponse"
573 },
574 "scopes": [
575 "https://www.googleapis.com/auth/adexchange.buye r"
576 ]
577 },
578 "create": {
579 "description": "Creates a creative.",
580 "httpMethod": "POST",
581 "id": "adexchangebuyer2.accounts.creatives.create",
582 "parameterOrder": [
583 "accountId"
584 ],
585 "parameters": {
586 "duplicateIdMode": {
587 "description": "Indicates if multiple creati ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
588 "enum": [
589 "NO_DUPLICATES",
590 "FORCE_ENABLE_DUPLICATE_IDS"
591 ],
592 "location": "query",
593 "type": "string"
594 },
595 "accountId": {
596 "description": "The account that this creati ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho d.",
597 "location": "path",
598 "required": true,
599 "type": "string"
600 }
601 },
602 "path": "v2beta1/accounts/{accountId}/creatives",
603 "request": {
604 "$ref": "Creative"
605 },
606 "response": {
607 "$ref": "Creative"
608 },
609 "scopes": [
610 "https://www.googleapis.com/auth/adexchange.buye r"
611 ]
612 },
613 "stopWatching": {
614 "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status." ,
615 "httpMethod": "POST",
616 "id": "adexchangebuyer2.accounts.creatives.stopWatch ing",
617 "parameterOrder": [
618 "accountId",
619 "creativeId"
620 ],
621 "parameters": {
622 "accountId": {
623 "description": "The account of the creative to stop notifications for.",
624 "location": "path",
625 "required": true,
626 "type": "string"
627 },
628 "creativeId": {
629 "description": "The creative ID of the creat ive to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
630 "location": "path",
631 "required": true,
632 "type": "string"
633 }
634 },
635 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:stopWatching",
636 "request": {
637 "$ref": "StopWatchingCreativeRequest"
638 },
639 "response": {
640 "$ref": "Empty"
641 },
642 "scopes": [
643 "https://www.googleapis.com/auth/adexchange.buye r"
644 ]
645 },
646 "get": {
647 "description": "Gets a creative.",
648 "httpMethod": "GET",
649 "id": "adexchangebuyer2.accounts.creatives.get",
650 "parameterOrder": [
651 "accountId",
652 "creativeId"
653 ],
654 "parameters": {
655 "accountId": {
656 "description": "The account the creative bel ongs to.",
657 "location": "path",
658 "required": true,
659 "type": "string"
660 },
661 "creativeId": {
662 "description": "The ID of the creative to re trieve.",
663 "location": "path",
664 "required": true,
665 "type": "string"
666 }
667 },
668 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}",
669 "response": {
670 "$ref": "Creative"
671 },
672 "scopes": [
673 "https://www.googleapis.com/auth/adexchange.buye r"
674 ]
675 },
676 "watch": {
677 "description": "Watches a creative. Will result in p ush notifications being sent to the\ntopic when the creative changes status.",
678 "httpMethod": "POST",
679 "id": "adexchangebuyer2.accounts.creatives.watch",
680 "parameterOrder": [
681 "accountId",
682 "creativeId"
683 ],
684 "parameters": {
685 "creativeId": {
686 "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\ nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
687 "location": "path",
688 "required": true,
689 "type": "string"
690 },
691 "accountId": {
692 "description": "The account of the creative to watch.",
693 "location": "path",
694 "required": true,
695 "type": "string"
696 }
697 },
698 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:watch",
699 "request": {
700 "$ref": "WatchCreativeRequest"
701 },
702 "response": {
703 "$ref": "Empty"
704 },
705 "scopes": [
706 "https://www.googleapis.com/auth/adexchange.buye r"
707 ]
708 }
709 },
710 "resources": {
326 "dealAssociations": { 711 "dealAssociations": {
327 "methods": { 712 "methods": {
328 "list": { 713 "list": {
329 "description": "List all creative-deal assoc iations.", 714 "description": "List all creative-deal assoc iations.",
330 "httpMethod": "GET", 715 "httpMethod": "GET",
331 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.list", 716 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.list",
332 "parameterOrder": [ 717 "parameterOrder": [
333 "accountId", 718 "accountId",
334 "creativeId" 719 "creativeId"
335 ], 720 ],
336 "parameters": { 721 "parameters": {
722 "pageToken": {
723 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stDealAssociationsResponse.next_page_token\nreturned from the previous call to ' ListDealAssociations' method.",
724 "location": "query",
725 "type": "string"
726 },
337 "pageSize": { 727 "pageSize": {
338 "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server wi ll pick an appropriate default.", 728 "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server wi ll pick an appropriate default.",
339 "format": "int32", 729 "format": "int32",
340 "location": "query", 730 "location": "query",
341 "type": "integer" 731 "type": "integer"
342 }, 732 },
343 "accountId": { 733 "accountId": {
344 "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.", 734 "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
345 "location": "path", 735 "location": "path",
346 "required": true, 736 "required": true,
347 "type": "string" 737 "type": "string"
348 }, 738 },
349 "query": { 739 "query": {
350 "description": "An optional query st ring to filter deal associations. If no filter is\nspecified, all associations w ill be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_stri ng</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string </i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12 345 AND dealsStatus:disapproved'", 740 "description": "An optional query st ring to filter deal associations. If no filter is\nspecified, all associations w ill be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_stri ng</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string </i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12 345 AND dealsStatus:disapproved'",
351 "location": "query", 741 "location": "query",
352 "type": "string" 742 "type": "string"
353 }, 743 },
354 "creativeId": { 744 "creativeId": {
355 "description": "The creative ID to l ist the associations from.\nSpecify \"-\" to list all creatives under the above account.", 745 "description": "The creative ID to l ist the associations from.\nSpecify \"-\" to list all creatives under the above account.",
356 "location": "path", 746 "location": "path",
357 "required": true, 747 "required": true,
358 "type": "string" 748 "type": "string"
359 },
360 "pageToken": {
361 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stDealAssociationsResponse.next_page_token\nreturned from the previous call to ' ListDealAssociations' method.",
362 "location": "query",
363 "type": "string"
364 } 749 }
365 }, 750 },
366 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations", 751 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations",
367 "response": { 752 "response": {
368 "$ref": "ListDealAssociationsResponse" 753 "$ref": "ListDealAssociationsResponse"
369 }, 754 },
370 "scopes": [ 755 "scopes": [
371 "https://www.googleapis.com/auth/adexcha nge.buyer" 756 "https://www.googleapis.com/auth/adexcha nge.buyer"
372 ] 757 ]
373 }, 758 },
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
406 }, 791 },
407 "add": { 792 "add": {
408 "description": "Associate an existing deal w ith a creative.", 793 "description": "Associate an existing deal w ith a creative.",
409 "httpMethod": "POST", 794 "httpMethod": "POST",
410 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.add", 795 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.add",
411 "parameterOrder": [ 796 "parameterOrder": [
412 "accountId", 797 "accountId",
413 "creativeId" 798 "creativeId"
414 ], 799 ],
415 "parameters": { 800 "parameters": {
416 "accountId": {
417 "description": "The account the crea tive belongs to.",
418 "location": "path",
419 "required": true,
420 "type": "string"
421 },
422 "creativeId": { 801 "creativeId": {
423 "description": "The ID of the creati ve associated with the deal.", 802 "description": "The ID of the creati ve associated with the deal.",
424 "location": "path", 803 "location": "path",
425 "required": true, 804 "required": true,
426 "type": "string" 805 "type": "string"
806 },
807 "accountId": {
808 "description": "The account the crea tive belongs to.",
809 "location": "path",
810 "required": true,
811 "type": "string"
427 } 812 }
428 }, 813 },
429 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations:add", 814 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations:add",
430 "request": { 815 "request": {
431 "$ref": "AddDealAssociationRequest" 816 "$ref": "AddDealAssociationRequest"
432 }, 817 },
433 "response": { 818 "response": {
434 "$ref": "Empty" 819 "$ref": "Empty"
435 }, 820 },
436 "scopes": [ 821 "scopes": [
437 "https://www.googleapis.com/auth/adexcha nge.buyer" 822 "https://www.googleapis.com/auth/adexcha nge.buyer"
438 ]
439 }
440 }
441 }
442 }
443 },
444 "filterSets": {
445 "methods": {
446 "list": {
447 "description": "Lists all filter sets for the accoun t with the given account ID.",
448 "httpMethod": "GET",
449 "id": "adexchangebuyer2.accounts.filterSets.list",
450 "parameterOrder": [
451 "accountId"
452 ],
453 "parameters": {
454 "pageToken": {
455 "description": "A token identifying a page o f results the server should return.\nTypically, this is the value of\nListFilter SetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.fil terSets.list\nmethod.",
456 "location": "query",
457 "type": "string"
458 },
459 "pageSize": {
460 "description": "Requested page size. The ser ver may return fewer results than requested.\nIf unspecified, the server will pi ck an appropriate default.",
461 "format": "int32",
462 "location": "query",
463 "type": "integer"
464 },
465 "accountId": {
466 "description": "Account ID of the buyer.",
467 "format": "int64",
468 "location": "path",
469 "required": true,
470 "type": "string"
471 }
472 },
473 "path": "v2beta1/accounts/{accountId}/filterSets",
474 "response": {
475 "$ref": "ListFilterSetsResponse"
476 },
477 "scopes": [
478 "https://www.googleapis.com/auth/adexchange.buye r"
479 ]
480 },
481 "get": {
482 "description": "Retrieves the requested filter set f or the account with the given account\nID.",
483 "httpMethod": "GET",
484 "id": "adexchangebuyer2.accounts.filterSets.get",
485 "parameterOrder": [
486 "accountId",
487 "filterSetId"
488 ],
489 "parameters": {
490 "accountId": {
491 "description": "Account ID of the buyer.",
492 "format": "int64",
493 "location": "path",
494 "required": true,
495 "type": "string"
496 },
497 "filterSetId": {
498 "description": "The ID of the filter set to get.",
499 "format": "int64",
500 "location": "path",
501 "required": true,
502 "type": "string"
503 }
504 },
505 "path": "v2beta1/accounts/{accountId}/filterSets/{fi lterSetId}",
506 "response": {
507 "$ref": "FilterSet"
508 },
509 "scopes": [
510 "https://www.googleapis.com/auth/adexchange.buye r"
511 ]
512 },
513 "create": {
514 "description": "Creates the specified filter set for the account with the given account ID.",
515 "httpMethod": "POST",
516 "id": "adexchangebuyer2.accounts.filterSets.create",
517 "parameterOrder": [
518 "accountId"
519 ],
520 "parameters": {
521 "isTransient": {
522 "description": "Whether the filter set is tr ansient, or should be persisted indefinitely.\nBy default, filter sets are not t ransient.\nIf transient, it will be available for at least 1 hour after creation .",
523 "location": "query",
524 "type": "boolean"
525 },
526 "accountId": {
527 "description": "Account ID of the buyer.",
528 "format": "int64",
529 "location": "path",
530 "required": true,
531 "type": "string"
532 }
533 },
534 "path": "v2beta1/accounts/{accountId}/filterSets",
535 "request": {
536 "$ref": "FilterSet"
537 },
538 "response": {
539 "$ref": "FilterSet"
540 },
541 "scopes": [
542 "https://www.googleapis.com/auth/adexchange.buye r"
543 ]
544 },
545 "delete": {
546 "description": "Deletes the requested filter set fro m the account with the given account\nID.",
547 "httpMethod": "DELETE",
548 "id": "adexchangebuyer2.accounts.filterSets.delete",
549 "parameterOrder": [
550 "accountId",
551 "filterSetId"
552 ],
553 "parameters": {
554 "accountId": {
555 "description": "Account ID of the buyer.",
556 "format": "int64",
557 "location": "path",
558 "required": true,
559 "type": "string"
560 },
561 "filterSetId": {
562 "description": "The ID of the filter set to delete.",
563 "format": "int64",
564 "location": "path",
565 "required": true,
566 "type": "string"
567 }
568 },
569 "path": "v2beta1/accounts/{accountId}/filterSets/{fi lterSetId}",
570 "response": {
571 "$ref": "Empty"
572 },
573 "scopes": [
574 "https://www.googleapis.com/auth/adexchange.buye r"
575 ]
576 }
577 },
578 "resources": {
579 "bidResponseErrors": {
580 "methods": {
581 "list": {
582 "description": "List all errors that occurre d in bid responses, with the number of bid\nresponses affected for each reason." ,
583 "httpMethod": "GET",
584 "id": "adexchangebuyer2.accounts.filterSets. bidResponseErrors.list",
585 "parameterOrder": [
586 "accountId",
587 "filterSetId"
588 ],
589 "parameters": {
590 "pageSize": {
591 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
592 "format": "int32",
593 "location": "query",
594 "type": "integer"
595 },
596 "accountId": {
597 "description": "Account ID of the bu yer.",
598 "format": "int64",
599 "location": "path",
600 "required": true,
601 "type": "string"
602 },
603 "filterSetId": {
604 "description": "The ID of the filter set to apply.",
605 "format": "int64",
606 "location": "path",
607 "required": true,
608 "type": "string"
609 },
610 "pageToken": {
611 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to th e\naccounts.filterSets.bidResponseErrors.list\nmethod.",
612 "location": "query",
613 "type": "string"
614 }
615 },
616 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidResponseErrors",
617 "response": {
618 "$ref": "ListBidResponseErrorsResponse"
619 },
620 "scopes": [
621 "https://www.googleapis.com/auth/adexcha nge.buyer"
622 ]
623 }
624 }
625 },
626 "bidResponsesWithoutBids": {
627 "methods": {
628 "list": {
629 "description": "List all reasons for which b id responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
630 "httpMethod": "GET",
631 "id": "adexchangebuyer2.accounts.filterSets. bidResponsesWithoutBids.list",
632 "parameterOrder": [
633 "accountId",
634 "filterSetId"
635 ],
636 "parameters": {
637 "pageToken": {
638 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
639 "location": "query",
640 "type": "string"
641 },
642 "pageSize": {
643 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
644 "format": "int32",
645 "location": "query",
646 "type": "integer"
647 },
648 "accountId": {
649 "description": "Account ID of the bu yer.",
650 "format": "int64",
651 "location": "path",
652 "required": true,
653 "type": "string"
654 },
655 "filterSetId": {
656 "description": "The ID of the filter set to apply.",
657 "format": "int64",
658 "location": "path",
659 "required": true,
660 "type": "string"
661 }
662 },
663 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidResponsesWithoutBids",
664 "response": {
665 "$ref": "ListBidResponsesWithoutBidsResp onse"
666 },
667 "scopes": [
668 "https://www.googleapis.com/auth/adexcha nge.buyer"
669 ]
670 }
671 }
672 },
673 "filteredBidRequests": {
674 "methods": {
675 "list": {
676 "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid request s not sent for each reason.",
677 "httpMethod": "GET",
678 "id": "adexchangebuyer2.accounts.filterSets. filteredBidRequests.list",
679 "parameterOrder": [
680 "accountId",
681 "filterSetId"
682 ],
683 "parameters": {
684 "pageSize": {
685 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
686 "format": "int32",
687 "location": "query",
688 "type": "integer"
689 },
690 "accountId": {
691 "description": "Account ID of the bu yer.",
692 "format": "int64",
693 "location": "path",
694 "required": true,
695 "type": "string"
696 },
697 "filterSetId": {
698 "description": "The ID of the filter set to apply.",
699 "format": "int64",
700 "location": "path",
701 "required": true,
702 "type": "string"
703 },
704 "pageToken": {
705 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
706 "location": "query",
707 "type": "string"
708 }
709 },
710 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/filteredBidRequests",
711 "response": {
712 "$ref": "ListFilteredBidRequestsResponse "
713 },
714 "scopes": [
715 "https://www.googleapis.com/auth/adexcha nge.buyer"
716 ]
717 }
718 }
719 },
720 "nonBillableWinningBids": {
721 "methods": {
722 "list": {
723 "description": "List all reasons for which w inning bids were not billable, with the number\nof bids not billed for each reas on.",
724 "httpMethod": "GET",
725 "id": "adexchangebuyer2.accounts.filterSets. nonBillableWinningBids.list",
726 "parameterOrder": [
727 "accountId",
728 "filterSetId"
729 ],
730 "parameters": {
731 "pageToken": {
732 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
733 "location": "query",
734 "type": "string"
735 },
736 "pageSize": {
737 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
738 "format": "int32",
739 "location": "query",
740 "type": "integer"
741 },
742 "accountId": {
743 "description": "Account ID of the bu yer.",
744 "format": "int64",
745 "location": "path",
746 "required": true,
747 "type": "string"
748 },
749 "filterSetId": {
750 "description": "The ID of the filter set to apply.",
751 "format": "int64",
752 "location": "path",
753 "required": true,
754 "type": "string"
755 }
756 },
757 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/nonBillableWinningBids",
758 "response": {
759 "$ref": "ListNonBillableWinningBidsRespo nse"
760 },
761 "scopes": [
762 "https://www.googleapis.com/auth/adexcha nge.buyer"
763 ]
764 }
765 }
766 },
767 "filteredBids": {
768 "methods": {
769 "list": {
770 "description": "List all reasons for which b ids were filtered, with the number of bids\nfiltered for each reason.",
771 "httpMethod": "GET",
772 "id": "adexchangebuyer2.accounts.filterSets. filteredBids.list",
773 "parameterOrder": [
774 "accountId",
775 "filterSetId"
776 ],
777 "parameters": {
778 "pageToken": {
779 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\nac counts.filterSets.filteredBids.list\nmethod.",
780 "location": "query",
781 "type": "string"
782 },
783 "pageSize": {
784 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
785 "format": "int32",
786 "location": "query",
787 "type": "integer"
788 },
789 "accountId": {
790 "description": "Account ID of the bu yer.",
791 "format": "int64",
792 "location": "path",
793 "required": true,
794 "type": "string"
795 },
796 "filterSetId": {
797 "description": "The ID of the filter set to apply.",
798 "format": "int64",
799 "location": "path",
800 "required": true,
801 "type": "string"
802 }
803 },
804 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/filteredBids",
805 "response": {
806 "$ref": "ListFilteredBidsResponse"
807 },
808 "scopes": [
809 "https://www.googleapis.com/auth/adexcha nge.buyer"
810 ]
811 }
812 },
813 "resources": {
814 "creatives": {
815 "methods": {
816 "list": {
817 "description": "List all creatives a ssociated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
818 "httpMethod": "GET",
819 "id": "adexchangebuyer2.accounts.fil terSets.filteredBids.creatives.list",
820 "parameterOrder": [
821 "accountId",
822 "filterSetId",
823 "creativeStatusId"
824 ],
825 "parameters": {
826 "pageToken": {
827 "description": "A token iden tifying a page of results the server should return.\nTypically, this is the valu e of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmeth od.",
828 "location": "query",
829 "type": "string"
830 },
831 "creativeStatusId": {
832 "description": "The ID of th e creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creativ e-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative -status-codes).",
833 "format": "int32",
834 "location": "path",
835 "required": true,
836 "type": "integer"
837 },
838 "pageSize": {
839 "description": "Requested pa ge size. The server may return fewer results than requested.\nIf unspecified, th e server will pick an appropriate default.",
840 "format": "int32",
841 "location": "query",
842 "type": "integer"
843 },
844 "accountId": {
845 "description": "Account ID o f the buyer.",
846 "format": "int64",
847 "location": "path",
848 "required": true,
849 "type": "string"
850 },
851 "filterSetId": {
852 "description": "The ID of th e filter set to apply.",
853 "format": "int64",
854 "location": "path",
855 "required": true,
856 "type": "string"
857 }
858 },
859 "path": "v2beta1/accounts/{accountId }/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
860 "response": {
861 "$ref": "ListCreativeStatusBreak downByCreativeResponse"
862 },
863 "scopes": [
864 "https://www.googleapis.com/auth /adexchange.buyer"
865 ]
866 }
867 }
868 },
869 "details": {
870 "methods": {
871 "list": {
872 "description": "List all details ass ociated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
873 "httpMethod": "GET",
874 "id": "adexchangebuyer2.accounts.fil terSets.filteredBids.details.list",
875 "parameterOrder": [
876 "accountId",
877 "filterSetId",
878 "creativeStatusId"
879 ],
880 "parameters": {
881 "pageToken": {
882 "description": "A token iden tifying a page of results the server should return.\nTypically, this is the valu e of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from t he previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod." ,
883 "location": "query",
884 "type": "string"
885 },
886 "creativeStatusId": {
887 "description": "The ID of th e creative status for which to retrieve a breakdown by detail.\nSee\n[creative-s tatus-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-st atus-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86 , and 87.",
888 "format": "int32",
889 "location": "path",
890 "required": true,
891 "type": "integer"
892 },
893 "pageSize": {
894 "description": "Requested pa ge size. The server may return fewer results than requested.\nIf unspecified, th e server will pick an appropriate default.",
895 "format": "int32",
896 "location": "query",
897 "type": "integer"
898 },
899 "accountId": {
900 "description": "Account ID o f the buyer.",
901 "format": "int64",
902 "location": "path",
903 "required": true,
904 "type": "string"
905 },
906 "filterSetId": {
907 "description": "The ID of th e filter set to apply.",
908 "format": "int64",
909 "location": "path",
910 "required": true,
911 "type": "string"
912 }
913 },
914 "path": "v2beta1/accounts/{accountId }/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
915 "response": {
916 "$ref": "ListCreativeStatusBreak downByDetailResponse"
917 },
918 "scopes": [
919 "https://www.googleapis.com/auth /adexchange.buyer"
920 ]
921 }
922 }
923 }
924 }
925 },
926 "losingBids": {
927 "methods": {
928 "list": {
929 "description": "List all reasons for which b ids lost in the auction, with the number of\nbids that lost for each reason.",
930 "httpMethod": "GET",
931 "id": "adexchangebuyer2.accounts.filterSets. losingBids.list",
932 "parameterOrder": [
933 "accountId",
934 "filterSetId"
935 ],
936 "parameters": {
937 "pageSize": {
938 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
939 "format": "int32",
940 "location": "query",
941 "type": "integer"
942 },
943 "accountId": {
944 "description": "Account ID of the bu yer.",
945 "format": "int64",
946 "location": "path",
947 "required": true,
948 "type": "string"
949 },
950 "filterSetId": {
951 "description": "The ID of the filter set to apply.",
952 "format": "int64",
953 "location": "path",
954 "required": true,
955 "type": "string"
956 },
957 "pageToken": {
958 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stLosingBidsResponse.nextPageToken\nreturned from the previous call to the\nacco unts.filterSets.losingBids.list\nmethod.",
959 "location": "query",
960 "type": "string"
961 }
962 },
963 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/losingBids",
964 "response": {
965 "$ref": "ListLosingBidsResponse"
966 },
967 "scopes": [
968 "https://www.googleapis.com/auth/adexcha nge.buyer"
969 ]
970 }
971 }
972 },
973 "impressionMetrics": {
974 "methods": {
975 "list": {
976 "description": "Lists all metrics that are m easured in terms of number of impressions.",
977 "httpMethod": "GET",
978 "id": "adexchangebuyer2.accounts.filterSets. impressionMetrics.list",
979 "parameterOrder": [
980 "accountId",
981 "filterSetId"
982 ],
983 "parameters": {
984 "pageToken": {
985 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stImpressionMetricsResponse.nextPageToken\nreturned from the previous call to th e\naccounts.filterSets.impressionMetrics.list\nmethod.",
986 "location": "query",
987 "type": "string"
988 },
989 "pageSize": {
990 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
991 "format": "int32",
992 "location": "query",
993 "type": "integer"
994 },
995 "accountId": {
996 "description": "Account ID of the bu yer.",
997 "format": "int64",
998 "location": "path",
999 "required": true,
1000 "type": "string"
1001 },
1002 "filterSetId": {
1003 "description": "The ID of the filter set to apply.",
1004 "format": "int64",
1005 "location": "path",
1006 "required": true,
1007 "type": "string"
1008 }
1009 },
1010 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/impressionMetrics",
1011 "response": {
1012 "$ref": "ListImpressionMetricsResponse"
1013 },
1014 "scopes": [
1015 "https://www.googleapis.com/auth/adexcha nge.buyer"
1016 ]
1017 }
1018 }
1019 },
1020 "bidMetrics": {
1021 "methods": {
1022 "list": {
1023 "description": "Lists all metrics that are m easured in terms of number of bids.",
1024 "httpMethod": "GET",
1025 "id": "adexchangebuyer2.accounts.filterSets. bidMetrics.list",
1026 "parameterOrder": [
1027 "accountId",
1028 "filterSetId"
1029 ],
1030 "parameters": {
1031 "pageSize": {
1032 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1033 "format": "int32",
1034 "location": "query",
1035 "type": "integer"
1036 },
1037 "accountId": {
1038 "description": "Account ID of the bu yer.",
1039 "format": "int64",
1040 "location": "path",
1041 "required": true,
1042 "type": "string"
1043 },
1044 "filterSetId": {
1045 "description": "The ID of the filter set to apply.",
1046 "format": "int64",
1047 "location": "path",
1048 "required": true,
1049 "type": "string"
1050 },
1051 "pageToken": {
1052 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stBidMetricsResponse.nextPageToken\nreturned from the previous call to the\nacco unts.filterSets.bidMetrics.list\nmethod.",
1053 "location": "query",
1054 "type": "string"
1055 }
1056 },
1057 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidMetrics",
1058 "response": {
1059 "$ref": "ListBidMetricsResponse"
1060 },
1061 "scopes": [
1062 "https://www.googleapis.com/auth/adexcha nge.buyer"
1063 ] 823 ]
1064 } 824 }
1065 } 825 }
1066 } 826 }
1067 } 827 }
1068 }, 828 },
1069 "clients": { 829 "filterSets": {
1070 "methods": { 830 "methods": {
831 "delete": {
832 "description": "Deletes the requested filter set fro m the account with the given account\nID.",
833 "httpMethod": "DELETE",
834 "id": "adexchangebuyer2.accounts.filterSets.delete",
835 "parameterOrder": [
836 "accountId",
837 "filterSetId"
838 ],
839 "parameters": {
840 "accountId": {
841 "description": "Account ID of the buyer.",
842 "format": "int64",
843 "location": "path",
844 "required": true,
845 "type": "string"
846 },
847 "filterSetId": {
848 "description": "The ID of the filter set to delete.",
849 "format": "int64",
850 "location": "path",
851 "required": true,
852 "type": "string"
853 }
854 },
855 "path": "v2beta1/accounts/{accountId}/filterSets/{fi lterSetId}",
856 "response": {
857 "$ref": "Empty"
858 },
859 "scopes": [
860 "https://www.googleapis.com/auth/adexchange.buye r"
861 ]
862 },
1071 "list": { 863 "list": {
1072 "description": "Lists all the clients for the curren t sponsor buyer.", 864 "description": "Lists all filter sets for the accoun t with the given account ID.",
1073 "httpMethod": "GET", 865 "httpMethod": "GET",
1074 "id": "adexchangebuyer2.accounts.clients.list", 866 "id": "adexchangebuyer2.accounts.filterSets.list",
1075 "parameterOrder": [ 867 "parameterOrder": [
1076 "accountId" 868 "accountId"
1077 ], 869 ],
1078 "parameters": { 870 "parameters": {
871 "pageToken": {
872 "description": "A token identifying a page o f results the server should return.\nTypically, this is the value of\nListFilter SetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.fil terSets.list\nmethod.",
873 "location": "query",
874 "type": "string"
875 },
1079 "pageSize": { 876 "pageSize": {
1080 "description": "Requested page size. The ser ver may return fewer clients than requested.\nIf unspecified, the server will pi ck an appropriate default.", 877 "description": "Requested page size. The ser ver may return fewer results than requested.\nIf unspecified, the server will pi ck an appropriate default.",
1081 "format": "int32", 878 "format": "int32",
1082 "location": "query", 879 "location": "query",
1083 "type": "integer" 880 "type": "integer"
1084 }, 881 },
1085 "accountId": { 882 "accountId": {
1086 "description": "Unique numerical account ID of the sponsor buyer to list the clients for.", 883 "description": "Account ID of the buyer.",
1087 "format": "int64", 884 "format": "int64",
1088 "location": "path", 885 "location": "path",
1089 "required": true, 886 "required": true,
1090 "type": "string" 887 "type": "string"
1091 },
1092 "pageToken": {
1093 "description": "A token identifying a page o f results the server should return.\nTypically, this is the value of\nListClient sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client s.list method.",
1094 "location": "query",
1095 "type": "string"
1096 } 888 }
1097 }, 889 },
1098 "path": "v2beta1/accounts/{accountId}/clients", 890 "path": "v2beta1/accounts/{accountId}/filterSets",
1099 "response": { 891 "response": {
1100 "$ref": "ListClientsResponse" 892 "$ref": "ListFilterSetsResponse"
1101 }, 893 },
1102 "scopes": [ 894 "scopes": [
1103 "https://www.googleapis.com/auth/adexchange.buye r" 895 "https://www.googleapis.com/auth/adexchange.buye r"
1104 ] 896 ]
1105 }, 897 },
1106 "get": { 898 "get": {
1107 "description": "Gets a client buyer with a given cli ent account ID.", 899 "description": "Retrieves the requested filter set f or the account with the given account\nID.",
1108 "httpMethod": "GET", 900 "httpMethod": "GET",
1109 "id": "adexchangebuyer2.accounts.clients.get", 901 "id": "adexchangebuyer2.accounts.filterSets.get",
1110 "parameterOrder": [ 902 "parameterOrder": [
1111 "accountId", 903 "accountId",
1112 "clientAccountId" 904 "filterSetId"
1113 ], 905 ],
1114 "parameters": { 906 "parameters": {
1115 "accountId": { 907 "filterSetId": {
1116 "description": "Numerical account ID of the client's sponsor buyer. (required)", 908 "description": "The ID of the filter set to get.",
1117 "format": "int64", 909 "format": "int64",
1118 "location": "path", 910 "location": "path",
1119 "required": true, 911 "required": true,
1120 "type": "string" 912 "type": "string"
1121 }, 913 },
1122 "clientAccountId": { 914 "accountId": {
1123 "description": "Numerical account ID of the client buyer to retrieve. (required)", 915 "description": "Account ID of the buyer.",
1124 "format": "int64", 916 "format": "int64",
1125 "location": "path", 917 "location": "path",
1126 "required": true, 918 "required": true,
1127 "type": "string" 919 "type": "string"
1128 } 920 }
1129 }, 921 },
1130 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}", 922 "path": "v2beta1/accounts/{accountId}/filterSets/{fi lterSetId}",
1131 "response": { 923 "response": {
1132 "$ref": "Client" 924 "$ref": "FilterSet"
1133 }, 925 },
1134 "scopes": [ 926 "scopes": [
1135 "https://www.googleapis.com/auth/adexchange.buye r" 927 "https://www.googleapis.com/auth/adexchange.buye r"
1136 ] 928 ]
1137 }, 929 },
1138 "update": { 930 "create": {
1139 "description": "Updates an existing client buyer.", 931 "description": "Creates the specified filter set for the account with the given account ID.",
1140 "httpMethod": "PUT", 932 "httpMethod": "POST",
1141 "id": "adexchangebuyer2.accounts.clients.update", 933 "id": "adexchangebuyer2.accounts.filterSets.create",
1142 "parameterOrder": [ 934 "parameterOrder": [
1143 "accountId", 935 "accountId"
1144 "clientAccountId"
1145 ], 936 ],
1146 "parameters": { 937 "parameters": {
938 "isTransient": {
939 "description": "Whether the filter set is tr ansient, or should be persisted indefinitely.\nBy default, filter sets are not t ransient.\nIf transient, it will be available for at least 1 hour after creation .",
940 "location": "query",
941 "type": "boolean"
942 },
1147 "accountId": { 943 "accountId": {
1148 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd ate a client for. (required)", 944 "description": "Account ID of the buyer.",
1149 "format": "int64",
1150 "location": "path",
1151 "required": true,
1152 "type": "string"
1153 },
1154 "clientAccountId": {
1155 "description": "Unique numerical account ID of the client to update. (required)",
1156 "format": "int64", 945 "format": "int64",
1157 "location": "path", 946 "location": "path",
1158 "required": true, 947 "required": true,
1159 "type": "string" 948 "type": "string"
1160 } 949 }
1161 }, 950 },
1162 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}", 951 "path": "v2beta1/accounts/{accountId}/filterSets",
1163 "request": { 952 "request": {
1164 "$ref": "Client" 953 "$ref": "FilterSet"
1165 }, 954 },
1166 "response": { 955 "response": {
1167 "$ref": "Client" 956 "$ref": "FilterSet"
1168 }, 957 },
1169 "scopes": [ 958 "scopes": [
1170 "https://www.googleapis.com/auth/adexchange.buye r" 959 "https://www.googleapis.com/auth/adexchange.buye r"
1171 ]
1172 },
1173 "create": {
1174 "description": "Creates a new client buyer.",
1175 "httpMethod": "POST",
1176 "id": "adexchangebuyer2.accounts.clients.create",
1177 "parameterOrder": [
1178 "accountId"
1179 ],
1180 "parameters": {
1181 "accountId": {
1182 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre ate a client for. (required)",
1183 "format": "int64",
1184 "location": "path",
1185 "required": true,
1186 "type": "string"
1187 }
1188 },
1189 "path": "v2beta1/accounts/{accountId}/clients",
1190 "request": {
1191 "$ref": "Client"
1192 },
1193 "response": {
1194 "$ref": "Client"
1195 },
1196 "scopes": [
1197 "https://www.googleapis.com/auth/adexchange.buye r"
1198 ] 960 ]
1199 } 961 }
1200 }, 962 },
1201 "resources": { 963 "resources": {
1202 "users": { 964 "bidResponseErrors": {
1203 "methods": { 965 "methods": {
1204 "get": { 966 "list": {
1205 "description": "Retrieves an existing client user.", 967 "description": "List all errors that occurre d in bid responses, with the number of bid\nresponses affected for each reason." ,
1206 "httpMethod": "GET", 968 "httpMethod": "GET",
1207 "id": "adexchangebuyer2.accounts.clients.use rs.get", 969 "id": "adexchangebuyer2.accounts.filterSets. bidResponseErrors.list",
1208 "parameterOrder": [ 970 "parameterOrder": [
1209 "accountId", 971 "accountId",
1210 "clientAccountId", 972 "filterSetId"
1211 "userId"
1212 ], 973 ],
1213 "parameters": { 974 "parameters": {
1214 "accountId": { 975 "filterSetId": {
1215 "description": "Numerical account ID of the client's sponsor buyer. (required)", 976 "description": "The ID of the filter set to apply.",
1216 "format": "int64", 977 "format": "int64",
1217 "location": "path", 978 "location": "path",
1218 "required": true, 979 "required": true,
1219 "type": "string" 980 "type": "string"
1220 }, 981 },
1221 "clientAccountId": { 982 "pageToken": {
1222 "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (require d)", 983 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to th e\naccounts.filterSets.bidResponseErrors.list\nmethod.",
1223 "format": "int64", 984 "location": "query",
1224 "location": "path",
1225 "required": true,
1226 "type": "string" 985 "type": "string"
1227 }, 986 },
1228 "userId": { 987 "pageSize": {
1229 "description": "Numerical identifier of the user to retrieve. (required)", 988 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
989 "format": "int32",
990 "location": "query",
991 "type": "integer"
992 },
993 "accountId": {
994 "description": "Account ID of the bu yer.",
1230 "format": "int64", 995 "format": "int64",
1231 "location": "path", 996 "location": "path",
1232 "required": true, 997 "required": true,
1233 "type": "string" 998 "type": "string"
1234 } 999 }
1235 }, 1000 },
1236 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users/{userId}", 1001 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidResponseErrors",
1237 "response": { 1002 "response": {
1238 "$ref": "ClientUser" 1003 "$ref": "ListBidResponseErrorsResponse"
1239 }, 1004 },
1240 "scopes": [ 1005 "scopes": [
1241 "https://www.googleapis.com/auth/adexcha nge.buyer" 1006 "https://www.googleapis.com/auth/adexcha nge.buyer"
1242 ] 1007 ]
1243 }, 1008 }
1009 }
1010 },
1011 "bidResponsesWithoutBids": {
1012 "methods": {
1244 "list": { 1013 "list": {
1245 "description": "Lists all the known client u sers for a specified\nsponsor buyer account ID.", 1014 "description": "List all reasons for which b id responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.",
1246 "httpMethod": "GET", 1015 "httpMethod": "GET",
1247 "id": "adexchangebuyer2.accounts.clients.use rs.list", 1016 "id": "adexchangebuyer2.accounts.filterSets. bidResponsesWithoutBids.list",
1248 "parameterOrder": [ 1017 "parameterOrder": [
1249 "accountId", 1018 "accountId",
1250 "clientAccountId" 1019 "filterSetId"
1251 ], 1020 ],
1252 "parameters": { 1021 "parameters": {
1022 "pageToken": {
1023 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.bidResponsesWithoutBids.list\nmethod.",
1024 "location": "query",
1025 "type": "string"
1026 },
1253 "pageSize": { 1027 "pageSize": {
1254 "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", 1028 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1255 "format": "int32", 1029 "format": "int32",
1256 "location": "query", 1030 "location": "query",
1257 "type": "integer" 1031 "type": "integer"
1258 }, 1032 },
1259 "accountId": { 1033 "accountId": {
1260 "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)", 1034 "description": "Account ID of the bu yer.",
1261 "format": "int64", 1035 "format": "int64",
1262 "location": "path", 1036 "location": "path",
1263 "required": true, 1037 "required": true,
1264 "type": "string" 1038 "type": "string"
1265 }, 1039 },
1266 "clientAccountId": { 1040 "filterSetId": {
1267 "description": "The account ID of th e client buyer to list users for. (required)\nYou must specify either a string r epresentation of a\nnumerical account identifier or the `-` character\nto list a ll the client users for all the clients\nof a given sponsor buyer.", 1041 "description": "The ID of the filter set to apply.",
1268 "location": "path",
1269 "required": true,
1270 "type": "string"
1271 },
1272 "pageToken": {
1273 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stClientUsersResponse.nextPageToken\nreturned from the previous call to the\nacc ounts.clients.users.list method.",
1274 "location": "query",
1275 "type": "string"
1276 }
1277 },
1278 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users",
1279 "response": {
1280 "$ref": "ListClientUsersResponse"
1281 },
1282 "scopes": [
1283 "https://www.googleapis.com/auth/adexcha nge.buyer"
1284 ]
1285 },
1286 "update": {
1287 "description": "Updates an existing client u ser.\nOnly the user status can be changed on update.",
1288 "httpMethod": "PUT",
1289 "id": "adexchangebuyer2.accounts.clients.use rs.update",
1290 "parameterOrder": [
1291 "accountId",
1292 "clientAccountId",
1293 "userId"
1294 ],
1295 "parameters": {
1296 "accountId": {
1297 "description": "Numerical account ID of the client's sponsor buyer. (required)",
1298 "format": "int64",
1299 "location": "path",
1300 "required": true,
1301 "type": "string"
1302 },
1303 "clientAccountId": {
1304 "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (require d)",
1305 "format": "int64",
1306 "location": "path",
1307 "required": true,
1308 "type": "string"
1309 },
1310 "userId": {
1311 "description": "Numerical identifier of the user to retrieve. (required)",
1312 "format": "int64", 1042 "format": "int64",
1313 "location": "path", 1043 "location": "path",
1314 "required": true, 1044 "required": true,
1315 "type": "string" 1045 "type": "string"
1316 } 1046 }
1317 }, 1047 },
1318 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users/{userId}", 1048 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidResponsesWithoutBids",
1319 "request": {
1320 "$ref": "ClientUser"
1321 },
1322 "response": { 1049 "response": {
1323 "$ref": "ClientUser" 1050 "$ref": "ListBidResponsesWithoutBidsResp onse"
1324 }, 1051 },
1325 "scopes": [ 1052 "scopes": [
1326 "https://www.googleapis.com/auth/adexcha nge.buyer" 1053 "https://www.googleapis.com/auth/adexcha nge.buyer"
1054 ]
1055 }
1056 }
1057 },
1058 "filteredBidRequests": {
1059 "methods": {
1060 "list": {
1061 "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid request s not sent for each reason.",
1062 "httpMethod": "GET",
1063 "id": "adexchangebuyer2.accounts.filterSets. filteredBidRequests.list",
1064 "parameterOrder": [
1065 "accountId",
1066 "filterSetId"
1067 ],
1068 "parameters": {
1069 "pageToken": {
1070 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
1071 "location": "query",
1072 "type": "string"
1073 },
1074 "pageSize": {
1075 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1076 "format": "int32",
1077 "location": "query",
1078 "type": "integer"
1079 },
1080 "accountId": {
1081 "description": "Account ID of the bu yer.",
1082 "format": "int64",
1083 "location": "path",
1084 "required": true,
1085 "type": "string"
1086 },
1087 "filterSetId": {
1088 "description": "The ID of the filter set to apply.",
1089 "format": "int64",
1090 "location": "path",
1091 "required": true,
1092 "type": "string"
1093 }
1094 },
1095 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/filteredBidRequests",
1096 "response": {
1097 "$ref": "ListFilteredBidRequestsResponse "
1098 },
1099 "scopes": [
1100 "https://www.googleapis.com/auth/adexcha nge.buyer"
1327 ] 1101 ]
1328 } 1102 }
1329 } 1103 }
1330 }, 1104 },
1331 "invitations": { 1105 "filteredBids": {
1332 "methods": { 1106 "methods": {
1333 "list": { 1107 "list": {
1334 "description": "Lists all the client users i nvitations for a client\nwith a given account ID.", 1108 "description": "List all reasons for which b ids were filtered, with the number of bids\nfiltered for each reason.",
1335 "httpMethod": "GET", 1109 "httpMethod": "GET",
1336 "id": "adexchangebuyer2.accounts.clients.inv itations.list", 1110 "id": "adexchangebuyer2.accounts.filterSets. filteredBids.list",
1337 "parameterOrder": [ 1111 "parameterOrder": [
1338 "accountId", 1112 "accountId",
1339 "clientAccountId" 1113 "filterSetId"
1340 ], 1114 ],
1341 "parameters": { 1115 "parameters": {
1342 "pageToken": { 1116 "pageToken": {
1343 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stClientUserInvitationsResponse.nextPageToken\nreturned from the previous call t o the\nclients.invitations.list\nmethod.", 1117 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stFilteredBidsResponse.nextPageToken\nreturned from the previous call to the\nac counts.filterSets.filteredBids.list\nmethod.",
1344 "location": "query", 1118 "location": "query",
1345 "type": "string" 1119 "type": "string"
1346 }, 1120 },
1347 "pageSize": { 1121 "pageSize": {
1348 "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pi ck an appropriate default.", 1122 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1349 "format": "int32", 1123 "format": "int32",
1350 "location": "query", 1124 "location": "query",
1351 "type": "integer" 1125 "type": "integer"
1352 }, 1126 },
1353 "accountId": { 1127 "accountId": {
1354 "description": "Numerical account ID of the client's sponsor buyer. (required)", 1128 "description": "Account ID of the bu yer.",
1355 "format": "int64", 1129 "format": "int64",
1356 "location": "path", 1130 "location": "path",
1357 "required": true, 1131 "required": true,
1358 "type": "string" 1132 "type": "string"
1359 }, 1133 },
1360 "clientAccountId": { 1134 "filterSetId": {
1361 "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either speci fy a string representation of a\nnumerical account identifier or the `-` charact er\nto list all the invitations for all the clients\nof a given sponsor buyer.", 1135 "description": "The ID of the filter set to apply.",
1362 "location": "path",
1363 "required": true,
1364 "type": "string"
1365 }
1366 },
1367 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations",
1368 "response": {
1369 "$ref": "ListClientUserInvitationsRespon se"
1370 },
1371 "scopes": [
1372 "https://www.googleapis.com/auth/adexcha nge.buyer"
1373 ]
1374 },
1375 "get": {
1376 "description": "Retrieves an existing client user invitation.",
1377 "httpMethod": "GET",
1378 "id": "adexchangebuyer2.accounts.clients.inv itations.get",
1379 "parameterOrder": [
1380 "accountId",
1381 "clientAccountId",
1382 "invitationId"
1383 ],
1384 "parameters": {
1385 "invitationId": {
1386 "description": "Numerical identifier of the user invitation to retrieve. (required)",
1387 "format": "int64",
1388 "location": "path",
1389 "required": true,
1390 "type": "string"
1391 },
1392 "accountId": {
1393 "description": "Numerical account ID of the client's sponsor buyer. (required)",
1394 "format": "int64",
1395 "location": "path",
1396 "required": true,
1397 "type": "string"
1398 },
1399 "clientAccountId": {
1400 "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated wit h. (required)",
1401 "format": "int64", 1136 "format": "int64",
1402 "location": "path", 1137 "location": "path",
1403 "required": true, 1138 "required": true,
1404 "type": "string" 1139 "type": "string"
1405 } 1140 }
1406 }, 1141 },
1407 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations/{invitationId}", 1142 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/filteredBids",
1408 "response": { 1143 "response": {
1409 "$ref": "ClientUserInvitation" 1144 "$ref": "ListFilteredBidsResponse"
1410 }, 1145 },
1411 "scopes": [ 1146 "scopes": [
1412 "https://www.googleapis.com/auth/adexcha nge.buyer" 1147 "https://www.googleapis.com/auth/adexcha nge.buyer"
1413 ] 1148 ]
1149 }
1150 },
1151 "resources": {
1152 "creatives": {
1153 "methods": {
1154 "list": {
1155 "description": "List all creatives a ssociated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.",
1156 "httpMethod": "GET",
1157 "id": "adexchangebuyer2.accounts.fil terSets.filteredBids.creatives.list",
1158 "parameterOrder": [
1159 "accountId",
1160 "filterSetId",
1161 "creativeStatusId"
1162 ],
1163 "parameters": {
1164 "filterSetId": {
1165 "description": "The ID of th e filter set to apply.",
1166 "format": "int64",
1167 "location": "path",
1168 "required": true,
1169 "type": "string"
1170 },
1171 "pageToken": {
1172 "description": "A token iden tifying a page of results the server should return.\nTypically, this is the valu e of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBids.creatives.list\nmeth od.",
1173 "location": "query",
1174 "type": "string"
1175 },
1176 "creativeStatusId": {
1177 "description": "The ID of th e creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creativ e-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative -status-codes).",
1178 "format": "int32",
1179 "location": "path",
1180 "required": true,
1181 "type": "integer"
1182 },
1183 "pageSize": {
1184 "description": "Requested pa ge size. The server may return fewer results than requested.\nIf unspecified, th e server will pick an appropriate default.",
1185 "format": "int32",
1186 "location": "query",
1187 "type": "integer"
1188 },
1189 "accountId": {
1190 "description": "Account ID o f the buyer.",
1191 "format": "int64",
1192 "location": "path",
1193 "required": true,
1194 "type": "string"
1195 }
1196 },
1197 "path": "v2beta1/accounts/{accountId }/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
1198 "response": {
1199 "$ref": "ListCreativeStatusBreak downByCreativeResponse"
1200 },
1201 "scopes": [
1202 "https://www.googleapis.com/auth /adexchange.buyer"
1203 ]
1204 }
1205 }
1414 }, 1206 },
1415 "create": { 1207 "details": {
1416 "description": "Creates and sends out an ema il invitation to access\nan Ad Exchange client buyer account.", 1208 "methods": {
1417 "httpMethod": "POST", 1209 "list": {
1418 "id": "adexchangebuyer2.accounts.clients.inv itations.create", 1210 "description": "List all details ass ociated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.",
1211 "httpMethod": "GET",
1212 "id": "adexchangebuyer2.accounts.fil terSets.filteredBids.details.list",
1213 "parameterOrder": [
1214 "accountId",
1215 "filterSetId",
1216 "creativeStatusId"
1217 ],
1218 "parameters": {
1219 "pageSize": {
1220 "description": "Requested pa ge size. The server may return fewer results than requested.\nIf unspecified, th e server will pick an appropriate default.",
1221 "format": "int32",
1222 "location": "query",
1223 "type": "integer"
1224 },
1225 "accountId": {
1226 "description": "Account ID o f the buyer.",
1227 "format": "int64",
1228 "location": "path",
1229 "required": true,
1230 "type": "string"
1231 },
1232 "filterSetId": {
1233 "description": "The ID of th e filter set to apply.",
1234 "format": "int64",
1235 "location": "path",
1236 "required": true,
1237 "type": "string"
1238 },
1239 "pageToken": {
1240 "description": "A token iden tifying a page of results the server should return.\nTypically, this is the valu e of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from t he previous call to the\naccounts.filterSets.filteredBids.details.list\nmethod." ,
1241 "location": "query",
1242 "type": "string"
1243 },
1244 "creativeStatusId": {
1245 "description": "The ID of th e creative status for which to retrieve a breakdown by detail.\nSee\n[creative-s tatus-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-st atus-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86 , and 87.",
1246 "format": "int32",
1247 "location": "path",
1248 "required": true,
1249 "type": "integer"
1250 }
1251 },
1252 "path": "v2beta1/accounts/{accountId }/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details",
1253 "response": {
1254 "$ref": "ListCreativeStatusBreak downByDetailResponse"
1255 },
1256 "scopes": [
1257 "https://www.googleapis.com/auth /adexchange.buyer"
1258 ]
1259 }
1260 }
1261 }
1262 }
1263 },
1264 "nonBillableWinningBids": {
1265 "methods": {
1266 "list": {
1267 "description": "List all reasons for which w inning bids were not billable, with the number\nof bids not billed for each reas on.",
1268 "httpMethod": "GET",
1269 "id": "adexchangebuyer2.accounts.filterSets. nonBillableWinningBids.list",
1419 "parameterOrder": [ 1270 "parameterOrder": [
1420 "accountId", 1271 "accountId",
1421 "clientAccountId" 1272 "filterSetId"
1422 ], 1273 ],
1423 "parameters": { 1274 "parameters": {
1275 "pageToken": {
1276 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.nonBillableWinningBids.list\nmethod.",
1277 "location": "query",
1278 "type": "string"
1279 },
1280 "pageSize": {
1281 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1282 "format": "int32",
1283 "location": "query",
1284 "type": "integer"
1285 },
1424 "accountId": { 1286 "accountId": {
1425 "description": "Numerical account ID of the client's sponsor buyer. (required)", 1287 "description": "Account ID of the bu yer.",
1426 "format": "int64", 1288 "format": "int64",
1427 "location": "path", 1289 "location": "path",
1428 "required": true, 1290 "required": true,
1429 "type": "string" 1291 "type": "string"
1430 }, 1292 },
1431 "clientAccountId": { 1293 "filterSetId": {
1432 "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)", 1294 "description": "The ID of the filter set to apply.",
1433 "format": "int64", 1295 "format": "int64",
1434 "location": "path", 1296 "location": "path",
1435 "required": true, 1297 "required": true,
1436 "type": "string" 1298 "type": "string"
1437 } 1299 }
1438 }, 1300 },
1439 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations", 1301 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/nonBillableWinningBids",
1440 "request": { 1302 "response": {
1441 "$ref": "ClientUserInvitation" 1303 "$ref": "ListNonBillableWinningBidsRespo nse"
1442 }, 1304 },
1305 "scopes": [
1306 "https://www.googleapis.com/auth/adexcha nge.buyer"
1307 ]
1308 }
1309 }
1310 },
1311 "losingBids": {
1312 "methods": {
1313 "list": {
1314 "description": "List all reasons for which b ids lost in the auction, with the number of\nbids that lost for each reason.",
1315 "httpMethod": "GET",
1316 "id": "adexchangebuyer2.accounts.filterSets. losingBids.list",
1317 "parameterOrder": [
1318 "accountId",
1319 "filterSetId"
1320 ],
1321 "parameters": {
1322 "pageToken": {
1323 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stLosingBidsResponse.nextPageToken\nreturned from the previous call to the\nacco unts.filterSets.losingBids.list\nmethod.",
1324 "location": "query",
1325 "type": "string"
1326 },
1327 "pageSize": {
1328 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1329 "format": "int32",
1330 "location": "query",
1331 "type": "integer"
1332 },
1333 "accountId": {
1334 "description": "Account ID of the bu yer.",
1335 "format": "int64",
1336 "location": "path",
1337 "required": true,
1338 "type": "string"
1339 },
1340 "filterSetId": {
1341 "description": "The ID of the filter set to apply.",
1342 "format": "int64",
1343 "location": "path",
1344 "required": true,
1345 "type": "string"
1346 }
1347 },
1348 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/losingBids",
1443 "response": { 1349 "response": {
1444 "$ref": "ClientUserInvitation" 1350 "$ref": "ListLosingBidsResponse"
1351 },
1352 "scopes": [
1353 "https://www.googleapis.com/auth/adexcha nge.buyer"
1354 ]
1355 }
1356 }
1357 },
1358 "bidMetrics": {
1359 "methods": {
1360 "list": {
1361 "description": "Lists all metrics that are m easured in terms of number of bids.",
1362 "httpMethod": "GET",
1363 "id": "adexchangebuyer2.accounts.filterSets. bidMetrics.list",
1364 "parameterOrder": [
1365 "accountId",
1366 "filterSetId"
1367 ],
1368 "parameters": {
1369 "pageToken": {
1370 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stBidMetricsResponse.nextPageToken\nreturned from the previous call to the\nacco unts.filterSets.bidMetrics.list\nmethod.",
1371 "location": "query",
1372 "type": "string"
1373 },
1374 "pageSize": {
1375 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1376 "format": "int32",
1377 "location": "query",
1378 "type": "integer"
1379 },
1380 "accountId": {
1381 "description": "Account ID of the bu yer.",
1382 "format": "int64",
1383 "location": "path",
1384 "required": true,
1385 "type": "string"
1386 },
1387 "filterSetId": {
1388 "description": "The ID of the filter set to apply.",
1389 "format": "int64",
1390 "location": "path",
1391 "required": true,
1392 "type": "string"
1393 }
1394 },
1395 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidMetrics",
1396 "response": {
1397 "$ref": "ListBidMetricsResponse"
1398 },
1399 "scopes": [
1400 "https://www.googleapis.com/auth/adexcha nge.buyer"
1401 ]
1402 }
1403 }
1404 },
1405 "impressionMetrics": {
1406 "methods": {
1407 "list": {
1408 "description": "Lists all metrics that are m easured in terms of number of impressions.",
1409 "httpMethod": "GET",
1410 "id": "adexchangebuyer2.accounts.filterSets. impressionMetrics.list",
1411 "parameterOrder": [
1412 "accountId",
1413 "filterSetId"
1414 ],
1415 "parameters": {
1416 "pageSize": {
1417 "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.",
1418 "format": "int32",
1419 "location": "query",
1420 "type": "integer"
1421 },
1422 "accountId": {
1423 "description": "Account ID of the bu yer.",
1424 "format": "int64",
1425 "location": "path",
1426 "required": true,
1427 "type": "string"
1428 },
1429 "filterSetId": {
1430 "description": "The ID of the filter set to apply.",
1431 "format": "int64",
1432 "location": "path",
1433 "required": true,
1434 "type": "string"
1435 },
1436 "pageToken": {
1437 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stImpressionMetricsResponse.nextPageToken\nreturned from the previous call to th e\naccounts.filterSets.impressionMetrics.list\nmethod.",
1438 "location": "query",
1439 "type": "string"
1440 }
1441 },
1442 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/impressionMetrics",
1443 "response": {
1444 "$ref": "ListImpressionMetricsResponse"
1445 }, 1445 },
1446 "scopes": [ 1446 "scopes": [
1447 "https://www.googleapis.com/auth/adexcha nge.buyer" 1447 "https://www.googleapis.com/auth/adexcha nge.buyer"
1448 ] 1448 ]
1449 } 1449 }
1450 } 1450 }
1451 } 1451 }
1452 } 1452 }
1453 } 1453 }
1454 } 1454 }
1455 } 1455 }
1456 }, 1456 },
1457 "revision": "20170815", 1457 "revision": "20170815",
1458 "rootUrl": "https://adexchangebuyer.googleapis.com/", 1458 "rootUrl": "https://adexchangebuyer.googleapis.com/",
1459 "schemas": { 1459 "schemas": {
1460 "AuctionContext": {
1461 "description": "@OutputOnly The auction type the restriction applies to.",
1462 "id": "AuctionContext",
1463 "properties": {
1464 "auctionTypes": {
1465 "description": "The auction types this restriction applies t o.",
1466 "enumDescriptions": [
1467 "The restriction applies to open auction.",
1468 "The restriction applies to direct deals."
1469 ],
1470 "items": {
1471 "enum": [
1472 "OPEN_AUCTION",
1473 "DIRECT_DEALS"
1474 ],
1475 "type": "string"
1476 },
1477 "type": "array"
1478 }
1479 },
1480 "type": "object"
1481 },
1482 "ListImpressionMetricsResponse": {
1483 "description": "Response message for listing the metrics that are me asured in number of\nimpressions.",
1484 "id": "ListImpressionMetricsResponse",
1485 "properties": {
1486 "impressionMetricsRows": {
1487 "description": "List of rows, each containing a set of impre ssion metrics.",
1488 "items": {
1489 "$ref": "ImpressionMetricsRow"
1490 },
1491 "type": "array"
1492 },
1493 "nextPageToken": {
1494 "description": "A token to retrieve the next page of results .\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to re trieve the next page of results.",
1495 "type": "string"
1496 }
1497 },
1498 "type": "object"
1499 },
1500 "BidMetricsRow": {
1501 "description": "The set of metrics that are measured in numbers of b ids, representing how\nmany bids with the specified dimension values were consid ered eligible at\neach stage of the bidding funnel;",
1502 "id": "BidMetricsRow",
1503 "properties": {
1504 "bids": {
1505 "$ref": "MetricValue",
1506 "description": "The number of bids that Ad Exchange received from the buyer."
1507 },
1508 "billedImpressions": {
1509 "$ref": "MetricValue",
1510 "description": "The number of bids for which the buyer was b illed."
1511 },
1512 "bidsInAuction": {
1513 "$ref": "MetricValue",
1514 "description": "The number of bids that were permitted to co mpete in the auction."
1515 },
1516 "rowDimensions": {
1517 "$ref": "RowDimensions",
1518 "description": "The values of all dimensions associated with metric values in this row."
1519 },
1520 "viewableImpressions": {
1521 "$ref": "MetricValue",
1522 "description": "The number of bids for which the correspondi ng impression was viewable (as\ndefined by Active View)."
1523 },
1524 "impressionsWon": {
1525 "$ref": "MetricValue",
1526 "description": "The number of bids that won an impression."
1527 },
1528 "measurableImpressions": {
1529 "$ref": "MetricValue",
1530 "description": "The number of bids for which the correspondi ng impression was measurable\nfor viewability (as defined by Active View)."
1531 }
1532 },
1533 "type": "object"
1534 },
1535 "ListBidResponseErrorsResponse": {
1536 "description": "Response message for listing all reasons that bid re sponses resulted in an\nerror.",
1537 "id": "ListBidResponseErrorsResponse",
1538 "properties": {
1539 "calloutStatusRows": {
1540 "description": "List of rows, with counts of bid responses a ggregated by callout status.",
1541 "items": {
1542 "$ref": "CalloutStatusRow"
1543 },
1544 "type": "array"
1545 },
1546 "nextPageToken": {
1547 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to re trieve the next page of results.",
1548 "type": "string"
1549 }
1550 },
1551 "type": "object"
1552 },
1553 "CreativeStatusRow": {
1554 "description": "The number of bids with the specified dimension valu es that did not win the\nauction (either were filtered pre-auction or lost the a uction), as described\nby the specified creative status.",
1555 "id": "CreativeStatusRow",
1556 "properties": {
1557 "bidCount": {
1558 "$ref": "MetricValue",
1559 "description": "The number of bids with the specified status ."
1560 },
1561 "rowDimensions": {
1562 "$ref": "RowDimensions",
1563 "description": "The values of all dimensions associated with metric values in this row."
1564 },
1565 "creativeStatusId": {
1566 "description": "The ID of the creative status.\nSee [creativ e-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative -status-codes).",
1567 "format": "int32",
1568 "type": "integer"
1569 }
1570 },
1571 "type": "object"
1572 },
1573 "RealtimeTimeRange": {
1574 "description": "An open-ended realtime time range specified by the s tart timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
1575 "id": "RealtimeTimeRange",
1576 "properties": {
1577 "startTimestamp": {
1578 "description": "The start timestamp of the real-time RTB met rics aggregation.",
1579 "format": "google-datetime",
1580 "type": "string"
1581 }
1582 },
1583 "type": "object"
1584 },
1585 "NonBillableWinningBidStatusRow": {
1586 "description": "The number of winning bids with the specified dimens ion values for which the\nbuyer was not billed, as described by the specified st atus.",
1587 "id": "NonBillableWinningBidStatusRow",
1588 "properties": {
1589 "bidCount": {
1590 "$ref": "MetricValue",
1591 "description": "The number of bids with the specified status ."
1592 },
1593 "status": {
1594 "description": "The status specifying why the winning bids w ere not billed.",
1595 "enum": [
1596 "STATUS_UNSPECIFIED",
1597 "AD_NOT_RENDERED",
1598 "INVALID_IMPRESSION"
1599 ],
1600 "enumDescriptions": [
1601 "A placeholder for an undefined status.\nThis value will never be returned in responses.",
1602 "The buyer was not billed because the ad was not rendere d by the\npublisher.",
1603 "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
1604 ],
1605 "type": "string"
1606 },
1607 "rowDimensions": {
1608 "$ref": "RowDimensions",
1609 "description": "The values of all dimensions associated with metric values in this row."
1610 }
1611 },
1612 "type": "object"
1613 },
1614 "FilteredBidDetailRow": {
1615 "description": "The number of filtered bids with the specified dimen sion values, among those\nfiltered due to the requested filtering reason (i.e. c reative status), that\nhave the specified detail.",
1616 "id": "FilteredBidDetailRow",
1617 "properties": {
1618 "detailId": {
1619 "description": "The ID of the detail. The associated value c an be looked up in the\ndictionary file corresponding to the DetailType in the r esponse message.",
1620 "format": "int32",
1621 "type": "integer"
1622 },
1623 "bidCount": {
1624 "$ref": "MetricValue",
1625 "description": "The number of bids with the specified detail ."
1626 },
1627 "rowDimensions": {
1628 "$ref": "RowDimensions",
1629 "description": "The values of all dimensions associated with metric values in this row."
1630 }
1631 },
1632 "type": "object"
1633 },
1634 "AbsoluteDateRange": {
1635 "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an abso lute\ndate range is run at a later date more than 30 days after start_date, it w ill\nfail.",
1636 "id": "AbsoluteDateRange",
1637 "properties": {
1638 "endDate": {
1639 "$ref": "Date",
1640 "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor afte r start_date."
1641 },
1642 "startDate": {
1643 "$ref": "Date",
1644 "description": "The start date of the range (inclusive).\nMu st be within the 30 days leading up to current date, and must be equal to\nor be fore end_date."
1645 }
1646 },
1647 "type": "object"
1648 },
1649 "AddDealAssociationRequest": {
1650 "description": "A request for associating a deal and a creative.",
1651 "id": "AddDealAssociationRequest",
1652 "properties": {
1653 "association": {
1654 "$ref": "CreativeDealAssociation",
1655 "description": "The association between a creative and a dea l that should be added."
1656 }
1657 },
1658 "type": "object"
1659 },
1660 "WatchCreativeRequest": {
1661 "description": "A request for watching changes to creative Status.",
1662 "id": "WatchCreativeRequest",
1663 "properties": {
1664 "topic": {
1665 "description": "The Pub/Sub topic to publish notifications t o.\nThis topic must already exist and must give permission to\nad-exchange-buysi de-reports@google.com to write to the topic.\nThis should be the full resource n ame in\n\"projects/{project_id}/topics/{topic_id}\" format.",
1666 "type": "string"
1667 }
1668 },
1669 "type": "object"
1670 },
1671 "TimeInterval": {
1672 "description": "An interval of time, with an absolute start and end. \nThis is included in the response, for several reasons:\n1) The request may hav e specified start or end times relative to the time the\n request was sent; th e response indicates the corresponding absolute time\n interval.\n2) The reque st may have specified an end time past the latest time for which\n data was av ailable (e.g. if requesting data for the today); the response\n indicates the latest time for which data was actually returned.\n3) The response data for a si ngle request may be broken down into multiple\n time intervals, if a time seri es was requested.",
1673 "id": "TimeInterval",
1674 "properties": {
1675 "endTime": {
1676 "description": "The timestamp marking the end of the range ( exclusive) for which data is\nincluded.",
1677 "format": "google-datetime",
1678 "type": "string"
1679 },
1680 "startTime": {
1681 "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
1682 "format": "google-datetime",
1683 "type": "string"
1684 }
1685 },
1686 "type": "object"
1687 },
1688 "FilteredBidCreativeRow": {
1689 "description": "The number of filtered bids with the specified dimen sion values that have the\nspecified creative.",
1690 "id": "FilteredBidCreativeRow",
1691 "properties": {
1692 "rowDimensions": {
1693 "$ref": "RowDimensions",
1694 "description": "The values of all dimensions associated with metric values in this row."
1695 },
1696 "bidCount": {
1697 "$ref": "MetricValue",
1698 "description": "The number of bids with the specified creati ve."
1699 },
1700 "creativeId": {
1701 "description": "The ID of the creative.",
1702 "type": "string"
1703 }
1704 },
1705 "type": "object"
1706 },
1707 "RelativeDateRange": {
1708 "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends tod ay.\nI.e. the limits for these values are:\noffset_days >= 0\nduration_days >= 1 \noffset_days + duration_days <= 30",
1709 "id": "RelativeDateRange",
1710 "properties": {
1711 "offsetDays": {
1712 "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today , 0.",
1713 "format": "int32",
1714 "type": "integer"
1715 },
1716 "durationDays": {
1717 "description": "The number of days in the requested date ran ge. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7 .",
1718 "format": "int32",
1719 "type": "integer"
1720 }
1721 },
1722 "type": "object"
1723 },
1724 "ListClientsResponse": {
1725 "id": "ListClientsResponse",
1726 "properties": {
1727 "nextPageToken": {
1728 "description": "A token to retrieve the next page of results .\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results .",
1729 "type": "string"
1730 },
1731 "clients": {
1732 "description": "The returned list of clients.",
1733 "items": {
1734 "$ref": "Client"
1735 },
1736 "type": "array"
1737 }
1738 },
1739 "type": "object"
1740 },
1741 "NativeContent": {
1742 "description": "Native content for a creative.",
1743 "id": "NativeContent",
1744 "properties": {
1745 "storeUrl": {
1746 "description": "The URL to the app store to purchase/downloa d the promoted app.",
1747 "type": "string"
1748 },
1749 "headline": {
1750 "description": "A short title for the ad.",
1751 "type": "string"
1752 },
1753 "appIcon": {
1754 "$ref": "Image",
1755 "description": "The app icon, for app download ads."
1756 },
1757 "callToAction": {
1758 "description": "A label for the button that the user is supp osed to click.",
1759 "type": "string"
1760 },
1761 "body": {
1762 "description": "A long description of the ad.",
1763 "type": "string"
1764 },
1765 "starRating": {
1766 "description": "The app rating in the app store. Must be in the range [0-5].",
1767 "format": "double",
1768 "type": "number"
1769 },
1770 "videoUrl": {
1771 "description": "The URL to fetch a native video ad.",
1772 "type": "string"
1773 },
1774 "clickLinkUrl": {
1775 "description": "The URL that the browser/SDK will load when the user clicks the ad.",
1776 "type": "string"
1777 },
1778 "logo": {
1779 "$ref": "Image",
1780 "description": "A smaller image, for the advertiser's logo."
1781 },
1782 "priceDisplayText": {
1783 "description": "The price of the promoted app including curr ency info.",
1784 "type": "string"
1785 },
1786 "image": {
1787 "$ref": "Image",
1788 "description": "A large image."
1789 },
1790 "clickTrackingUrl": {
1791 "description": "The URL to use for click tracking.",
1792 "type": "string"
1793 },
1794 "advertiserName": {
1795 "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
1796 "type": "string"
1797 }
1798 },
1799 "type": "object"
1800 },
1801 "ListBidResponsesWithoutBidsResponse": {
1802 "description": "Response message for listing all reasons that bid re sponses were considered\nto have no applicable bids.",
1803 "id": "ListBidResponsesWithoutBidsResponse",
1804 "properties": {
1805 "nextPageToken": {
1806 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield i n the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\n method to retrieve the next page of results.",
1807 "type": "string"
1808 },
1809 "bidResponseWithoutBidsStatusRows": {
1810 "description": "List of rows, with counts of bid responses w ithout bids aggregated by\nstatus.",
1811 "items": {
1812 "$ref": "BidResponseWithoutBidsStatusRow"
1813 },
1814 "type": "array"
1815 }
1816 },
1817 "type": "object"
1818 },
1819 "ServingContext": {
1820 "description": "The serving context for this restriction.",
1821 "id": "ServingContext",
1822 "properties": {
1823 "securityType": {
1824 "$ref": "SecurityContext",
1825 "description": "Matches impressions for a particular securit y type."
1826 },
1827 "platform": {
1828 "$ref": "PlatformContext",
1829 "description": "Matches impressions coming from a particular platform."
1830 },
1831 "location": {
1832 "$ref": "LocationContext",
1833 "description": "Matches impressions coming from users *or* p ublishers in a specific\nlocation."
1834 },
1835 "auctionType": {
1836 "$ref": "AuctionContext",
1837 "description": "Matches impressions for a particular auction type."
1838 },
1839 "all": {
1840 "description": "Matches all contexts.",
1841 "enum": [
1842 "SIMPLE_CONTEXT"
1843 ],
1844 "enumDescriptions": [
1845 "A simple context."
1846 ],
1847 "type": "string"
1848 },
1849 "appType": {
1850 "$ref": "AppContext",
1851 "description": "Matches impressions for a particular app typ e."
1852 }
1853 },
1854 "type": "object"
1855 },
1856 "Image": {
1857 "description": "An image resource. You may provide a larger image th an was requested,\nso long as the aspect ratio is preserved.",
1858 "id": "Image",
1859 "properties": {
1860 "height": {
1861 "description": "Image height in pixels.",
1862 "format": "int32",
1863 "type": "integer"
1864 },
1865 "width": {
1866 "description": "Image width in pixels.",
1867 "format": "int32",
1868 "type": "integer"
1869 },
1870 "url": {
1871 "description": "The URL of the image.",
1872 "type": "string"
1873 }
1874 },
1875 "type": "object"
1876 },
1877 "ListFilterSetsResponse": {
1878 "description": "Response message for listing filter sets.",
1879 "id": "ListFilterSetsResponse",
1880 "properties": {
1881 "filterSets": {
1882 "description": "The filter sets belonging to the buyer.",
1883 "items": {
1884 "$ref": "FilterSet"
1885 },
1886 "type": "array"
1887 },
1888 "nextPageToken": {
1889 "description": "A token to retrieve the next page of results .\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequ ent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of r esults.",
1890 "type": "string"
1891 }
1892 },
1893 "type": "object"
1894 },
1895 "BidResponseWithoutBidsStatusRow": {
1896 "description": "The number of impressions with the specified dimensi on values that were\nconsidered to have no applicable bids, as described by the specified status.",
1897 "id": "BidResponseWithoutBidsStatusRow",
1898 "properties": {
1899 "impressionCount": {
1900 "$ref": "MetricValue",
1901 "description": "The number of impressions for which there wa s a bid response with the\nspecified status."
1902 },
1903 "status": {
1904 "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
1905 "enum": [
1906 "STATUS_UNSPECIFIED",
1907 "RESPONSES_WITHOUT_BIDS",
1908 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
1909 "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
1910 ],
1911 "enumDescriptions": [
1912 "A placeholder for an undefined status.\nThis value will never be returned in responses.",
1913 "The response had no bids.",
1914 "The response had no bids for the specified account, tho ugh it may have\nincluded bids on behalf of other accounts.",
1915 "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
1916 ],
1917 "type": "string"
1918 },
1919 "rowDimensions": {
1920 "$ref": "RowDimensions",
1921 "description": "The values of all dimensions associated with metric values in this row."
1922 }
1923 },
1924 "type": "object"
1925 },
1926 "ClientUserInvitation": {
1927 "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified. ",
1928 "id": "ClientUserInvitation",
1929 "properties": {
1930 "clientAccountId": {
1931 "description": "Numerical account ID of the client buyer\nth at the invited user is associated with.\nThe value of this field is ignored in c reate operations.",
1932 "format": "int64",
1933 "type": "string"
1934 },
1935 "invitationId": {
1936 "description": "The unique numerical ID of the invitation th at is sent to the user.\nThe value of this field is ignored in create operations .",
1937 "format": "int64",
1938 "type": "string"
1939 },
1940 "email": {
1941 "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each spons or\nbuyer.",
1942 "type": "string"
1943 }
1944 },
1945 "type": "object"
1946 },
1947 "ListCreativeStatusBreakdownByDetailResponse": {
1948 "description": "Response message for listing all details associated with a given filtered bid\nreason.",
1949 "id": "ListCreativeStatusBreakdownByDetailResponse",
1950 "properties": {
1951 "detailType": {
1952 "description": "The type of detail that the detail IDs repre sent.",
1953 "enum": [
1954 "DETAIL_TYPE_UNSPECIFIED",
1955 "CREATIVE_ATTRIBUTE",
1956 "VENDOR",
1957 "SENSITIVE_CATEGORY",
1958 "PRODUCT_CATEGORY",
1959 "DISAPPROVAL_REASON"
1960 ],
1961 "enumDescriptions": [
1962 "A placeholder for an undefined status.\nThis value will never be returned in responses.",
1963 "Indicates that the detail ID refers to a creative attri bute; see\n[publisher-excludable-creative-attributes](https://developers.google. com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
1964 "Indicates that the detail ID refers to a vendor; see\n[ vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
1965 "Indicates that the detail ID refers to a sensitive cate gory; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/r tb/downloads/ad-sensitive-categories).",
1966 "Indicates that the detail ID refers to a product catego ry; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/d ownloads/ad-product-categories).",
1967 "Indicates that the detail ID refers to a disapproval re ason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://devel opers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
1968 ],
1969 "type": "string"
1970 },
1971 "nextPageToken": {
1972 "description": "A token to retrieve the next page of results .\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\ nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.l ist\nmethod to retrieve the next page of results.",
1973 "type": "string"
1974 },
1975 "filteredBidDetailRows": {
1976 "description": "List of rows, with counts of bids with a giv en creative status aggregated\nby detail.",
1977 "items": {
1978 "$ref": "FilteredBidDetailRow"
1979 },
1980 "type": "array"
1981 }
1982 },
1983 "type": "object"
1984 },
1985 "ListClientUsersResponse": {
1986 "id": "ListClientUsersResponse",
1987 "properties": {
1988 "nextPageToken": {
1989 "description": "A token to retrieve the next page of results .\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subseq uent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
1990 "type": "string"
1991 },
1992 "users": {
1993 "description": "The returned list of client users.",
1994 "items": {
1995 "$ref": "ClientUser"
1996 },
1997 "type": "array"
1998 }
1999 },
2000 "type": "object"
2001 },
2002 "ListClientUserInvitationsResponse": {
2003 "id": "ListClientUserInvitationsResponse",
2004 "properties": {
2005 "nextPageToken": {
2006 "description": "A token to retrieve the next page of results .\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the nex t\npage of results.",
2007 "type": "string"
2008 },
2009 "invitations": {
2010 "description": "The returned list of client users.",
2011 "items": {
2012 "$ref": "ClientUserInvitation"
2013 },
2014 "type": "array"
2015 }
2016 },
2017 "type": "object"
2018 },
2019 "LocationContext": {
2020 "description": "@OutputOnly The Geo criteria the restriction applies to.",
2021 "id": "LocationContext",
2022 "properties": {
2023 "geoCriteriaIds": {
2024 "description": "IDs representing the geo location for this c ontext.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx -rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
2025 "items": {
2026 "format": "int32",
2027 "type": "integer"
2028 },
2029 "type": "array"
2030 }
2031 },
2032 "type": "object"
2033 },
2034 "PlatformContext": {
2035 "description": "@OutputOnly The type of platform the restriction app lies to.",
2036 "id": "PlatformContext",
2037 "properties": {
2038 "platforms": {
2039 "description": "The platforms this restriction applies to.",
2040 "enumDescriptions": [
2041 "Desktop platform.",
2042 "Android platform.",
2043 "iOS platform."
2044 ],
2045 "items": {
2046 "enum": [
2047 "DESKTOP",
2048 "ANDROID",
2049 "IOS"
2050 ],
2051 "type": "string"
2052 },
2053 "type": "array"
2054 }
2055 },
2056 "type": "object"
2057 },
2058 "MetricValue": {
2059 "description": "A metric value, with an expected value and a varianc e; represents a count\nthat may be either exact or estimated (i.e. when sampled) .",
2060 "id": "MetricValue",
2061 "properties": {
2062 "variance": {
2063 "description": "The variance (i.e. square of the standard de viation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formul a, where Z is the standard constant that depends on the\ndesired size of the con fidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n margin OfError = 100 * Z * sqrt(variance) / value",
2064 "format": "int64",
2065 "type": "string"
2066 },
2067 "value": {
2068 "description": "The expected value of the metric.",
2069 "format": "int64",
2070 "type": "string"
2071 }
2072 },
2073 "type": "object"
2074 },
2075 "ClientUser": { 1460 "ClientUser": {
2076 "description": "A client user is created under a client buyer and ha s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n of the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nema il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi elds are required unless otherwise specified.", 1461 "description": "A client user is created under a client buyer and ha s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n of the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nema il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi elds are required unless otherwise specified.",
2077 "id": "ClientUser", 1462 "id": "ClientUser",
2078 "properties": { 1463 "properties": {
1464 "email": {
1465 "description": "User's email address. The value of this fiel d\nis ignored in an update operation.",
1466 "type": "string"
1467 },
1468 "userId": {
1469 "description": "The unique numerical ID of the client user\n that has accepted an invitation.\nThe value of this field is ignored in an updat e operation.",
1470 "format": "int64",
1471 "type": "string"
1472 },
1473 "clientAccountId": {
1474 "description": "Numerical account ID of the client buyer\nwi th which the user is associated; the\nbuyer must be a client of the current spon sor buyer.\nThe value of this field is ignored in an update operation.",
1475 "format": "int64",
1476 "type": "string"
1477 },
2079 "status": { 1478 "status": {
2080 "description": "The status of the client user.", 1479 "description": "The status of the client user.",
2081 "enum": [ 1480 "enum": [
2082 "USER_STATUS_UNSPECIFIED", 1481 "USER_STATUS_UNSPECIFIED",
2083 "PENDING", 1482 "PENDING",
2084 "ACTIVE", 1483 "ACTIVE",
2085 "DISABLED" 1484 "DISABLED"
2086 ], 1485 ],
2087 "enumDescriptions": [ 1486 "enumDescriptions": [
2088 "A placeholder for an undefined user status.", 1487 "A placeholder for an undefined user status.",
2089 "A user who was already created but hasn't accepted the invitation yet.", 1488 "A user who was already created but hasn't accepted the invitation yet.",
2090 "A user that is currently active.", 1489 "A user that is currently active.",
2091 "A user that is currently disabled." 1490 "A user that is currently disabled."
2092 ], 1491 ],
2093 "type": "string" 1492 "type": "string"
2094 },
2095 "email": {
2096 "description": "User's email address. The value of this fiel d\nis ignored in an update operation.",
2097 "type": "string"
2098 },
2099 "userId": {
2100 "description": "The unique numerical ID of the client user\n that has accepted an invitation.\nThe value of this field is ignored in an updat e operation.",
2101 "format": "int64",
2102 "type": "string"
2103 },
2104 "clientAccountId": {
2105 "description": "Numerical account ID of the client buyer\nwi th which the user is associated; the\nbuyer must be a client of the current spon sor buyer.\nThe value of this field is ignored in an update operation.",
2106 "format": "int64",
2107 "type": "string"
2108 } 1493 }
2109 }, 1494 },
2110 "type": "object" 1495 "type": "object"
2111 }, 1496 },
2112 "CreativeDealAssociation": { 1497 "CreativeDealAssociation": {
2113 "description": "The association between a creative and a deal.", 1498 "description": "The association between a creative and a deal.",
2114 "id": "CreativeDealAssociation", 1499 "id": "CreativeDealAssociation",
2115 "properties": { 1500 "properties": {
2116 "accountId": { 1501 "accountId": {
2117 "description": "The account the creative belongs to.", 1502 "description": "The account the creative belongs to.",
2118 "type": "string" 1503 "type": "string"
2119 }, 1504 },
2120 "creativeId": { 1505 "creativeId": {
2121 "description": "The ID of the creative associated with the d eal.", 1506 "description": "The ID of the creative associated with the d eal.",
2122 "type": "string" 1507 "type": "string"
2123 }, 1508 },
2124 "dealsId": { 1509 "dealsId": {
2125 "description": "The externalDealId for the deal associated w ith the creative.", 1510 "description": "The externalDealId for the deal associated w ith the creative.",
2126 "type": "string" 1511 "type": "string"
2127 } 1512 }
2128 }, 1513 },
2129 "type": "object" 1514 "type": "object"
2130 }, 1515 },
2131 "FilteringStats": {
2132 "description": "@OutputOnly Filtering reasons for this creative duri ng a period of a single\nday (from midnight to midnight Pacific).",
2133 "id": "FilteringStats",
2134 "properties": {
2135 "reasons": {
2136 "description": "The set of filtering reasons for this date." ,
2137 "items": {
2138 "$ref": "Reason"
2139 },
2140 "type": "array"
2141 },
2142 "date": {
2143 "$ref": "Date",
2144 "description": "The day during which the data was collected. \nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usua l 24."
2145 }
2146 },
2147 "type": "object"
2148 },
2149 "Creative": { 1516 "Creative": {
2150 "description": "A creative and its classification data.", 1517 "description": "A creative and its classification data.",
2151 "id": "Creative", 1518 "id": "Creative",
2152 "properties": { 1519 "properties": {
1520 "dealsStatus": {
1521 "description": "@OutputOnly The top-level deals status of th is creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with o ther contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreat ives.list\nmethod.",
1522 "enum": [
1523 "STATUS_UNSPECIFIED",
1524 "NOT_CHECKED",
1525 "CONDITIONALLY_APPROVED",
1526 "APPROVED",
1527 "DISAPPROVED"
1528 ],
1529 "enumDescriptions": [
1530 "The status is unknown.",
1531 "The creative has not been checked.",
1532 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
1533 "The creative has been approved.",
1534 "The creative has been disapproved."
1535 ],
1536 "type": "string"
1537 },
1538 "detectedProductCategories": {
1539 "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
1540 "items": {
1541 "format": "int32",
1542 "type": "integer"
1543 },
1544 "type": "array"
1545 },
1546 "openAuctionStatus": {
1547 "description": "@OutputOnly The top-level open auction statu s of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' ( or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanc ed with other contextual restrictions, in which case,\nit may be preferable to r ead from serving_restrictions directly.\nCan be used to filter the response of t he\ncreatives.list\nmethod.",
1548 "enum": [
1549 "STATUS_UNSPECIFIED",
1550 "NOT_CHECKED",
1551 "CONDITIONALLY_APPROVED",
1552 "APPROVED",
1553 "DISAPPROVED"
1554 ],
1555 "enumDescriptions": [
1556 "The status is unknown.",
1557 "The creative has not been checked.",
1558 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
1559 "The creative has been approved.",
1560 "The creative has been disapproved."
1561 ],
1562 "type": "string"
1563 },
1564 "advertiserName": {
1565 "description": "The name of the company being advertised in the creative.",
1566 "type": "string"
1567 },
1568 "detectedDomains": {
1569 "description": "@OutputOnly\nThe detected domains for this c reative.",
1570 "items": {
1571 "type": "string"
1572 },
1573 "type": "array"
1574 },
1575 "detectedAdvertiserIds": {
1576 "description": "@OutputOnly Detected advertiser IDs, if any. ",
1577 "items": {
1578 "format": "int64",
1579 "type": "string"
1580 },
1581 "type": "array"
1582 },
2153 "filteringStats": { 1583 "filteringStats": {
2154 "$ref": "FilteringStats", 1584 "$ref": "FilteringStats",
2155 "description": "@OutputOnly The filtering stats for this cre ative." 1585 "description": "@OutputOnly The filtering stats for this cre ative."
2156 }, 1586 },
2157 "attributes": { 1587 "attributes": {
2158 "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\ nmethod.", 1588 "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\ nmethod.",
2159 "enumDescriptions": [ 1589 "enumDescriptions": [
2160 "Do not use. This is a placeholder value only.", 1590 "Do not use. This is a placeholder value only.",
2161 "The creative is tagged.", 1591 "The creative is tagged.",
2162 "The creative is cookie targeted.", 1592 "The creative is cookie targeted.",
(...skipping 147 matching lines...) Expand 10 before | Expand all | Expand 10 after
2310 "impressionTrackingUrls": { 1740 "impressionTrackingUrls": {
2311 "description": "The set of URLs to be called to record an im pression.", 1741 "description": "The set of URLs to be called to record an im pression.",
2312 "items": { 1742 "items": {
2313 "type": "string" 1743 "type": "string"
2314 }, 1744 },
2315 "type": "array" 1745 "type": "array"
2316 }, 1746 },
2317 "html": { 1747 "html": {
2318 "$ref": "HtmlContent", 1748 "$ref": "HtmlContent",
2319 "description": "An HTML creative." 1749 "description": "An HTML creative."
2320 }, 1750 }
2321 "detectedProductCategories": { 1751 },
2322 "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.", 1752 "type": "object"
2323 "items": { 1753 },
2324 "format": "int32", 1754 "FilteringStats": {
2325 "type": "integer" 1755 "description": "@OutputOnly Filtering reasons for this creative duri ng a period of a single\nday (from midnight to midnight Pacific).",
2326 }, 1756 "id": "FilteringStats",
2327 "type": "array" 1757 "properties": {
2328 }, 1758 "reasons": {
2329 "dealsStatus": { 1759 "description": "The set of filtering reasons for this date." ,
2330 "description": "@OutputOnly The top-level deals status of th is creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with o ther contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreat ives.list\nmethod.", 1760 "items": {
2331 "enum": [ 1761 "$ref": "Reason"
2332 "STATUS_UNSPECIFIED", 1762 },
2333 "NOT_CHECKED", 1763 "type": "array"
2334 "CONDITIONALLY_APPROVED", 1764 },
2335 "APPROVED", 1765 "date": {
2336 "DISAPPROVED" 1766 "$ref": "Date",
2337 ], 1767 "description": "The day during which the data was collected. \nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usua l 24."
2338 "enumDescriptions": [
2339 "The status is unknown.",
2340 "The creative has not been checked.",
2341 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
2342 "The creative has been approved.",
2343 "The creative has been disapproved."
2344 ],
2345 "type": "string"
2346 },
2347 "openAuctionStatus": {
2348 "description": "@OutputOnly The top-level open auction statu s of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' ( or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanc ed with other contextual restrictions, in which case,\nit may be preferable to r ead from serving_restrictions directly.\nCan be used to filter the response of t he\ncreatives.list\nmethod.",
2349 "enum": [
2350 "STATUS_UNSPECIFIED",
2351 "NOT_CHECKED",
2352 "CONDITIONALLY_APPROVED",
2353 "APPROVED",
2354 "DISAPPROVED"
2355 ],
2356 "enumDescriptions": [
2357 "The status is unknown.",
2358 "The creative has not been checked.",
2359 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
2360 "The creative has been approved.",
2361 "The creative has been disapproved."
2362 ],
2363 "type": "string"
2364 },
2365 "advertiserName": {
2366 "description": "The name of the company being advertised in the creative.",
2367 "type": "string"
2368 },
2369 "detectedAdvertiserIds": {
2370 "description": "@OutputOnly Detected advertiser IDs, if any. ",
2371 "items": {
2372 "format": "int64",
2373 "type": "string"
2374 },
2375 "type": "array"
2376 },
2377 "detectedDomains": {
2378 "description": "@OutputOnly\nThe detected domains for this c reative.",
2379 "items": {
2380 "type": "string"
2381 },
2382 "type": "array"
2383 } 1768 }
2384 }, 1769 },
2385 "type": "object" 1770 "type": "object"
2386 }, 1771 },
2387 "RemoveDealAssociationRequest": { 1772 "RemoveDealAssociationRequest": {
2388 "description": "A request for removing the association between a dea l and a creative.", 1773 "description": "A request for removing the association between a dea l and a creative.",
2389 "id": "RemoveDealAssociationRequest", 1774 "id": "RemoveDealAssociationRequest",
2390 "properties": { 1775 "properties": {
2391 "association": { 1776 "association": {
2392 "$ref": "CreativeDealAssociation", 1777 "$ref": "CreativeDealAssociation",
2393 "description": "The association between a creative and a dea l that should be removed." 1778 "description": "The association between a creative and a dea l that should be removed."
2394 } 1779 }
2395 }, 1780 },
2396 "type": "object" 1781 "type": "object"
2397 }, 1782 },
1783 "ListCreativeStatusBreakdownByCreativeResponse": {
1784 "description": "Response message for listing all creatives associate d with a given filtered\nbid reason.",
1785 "id": "ListCreativeStatusBreakdownByCreativeResponse",
1786 "properties": {
1787 "nextPageToken": {
1788 "description": "A token to retrieve the next page of results .\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToke n\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creativ es.list\nmethod to retrieve the next page of results.",
1789 "type": "string"
1790 },
1791 "filteredBidCreativeRows": {
1792 "description": "List of rows, with counts of bids with a giv en creative status aggregated\nby creative.",
1793 "items": {
1794 "$ref": "FilteredBidCreativeRow"
1795 },
1796 "type": "array"
1797 }
1798 },
1799 "type": "object"
1800 },
2398 "Client": { 1801 "Client": {
2399 "description": "A client resource represents a client buyer&mdash;an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra nted to the client buyer.\nAll fields are required unless otherwise specified.", 1802 "description": "A client resource represents a client buyer&mdash;an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra nted to the client buyer.\nAll fields are required unless otherwise specified.",
2400 "id": "Client", 1803 "id": "Client",
2401 "properties": { 1804 "properties": {
1805 "entityId": {
1806 "description": "Numerical identifier of the client entity.\n The entity can be an advertiser, a brand, or an agency.\nThis identifier is uniq ue among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.g oogleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all know n brands with their identifiers is available in the\n[brands.txt](https://storag e.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://stor age.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
1807 "format": "int64",
1808 "type": "string"
1809 },
1810 "clientAccountId": {
1811 "description": "The globally-unique numerical ID of the clie nt.\nThe value of this field is ignored in create and update operations.",
1812 "format": "int64",
1813 "type": "string"
1814 },
1815 "entityName": {
1816 "description": "The name of the entity. This field is automa tically fetched based on\nthe type and ID.\nThe value of this field is ignored i n create and update operations.",
1817 "type": "string"
1818 },
1819 "status": {
1820 "description": "The status of the client buyer.",
1821 "enum": [
1822 "CLIENT_STATUS_UNSPECIFIED",
1823 "DISABLED",
1824 "ACTIVE"
1825 ],
1826 "enumDescriptions": [
1827 "A placeholder for an undefined client status.",
1828 "A client that is currently disabled.",
1829 "A client that is currently active."
1830 ],
1831 "type": "string"
1832 },
2402 "entityType": { 1833 "entityType": {
2403 "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.", 1834 "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
2404 "enum": [ 1835 "enum": [
2405 "ENTITY_TYPE_UNSPECIFIED", 1836 "ENTITY_TYPE_UNSPECIFIED",
2406 "ADVERTISER", 1837 "ADVERTISER",
2407 "BRAND", 1838 "BRAND",
2408 "AGENCY" 1839 "AGENCY"
2409 ], 1840 ],
2410 "enumDescriptions": [ 1841 "enumDescriptions": [
2411 "A placeholder for an undefined client entity type. Shou ld not be used.", 1842 "A placeholder for an undefined client entity type. Shou ld not be used.",
(...skipping 19 matching lines...) Expand all
2431 "A placeholder for an undefined client role.", 1862 "A placeholder for an undefined client role.",
2432 "Users associated with this client can see publisher dea l offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nt o this client.", 1863 "Users associated with this client can see publisher dea l offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nt o this client.",
2433 "Users associated with this client can respond to deal p roposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.", 1864 "Users associated with this client can respond to deal p roposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
2434 "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinali zation. If this role is not selected, the sponsor buyer\nwill need to manually a pprove each of their deals." 1865 "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinali zation. If this role is not selected, the sponsor buyer\nwill need to manually a pprove each of their deals."
2435 ], 1866 ],
2436 "type": "string" 1867 "type": "string"
2437 }, 1868 },
2438 "visibleToSeller": { 1869 "visibleToSeller": {
2439 "description": "Whether the client buyer will be visible to sellers.", 1870 "description": "Whether the client buyer will be visible to sellers.",
2440 "type": "boolean" 1871 "type": "boolean"
2441 },
2442 "entityId": {
2443 "description": "Numerical identifier of the client entity.\n The entity can be an advertiser, a brand, or an agency.\nThis identifier is uniq ue among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.g oogleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all know n brands with their identifiers is available in the\n[brands.txt](https://storag e.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://stor age.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
2444 "format": "int64",
2445 "type": "string"
2446 },
2447 "clientAccountId": {
2448 "description": "The globally-unique numerical ID of the clie nt.\nThe value of this field is ignored in create and update operations.",
2449 "format": "int64",
2450 "type": "string"
2451 },
2452 "entityName": {
2453 "description": "The name of the entity. This field is automa tically fetched based on\nthe type and ID.\nThe value of this field is ignored i n create and update operations.",
2454 "type": "string"
2455 },
2456 "status": {
2457 "description": "The status of the client buyer.",
2458 "enum": [
2459 "CLIENT_STATUS_UNSPECIFIED",
2460 "DISABLED",
2461 "ACTIVE"
2462 ],
2463 "enumDescriptions": [
2464 "A placeholder for an undefined client status.",
2465 "A client that is currently disabled.",
2466 "A client that is currently active."
2467 ],
2468 "type": "string"
2469 }
2470 },
2471 "type": "object"
2472 },
2473 "ListCreativeStatusBreakdownByCreativeResponse": {
2474 "description": "Response message for listing all creatives associate d with a given filtered\nbid reason.",
2475 "id": "ListCreativeStatusBreakdownByCreativeResponse",
2476 "properties": {
2477 "nextPageToken": {
2478 "description": "A token to retrieve the next page of results .\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToke n\nfield in the subsequent call to the\naccounts.filterSets.filteredBids.creativ es.list\nmethod to retrieve the next page of results.",
2479 "type": "string"
2480 },
2481 "filteredBidCreativeRows": {
2482 "description": "List of rows, with counts of bids with a giv en creative status aggregated\nby creative.",
2483 "items": {
2484 "$ref": "FilteredBidCreativeRow"
2485 },
2486 "type": "array"
2487 } 1872 }
2488 }, 1873 },
2489 "type": "object" 1874 "type": "object"
2490 }, 1875 },
2491 "Correction": { 1876 "Correction": {
2492 "description": "@OutputOnly Shows any corrections that were applied to this creative.", 1877 "description": "@OutputOnly Shows any corrections that were applied to this creative.",
2493 "id": "Correction", 1878 "id": "Correction",
2494 "properties": { 1879 "properties": {
1880 "details": {
1881 "description": "Additional details about what was corrected. ",
1882 "items": {
1883 "type": "string"
1884 },
1885 "type": "array"
1886 },
2495 "type": { 1887 "type": {
2496 "description": "The type of correction that was applied to t he creative.", 1888 "description": "The type of correction that was applied to t he creative.",
2497 "enum": [ 1889 "enum": [
2498 "CORRECTION_TYPE_UNSPECIFIED", 1890 "CORRECTION_TYPE_UNSPECIFIED",
2499 "VENDOR_IDS_ADDED", 1891 "VENDOR_IDS_ADDED",
2500 "SSL_ATTRIBUTE_REMOVED", 1892 "SSL_ATTRIBUTE_REMOVED",
2501 "FLASH_FREE_ATTRIBUTE_REMOVED", 1893 "FLASH_FREE_ATTRIBUTE_REMOVED",
2502 "FLASH_FREE_ATTRIBUTE_ADDED", 1894 "FLASH_FREE_ATTRIBUTE_ADDED",
2503 "REQUIRED_ATTRIBUTE_ADDED", 1895 "REQUIRED_ATTRIBUTE_ADDED",
2504 "REQUIRED_VENDOR_ADDED", 1896 "REQUIRED_VENDOR_ADDED",
(...skipping 18 matching lines...) Expand all
2523 "The ad contains video content." 1915 "The ad contains video content."
2524 ], 1916 ],
2525 "type": "string" 1917 "type": "string"
2526 }, 1918 },
2527 "contexts": { 1919 "contexts": {
2528 "description": "The contexts for the correction.", 1920 "description": "The contexts for the correction.",
2529 "items": { 1921 "items": {
2530 "$ref": "ServingContext" 1922 "$ref": "ServingContext"
2531 }, 1923 },
2532 "type": "array" 1924 "type": "array"
2533 },
2534 "details": {
2535 "description": "Additional details about what was corrected. ",
2536 "items": {
2537 "type": "string"
2538 },
2539 "type": "array"
2540 } 1925 }
2541 }, 1926 },
2542 "type": "object" 1927 "type": "object"
2543 }, 1928 },
2544 "FilterSet": { 1929 "FilterSet": {
2545 "description": "A set of filters that is applied to a request for da ta.\nWithin a filter set, an AND operation is performed across the filters\nrepr esented by each field. An OR operation is performed across the filters\nrepresen ted by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id =12 AND (seller_network_id=34 OR\nseller_network_id=56)\"", 1930 "description": "A set of filters that is applied to a request for da ta.\nWithin a filter set, an AND operation is performed across the filters\nrepr esented by each field. An OR operation is performed across the filters\nrepresen ted by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id =12 AND (seller_network_id=34 OR\nseller_network_id=56)\"",
2546 "id": "FilterSet", 1931 "id": "FilterSet",
2547 "properties": { 1932 "properties": {
1933 "sellerNetworkIds": {
1934 "description": "The list of IDs of the seller (publisher) ne tworks on which to filter;\nmay be empty. The filters represented by multiple se ller network IDs are\nORed together (i.e. if non-empty, results must match any o ne of the\npublisher networks).\nSee [seller-network-ids](https://developers.goo gle.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of exist ing seller network IDs.",
1935 "items": {
1936 "format": "int32",
1937 "type": "integer"
1938 },
1939 "type": "array"
1940 },
1941 "ownerAccountId": {
1942 "description": "The account ID of the buyer who owns this fi lter set.\nThe value of this field is ignored in create operations.",
1943 "format": "int64",
1944 "type": "string"
1945 },
1946 "buyerAccountId": {
1947 "description": "The ID of the buyer account on which to filt er; optional.",
1948 "format": "int64",
1949 "type": "string"
1950 },
1951 "absoluteDateRange": {
1952 "$ref": "AbsoluteDateRange",
1953 "description": "An absolute date range, defined by a start d ate and an end date.\nInterpreted relative to Pacific time zone."
1954 },
1955 "environment": {
1956 "description": "The environment on which to filter; optional .",
1957 "enum": [
1958 "ENVIRONMENT_UNSPECIFIED",
1959 "WEB",
1960 "APP"
1961 ],
1962 "enumDescriptions": [
1963 "A placeholder for an undefined environment; indicates t hat no environment\nfilter will be applied.",
1964 "The ad impression appears on the web.",
1965 "The ad impression appears in an app."
1966 ],
1967 "type": "string"
1968 },
1969 "format": {
1970 "description": "The format on which to filter; optional.",
1971 "enum": [
1972 "FORMAT_UNSPECIFIED",
1973 "DISPLAY",
1974 "VIDEO"
1975 ],
1976 "enumDescriptions": [
1977 "A placeholder for an undefined format; indicates that n o format filter\nwill be applied.",
1978 "The ad impression is display format (i.e. an image).",
1979 "The ad impression is video format."
1980 ],
1981 "type": "string"
1982 },
1983 "dealId": {
1984 "description": "The ID of the deal on which to filter; optio nal.",
1985 "format": "int64",
1986 "type": "string"
1987 },
1988 "timeSeriesGranularity": {
1989 "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
1990 "enum": [
1991 "TIME_SERIES_GRANULARITY_UNSPECIFIED",
1992 "HOURLY",
1993 "DAILY"
1994 ],
1995 "enumDescriptions": [
1996 "A placeholder for an unspecified interval; no time seri es is applied.\nAll rows in response will contain data for the entire requested time range.",
1997 "Indicates that data will be broken down by the hour.",
1998 "Indicates that data will be broken down by the day."
1999 ],
2000 "type": "string"
2001 },
2002 "filterSetId": {
2003 "description": "The ID of the filter set; unique within the account of the filter set\nowner.\nThe value of this field is ignored in create operations.",
2004 "format": "int64",
2005 "type": "string"
2006 },
2007 "realtimeTimeRange": {
2008 "$ref": "RealtimeTimeRange",
2009 "description": "An open-ended realtime time range, defined b y the aggregation start\ntimestamp."
2010 },
2011 "creativeId": {
2012 "description": "The ID of the creative on which to filter; o ptional.",
2013 "type": "string"
2014 },
2548 "relativeDateRange": { 2015 "relativeDateRange": {
2549 "$ref": "RelativeDateRange", 2016 "$ref": "RelativeDateRange",
2550 "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone." 2017 "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
2551 }, 2018 },
2552 "platforms": { 2019 "platforms": {
2553 "description": "The list of platforms on which to filter; ma y be empty. The filters\nrepresented by multiple platforms are ORed together (i. e. if non-empty,\nresults must match any one of the platforms).", 2020 "description": "The list of platforms on which to filter; ma y be empty. The filters\nrepresented by multiple platforms are ORed together (i. e. if non-empty,\nresults must match any one of the platforms).",
2554 "enumDescriptions": [ 2021 "enumDescriptions": [
2555 "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.", 2022 "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
2556 "The ad impression appears on a desktop.", 2023 "The ad impression appears on a desktop.",
2557 "The ad impression appears on a tablet.", 2024 "The ad impression appears on a tablet.",
2558 "The ad impression appears on a mobile device." 2025 "The ad impression appears on a mobile device."
2559 ], 2026 ],
2560 "items": { 2027 "items": {
2561 "enum": [ 2028 "enum": [
2562 "PLATFORM_UNSPECIFIED", 2029 "PLATFORM_UNSPECIFIED",
2563 "DESKTOP", 2030 "DESKTOP",
2564 "TABLET", 2031 "TABLET",
2565 "MOBILE" 2032 "MOBILE"
2566 ], 2033 ],
2567 "type": "string" 2034 "type": "string"
2568 }, 2035 },
2569 "type": "array" 2036 "type": "array"
2570 }, 2037 }
2571 "sellerNetworkIds": { 2038 },
2572 "description": "The list of IDs of the seller (publisher) ne tworks on which to filter;\nmay be empty. The filters represented by multiple se ller network IDs are\nORed together (i.e. if non-empty, results must match any o ne of the\npublisher networks).\nSee [seller-network-ids](https://developers.goo gle.com/ad-exchange/rtb/downloads/seller-network-ids)\nfile for the set of exist ing seller network IDs.", 2039 "type": "object"
2573 "items": { 2040 },
2574 "format": "int32", 2041 "ListDealAssociationsResponse": {
2575 "type": "integer" 2042 "description": "A response for listing creative and deal association s",
2576 }, 2043 "id": "ListDealAssociationsResponse",
2577 "type": "array" 2044 "properties": {
2578 }, 2045 "associations": {
2579 "ownerAccountId": { 2046 "description": "The list of associations.",
2580 "description": "The account ID of the buyer who owns this fi lter set.\nThe value of this field is ignored in create operations.", 2047 "items": {
2581 "format": "int64", 2048 "$ref": "CreativeDealAssociation"
2582 "type": "string" 2049 },
2583 }, 2050 "type": "array"
2584 "absoluteDateRange": { 2051 },
2585 "$ref": "AbsoluteDateRange", 2052 "nextPageToken": {
2586 "description": "An absolute date range, defined by a start d ate and an end date.\nInterpreted relative to Pacific time zone." 2053 "description": "A token to retrieve the next page of results .\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of re sults.",
2587 },
2588 "buyerAccountId": {
2589 "description": "The ID of the buyer account on which to filt er; optional.",
2590 "format": "int64",
2591 "type": "string"
2592 },
2593 "environment": {
2594 "description": "The environment on which to filter; optional .",
2595 "enum": [
2596 "ENVIRONMENT_UNSPECIFIED",
2597 "WEB",
2598 "APP"
2599 ],
2600 "enumDescriptions": [
2601 "A placeholder for an undefined environment; indicates t hat no environment\nfilter will be applied.",
2602 "The ad impression appears on the web.",
2603 "The ad impression appears in an app."
2604 ],
2605 "type": "string"
2606 },
2607 "format": {
2608 "description": "The format on which to filter; optional.",
2609 "enum": [
2610 "FORMAT_UNSPECIFIED",
2611 "DISPLAY",
2612 "VIDEO"
2613 ],
2614 "enumDescriptions": [
2615 "A placeholder for an undefined format; indicates that n o format filter\nwill be applied.",
2616 "The ad impression is display format (i.e. an image).",
2617 "The ad impression is video format."
2618 ],
2619 "type": "string"
2620 },
2621 "dealId": {
2622 "description": "The ID of the deal on which to filter; optio nal.",
2623 "format": "int64",
2624 "type": "string"
2625 },
2626 "timeSeriesGranularity": {
2627 "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.",
2628 "enum": [
2629 "TIME_SERIES_GRANULARITY_UNSPECIFIED",
2630 "HOURLY",
2631 "DAILY"
2632 ],
2633 "enumDescriptions": [
2634 "A placeholder for an unspecified interval; no time seri es is applied.\nAll rows in response will contain data for the entire requested time range.",
2635 "Indicates that data will be broken down by the hour.",
2636 "Indicates that data will be broken down by the day."
2637 ],
2638 "type": "string"
2639 },
2640 "filterSetId": {
2641 "description": "The ID of the filter set; unique within the account of the filter set\nowner.\nThe value of this field is ignored in create operations.",
2642 "format": "int64",
2643 "type": "string"
2644 },
2645 "realtimeTimeRange": {
2646 "$ref": "RealtimeTimeRange",
2647 "description": "An open-ended realtime time range, defined b y the aggregation start\ntimestamp."
2648 },
2649 "creativeId": {
2650 "description": "The ID of the creative on which to filter; o ptional.",
2651 "type": "string" 2054 "type": "string"
2652 } 2055 }
2653 }, 2056 },
2654 "type": "object" 2057 "type": "object"
2655 }, 2058 },
2656 "CalloutStatusRow": { 2059 "CalloutStatusRow": {
2657 "description": "The number of impressions with the specified dimensi on values where the\ncorresponding bid request or bid response was not successfu l, as described by\nthe specified callout status.", 2060 "description": "The number of impressions with the specified dimensi on values where the\ncorresponding bid request or bid response was not successfu l, as described by\nthe specified callout status.",
2658 "id": "CalloutStatusRow", 2061 "id": "CalloutStatusRow",
2659 "properties": { 2062 "properties": {
2660 "impressionCount": {
2661 "$ref": "MetricValue",
2662 "description": "The number of impressions for which there wa s a bid request or bid response\nwith the specified callout status."
2663 },
2664 "rowDimensions": { 2063 "rowDimensions": {
2665 "$ref": "RowDimensions", 2064 "$ref": "RowDimensions",
2666 "description": "The values of all dimensions associated with metric values in this row." 2065 "description": "The values of all dimensions associated with metric values in this row."
2667 }, 2066 },
2668 "calloutStatusId": { 2067 "calloutStatusId": {
2669 "description": "The ID of the callout status.\nSee [callout- status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-st atus-codes).", 2068 "description": "The ID of the callout status.\nSee [callout- status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-st atus-codes).",
2670 "format": "int32", 2069 "format": "int32",
2671 "type": "integer" 2070 "type": "integer"
2672 } 2071 },
2673 }, 2072 "impressionCount": {
2674 "type": "object" 2073 "$ref": "MetricValue",
2675 }, 2074 "description": "The number of impressions for which there wa s a bid request or bid response\nwith the specified callout status."
2676 "ListDealAssociationsResponse": { 2075 }
2677 "description": "A response for listing creative and deal association s", 2076 },
2678 "id": "ListDealAssociationsResponse",
2679 "properties": {
2680 "associations": {
2681 "description": "The list of associations.",
2682 "items": {
2683 "$ref": "CreativeDealAssociation"
2684 },
2685 "type": "array"
2686 },
2687 "nextPageToken": {
2688 "description": "A token to retrieve the next page of results .\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of re sults.",
2689 "type": "string"
2690 }
2691 },
2692 "type": "object"
2693 },
2694 "StopWatchingCreativeRequest": {
2695 "description": "A request for stopping notifications for changes to creative Status.",
2696 "id": "StopWatchingCreativeRequest",
2697 "properties": {},
2698 "type": "object" 2077 "type": "object"
2699 }, 2078 },
2700 "Disapproval": { 2079 "Disapproval": {
2701 "description": "@OutputOnly The reason and details for a disapproval .", 2080 "description": "@OutputOnly The reason and details for a disapproval .",
2702 "id": "Disapproval", 2081 "id": "Disapproval",
2703 "properties": { 2082 "properties": {
2704 "details": { 2083 "details": {
2705 "description": "Additional details about the reason for disa pproval.", 2084 "description": "Additional details about the reason for disa pproval.",
2706 "items": { 2085 "items": {
2707 "type": "string" 2086 "type": "string"
(...skipping 192 matching lines...) Expand 10 before | Expand all | Expand 10 after
2900 "Maximum number of HTTP calls exceeded.", 2279 "Maximum number of HTTP calls exceeded.",
2901 "Maximum number of cookies exceeded.", 2280 "Maximum number of cookies exceeded.",
2902 "Financial service ad does not adhere to specifications. ", 2281 "Financial service ad does not adhere to specifications. ",
2903 "Flash content was found in an unsupported context." 2282 "Flash content was found in an unsupported context."
2904 ], 2283 ],
2905 "type": "string" 2284 "type": "string"
2906 } 2285 }
2907 }, 2286 },
2908 "type": "object" 2287 "type": "object"
2909 }, 2288 },
2289 "StopWatchingCreativeRequest": {
2290 "description": "A request for stopping notifications for changes to creative Status.",
2291 "id": "StopWatchingCreativeRequest",
2292 "properties": {},
2293 "type": "object"
2294 },
2910 "ServingRestriction": { 2295 "ServingRestriction": {
2911 "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately ser ves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request ,\nor the type of auction).", 2296 "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately ser ves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request ,\nor the type of auction).",
2912 "id": "ServingRestriction", 2297 "id": "ServingRestriction",
2913 "properties": { 2298 "properties": {
2914 "status": { 2299 "status": {
2915 "description": "The status of the creative in this context ( for example, it has been\nexplicitly disapproved or is pending review).", 2300 "description": "The status of the creative in this context ( for example, it has been\nexplicitly disapproved or is pending review).",
2916 "enum": [ 2301 "enum": [
2917 "STATUS_UNSPECIFIED", 2302 "STATUS_UNSPECIFIED",
2918 "DISAPPROVAL", 2303 "DISAPPROVAL",
2919 "PENDING_REVIEW" 2304 "PENDING_REVIEW"
(...skipping 134 matching lines...) Expand 10 before | Expand all | Expand 10 after
3054 }, 2439 },
3055 "type": "array" 2440 "type": "array"
3056 }, 2441 },
3057 "nextPageToken": { 2442 "nextPageToken": {
3058 "description": "A token to retrieve the next page of results .\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in th e subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod t o retrieve the next page of results.", 2443 "description": "A token to retrieve the next page of results .\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in th e subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod t o retrieve the next page of results.",
3059 "type": "string" 2444 "type": "string"
3060 } 2445 }
3061 }, 2446 },
3062 "type": "object" 2447 "type": "object"
3063 }, 2448 },
2449 "ListCreativesResponse": {
2450 "description": "A response for listing creatives.",
2451 "id": "ListCreativesResponse",
2452 "properties": {
2453 "nextPageToken": {
2454 "description": "A token to retrieve the next page of results .\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequ ent call to `ListCreatives` method to retrieve the next\npage of results.",
2455 "type": "string"
2456 },
2457 "creatives": {
2458 "description": "The list of creatives.",
2459 "items": {
2460 "$ref": "Creative"
2461 },
2462 "type": "array"
2463 }
2464 },
2465 "type": "object"
2466 },
3064 "HtmlContent": { 2467 "HtmlContent": {
3065 "description": "HTML content for a creative.", 2468 "description": "HTML content for a creative.",
3066 "id": "HtmlContent", 2469 "id": "HtmlContent",
3067 "properties": { 2470 "properties": {
2471 "snippet": {
2472 "description": "The HTML snippet that displays the ad when i nserted in the web page.",
2473 "type": "string"
2474 },
2475 "height": {
2476 "description": "The height of the HTML snippet in pixels.",
2477 "format": "int32",
2478 "type": "integer"
2479 },
3068 "width": { 2480 "width": {
3069 "description": "The width of the HTML snippet in pixels.", 2481 "description": "The width of the HTML snippet in pixels.",
3070 "format": "int32", 2482 "format": "int32",
3071 "type": "integer" 2483 "type": "integer"
3072 },
3073 "snippet": {
3074 "description": "The HTML snippet that displays the ad when i nserted in the web page.",
3075 "type": "string"
3076 },
3077 "height": {
3078 "description": "The height of the HTML snippet in pixels.",
3079 "format": "int32",
3080 "type": "integer"
3081 }
3082 },
3083 "type": "object"
3084 },
3085 "ListCreativesResponse": {
3086 "description": "A response for listing creatives.",
3087 "id": "ListCreativesResponse",
3088 "properties": {
3089 "creatives": {
3090 "description": "The list of creatives.",
3091 "items": {
3092 "$ref": "Creative"
3093 },
3094 "type": "array"
3095 },
3096 "nextPageToken": {
3097 "description": "A token to retrieve the next page of results .\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequ ent call to `ListCreatives` method to retrieve the next\npage of results.",
3098 "type": "string"
3099 } 2484 }
3100 }, 2485 },
3101 "type": "object" 2486 "type": "object"
3102 }, 2487 },
3103 "ListBidMetricsResponse": { 2488 "ListBidMetricsResponse": {
3104 "description": "Response message for listing the metrics that are me asured in number of bids.", 2489 "description": "Response message for listing the metrics that are me asured in number of bids.",
3105 "id": "ListBidMetricsResponse", 2490 "id": "ListBidMetricsResponse",
3106 "properties": { 2491 "properties": {
3107 "nextPageToken": { 2492 "nextPageToken": {
3108 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequ ent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the nex t page of results.", 2493 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequ ent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the nex t page of results.",
3109 "type": "string" 2494 "type": "string"
3110 }, 2495 },
3111 "bidMetricsRows": { 2496 "bidMetricsRows": {
3112 "description": "List of rows, each containing a set of bid m etrics.", 2497 "description": "List of rows, each containing a set of bid m etrics.",
3113 "items": { 2498 "items": {
3114 "$ref": "BidMetricsRow" 2499 "$ref": "BidMetricsRow"
3115 }, 2500 },
3116 "type": "array" 2501 "type": "array"
3117 } 2502 }
3118 }, 2503 },
3119 "type": "object" 2504 "type": "object"
3120 }, 2505 },
3121 "Reason": { 2506 "Reason": {
3122 "description": "A specific filtering status and how many times it oc curred.", 2507 "description": "A specific filtering status and how many times it oc curred.",
3123 "id": "Reason", 2508 "id": "Reason",
3124 "properties": { 2509 "properties": {
2510 "count": {
2511 "description": "The number of times the creative was filtere d for the status. The\ncount is aggregated across all publishers on the exchange .",
2512 "format": "int64",
2513 "type": "string"
2514 },
3125 "status": { 2515 "status": {
3126 "description": "The filtering status code. Please refer to t he\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionar ies/creative-status-codes.txt)\nfile for different statuses.", 2516 "description": "The filtering status code. Please refer to t he\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionar ies/creative-status-codes.txt)\nfile for different statuses.",
3127 "format": "int32", 2517 "format": "int32",
3128 "type": "integer" 2518 "type": "integer"
3129 },
3130 "count": {
3131 "description": "The number of times the creative was filtere d for the status. The\ncount is aggregated across all publishers on the exchange .",
3132 "format": "int64",
3133 "type": "string"
3134 } 2519 }
3135 }, 2520 },
3136 "type": "object" 2521 "type": "object"
3137 }, 2522 },
3138 "VideoContent": { 2523 "VideoContent": {
3139 "description": "Video content for a creative.", 2524 "description": "Video content for a creative.",
3140 "id": "VideoContent", 2525 "id": "VideoContent",
3141 "properties": { 2526 "properties": {
3142 "videoUrl": { 2527 "videoUrl": {
3143 "description": "The URL to fetch a video ad.", 2528 "description": "The URL to fetch a video ad.",
(...skipping 17 matching lines...) Expand all
3161 "description": "A token to retrieve the next page of results .\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequ ent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the nex t page of results.", 2546 "description": "A token to retrieve the next page of results .\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequ ent call to the\naccounts.filterSets.losingBids.list\nmethod to retrieve the nex t page of results.",
3162 "type": "string" 2547 "type": "string"
3163 } 2548 }
3164 }, 2549 },
3165 "type": "object" 2550 "type": "object"
3166 }, 2551 },
3167 "ListNonBillableWinningBidsResponse": { 2552 "ListNonBillableWinningBidsResponse": {
3168 "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.", 2553 "description": "Response message for listing all reasons for which a buyer was not billed for\na winning bid.",
3169 "id": "ListNonBillableWinningBidsResponse", 2554 "id": "ListNonBillableWinningBidsResponse",
3170 "properties": { 2555 "properties": {
2556 "nextPageToken": {
2557 "description": "A token to retrieve the next page of results .\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nme thod to retrieve the next page of results.",
2558 "type": "string"
2559 },
3171 "nonBillableWinningBidStatusRows": { 2560 "nonBillableWinningBidStatusRows": {
3172 "description": "List of rows, with counts of bids not billed aggregated by reason.", 2561 "description": "List of rows, with counts of bids not billed aggregated by reason.",
3173 "items": { 2562 "items": {
3174 "$ref": "NonBillableWinningBidStatusRow" 2563 "$ref": "NonBillableWinningBidStatusRow"
3175 }, 2564 },
3176 "type": "array" 2565 "type": "array"
3177 },
3178 "nextPageToken": {
3179 "description": "A token to retrieve the next page of results .\nPass this value in the\nListNonBillableWinningBidsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.nonBillableWinningBids.list\nme thod to retrieve the next page of results.",
3180 "type": "string"
3181 } 2566 }
3182 }, 2567 },
3183 "type": "object" 2568 "type": "object"
3184 }, 2569 },
3185 "ImpressionMetricsRow": { 2570 "ImpressionMetricsRow": {
3186 "description": "The set of metrics that are measured in numbers of i mpressions, representing\nhow many impressions with the specified dimension valu es were considered\neligible at each stage of the bidding funnel.", 2571 "description": "The set of metrics that are measured in numbers of i mpressions, representing\nhow many impressions with the specified dimension valu es were considered\neligible at each stage of the bidding funnel.",
3187 "id": "ImpressionMetricsRow", 2572 "id": "ImpressionMetricsRow",
3188 "properties": { 2573 "properties": {
3189 "rowDimensions": { 2574 "rowDimensions": {
3190 "$ref": "RowDimensions", 2575 "$ref": "RowDimensions",
(...skipping 14 matching lines...) Expand all
3205 "responsesWithBids": { 2590 "responsesWithBids": {
3206 "$ref": "MetricValue", 2591 "$ref": "MetricValue",
3207 "description": "The number of impressions for which Ad Excha nge received a response from\nthe buyer that contained at least one applicable b id." 2592 "description": "The number of impressions for which Ad Excha nge received a response from\nthe buyer that contained at least one applicable b id."
3208 }, 2593 },
3209 "successfulResponses": { 2594 "successfulResponses": {
3210 "$ref": "MetricValue", 2595 "$ref": "MetricValue",
3211 "description": "The number of impressions for which the buye r successfully sent a response\nto Ad Exchange." 2596 "description": "The number of impressions for which the buye r successfully sent a response\nto Ad Exchange."
3212 } 2597 }
3213 }, 2598 },
3214 "type": "object" 2599 "type": "object"
2600 },
2601 "AuctionContext": {
2602 "description": "@OutputOnly The auction type the restriction applies to.",
2603 "id": "AuctionContext",
2604 "properties": {
2605 "auctionTypes": {
2606 "description": "The auction types this restriction applies t o.",
2607 "enumDescriptions": [
2608 "The restriction applies to open auction.",
2609 "The restriction applies to direct deals."
2610 ],
2611 "items": {
2612 "enum": [
2613 "OPEN_AUCTION",
2614 "DIRECT_DEALS"
2615 ],
2616 "type": "string"
2617 },
2618 "type": "array"
2619 }
2620 },
2621 "type": "object"
2622 },
2623 "ListImpressionMetricsResponse": {
2624 "description": "Response message for listing the metrics that are me asured in number of\nimpressions.",
2625 "id": "ListImpressionMetricsResponse",
2626 "properties": {
2627 "impressionMetricsRows": {
2628 "description": "List of rows, each containing a set of impre ssion metrics.",
2629 "items": {
2630 "$ref": "ImpressionMetricsRow"
2631 },
2632 "type": "array"
2633 },
2634 "nextPageToken": {
2635 "description": "A token to retrieve the next page of results .\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to re trieve the next page of results.",
2636 "type": "string"
2637 }
2638 },
2639 "type": "object"
2640 },
2641 "BidMetricsRow": {
2642 "description": "The set of metrics that are measured in numbers of b ids, representing how\nmany bids with the specified dimension values were consid ered eligible at\neach stage of the bidding funnel;",
2643 "id": "BidMetricsRow",
2644 "properties": {
2645 "bidsInAuction": {
2646 "$ref": "MetricValue",
2647 "description": "The number of bids that were permitted to co mpete in the auction."
2648 },
2649 "rowDimensions": {
2650 "$ref": "RowDimensions",
2651 "description": "The values of all dimensions associated with metric values in this row."
2652 },
2653 "viewableImpressions": {
2654 "$ref": "MetricValue",
2655 "description": "The number of bids for which the correspondi ng impression was viewable (as\ndefined by Active View)."
2656 },
2657 "impressionsWon": {
2658 "$ref": "MetricValue",
2659 "description": "The number of bids that won an impression."
2660 },
2661 "measurableImpressions": {
2662 "$ref": "MetricValue",
2663 "description": "The number of bids for which the correspondi ng impression was measurable\nfor viewability (as defined by Active View)."
2664 },
2665 "bids": {
2666 "$ref": "MetricValue",
2667 "description": "The number of bids that Ad Exchange received from the buyer."
2668 },
2669 "billedImpressions": {
2670 "$ref": "MetricValue",
2671 "description": "The number of bids for which the buyer was b illed."
2672 }
2673 },
2674 "type": "object"
2675 },
2676 "ListBidResponseErrorsResponse": {
2677 "description": "Response message for listing all reasons that bid re sponses resulted in an\nerror.",
2678 "id": "ListBidResponseErrorsResponse",
2679 "properties": {
2680 "calloutStatusRows": {
2681 "description": "List of rows, with counts of bid responses a ggregated by callout status.",
2682 "items": {
2683 "$ref": "CalloutStatusRow"
2684 },
2685 "type": "array"
2686 },
2687 "nextPageToken": {
2688 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to re trieve the next page of results.",
2689 "type": "string"
2690 }
2691 },
2692 "type": "object"
2693 },
2694 "CreativeStatusRow": {
2695 "description": "The number of bids with the specified dimension valu es that did not win the\nauction (either were filtered pre-auction or lost the a uction), as described\nby the specified creative status.",
2696 "id": "CreativeStatusRow",
2697 "properties": {
2698 "rowDimensions": {
2699 "$ref": "RowDimensions",
2700 "description": "The values of all dimensions associated with metric values in this row."
2701 },
2702 "creativeStatusId": {
2703 "description": "The ID of the creative status.\nSee [creativ e-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative -status-codes).",
2704 "format": "int32",
2705 "type": "integer"
2706 },
2707 "bidCount": {
2708 "$ref": "MetricValue",
2709 "description": "The number of bids with the specified status ."
2710 }
2711 },
2712 "type": "object"
2713 },
2714 "RealtimeTimeRange": {
2715 "description": "An open-ended realtime time range specified by the s tart timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
2716 "id": "RealtimeTimeRange",
2717 "properties": {
2718 "startTimestamp": {
2719 "description": "The start timestamp of the real-time RTB met rics aggregation.",
2720 "format": "google-datetime",
2721 "type": "string"
2722 }
2723 },
2724 "type": "object"
2725 },
2726 "NonBillableWinningBidStatusRow": {
2727 "description": "The number of winning bids with the specified dimens ion values for which the\nbuyer was not billed, as described by the specified st atus.",
2728 "id": "NonBillableWinningBidStatusRow",
2729 "properties": {
2730 "bidCount": {
2731 "$ref": "MetricValue",
2732 "description": "The number of bids with the specified status ."
2733 },
2734 "status": {
2735 "description": "The status specifying why the winning bids w ere not billed.",
2736 "enum": [
2737 "STATUS_UNSPECIFIED",
2738 "AD_NOT_RENDERED",
2739 "INVALID_IMPRESSION"
2740 ],
2741 "enumDescriptions": [
2742 "A placeholder for an undefined status.\nThis value will never be returned in responses.",
2743 "The buyer was not billed because the ad was not rendere d by the\npublisher.",
2744 "The buyer was not billed because the impression won by the bid was\ndetermined to be invalid."
2745 ],
2746 "type": "string"
2747 },
2748 "rowDimensions": {
2749 "$ref": "RowDimensions",
2750 "description": "The values of all dimensions associated with metric values in this row."
2751 }
2752 },
2753 "type": "object"
2754 },
2755 "FilteredBidDetailRow": {
2756 "description": "The number of filtered bids with the specified dimen sion values, among those\nfiltered due to the requested filtering reason (i.e. c reative status), that\nhave the specified detail.",
2757 "id": "FilteredBidDetailRow",
2758 "properties": {
2759 "detailId": {
2760 "description": "The ID of the detail. The associated value c an be looked up in the\ndictionary file corresponding to the DetailType in the r esponse message.",
2761 "format": "int32",
2762 "type": "integer"
2763 },
2764 "bidCount": {
2765 "$ref": "MetricValue",
2766 "description": "The number of bids with the specified detail ."
2767 },
2768 "rowDimensions": {
2769 "$ref": "RowDimensions",
2770 "description": "The values of all dimensions associated with metric values in this row."
2771 }
2772 },
2773 "type": "object"
2774 },
2775 "AbsoluteDateRange": {
2776 "description": "An absolute date range, specified by its start date and end date.\nThe supported range of dates begins 30 days before today and ends today.\nValidity checked upon filter set creation. If a filter set with an abso lute\ndate range is run at a later date more than 30 days after start_date, it w ill\nfail.",
2777 "id": "AbsoluteDateRange",
2778 "properties": {
2779 "endDate": {
2780 "$ref": "Date",
2781 "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor afte r start_date."
2782 },
2783 "startDate": {
2784 "$ref": "Date",
2785 "description": "The start date of the range (inclusive).\nMu st be within the 30 days leading up to current date, and must be equal to\nor be fore end_date."
2786 }
2787 },
2788 "type": "object"
2789 },
2790 "AddDealAssociationRequest": {
2791 "description": "A request for associating a deal and a creative.",
2792 "id": "AddDealAssociationRequest",
2793 "properties": {
2794 "association": {
2795 "$ref": "CreativeDealAssociation",
2796 "description": "The association between a creative and a dea l that should be added."
2797 }
2798 },
2799 "type": "object"
2800 },
2801 "WatchCreativeRequest": {
2802 "description": "A request for watching changes to creative Status.",
2803 "id": "WatchCreativeRequest",
2804 "properties": {
2805 "topic": {
2806 "description": "The Pub/Sub topic to publish notifications t o.\nThis topic must already exist and must give permission to\nad-exchange-buysi de-reports@google.com to write to the topic.\nThis should be the full resource n ame in\n\"projects/{project_id}/topics/{topic_id}\" format.",
2807 "type": "string"
2808 }
2809 },
2810 "type": "object"
2811 },
2812 "TimeInterval": {
2813 "description": "An interval of time, with an absolute start and end. \nThis is included in the response, for several reasons:\n1) The request may hav e specified start or end times relative to the time the\n request was sent; th e response indicates the corresponding absolute time\n interval.\n2) The reque st may have specified an end time past the latest time for which\n data was av ailable (e.g. if requesting data for the today); the response\n indicates the latest time for which data was actually returned.\n3) The response data for a si ngle request may be broken down into multiple\n time intervals, if a time seri es was requested.",
2814 "id": "TimeInterval",
2815 "properties": {
2816 "startTime": {
2817 "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
2818 "format": "google-datetime",
2819 "type": "string"
2820 },
2821 "endTime": {
2822 "description": "The timestamp marking the end of the range ( exclusive) for which data is\nincluded.",
2823 "format": "google-datetime",
2824 "type": "string"
2825 }
2826 },
2827 "type": "object"
2828 },
2829 "FilteredBidCreativeRow": {
2830 "description": "The number of filtered bids with the specified dimen sion values that have the\nspecified creative.",
2831 "id": "FilteredBidCreativeRow",
2832 "properties": {
2833 "rowDimensions": {
2834 "$ref": "RowDimensions",
2835 "description": "The values of all dimensions associated with metric values in this row."
2836 },
2837 "bidCount": {
2838 "$ref": "MetricValue",
2839 "description": "The number of bids with the specified creati ve."
2840 },
2841 "creativeId": {
2842 "description": "The ID of the creative.",
2843 "type": "string"
2844 }
2845 },
2846 "type": "object"
2847 },
2848 "RelativeDateRange": {
2849 "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends tod ay.\nI.e. the limits for these values are:\noffset_days >= 0\nduration_days >= 1 \noffset_days + duration_days <= 30",
2850 "id": "RelativeDateRange",
2851 "properties": {
2852 "durationDays": {
2853 "description": "The number of days in the requested date ran ge. E.g. for a range spanning\ntoday, 1. For a range spanning the last 7 days, 7 .",
2854 "format": "int32",
2855 "type": "integer"
2856 },
2857 "offsetDays": {
2858 "description": "The end date of the filter set, specified as the number of days before\ntoday. E.g. for a range where the last date is today , 0.",
2859 "format": "int32",
2860 "type": "integer"
2861 }
2862 },
2863 "type": "object"
2864 },
2865 "NativeContent": {
2866 "description": "Native content for a creative.",
2867 "id": "NativeContent",
2868 "properties": {
2869 "advertiserName": {
2870 "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
2871 "type": "string"
2872 },
2873 "storeUrl": {
2874 "description": "The URL to the app store to purchase/downloa d the promoted app.",
2875 "type": "string"
2876 },
2877 "headline": {
2878 "description": "A short title for the ad.",
2879 "type": "string"
2880 },
2881 "appIcon": {
2882 "$ref": "Image",
2883 "description": "The app icon, for app download ads."
2884 },
2885 "callToAction": {
2886 "description": "A label for the button that the user is supp osed to click.",
2887 "type": "string"
2888 },
2889 "body": {
2890 "description": "A long description of the ad.",
2891 "type": "string"
2892 },
2893 "starRating": {
2894 "description": "The app rating in the app store. Must be in the range [0-5].",
2895 "format": "double",
2896 "type": "number"
2897 },
2898 "videoUrl": {
2899 "description": "The URL to fetch a native video ad.",
2900 "type": "string"
2901 },
2902 "clickLinkUrl": {
2903 "description": "The URL that the browser/SDK will load when the user clicks the ad.",
2904 "type": "string"
2905 },
2906 "logo": {
2907 "$ref": "Image",
2908 "description": "A smaller image, for the advertiser's logo."
2909 },
2910 "priceDisplayText": {
2911 "description": "The price of the promoted app including curr ency info.",
2912 "type": "string"
2913 },
2914 "clickTrackingUrl": {
2915 "description": "The URL to use for click tracking.",
2916 "type": "string"
2917 },
2918 "image": {
2919 "$ref": "Image",
2920 "description": "A large image."
2921 }
2922 },
2923 "type": "object"
2924 },
2925 "ListClientsResponse": {
2926 "id": "ListClientsResponse",
2927 "properties": {
2928 "clients": {
2929 "description": "The returned list of clients.",
2930 "items": {
2931 "$ref": "Client"
2932 },
2933 "type": "array"
2934 },
2935 "nextPageToken": {
2936 "description": "A token to retrieve the next page of results .\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results .",
2937 "type": "string"
2938 }
2939 },
2940 "type": "object"
2941 },
2942 "ListBidResponsesWithoutBidsResponse": {
2943 "description": "Response message for listing all reasons that bid re sponses were considered\nto have no applicable bids.",
2944 "id": "ListBidResponsesWithoutBidsResponse",
2945 "properties": {
2946 "nextPageToken": {
2947 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidResponsesWithoutBidsRequest.pageToken\nfield i n the subsequent call to the\naccounts.filterSets.bidResponsesWithoutBids.list\n method to retrieve the next page of results.",
2948 "type": "string"
2949 },
2950 "bidResponseWithoutBidsStatusRows": {
2951 "description": "List of rows, with counts of bid responses w ithout bids aggregated by\nstatus.",
2952 "items": {
2953 "$ref": "BidResponseWithoutBidsStatusRow"
2954 },
2955 "type": "array"
2956 }
2957 },
2958 "type": "object"
2959 },
2960 "ServingContext": {
2961 "description": "The serving context for this restriction.",
2962 "id": "ServingContext",
2963 "properties": {
2964 "all": {
2965 "description": "Matches all contexts.",
2966 "enum": [
2967 "SIMPLE_CONTEXT"
2968 ],
2969 "enumDescriptions": [
2970 "A simple context."
2971 ],
2972 "type": "string"
2973 },
2974 "appType": {
2975 "$ref": "AppContext",
2976 "description": "Matches impressions for a particular app typ e."
2977 },
2978 "securityType": {
2979 "$ref": "SecurityContext",
2980 "description": "Matches impressions for a particular securit y type."
2981 },
2982 "platform": {
2983 "$ref": "PlatformContext",
2984 "description": "Matches impressions coming from a particular platform."
2985 },
2986 "location": {
2987 "$ref": "LocationContext",
2988 "description": "Matches impressions coming from users *or* p ublishers in a specific\nlocation."
2989 },
2990 "auctionType": {
2991 "$ref": "AuctionContext",
2992 "description": "Matches impressions for a particular auction type."
2993 }
2994 },
2995 "type": "object"
2996 },
2997 "Image": {
2998 "description": "An image resource. You may provide a larger image th an was requested,\nso long as the aspect ratio is preserved.",
2999 "id": "Image",
3000 "properties": {
3001 "url": {
3002 "description": "The URL of the image.",
3003 "type": "string"
3004 },
3005 "height": {
3006 "description": "Image height in pixels.",
3007 "format": "int32",
3008 "type": "integer"
3009 },
3010 "width": {
3011 "description": "Image width in pixels.",
3012 "format": "int32",
3013 "type": "integer"
3014 }
3015 },
3016 "type": "object"
3017 },
3018 "ListFilterSetsResponse": {
3019 "description": "Response message for listing filter sets.",
3020 "id": "ListFilterSetsResponse",
3021 "properties": {
3022 "filterSets": {
3023 "description": "The filter sets belonging to the buyer.",
3024 "items": {
3025 "$ref": "FilterSet"
3026 },
3027 "type": "array"
3028 },
3029 "nextPageToken": {
3030 "description": "A token to retrieve the next page of results .\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequ ent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of r esults.",
3031 "type": "string"
3032 }
3033 },
3034 "type": "object"
3035 },
3036 "BidResponseWithoutBidsStatusRow": {
3037 "description": "The number of impressions with the specified dimensi on values that were\nconsidered to have no applicable bids, as described by the specified status.",
3038 "id": "BidResponseWithoutBidsStatusRow",
3039 "properties": {
3040 "impressionCount": {
3041 "$ref": "MetricValue",
3042 "description": "The number of impressions for which there wa s a bid response with the\nspecified status."
3043 },
3044 "status": {
3045 "description": "The status specifying why the bid responses were considered to have no\napplicable bids.",
3046 "enum": [
3047 "STATUS_UNSPECIFIED",
3048 "RESPONSES_WITHOUT_BIDS",
3049 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
3050 "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
3051 ],
3052 "enumDescriptions": [
3053 "A placeholder for an undefined status.\nThis value will never be returned in responses.",
3054 "The response had no bids.",
3055 "The response had no bids for the specified account, tho ugh it may have\nincluded bids on behalf of other accounts.",
3056 "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs."
3057 ],
3058 "type": "string"
3059 },
3060 "rowDimensions": {
3061 "$ref": "RowDimensions",
3062 "description": "The values of all dimensions associated with metric values in this row."
3063 }
3064 },
3065 "type": "object"
3066 },
3067 "ClientUserInvitation": {
3068 "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified. ",
3069 "id": "ClientUserInvitation",
3070 "properties": {
3071 "invitationId": {
3072 "description": "The unique numerical ID of the invitation th at is sent to the user.\nThe value of this field is ignored in create operations .",
3073 "format": "int64",
3074 "type": "string"
3075 },
3076 "email": {
3077 "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each spons or\nbuyer.",
3078 "type": "string"
3079 },
3080 "clientAccountId": {
3081 "description": "Numerical account ID of the client buyer\nth at the invited user is associated with.\nThe value of this field is ignored in c reate operations.",
3082 "format": "int64",
3083 "type": "string"
3084 }
3085 },
3086 "type": "object"
3087 },
3088 "ListClientUserInvitationsResponse": {
3089 "id": "ListClientUserInvitationsResponse",
3090 "properties": {
3091 "nextPageToken": {
3092 "description": "A token to retrieve the next page of results .\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the nex t\npage of results.",
3093 "type": "string"
3094 },
3095 "invitations": {
3096 "description": "The returned list of client users.",
3097 "items": {
3098 "$ref": "ClientUserInvitation"
3099 },
3100 "type": "array"
3101 }
3102 },
3103 "type": "object"
3104 },
3105 "ListClientUsersResponse": {
3106 "id": "ListClientUsersResponse",
3107 "properties": {
3108 "nextPageToken": {
3109 "description": "A token to retrieve the next page of results .\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subseq uent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.",
3110 "type": "string"
3111 },
3112 "users": {
3113 "description": "The returned list of client users.",
3114 "items": {
3115 "$ref": "ClientUser"
3116 },
3117 "type": "array"
3118 }
3119 },
3120 "type": "object"
3121 },
3122 "ListCreativeStatusBreakdownByDetailResponse": {
3123 "description": "Response message for listing all details associated with a given filtered bid\nreason.",
3124 "id": "ListCreativeStatusBreakdownByDetailResponse",
3125 "properties": {
3126 "nextPageToken": {
3127 "description": "A token to retrieve the next page of results .\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\ nfield in the subsequent call to the\naccounts.filterSets.filteredBids.details.l ist\nmethod to retrieve the next page of results.",
3128 "type": "string"
3129 },
3130 "filteredBidDetailRows": {
3131 "description": "List of rows, with counts of bids with a giv en creative status aggregated\nby detail.",
3132 "items": {
3133 "$ref": "FilteredBidDetailRow"
3134 },
3135 "type": "array"
3136 },
3137 "detailType": {
3138 "description": "The type of detail that the detail IDs repre sent.",
3139 "enum": [
3140 "DETAIL_TYPE_UNSPECIFIED",
3141 "CREATIVE_ATTRIBUTE",
3142 "VENDOR",
3143 "SENSITIVE_CATEGORY",
3144 "PRODUCT_CATEGORY",
3145 "DISAPPROVAL_REASON"
3146 ],
3147 "enumDescriptions": [
3148 "A placeholder for an undefined status.\nThis value will never be returned in responses.",
3149 "Indicates that the detail ID refers to a creative attri bute; see\n[publisher-excludable-creative-attributes](https://developers.google. com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).",
3150 "Indicates that the detail ID refers to a vendor; see\n[ vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).",
3151 "Indicates that the detail ID refers to a sensitive cate gory; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/r tb/downloads/ad-sensitive-categories).",
3152 "Indicates that the detail ID refers to a product catego ry; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/d ownloads/ad-product-categories).",
3153 "Indicates that the detail ID refers to a disapproval re ason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://devel opers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)."
3154 ],
3155 "type": "string"
3156 }
3157 },
3158 "type": "object"
3159 },
3160 "LocationContext": {
3161 "description": "@OutputOnly The Geo criteria the restriction applies to.",
3162 "id": "LocationContext",
3163 "properties": {
3164 "geoCriteriaIds": {
3165 "description": "IDs representing the geo location for this c ontext.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx -rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
3166 "items": {
3167 "format": "int32",
3168 "type": "integer"
3169 },
3170 "type": "array"
3171 }
3172 },
3173 "type": "object"
3174 },
3175 "PlatformContext": {
3176 "description": "@OutputOnly The type of platform the restriction app lies to.",
3177 "id": "PlatformContext",
3178 "properties": {
3179 "platforms": {
3180 "description": "The platforms this restriction applies to.",
3181 "enumDescriptions": [
3182 "Desktop platform.",
3183 "Android platform.",
3184 "iOS platform."
3185 ],
3186 "items": {
3187 "enum": [
3188 "DESKTOP",
3189 "ANDROID",
3190 "IOS"
3191 ],
3192 "type": "string"
3193 },
3194 "type": "array"
3195 }
3196 },
3197 "type": "object"
3198 },
3199 "MetricValue": {
3200 "description": "A metric value, with an expected value and a varianc e; represents a count\nthat may be either exact or estimated (i.e. when sampled) .",
3201 "id": "MetricValue",
3202 "properties": {
3203 "variance": {
3204 "description": "The variance (i.e. square of the standard de viation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formul a, where Z is the standard constant that depends on the\ndesired size of the con fidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n margin OfError = 100 * Z * sqrt(variance) / value",
3205 "format": "int64",
3206 "type": "string"
3207 },
3208 "value": {
3209 "description": "The expected value of the metric.",
3210 "format": "int64",
3211 "type": "string"
3212 }
3213 },
3214 "type": "object"
3215 } 3215 }
3216 }, 3216 },
3217 "servicePath": "", 3217 "servicePath": "",
3218 "title": "Ad Exchange Buyer API II", 3218 "title": "Ad Exchange Buyer API II",
3219 "version": "v2beta1" 3219 "version": "v2beta1"
3220 } 3220 }
OLDNEW
« no previous file with comments | « discovery/googleapis/youtubereporting__v1.json ('k') | discovery/googleapis_beta/appengine__v1beta.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698