OLD | NEW |
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/g
uides/client-access/", | 17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/g
uides/client-access/", |
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 "uploadType": { | 28 "quotaUser": { |
29 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 29 "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.", |
30 "location": "query", | 30 "location": "query", |
31 "type": "string" | 31 "type": "string" |
32 }, | 32 }, |
| 33 "pp": { |
| 34 "default": "true", |
| 35 "description": "Pretty-print response.", |
| 36 "location": "query", |
| 37 "type": "boolean" |
| 38 }, |
| 39 "bearer_token": { |
| 40 "description": "OAuth bearer token.", |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
| 44 "oauth_token": { |
| 45 "description": "OAuth 2.0 token for the current user.", |
| 46 "location": "query", |
| 47 "type": "string" |
| 48 }, |
| 49 "upload_protocol": { |
| 50 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 51 "location": "query", |
| 52 "type": "string" |
| 53 }, |
| 54 "prettyPrint": { |
| 55 "default": "true", |
| 56 "description": "Returns response with indentations and line breaks."
, |
| 57 "location": "query", |
| 58 "type": "boolean" |
| 59 }, |
33 "fields": { | 60 "fields": { |
34 "description": "Selector specifying which fields to include in a par
tial response.", | 61 "description": "Selector specifying which fields to include in a par
tial response.", |
35 "location": "query", | 62 "location": "query", |
36 "type": "string" | 63 "type": "string" |
37 }, | 64 }, |
| 65 "uploadType": { |
| 66 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 67 "location": "query", |
| 68 "type": "string" |
| 69 }, |
38 "$.xgafv": { | 70 "$.xgafv": { |
39 "description": "V1 error format.", | 71 "description": "V1 error format.", |
40 "enum": [ | 72 "enum": [ |
41 "1", | 73 "1", |
42 "2" | 74 "2" |
43 ], | 75 ], |
44 "enumDescriptions": [ | 76 "enumDescriptions": [ |
45 "v1 error format", | 77 "v1 error format", |
46 "v2 error format" | 78 "v2 error format" |
47 ], | 79 ], |
(...skipping 23 matching lines...) Expand all Loading... |
71 }, | 103 }, |
72 "access_token": { | 104 "access_token": { |
73 "description": "OAuth access token.", | 105 "description": "OAuth access token.", |
74 "location": "query", | 106 "location": "query", |
75 "type": "string" | 107 "type": "string" |
76 }, | 108 }, |
77 "key": { | 109 "key": { |
78 "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.", | 110 "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.", |
79 "location": "query", | 111 "location": "query", |
80 "type": "string" | 112 "type": "string" |
81 }, | |
82 "quotaUser": { | |
83 "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.", | |
84 "location": "query", | |
85 "type": "string" | |
86 }, | |
87 "pp": { | |
88 "default": "true", | |
89 "description": "Pretty-print response.", | |
90 "location": "query", | |
91 "type": "boolean" | |
92 }, | |
93 "oauth_token": { | |
94 "description": "OAuth 2.0 token for the current user.", | |
95 "location": "query", | |
96 "type": "string" | |
97 }, | |
98 "bearer_token": { | |
99 "description": "OAuth bearer token.", | |
100 "location": "query", | |
101 "type": "string" | |
102 }, | |
103 "upload_protocol": { | |
104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
105 "location": "query", | |
106 "type": "string" | |
107 }, | |
108 "prettyPrint": { | |
109 "default": "true", | |
110 "description": "Returns response with indentations and line breaks."
, | |
111 "location": "query", | |
112 "type": "boolean" | |
113 } | 113 } |
114 }, | 114 }, |
115 "protocol": "rest", | 115 "protocol": "rest", |
116 "resources": { | 116 "resources": { |
117 "accounts": { | 117 "accounts": { |
118 "resources": { | 118 "resources": { |
119 "clients": { | 119 "clients": { |
120 "methods": { | 120 "methods": { |
121 "create": { | |
122 "description": "Creates a new client buyer.", | |
123 "httpMethod": "POST", | |
124 "id": "adexchangebuyer2.accounts.clients.create", | |
125 "parameterOrder": [ | |
126 "accountId" | |
127 ], | |
128 "parameters": { | |
129 "accountId": { | |
130 "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)", | |
131 "format": "int64", | |
132 "location": "path", | |
133 "required": true, | |
134 "type": "string" | |
135 } | |
136 }, | |
137 "path": "v2beta1/accounts/{accountId}/clients", | |
138 "request": { | |
139 "$ref": "Client" | |
140 }, | |
141 "response": { | |
142 "$ref": "Client" | |
143 }, | |
144 "scopes": [ | |
145 "https://www.googleapis.com/auth/adexchange.buye
r" | |
146 ] | |
147 }, | |
148 "get": { | 121 "get": { |
149 "description": "Gets a client buyer with a given cli
ent account ID.", | 122 "description": "Gets a client buyer with a given cli
ent account ID.", |
150 "httpMethod": "GET", | 123 "httpMethod": "GET", |
151 "id": "adexchangebuyer2.accounts.clients.get", | 124 "id": "adexchangebuyer2.accounts.clients.get", |
152 "parameterOrder": [ | 125 "parameterOrder": [ |
153 "accountId", | 126 "accountId", |
154 "clientAccountId" | 127 "clientAccountId" |
155 ], | 128 ], |
156 "parameters": { | 129 "parameters": { |
157 "accountId": { | 130 "accountId": { |
(...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
239 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", | 212 "path": "v2beta1/accounts/{accountId}/clients/{clien
tAccountId}", |
240 "request": { | 213 "request": { |
241 "$ref": "Client" | 214 "$ref": "Client" |
242 }, | 215 }, |
243 "response": { | 216 "response": { |
244 "$ref": "Client" | 217 "$ref": "Client" |
245 }, | 218 }, |
246 "scopes": [ | 219 "scopes": [ |
247 "https://www.googleapis.com/auth/adexchange.buye
r" | 220 "https://www.googleapis.com/auth/adexchange.buye
r" |
248 ] | 221 ] |
| 222 }, |
| 223 "create": { |
| 224 "description": "Creates a new client buyer.", |
| 225 "httpMethod": "POST", |
| 226 "id": "adexchangebuyer2.accounts.clients.create", |
| 227 "parameterOrder": [ |
| 228 "accountId" |
| 229 ], |
| 230 "parameters": { |
| 231 "accountId": { |
| 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)", |
| 233 "format": "int64", |
| 234 "location": "path", |
| 235 "required": true, |
| 236 "type": "string" |
| 237 } |
| 238 }, |
| 239 "path": "v2beta1/accounts/{accountId}/clients", |
| 240 "request": { |
| 241 "$ref": "Client" |
| 242 }, |
| 243 "response": { |
| 244 "$ref": "Client" |
| 245 }, |
| 246 "scopes": [ |
| 247 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 248 ] |
249 } | 249 } |
250 }, | 250 }, |
251 "resources": { | 251 "resources": { |
252 "invitations": { | 252 "invitations": { |
253 "methods": { | 253 "methods": { |
254 "get": { | 254 "get": { |
255 "description": "Retrieves an existing client
user invitation.", | 255 "description": "Retrieves an existing client
user invitation.", |
256 "httpMethod": "GET", | 256 "httpMethod": "GET", |
257 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", | 257 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", |
258 "parameterOrder": [ | 258 "parameterOrder": [ |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
293 }, | 293 }, |
294 "list": { | 294 "list": { |
295 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", | 295 "description": "Lists all the client users i
nvitations for a client\nwith a given account ID.", |
296 "httpMethod": "GET", | 296 "httpMethod": "GET", |
297 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", | 297 "id": "adexchangebuyer2.accounts.clients.inv
itations.list", |
298 "parameterOrder": [ | 298 "parameterOrder": [ |
299 "accountId", | 299 "accountId", |
300 "clientAccountId" | 300 "clientAccountId" |
301 ], | 301 ], |
302 "parameters": { | 302 "parameters": { |
| 303 "pageToken": { |
| 304 "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.", |
| 305 "location": "query", |
| 306 "type": "string" |
| 307 }, |
303 "accountId": { | 308 "accountId": { |
304 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 309 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
305 "format": "int64", | 310 "format": "int64", |
306 "location": "path", | 311 "location": "path", |
307 "required": true, | 312 "required": true, |
308 "type": "string" | 313 "type": "string" |
309 }, | 314 }, |
310 "pageSize": { | 315 "pageSize": { |
311 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", | 316 "description": "Requested page size.
Server may return fewer clients than requested.\nIf unspecified, server will pi
ck an appropriate default.", |
312 "format": "int32", | 317 "format": "int32", |
313 "location": "query", | 318 "location": "query", |
314 "type": "integer" | 319 "type": "integer" |
315 }, | 320 }, |
316 "clientAccountId": { | 321 "clientAccountId": { |
317 "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.", | 322 "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.", |
318 "location": "path", | 323 "location": "path", |
319 "required": true, | 324 "required": true, |
320 "type": "string" | 325 "type": "string" |
321 }, | |
322 "pageToken": { | |
323 "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.", | |
324 "location": "query", | |
325 "type": "string" | |
326 } | 326 } |
327 }, | 327 }, |
328 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 328 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
329 "response": { | 329 "response": { |
330 "$ref": "ListClientUserInvitationsRespon
se" | 330 "$ref": "ListClientUserInvitationsRespon
se" |
331 }, | 331 }, |
332 "scopes": [ | 332 "scopes": [ |
333 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 333 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
334 ] | 334 ] |
335 }, | 335 }, |
336 "create": { | 336 "create": { |
337 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", | 337 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", |
338 "httpMethod": "POST", | 338 "httpMethod": "POST", |
339 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", | 339 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", |
340 "parameterOrder": [ | 340 "parameterOrder": [ |
341 "accountId", | 341 "accountId", |
342 "clientAccountId" | 342 "clientAccountId" |
343 ], | 343 ], |
344 "parameters": { | 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 }, |
345 "clientAccountId": { | 352 "clientAccountId": { |
346 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", | 353 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", |
347 "format": "int64", | 354 "format": "int64", |
348 "location": "path", | 355 "location": "path", |
349 "required": true, | 356 "required": true, |
350 "type": "string" | |
351 }, | |
352 "accountId": { | |
353 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
354 "format": "int64", | |
355 "location": "path", | |
356 "required": true, | |
357 "type": "string" | 357 "type": "string" |
358 } | 358 } |
359 }, | 359 }, |
360 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 360 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
361 "request": { | 361 "request": { |
362 "$ref": "ClientUserInvitation" | 362 "$ref": "ClientUserInvitation" |
363 }, | 363 }, |
364 "response": { | 364 "response": { |
365 "$ref": "ClientUserInvitation" | 365 "$ref": "ClientUserInvitation" |
366 }, | 366 }, |
367 "scopes": [ | 367 "scopes": [ |
368 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 368 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
369 ] | 369 ] |
370 } | 370 } |
371 } | 371 } |
372 }, | 372 }, |
373 "users": { | 373 "users": { |
374 "methods": { | 374 "methods": { |
375 "list": { | 375 "list": { |
376 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", | 376 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", |
377 "httpMethod": "GET", | 377 "httpMethod": "GET", |
378 "id": "adexchangebuyer2.accounts.clients.use
rs.list", | 378 "id": "adexchangebuyer2.accounts.clients.use
rs.list", |
379 "parameterOrder": [ | 379 "parameterOrder": [ |
380 "accountId", | 380 "accountId", |
381 "clientAccountId" | 381 "clientAccountId" |
382 ], | 382 ], |
383 "parameters": { | 383 "parameters": { |
384 "clientAccountId": { | |
385 "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.", | |
386 "location": "path", | |
387 "required": true, | |
388 "type": "string" | |
389 }, | |
390 "pageToken": { | 384 "pageToken": { |
391 "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.", | 385 "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.", |
392 "location": "query", | 386 "location": "query", |
393 "type": "string" | 387 "type": "string" |
394 }, | 388 }, |
395 "accountId": { | 389 "accountId": { |
396 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", | 390 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", |
397 "format": "int64", | 391 "format": "int64", |
398 "location": "path", | 392 "location": "path", |
399 "required": true, | 393 "required": true, |
400 "type": "string" | 394 "type": "string" |
401 }, | 395 }, |
402 "pageSize": { | 396 "pageSize": { |
403 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", | 397 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", |
404 "format": "int32", | 398 "format": "int32", |
405 "location": "query", | 399 "location": "query", |
406 "type": "integer" | 400 "type": "integer" |
| 401 }, |
| 402 "clientAccountId": { |
| 403 "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.", |
| 404 "location": "path", |
| 405 "required": true, |
| 406 "type": "string" |
407 } | 407 } |
408 }, | 408 }, |
409 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", | 409 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", |
410 "response": { | 410 "response": { |
411 "$ref": "ListClientUsersResponse" | 411 "$ref": "ListClientUsersResponse" |
412 }, | 412 }, |
413 "scopes": [ | 413 "scopes": [ |
414 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 414 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
415 ] | 415 ] |
416 }, | 416 }, |
417 "get": { | 417 "get": { |
418 "description": "Retrieves an existing client
user.", | 418 "description": "Retrieves an existing client
user.", |
419 "httpMethod": "GET", | 419 "httpMethod": "GET", |
420 "id": "adexchangebuyer2.accounts.clients.use
rs.get", | 420 "id": "adexchangebuyer2.accounts.clients.use
rs.get", |
421 "parameterOrder": [ | 421 "parameterOrder": [ |
422 "accountId", | 422 "accountId", |
423 "clientAccountId", | 423 "clientAccountId", |
424 "userId" | 424 "userId" |
425 ], | 425 ], |
426 "parameters": { | 426 "parameters": { |
427 "accountId": { | |
428 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
429 "format": "int64", | |
430 "location": "path", | |
431 "required": true, | |
432 "type": "string" | |
433 }, | |
434 "clientAccountId": { | 427 "clientAccountId": { |
435 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", | 428 "description": "Numerical account ID
of the client buyer\nthat the user to be retrieved is associated with. (require
d)", |
436 "format": "int64", | 429 "format": "int64", |
437 "location": "path", | 430 "location": "path", |
438 "required": true, | 431 "required": true, |
439 "type": "string" | 432 "type": "string" |
440 }, | 433 }, |
441 "userId": { | 434 "userId": { |
442 "description": "Numerical identifier
of the user to retrieve. (required)", | 435 "description": "Numerical identifier
of the user to retrieve. (required)", |
443 "format": "int64", | 436 "format": "int64", |
444 "location": "path", | 437 "location": "path", |
445 "required": true, | 438 "required": true, |
| 439 "type": "string" |
| 440 }, |
| 441 "accountId": { |
| 442 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 443 "format": "int64", |
| 444 "location": "path", |
| 445 "required": true, |
446 "type": "string" | 446 "type": "string" |
447 } | 447 } |
448 }, | 448 }, |
449 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | 449 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
450 "response": { | 450 "response": { |
451 "$ref": "ClientUser" | 451 "$ref": "ClientUser" |
452 }, | 452 }, |
453 "scopes": [ | 453 "scopes": [ |
454 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 454 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
455 ] | 455 ] |
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
496 "scopes": [ | 496 "scopes": [ |
497 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 497 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
498 ] | 498 ] |
499 } | 499 } |
500 } | 500 } |
501 } | 501 } |
502 } | 502 } |
503 }, | 503 }, |
504 "creatives": { | 504 "creatives": { |
505 "methods": { | 505 "methods": { |
506 "create": { | |
507 "description": "Creates a creative.", | |
508 "httpMethod": "POST", | |
509 "id": "adexchangebuyer2.accounts.creatives.create", | |
510 "parameterOrder": [ | |
511 "accountId" | |
512 ], | |
513 "parameters": { | |
514 "accountId": { | |
515 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", | |
516 "location": "path", | |
517 "required": true, | |
518 "type": "string" | |
519 }, | |
520 "duplicateIdMode": { | |
521 "description": "Indicates if multiple creati
ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", | |
522 "enum": [ | |
523 "NO_DUPLICATES", | |
524 "FORCE_ENABLE_DUPLICATE_IDS" | |
525 ], | |
526 "location": "query", | |
527 "type": "string" | |
528 } | |
529 }, | |
530 "path": "v2beta1/accounts/{accountId}/creatives", | |
531 "request": { | |
532 "$ref": "Creative" | |
533 }, | |
534 "response": { | |
535 "$ref": "Creative" | |
536 }, | |
537 "scopes": [ | |
538 "https://www.googleapis.com/auth/adexchange.buye
r" | |
539 ] | |
540 }, | |
541 "stopWatching": { | |
542 "description": "Stops watching a creative. Will stop
push notifications being sent to the\ntopics when the creative changes status."
, | |
543 "httpMethod": "POST", | |
544 "id": "adexchangebuyer2.accounts.creatives.stopWatch
ing", | |
545 "parameterOrder": [ | |
546 "accountId", | |
547 "creativeId" | |
548 ], | |
549 "parameters": { | |
550 "accountId": { | |
551 "description": "The account of the creative
to stop notifications for.", | |
552 "location": "path", | |
553 "required": true, | |
554 "type": "string" | |
555 }, | |
556 "creativeId": { | |
557 "description": "The creative ID of the creat
ive to stop notifications for.\nSpecify \"-\" to specify stopping account level
notifications.", | |
558 "location": "path", | |
559 "required": true, | |
560 "type": "string" | |
561 } | |
562 }, | |
563 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:stopWatching", | |
564 "request": { | |
565 "$ref": "StopWatchingCreativeRequest" | |
566 }, | |
567 "response": { | |
568 "$ref": "Empty" | |
569 }, | |
570 "scopes": [ | |
571 "https://www.googleapis.com/auth/adexchange.buye
r" | |
572 ] | |
573 }, | |
574 "get": { | 506 "get": { |
575 "description": "Gets a creative.", | 507 "description": "Gets a creative.", |
576 "httpMethod": "GET", | 508 "httpMethod": "GET", |
577 "id": "adexchangebuyer2.accounts.creatives.get", | 509 "id": "adexchangebuyer2.accounts.creatives.get", |
578 "parameterOrder": [ | 510 "parameterOrder": [ |
579 "accountId", | 511 "accountId", |
580 "creativeId" | 512 "creativeId" |
581 ], | 513 ], |
582 "parameters": { | 514 "parameters": { |
583 "accountId": { | 515 "accountId": { |
(...skipping 114 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
698 "type": "string" | 630 "type": "string" |
699 } | 631 } |
700 }, | 632 }, |
701 "path": "v2beta1/accounts/{accountId}/creatives", | 633 "path": "v2beta1/accounts/{accountId}/creatives", |
702 "response": { | 634 "response": { |
703 "$ref": "ListCreativesResponse" | 635 "$ref": "ListCreativesResponse" |
704 }, | 636 }, |
705 "scopes": [ | 637 "scopes": [ |
706 "https://www.googleapis.com/auth/adexchange.buye
r" | 638 "https://www.googleapis.com/auth/adexchange.buye
r" |
707 ] | 639 ] |
| 640 }, |
| 641 "create": { |
| 642 "description": "Creates a creative.", |
| 643 "httpMethod": "POST", |
| 644 "id": "adexchangebuyer2.accounts.creatives.create", |
| 645 "parameterOrder": [ |
| 646 "accountId" |
| 647 ], |
| 648 "parameters": { |
| 649 "accountId": { |
| 650 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", |
| 651 "location": "path", |
| 652 "required": true, |
| 653 "type": "string" |
| 654 }, |
| 655 "duplicateIdMode": { |
| 656 "description": "Indicates if multiple creati
ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", |
| 657 "enum": [ |
| 658 "NO_DUPLICATES", |
| 659 "FORCE_ENABLE_DUPLICATE_IDS" |
| 660 ], |
| 661 "location": "query", |
| 662 "type": "string" |
| 663 } |
| 664 }, |
| 665 "path": "v2beta1/accounts/{accountId}/creatives", |
| 666 "request": { |
| 667 "$ref": "Creative" |
| 668 }, |
| 669 "response": { |
| 670 "$ref": "Creative" |
| 671 }, |
| 672 "scopes": [ |
| 673 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 674 ] |
| 675 }, |
| 676 "stopWatching": { |
| 677 "description": "Stops watching a creative. Will stop
push notifications being sent to the\ntopics when the creative changes status."
, |
| 678 "httpMethod": "POST", |
| 679 "id": "adexchangebuyer2.accounts.creatives.stopWatch
ing", |
| 680 "parameterOrder": [ |
| 681 "accountId", |
| 682 "creativeId" |
| 683 ], |
| 684 "parameters": { |
| 685 "accountId": { |
| 686 "description": "The account of the creative
to stop notifications for.", |
| 687 "location": "path", |
| 688 "required": true, |
| 689 "type": "string" |
| 690 }, |
| 691 "creativeId": { |
| 692 "description": "The creative ID of the creat
ive to stop notifications for.\nSpecify \"-\" to specify stopping account level
notifications.", |
| 693 "location": "path", |
| 694 "required": true, |
| 695 "type": "string" |
| 696 } |
| 697 }, |
| 698 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:stopWatching", |
| 699 "request": { |
| 700 "$ref": "StopWatchingCreativeRequest" |
| 701 }, |
| 702 "response": { |
| 703 "$ref": "Empty" |
| 704 }, |
| 705 "scopes": [ |
| 706 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 707 ] |
708 } | 708 } |
709 }, | 709 }, |
710 "resources": { | 710 "resources": { |
711 "dealAssociations": { | 711 "dealAssociations": { |
712 "methods": { | 712 "methods": { |
713 "list": { | 713 "list": { |
714 "description": "List all creative-deal assoc
iations.", | 714 "description": "List all creative-deal assoc
iations.", |
715 "httpMethod": "GET", | 715 "httpMethod": "GET", |
716 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.list", | 716 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.list", |
717 "parameterOrder": [ | 717 "parameterOrder": [ |
(...skipping 104 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
822 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 822 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
823 ] | 823 ] |
824 } | 824 } |
825 } | 825 } |
826 } | 826 } |
827 } | 827 } |
828 } | 828 } |
829 } | 829 } |
830 } | 830 } |
831 }, | 831 }, |
832 "revision": "20170323", | 832 "revision": "20170413", |
833 "rootUrl": "https://adexchangebuyer.googleapis.com/", | 833 "rootUrl": "https://adexchangebuyer.googleapis.com/", |
834 "schemas": { | 834 "schemas": { |
| 835 "Empty": { |
| 836 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 837 "id": "Empty", |
| 838 "properties": {}, |
| 839 "type": "object" |
| 840 }, |
| 841 "WatchCreativeRequest": { |
| 842 "description": "A request for watching changes to creative Status.", |
| 843 "id": "WatchCreativeRequest", |
| 844 "properties": { |
| 845 "topic": { |
| 846 "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.", |
| 847 "type": "string" |
| 848 } |
| 849 }, |
| 850 "type": "object" |
| 851 }, |
| 852 "AppContext": { |
| 853 "description": "@OutputOnly The app type the restriction applies to
for mobile device.", |
| 854 "id": "AppContext", |
| 855 "properties": { |
| 856 "appTypes": { |
| 857 "description": "The app types this restriction applies to.", |
| 858 "enumDescriptions": [ |
| 859 "Native app context.", |
| 860 "Mobile web app context." |
| 861 ], |
| 862 "items": { |
| 863 "enum": [ |
| 864 "NATIVE", |
| 865 "WEB" |
| 866 ], |
| 867 "type": "string" |
| 868 }, |
| 869 "type": "array" |
| 870 } |
| 871 }, |
| 872 "type": "object" |
| 873 }, |
| 874 "NativeContent": { |
| 875 "description": "Native content for a creative.", |
| 876 "id": "NativeContent", |
| 877 "properties": { |
| 878 "videoUrl": { |
| 879 "description": "The URL to fetch a native video ad.", |
| 880 "type": "string" |
| 881 }, |
| 882 "logo": { |
| 883 "$ref": "Image", |
| 884 "description": "A smaller image, for the advertiser's logo." |
| 885 }, |
| 886 "clickLinkUrl": { |
| 887 "description": "The URL that the browser/SDK will load when
the user clicks the ad.", |
| 888 "type": "string" |
| 889 }, |
| 890 "priceDisplayText": { |
| 891 "description": "The price of the promoted app including curr
ency info.", |
| 892 "type": "string" |
| 893 }, |
| 894 "clickTrackingUrl": { |
| 895 "description": "The URL to use for click tracking.", |
| 896 "type": "string" |
| 897 }, |
| 898 "image": { |
| 899 "$ref": "Image", |
| 900 "description": "A large image." |
| 901 }, |
| 902 "advertiserName": { |
| 903 "description": "The name of the advertiser or sponsor, to be
displayed in the ad creative.", |
| 904 "type": "string" |
| 905 }, |
| 906 "storeUrl": { |
| 907 "description": "The URL to the app store to purchase/downloa
d the promoted app.", |
| 908 "type": "string" |
| 909 }, |
| 910 "headline": { |
| 911 "description": "A short title for the ad.", |
| 912 "type": "string" |
| 913 }, |
| 914 "appIcon": { |
| 915 "$ref": "Image", |
| 916 "description": "The app icon, for app download ads." |
| 917 }, |
| 918 "callToAction": { |
| 919 "description": "A label for the button that the user is supp
osed to click.", |
| 920 "type": "string" |
| 921 }, |
| 922 "body": { |
| 923 "description": "A long description of the ad.", |
| 924 "type": "string" |
| 925 }, |
| 926 "starRating": { |
| 927 "description": "The app rating in the app store. Must be in
the range [0-5].", |
| 928 "format": "double", |
| 929 "type": "number" |
| 930 } |
| 931 }, |
| 932 "type": "object" |
| 933 }, |
| 934 "ListClientsResponse": { |
| 935 "id": "ListClientsResponse", |
| 936 "properties": { |
| 937 "nextPageToken": { |
| 938 "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
.", |
| 939 "type": "string" |
| 940 }, |
| 941 "clients": { |
| 942 "description": "The returned list of clients.", |
| 943 "items": { |
| 944 "$ref": "Client" |
| 945 }, |
| 946 "type": "array" |
| 947 } |
| 948 }, |
| 949 "type": "object" |
| 950 }, |
| 951 "SecurityContext": { |
| 952 "description": "@OutputOnly A security context.", |
| 953 "id": "SecurityContext", |
| 954 "properties": { |
| 955 "securities": { |
| 956 "description": "The security types in this context.", |
| 957 "enumDescriptions": [ |
| 958 "Matches impressions that require insecure compatibility
.", |
| 959 "Matches impressions that require SSL compatibility." |
| 960 ], |
| 961 "items": { |
| 962 "enum": [ |
| 963 "INSECURE", |
| 964 "SSL" |
| 965 ], |
| 966 "type": "string" |
| 967 }, |
| 968 "type": "array" |
| 969 } |
| 970 }, |
| 971 "type": "object" |
| 972 }, |
| 973 "HtmlContent": { |
| 974 "description": "HTML content for a creative.", |
| 975 "id": "HtmlContent", |
| 976 "properties": { |
| 977 "width": { |
| 978 "description": "The width of the HTML snippet in pixels.", |
| 979 "format": "int32", |
| 980 "type": "integer" |
| 981 }, |
| 982 "snippet": { |
| 983 "description": "The HTML snippet that displays the ad when i
nserted in the web page.", |
| 984 "type": "string" |
| 985 }, |
| 986 "height": { |
| 987 "description": "The height of the HTML snippet in pixels.", |
| 988 "format": "int32", |
| 989 "type": "integer" |
| 990 } |
| 991 }, |
| 992 "type": "object" |
| 993 }, |
| 994 "ListCreativesResponse": { |
| 995 "description": "A response for listing creatives.", |
| 996 "id": "ListCreativesResponse", |
| 997 "properties": { |
| 998 "nextPageToken": { |
| 999 "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.", |
| 1000 "type": "string" |
| 1001 }, |
| 1002 "creatives": { |
| 1003 "description": "The list of creatives.", |
| 1004 "items": { |
| 1005 "$ref": "Creative" |
| 1006 }, |
| 1007 "type": "array" |
| 1008 } |
| 1009 }, |
| 1010 "type": "object" |
| 1011 }, |
| 1012 "ServingContext": { |
| 1013 "description": "The serving context for this restriction.", |
| 1014 "id": "ServingContext", |
| 1015 "properties": { |
| 1016 "auctionType": { |
| 1017 "$ref": "AuctionContext", |
| 1018 "description": "Matches impressions for a particular auction
type." |
| 1019 }, |
| 1020 "all": { |
| 1021 "description": "Matches all contexts.", |
| 1022 "enum": [ |
| 1023 "SIMPLE_CONTEXT" |
| 1024 ], |
| 1025 "enumDescriptions": [ |
| 1026 "A simple context." |
| 1027 ], |
| 1028 "type": "string" |
| 1029 }, |
| 1030 "appType": { |
| 1031 "$ref": "AppContext", |
| 1032 "description": "Matches impressions for a particular app typ
e." |
| 1033 }, |
| 1034 "securityType": { |
| 1035 "$ref": "SecurityContext", |
| 1036 "description": "Matches impressions for a particular securit
y type." |
| 1037 }, |
| 1038 "platform": { |
| 1039 "$ref": "PlatformContext", |
| 1040 "description": "Matches impressions coming from a particular
platform." |
| 1041 }, |
| 1042 "location": { |
| 1043 "$ref": "LocationContext", |
| 1044 "description": "Matches impressions coming from users *or* p
ublishers in a specific\nlocation." |
| 1045 } |
| 1046 }, |
| 1047 "type": "object" |
| 1048 }, |
| 1049 "Image": { |
| 1050 "description": "An image resource. You may provide a larger image th
an was requested,\nso long as the aspect ratio is preserved.", |
| 1051 "id": "Image", |
| 1052 "properties": { |
| 1053 "width": { |
| 1054 "description": "Image width in pixels.", |
| 1055 "format": "int32", |
| 1056 "type": "integer" |
| 1057 }, |
| 1058 "url": { |
| 1059 "description": "The URL of the image.", |
| 1060 "type": "string" |
| 1061 }, |
| 1062 "height": { |
| 1063 "description": "Image height in pixels.", |
| 1064 "format": "int32", |
| 1065 "type": "integer" |
| 1066 } |
| 1067 }, |
| 1068 "type": "object" |
| 1069 }, |
| 1070 "Reason": { |
| 1071 "description": "A specific filtering status and how many times it oc
curred.", |
| 1072 "id": "Reason", |
| 1073 "properties": { |
| 1074 "status": { |
| 1075 "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.", |
| 1076 "format": "int32", |
| 1077 "type": "integer" |
| 1078 }, |
| 1079 "count": { |
| 1080 "description": "The number of times the creative was filtere
d for the status. The\ncount is aggregated across all publishers on the exchange
.", |
| 1081 "format": "int64", |
| 1082 "type": "string" |
| 1083 } |
| 1084 }, |
| 1085 "type": "object" |
| 1086 }, |
| 1087 "VideoContent": { |
| 1088 "description": "Video content for a creative.", |
| 1089 "id": "VideoContent", |
| 1090 "properties": { |
| 1091 "videoUrl": { |
| 1092 "description": "The URL to fetch a video ad.", |
| 1093 "type": "string" |
| 1094 } |
| 1095 }, |
| 1096 "type": "object" |
| 1097 }, |
| 1098 "ClientUserInvitation": { |
| 1099 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", |
| 1100 "id": "ClientUserInvitation", |
| 1101 "properties": { |
| 1102 "invitationId": { |
| 1103 "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
.", |
| 1104 "format": "int64", |
| 1105 "type": "string" |
| 1106 }, |
| 1107 "email": { |
| 1108 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", |
| 1109 "type": "string" |
| 1110 }, |
| 1111 "clientAccountId": { |
| 1112 "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.", |
| 1113 "format": "int64", |
| 1114 "type": "string" |
| 1115 } |
| 1116 }, |
| 1117 "type": "object" |
| 1118 }, |
| 1119 "AuctionContext": { |
| 1120 "description": "@OutputOnly The auction type the restriction applies
to.", |
| 1121 "id": "AuctionContext", |
| 1122 "properties": { |
| 1123 "auctionTypes": { |
| 1124 "description": "The auction types this restriction applies t
o.", |
| 1125 "enumDescriptions": [ |
| 1126 "The restriction applies to open auction.", |
| 1127 "The restriction applies to direct deals." |
| 1128 ], |
| 1129 "items": { |
| 1130 "enum": [ |
| 1131 "OPEN_AUCTION", |
| 1132 "DIRECT_DEALS" |
| 1133 ], |
| 1134 "type": "string" |
| 1135 }, |
| 1136 "type": "array" |
| 1137 } |
| 1138 }, |
| 1139 "type": "object" |
| 1140 }, |
| 1141 "ListClientUsersResponse": { |
| 1142 "id": "ListClientUsersResponse", |
| 1143 "properties": { |
| 1144 "nextPageToken": { |
| 1145 "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.", |
| 1146 "type": "string" |
| 1147 }, |
| 1148 "users": { |
| 1149 "description": "The returned list of client users.", |
| 1150 "items": { |
| 1151 "$ref": "ClientUser" |
| 1152 }, |
| 1153 "type": "array" |
| 1154 } |
| 1155 }, |
| 1156 "type": "object" |
| 1157 }, |
| 1158 "ListClientUserInvitationsResponse": { |
| 1159 "id": "ListClientUserInvitationsResponse", |
| 1160 "properties": { |
| 1161 "invitations": { |
| 1162 "description": "The returned list of client users.", |
| 1163 "items": { |
| 1164 "$ref": "ClientUserInvitation" |
| 1165 }, |
| 1166 "type": "array" |
| 1167 }, |
| 1168 "nextPageToken": { |
| 1169 "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.", |
| 1170 "type": "string" |
| 1171 } |
| 1172 }, |
| 1173 "type": "object" |
| 1174 }, |
| 1175 "LocationContext": { |
| 1176 "description": "@OutputOnly The Geo criteria the restriction applies
to.", |
| 1177 "id": "LocationContext", |
| 1178 "properties": { |
| 1179 "geoCriteriaIds": { |
| 1180 "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.", |
| 1181 "items": { |
| 1182 "format": "int32", |
| 1183 "type": "integer" |
| 1184 }, |
| 1185 "type": "array" |
| 1186 } |
| 1187 }, |
| 1188 "type": "object" |
| 1189 }, |
| 1190 "PlatformContext": { |
| 1191 "description": "@OutputOnly The type of platform the restriction app
lies to.", |
| 1192 "id": "PlatformContext", |
| 1193 "properties": { |
| 1194 "platforms": { |
| 1195 "description": "The platforms this restriction applies to.", |
| 1196 "enumDescriptions": [ |
| 1197 "Desktop platform.", |
| 1198 "Android platform.", |
| 1199 "iOS platform." |
| 1200 ], |
| 1201 "items": { |
| 1202 "enum": [ |
| 1203 "DESKTOP", |
| 1204 "ANDROID", |
| 1205 "IOS" |
| 1206 ], |
| 1207 "type": "string" |
| 1208 }, |
| 1209 "type": "array" |
| 1210 } |
| 1211 }, |
| 1212 "type": "object" |
| 1213 }, |
835 "ClientUser": { | 1214 "ClientUser": { |
836 "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.", | 1215 "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.", |
837 "id": "ClientUser", | 1216 "id": "ClientUser", |
838 "properties": { | 1217 "properties": { |
839 "userId": { | |
840 "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.", | |
841 "format": "int64", | |
842 "type": "string" | |
843 }, | |
844 "email": { | |
845 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", | |
846 "type": "string" | |
847 }, | |
848 "clientAccountId": { | 1218 "clientAccountId": { |
849 "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.", | 1219 "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.", |
850 "format": "int64", | 1220 "format": "int64", |
851 "type": "string" | 1221 "type": "string" |
852 }, | 1222 }, |
853 "status": { | 1223 "status": { |
854 "description": "The status of the client user.", | 1224 "description": "The status of the client user.", |
855 "enum": [ | 1225 "enum": [ |
856 "USER_STATUS_UNSPECIFIED", | 1226 "USER_STATUS_UNSPECIFIED", |
857 "PENDING", | 1227 "PENDING", |
858 "ACTIVE", | 1228 "ACTIVE", |
859 "DISABLED" | 1229 "DISABLED" |
860 ], | 1230 ], |
861 "enumDescriptions": [ | 1231 "enumDescriptions": [ |
862 "A placeholder for an undefined user status.", | 1232 "A placeholder for an undefined user status.", |
863 "A user who was already created but hasn't accepted the
invitation yet.", | 1233 "A user who was already created but hasn't accepted the
invitation yet.", |
864 "A user that is currently active.", | 1234 "A user that is currently active.", |
865 "A user that is currently disabled." | 1235 "A user that is currently disabled." |
866 ], | 1236 ], |
867 "type": "string" | 1237 "type": "string" |
| 1238 }, |
| 1239 "userId": { |
| 1240 "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.", |
| 1241 "format": "int64", |
| 1242 "type": "string" |
| 1243 }, |
| 1244 "email": { |
| 1245 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", |
| 1246 "type": "string" |
868 } | 1247 } |
869 }, | 1248 }, |
870 "type": "object" | 1249 "type": "object" |
871 }, | 1250 }, |
872 "CreativeDealAssociation": { | 1251 "CreativeDealAssociation": { |
873 "description": "The association between a creative and a deal.", | 1252 "description": "The association between a creative and a deal.", |
874 "id": "CreativeDealAssociation", | 1253 "id": "CreativeDealAssociation", |
875 "properties": { | 1254 "properties": { |
| 1255 "accountId": { |
| 1256 "description": "The account the creative belongs to.", |
| 1257 "type": "string" |
| 1258 }, |
876 "creativeId": { | 1259 "creativeId": { |
877 "description": "The ID of the creative associated with the d
eal.", | 1260 "description": "The ID of the creative associated with the d
eal.", |
878 "type": "string" | 1261 "type": "string" |
879 }, | 1262 }, |
880 "dealsId": { | 1263 "dealsId": { |
881 "description": "The externalDealId for the deal associated w
ith the creative.", | 1264 "description": "The externalDealId for the deal associated w
ith the creative.", |
882 "type": "string" | 1265 "type": "string" |
883 }, | 1266 } |
884 "accountId": { | 1267 }, |
885 "description": "The account the creative belongs to.", | 1268 "type": "object" |
886 "type": "string" | 1269 }, |
| 1270 "FilteringStats": { |
| 1271 "description": "@OutputOnly Filtering reasons for this creative duri
ng a period of a single\nday (from midnight to midnight Pacific).", |
| 1272 "id": "FilteringStats", |
| 1273 "properties": { |
| 1274 "reasons": { |
| 1275 "description": "The set of filtering reasons for this date."
, |
| 1276 "items": { |
| 1277 "$ref": "Reason" |
| 1278 }, |
| 1279 "type": "array" |
| 1280 }, |
| 1281 "date": { |
| 1282 "$ref": "Date", |
| 1283 "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." |
887 } | 1284 } |
888 }, | 1285 }, |
889 "type": "object" | 1286 "type": "object" |
890 }, | 1287 }, |
891 "Creative": { | 1288 "Creative": { |
892 "description": "A creative and its classification data.", | 1289 "description": "A creative and its classification data.", |
893 "id": "Creative", | 1290 "id": "Creative", |
894 "properties": { | 1291 "properties": { |
| 1292 "native": { |
| 1293 "$ref": "NativeContent", |
| 1294 "description": "A native creative." |
| 1295 }, |
| 1296 "video": { |
| 1297 "$ref": "VideoContent", |
| 1298 "description": "A video creative." |
| 1299 }, |
| 1300 "servingRestrictions": { |
| 1301 "description": "@OutputOnly The granular status of this ad i
n specific contexts.\nA context here relates to where something ultimately serve
s (for example,\na physical location, a platform, an HTTPS vs HTTP request, or t
he type\nof auction).", |
| 1302 "items": { |
| 1303 "$ref": "ServingRestriction" |
| 1304 }, |
| 1305 "type": "array" |
| 1306 }, |
| 1307 "agencyId": { |
| 1308 "description": "The agency ID for this creative.", |
| 1309 "format": "int64", |
| 1310 "type": "string" |
| 1311 }, |
| 1312 "clickThroughUrls": { |
| 1313 "description": "The set of destination URLs for the creative
.", |
| 1314 "items": { |
| 1315 "type": "string" |
| 1316 }, |
| 1317 "type": "array" |
| 1318 }, |
| 1319 "adChoicesDestinationUrl": { |
| 1320 "description": "The link to AdChoices destination page.", |
| 1321 "type": "string" |
| 1322 }, |
895 "detectedSensitiveCategories": { | 1323 "detectedSensitiveCategories": { |
896 "description": "@OutputOnly Detected sensitive categories, i
f any.\nSee the ad-sensitive-categories.txt file in the technical documentation
for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-
category field in the bid request to filter your bids.", | 1324 "description": "@OutputOnly Detected sensitive categories, i
f any.\nSee the ad-sensitive-categories.txt file in the technical documentation
for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-
category field in the bid request to filter your bids.", |
897 "items": { | 1325 "items": { |
898 "format": "int32", | 1326 "format": "int32", |
899 "type": "integer" | 1327 "type": "integer" |
900 }, | 1328 }, |
901 "type": "array" | 1329 "type": "array" |
902 }, | 1330 }, |
903 "adChoicesDestinationUrl": { | |
904 "description": "The link to AdChoices destination page.", | |
905 "type": "string" | |
906 }, | |
907 "restrictedCategories": { | 1331 "restrictedCategories": { |
908 "description": "All restricted categories for the ads that m
ay be shown from this creative.", | 1332 "description": "All restricted categories for the ads that m
ay be shown from this creative.", |
909 "enumDescriptions": [ | 1333 "enumDescriptions": [ |
910 "The ad has no restricted categories", | 1334 "The ad has no restricted categories", |
911 "The alcohol restricted category." | 1335 "The alcohol restricted category." |
912 ], | 1336 ], |
913 "items": { | 1337 "items": { |
914 "enum": [ | 1338 "enum": [ |
915 "NO_RESTRICTED_CATEGORIES", | 1339 "NO_RESTRICTED_CATEGORIES", |
916 "ALCOHOL" | 1340 "ALCOHOL" |
(...skipping 74 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
991 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", | 1415 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", |
992 "The creative has been approved.", | 1416 "The creative has been approved.", |
993 "The creative has been disapproved." | 1417 "The creative has been disapproved." |
994 ], | 1418 ], |
995 "type": "string" | 1419 "type": "string" |
996 }, | 1420 }, |
997 "advertiserName": { | 1421 "advertiserName": { |
998 "description": "The name of the company being advertised in
the creative.", | 1422 "description": "The name of the company being advertised in
the creative.", |
999 "type": "string" | 1423 "type": "string" |
1000 }, | 1424 }, |
| 1425 "detectedDomains": { |
| 1426 "description": "@OutputOnly\nThe detected domains for this c
reative.", |
| 1427 "items": { |
| 1428 "type": "string" |
| 1429 }, |
| 1430 "type": "array" |
| 1431 }, |
1001 "detectedAdvertiserIds": { | 1432 "detectedAdvertiserIds": { |
1002 "description": "@OutputOnly Detected advertiser IDs, if any.
", | 1433 "description": "@OutputOnly Detected advertiser IDs, if any.
", |
1003 "items": { | 1434 "items": { |
1004 "format": "int64", | 1435 "format": "int64", |
1005 "type": "string" | 1436 "type": "string" |
1006 }, | 1437 }, |
1007 "type": "array" | 1438 "type": "array" |
1008 }, | |
1009 "detectedDomains": { | |
1010 "description": "@OutputOnly\nThe detected domains for this c
reative.", | |
1011 "items": { | |
1012 "type": "string" | |
1013 }, | |
1014 "type": "array" | |
1015 }, | 1439 }, |
1016 "filteringStats": { | 1440 "filteringStats": { |
1017 "$ref": "FilteringStats", | 1441 "$ref": "FilteringStats", |
1018 "description": "@OutputOnly The filtering stats for this cre
ative." | 1442 "description": "@OutputOnly The filtering stats for this cre
ative." |
1019 }, | 1443 }, |
1020 "attributes": { | 1444 "attributes": { |
1021 "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.", | 1445 "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.", |
1022 "enumDescriptions": [ | 1446 "enumDescriptions": [ |
1023 "Do not use. This is a placeholder value only.", | 1447 "Do not use. This is a placeholder value only.", |
1024 "The creative is tagged.", | 1448 "The creative is tagged.", |
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1088 }, | 1512 }, |
1089 "type": "array" | 1513 "type": "array" |
1090 }, | 1514 }, |
1091 "creativeId": { | 1515 "creativeId": { |
1092 "description": "The buyer-defined creative ID of this creati
ve.\nCan be used to filter the response of the\ncreatives.list\nmethod.", | 1516 "description": "The buyer-defined creative ID of this creati
ve.\nCan be used to filter the response of the\ncreatives.list\nmethod.", |
1093 "type": "string" | 1517 "type": "string" |
1094 }, | 1518 }, |
1095 "accountId": { | 1519 "accountId": { |
1096 "description": "The account that this creative belongs to.\n
Can be used to filter the response of the\ncreatives.list\nmethod.", | 1520 "description": "The account that this creative belongs to.\n
Can be used to filter the response of the\ncreatives.list\nmethod.", |
1097 "type": "string" | 1521 "type": "string" |
1098 }, | |
1099 "native": { | |
1100 "$ref": "NativeContent", | |
1101 "description": "A native creative." | |
1102 }, | |
1103 "video": { | |
1104 "$ref": "VideoContent", | |
1105 "description": "A video creative." | |
1106 }, | |
1107 "servingRestrictions": { | |
1108 "description": "@OutputOnly The granular status of this ad i
n specific contexts.\nA context here relates to where something ultimately serve
s (for example,\na physical location, a platform, an HTTPS vs HTTP request, or t
he type\nof auction).", | |
1109 "items": { | |
1110 "$ref": "ServingRestriction" | |
1111 }, | |
1112 "type": "array" | |
1113 }, | |
1114 "agencyId": { | |
1115 "description": "The agency ID for this creative.", | |
1116 "format": "int64", | |
1117 "type": "string" | |
1118 }, | |
1119 "clickThroughUrls": { | |
1120 "description": "The set of destination URLs for the creative
.", | |
1121 "items": { | |
1122 "type": "string" | |
1123 }, | |
1124 "type": "array" | |
1125 } | 1522 } |
1126 }, | 1523 }, |
1127 "type": "object" | 1524 "type": "object" |
1128 }, | |
1129 "FilteringStats": { | |
1130 "description": "@OutputOnly Filtering reasons for this creative duri
ng a period of a single\nday (from midnight to midnight Pacific).", | |
1131 "id": "FilteringStats", | |
1132 "properties": { | |
1133 "date": { | |
1134 "$ref": "Date", | |
1135 "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." | |
1136 }, | |
1137 "reasons": { | |
1138 "description": "The set of filtering reasons for this date."
, | |
1139 "items": { | |
1140 "$ref": "Reason" | |
1141 }, | |
1142 "type": "array" | |
1143 } | |
1144 }, | |
1145 "type": "object" | |
1146 }, | 1525 }, |
1147 "RemoveDealAssociationRequest": { | 1526 "RemoveDealAssociationRequest": { |
1148 "description": "A request for removing the association between a dea
l and a creative.", | 1527 "description": "A request for removing the association between a dea
l and a creative.", |
1149 "id": "RemoveDealAssociationRequest", | 1528 "id": "RemoveDealAssociationRequest", |
1150 "properties": { | 1529 "properties": { |
1151 "association": { | 1530 "association": { |
1152 "$ref": "CreativeDealAssociation", | 1531 "$ref": "CreativeDealAssociation", |
1153 "description": "The association between a creative and a dea
l that should be removed." | 1532 "description": "The association between a creative and a dea
l that should be removed." |
1154 } | 1533 } |
1155 }, | 1534 }, |
1156 "type": "object" | 1535 "type": "object" |
1157 }, | 1536 }, |
1158 "Client": { | 1537 "Client": { |
1159 "description": "A client resource represents a client buyer—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.", | 1538 "description": "A client resource represents a client buyer—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.", |
1160 "id": "Client", | 1539 "id": "Client", |
1161 "properties": { | 1540 "properties": { |
| 1541 "entityName": { |
| 1542 "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.", |
| 1543 "type": "string" |
| 1544 }, |
| 1545 "status": { |
| 1546 "description": "The status of the client buyer.", |
| 1547 "enum": [ |
| 1548 "CLIENT_STATUS_UNSPECIFIED", |
| 1549 "DISABLED", |
| 1550 "ACTIVE" |
| 1551 ], |
| 1552 "enumDescriptions": [ |
| 1553 "A placeholder for an undefined client status.", |
| 1554 "A client that is currently disabled.", |
| 1555 "A client that is currently active." |
| 1556 ], |
| 1557 "type": "string" |
| 1558 }, |
1162 "entityType": { | 1559 "entityType": { |
1163 "description": "The type of the client entity: `ADVERTISER`,
`BRAND`, or `AGENCY`.", | 1560 "description": "The type of the client entity: `ADVERTISER`,
`BRAND`, or `AGENCY`.", |
1164 "enum": [ | 1561 "enum": [ |
1165 "ENTITY_TYPE_UNSPECIFIED", | 1562 "ENTITY_TYPE_UNSPECIFIED", |
1166 "ADVERTISER", | 1563 "ADVERTISER", |
1167 "BRAND", | 1564 "BRAND", |
1168 "AGENCY" | 1565 "AGENCY" |
1169 ], | 1566 ], |
1170 "enumDescriptions": [ | 1567 "enumDescriptions": [ |
1171 "A placeholder for an undefined client entity type. Shou
ld not be used.", | 1568 "A placeholder for an undefined client entity type. Shou
ld not be used.", |
(...skipping 29 matching lines...) Expand all Loading... |
1201 }, | 1598 }, |
1202 "entityId": { | 1599 "entityId": { |
1203 "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.", | 1600 "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.", |
1204 "format": "int64", | 1601 "format": "int64", |
1205 "type": "string" | 1602 "type": "string" |
1206 }, | 1603 }, |
1207 "clientAccountId": { | 1604 "clientAccountId": { |
1208 "description": "The globally-unique numerical ID of the clie
nt.\nThe value of this field is ignored in create and update operations.", | 1605 "description": "The globally-unique numerical ID of the clie
nt.\nThe value of this field is ignored in create and update operations.", |
1209 "format": "int64", | 1606 "format": "int64", |
1210 "type": "string" | 1607 "type": "string" |
1211 }, | |
1212 "entityName": { | |
1213 "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.", | |
1214 "type": "string" | |
1215 }, | |
1216 "status": { | |
1217 "description": "The status of the client buyer.", | |
1218 "enum": [ | |
1219 "CLIENT_STATUS_UNSPECIFIED", | |
1220 "DISABLED", | |
1221 "ACTIVE" | |
1222 ], | |
1223 "enumDescriptions": [ | |
1224 "A placeholder for an undefined client status.", | |
1225 "A client that is currently disabled.", | |
1226 "A client that is currently active." | |
1227 ], | |
1228 "type": "string" | |
1229 } | 1608 } |
1230 }, | 1609 }, |
1231 "type": "object" | 1610 "type": "object" |
1232 }, | 1611 }, |
1233 "Correction": { | 1612 "Correction": { |
1234 "description": "@OutputOnly Shows any corrections that were applied
to this creative.", | 1613 "description": "@OutputOnly Shows any corrections that were applied
to this creative.", |
1235 "id": "Correction", | 1614 "id": "Correction", |
1236 "properties": { | 1615 "properties": { |
| 1616 "details": { |
| 1617 "description": "Additional details about what was corrected.
", |
| 1618 "items": { |
| 1619 "type": "string" |
| 1620 }, |
| 1621 "type": "array" |
| 1622 }, |
1237 "type": { | 1623 "type": { |
1238 "description": "The type of correction that was applied to t
he creative.", | 1624 "description": "The type of correction that was applied to t
he creative.", |
1239 "enum": [ | 1625 "enum": [ |
1240 "CORRECTION_TYPE_UNSPECIFIED", | 1626 "CORRECTION_TYPE_UNSPECIFIED", |
1241 "VENDOR_IDS_ADDED", | 1627 "VENDOR_IDS_ADDED", |
1242 "SSL_ATTRIBUTE_REMOVED", | 1628 "SSL_ATTRIBUTE_REMOVED", |
1243 "FLASH_FREE_ATTRIBUTE_REMOVED", | 1629 "FLASH_FREE_ATTRIBUTE_REMOVED", |
1244 "FLASH_FREE_ATTRIBUTE_ADDED", | 1630 "FLASH_FREE_ATTRIBUTE_ADDED", |
1245 "REQUIRED_ATTRIBUTE_ADDED", | 1631 "REQUIRED_ATTRIBUTE_ADDED", |
1246 "REQUIRED_VENDOR_ADDED", | 1632 "REQUIRED_VENDOR_ADDED", |
(...skipping 18 matching lines...) Expand all Loading... |
1265 "The ad contains video content." | 1651 "The ad contains video content." |
1266 ], | 1652 ], |
1267 "type": "string" | 1653 "type": "string" |
1268 }, | 1654 }, |
1269 "contexts": { | 1655 "contexts": { |
1270 "description": "The contexts for the correction.", | 1656 "description": "The contexts for the correction.", |
1271 "items": { | 1657 "items": { |
1272 "$ref": "ServingContext" | 1658 "$ref": "ServingContext" |
1273 }, | 1659 }, |
1274 "type": "array" | 1660 "type": "array" |
1275 }, | |
1276 "details": { | |
1277 "description": "Additional details about what was corrected.
", | |
1278 "items": { | |
1279 "type": "string" | |
1280 }, | |
1281 "type": "array" | |
1282 } | 1661 } |
1283 }, | 1662 }, |
1284 "type": "object" | 1663 "type": "object" |
1285 }, | 1664 }, |
1286 "ListDealAssociationsResponse": { | 1665 "ListDealAssociationsResponse": { |
1287 "description": "A response for listing creative and deal association
s", | 1666 "description": "A response for listing creative and deal association
s", |
1288 "id": "ListDealAssociationsResponse", | 1667 "id": "ListDealAssociationsResponse", |
1289 "properties": { | 1668 "properties": { |
1290 "nextPageToken": { | |
1291 "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.", | |
1292 "type": "string" | |
1293 }, | |
1294 "associations": { | 1669 "associations": { |
1295 "description": "The list of associations.", | 1670 "description": "The list of associations.", |
1296 "items": { | 1671 "items": { |
1297 "$ref": "CreativeDealAssociation" | 1672 "$ref": "CreativeDealAssociation" |
1298 }, | 1673 }, |
1299 "type": "array" | 1674 "type": "array" |
| 1675 }, |
| 1676 "nextPageToken": { |
| 1677 "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.", |
| 1678 "type": "string" |
1300 } | 1679 } |
1301 }, | 1680 }, |
1302 "type": "object" | 1681 "type": "object" |
1303 }, | 1682 }, |
1304 "AddDealAssociationRequest": { | 1683 "AddDealAssociationRequest": { |
1305 "description": "A request for associating a deal and a creative.", | 1684 "description": "A request for associating a deal and a creative.", |
1306 "id": "AddDealAssociationRequest", | 1685 "id": "AddDealAssociationRequest", |
1307 "properties": { | 1686 "properties": { |
1308 "association": { | 1687 "association": { |
1309 "$ref": "CreativeDealAssociation", | 1688 "$ref": "CreativeDealAssociation", |
1310 "description": "The association between a creative and a dea
l that should be added." | 1689 "description": "The association between a creative and a dea
l that should be added." |
1311 } | 1690 } |
1312 }, | 1691 }, |
1313 "type": "object" | 1692 "type": "object" |
1314 }, | 1693 }, |
| 1694 "StopWatchingCreativeRequest": { |
| 1695 "description": "A request for stopping notifications for changes to
creative Status.", |
| 1696 "id": "StopWatchingCreativeRequest", |
| 1697 "properties": {}, |
| 1698 "type": "object" |
| 1699 }, |
1315 "Disapproval": { | 1700 "Disapproval": { |
1316 "description": "@OutputOnly The reason and details for a disapproval
.", | 1701 "description": "@OutputOnly The reason and details for a disapproval
.", |
1317 "id": "Disapproval", | 1702 "id": "Disapproval", |
1318 "properties": { | 1703 "properties": { |
1319 "details": { | 1704 "details": { |
1320 "description": "Additional details about the reason for disa
pproval.", | 1705 "description": "Additional details about the reason for disa
pproval.", |
1321 "items": { | 1706 "items": { |
1322 "type": "string" | 1707 "type": "string" |
1323 }, | 1708 }, |
1324 "type": "array" | 1709 "type": "array" |
(...skipping 190 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1515 "Maximum number of HTTP calls exceeded.", | 1900 "Maximum number of HTTP calls exceeded.", |
1516 "Maximum number of cookies exceeded.", | 1901 "Maximum number of cookies exceeded.", |
1517 "Financial service ad does not adhere to specifications.
", | 1902 "Financial service ad does not adhere to specifications.
", |
1518 "Flash content was found in an unsupported context." | 1903 "Flash content was found in an unsupported context." |
1519 ], | 1904 ], |
1520 "type": "string" | 1905 "type": "string" |
1521 } | 1906 } |
1522 }, | 1907 }, |
1523 "type": "object" | 1908 "type": "object" |
1524 }, | 1909 }, |
1525 "StopWatchingCreativeRequest": { | |
1526 "description": "A request for stopping notifications for changes to
creative Status.", | |
1527 "id": "StopWatchingCreativeRequest", | |
1528 "properties": {}, | |
1529 "type": "object" | |
1530 }, | |
1531 "ServingRestriction": { | 1910 "ServingRestriction": { |
1532 "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).", | 1911 "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).", |
1533 "id": "ServingRestriction", | 1912 "id": "ServingRestriction", |
1534 "properties": { | 1913 "properties": { |
| 1914 "disapprovalReasons": { |
| 1915 "description": "Any disapprovals bound to this restriction.\
nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\
ncreatives.list\nmethod.", |
| 1916 "items": { |
| 1917 "$ref": "Disapproval" |
| 1918 }, |
| 1919 "type": "array" |
| 1920 }, |
| 1921 "contexts": { |
| 1922 "description": "The contexts for the restriction.", |
| 1923 "items": { |
| 1924 "$ref": "ServingContext" |
| 1925 }, |
| 1926 "type": "array" |
| 1927 }, |
1535 "status": { | 1928 "status": { |
1536 "description": "The status of the creative in this context (
for example, it has been\nexplicitly disapproved or is pending review).", | 1929 "description": "The status of the creative in this context (
for example, it has been\nexplicitly disapproved or is pending review).", |
1537 "enum": [ | 1930 "enum": [ |
1538 "STATUS_UNSPECIFIED", | 1931 "STATUS_UNSPECIFIED", |
1539 "DISAPPROVAL", | 1932 "DISAPPROVAL", |
1540 "PENDING_REVIEW" | 1933 "PENDING_REVIEW" |
1541 ], | 1934 ], |
1542 "enumDescriptions": [ | 1935 "enumDescriptions": [ |
1543 "The status is not known.", | 1936 "The status is not known.", |
1544 "The ad was disapproved in this context.", | 1937 "The ad was disapproved in this context.", |
1545 "The ad is pending review in this context." | 1938 "The ad is pending review in this context." |
1546 ], | 1939 ], |
1547 "type": "string" | 1940 "type": "string" |
1548 }, | |
1549 "disapprovalReasons": { | |
1550 "description": "Any disapprovals bound to this restriction.\
nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\
ncreatives.list\nmethod.", | |
1551 "items": { | |
1552 "$ref": "Disapproval" | |
1553 }, | |
1554 "type": "array" | |
1555 }, | |
1556 "contexts": { | |
1557 "description": "The contexts for the restriction.", | |
1558 "items": { | |
1559 "$ref": "ServingContext" | |
1560 }, | |
1561 "type": "array" | |
1562 } | 1941 } |
1563 }, | 1942 }, |
1564 "type": "object" | 1943 "type": "object" |
1565 }, | 1944 }, |
1566 "Date": { | 1945 "Date": { |
1567 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", | 1946 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", |
1568 "id": "Date", | 1947 "id": "Date", |
1569 "properties": { | 1948 "properties": { |
| 1949 "month": { |
| 1950 "description": "Month of year. Must be from 1 to 12.", |
| 1951 "format": "int32", |
| 1952 "type": "integer" |
| 1953 }, |
1570 "year": { | 1954 "year": { |
1571 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | 1955 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
1572 "format": "int32", | 1956 "format": "int32", |
1573 "type": "integer" | 1957 "type": "integer" |
1574 }, | 1958 }, |
1575 "day": { | 1959 "day": { |
1576 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", | 1960 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", |
1577 "format": "int32", | 1961 "format": "int32", |
1578 "type": "integer" | 1962 "type": "integer" |
1579 }, | |
1580 "month": { | |
1581 "description": "Month of year. Must be from 1 to 12.", | |
1582 "format": "int32", | |
1583 "type": "integer" | |
1584 } | |
1585 }, | |
1586 "type": "object" | |
1587 }, | |
1588 "Empty": { | |
1589 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | |
1590 "id": "Empty", | |
1591 "properties": {}, | |
1592 "type": "object" | |
1593 }, | |
1594 "WatchCreativeRequest": { | |
1595 "description": "A request for watching changes to creative Status.", | |
1596 "id": "WatchCreativeRequest", | |
1597 "properties": { | |
1598 "topic": { | |
1599 "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.", | |
1600 "type": "string" | |
1601 } | |
1602 }, | |
1603 "type": "object" | |
1604 }, | |
1605 "AppContext": { | |
1606 "description": "@OutputOnly The app type the restriction applies to
for mobile device.", | |
1607 "id": "AppContext", | |
1608 "properties": { | |
1609 "appTypes": { | |
1610 "description": "The app types this restriction applies to.", | |
1611 "enumDescriptions": [ | |
1612 "Native app context.", | |
1613 "Mobile web app context." | |
1614 ], | |
1615 "items": { | |
1616 "enum": [ | |
1617 "NATIVE", | |
1618 "WEB" | |
1619 ], | |
1620 "type": "string" | |
1621 }, | |
1622 "type": "array" | |
1623 } | |
1624 }, | |
1625 "type": "object" | |
1626 }, | |
1627 "ListClientsResponse": { | |
1628 "id": "ListClientsResponse", | |
1629 "properties": { | |
1630 "nextPageToken": { | |
1631 "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
.", | |
1632 "type": "string" | |
1633 }, | |
1634 "clients": { | |
1635 "description": "The returned list of clients.", | |
1636 "items": { | |
1637 "$ref": "Client" | |
1638 }, | |
1639 "type": "array" | |
1640 } | |
1641 }, | |
1642 "type": "object" | |
1643 }, | |
1644 "NativeContent": { | |
1645 "description": "Native content for a creative.", | |
1646 "id": "NativeContent", | |
1647 "properties": { | |
1648 "videoUrl": { | |
1649 "description": "The URL to fetch a native video ad.", | |
1650 "type": "string" | |
1651 }, | |
1652 "logo": { | |
1653 "$ref": "Image", | |
1654 "description": "A smaller image, for the advertiser's logo." | |
1655 }, | |
1656 "clickLinkUrl": { | |
1657 "description": "The URL that the browser/SDK will load when
the user clicks the ad.", | |
1658 "type": "string" | |
1659 }, | |
1660 "priceDisplayText": { | |
1661 "description": "The price of the promoted app including curr
ency info.", | |
1662 "type": "string" | |
1663 }, | |
1664 "clickTrackingUrl": { | |
1665 "description": "The URL to use for click tracking.", | |
1666 "type": "string" | |
1667 }, | |
1668 "image": { | |
1669 "$ref": "Image", | |
1670 "description": "A large image." | |
1671 }, | |
1672 "advertiserName": { | |
1673 "description": "The name of the advertiser or sponsor, to be
displayed in the ad creative.", | |
1674 "type": "string" | |
1675 }, | |
1676 "storeUrl": { | |
1677 "description": "The URL to the app store to purchase/downloa
d the promoted app.", | |
1678 "type": "string" | |
1679 }, | |
1680 "headline": { | |
1681 "description": "A short title for the ad.", | |
1682 "type": "string" | |
1683 }, | |
1684 "appIcon": { | |
1685 "$ref": "Image", | |
1686 "description": "The app icon, for app download ads." | |
1687 }, | |
1688 "callToAction": { | |
1689 "description": "A label for the button that the user is supp
osed to click.", | |
1690 "type": "string" | |
1691 }, | |
1692 "body": { | |
1693 "description": "A long description of the ad.", | |
1694 "type": "string" | |
1695 }, | |
1696 "starRating": { | |
1697 "description": "The app rating in the app store. Must be in
the range [0-5].", | |
1698 "format": "double", | |
1699 "type": "number" | |
1700 } | |
1701 }, | |
1702 "type": "object" | |
1703 }, | |
1704 "SecurityContext": { | |
1705 "description": "@OutputOnly A security context.", | |
1706 "id": "SecurityContext", | |
1707 "properties": { | |
1708 "securities": { | |
1709 "description": "The security types in this context.", | |
1710 "enumDescriptions": [ | |
1711 "Matches impressions that require insecure compatibility
.", | |
1712 "Matches impressions that require SSL compatibility." | |
1713 ], | |
1714 "items": { | |
1715 "enum": [ | |
1716 "INSECURE", | |
1717 "SSL" | |
1718 ], | |
1719 "type": "string" | |
1720 }, | |
1721 "type": "array" | |
1722 } | |
1723 }, | |
1724 "type": "object" | |
1725 }, | |
1726 "ListCreativesResponse": { | |
1727 "description": "A response for listing creatives.", | |
1728 "id": "ListCreativesResponse", | |
1729 "properties": { | |
1730 "creatives": { | |
1731 "description": "The list of creatives.", | |
1732 "items": { | |
1733 "$ref": "Creative" | |
1734 }, | |
1735 "type": "array" | |
1736 }, | |
1737 "nextPageToken": { | |
1738 "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.", | |
1739 "type": "string" | |
1740 } | |
1741 }, | |
1742 "type": "object" | |
1743 }, | |
1744 "HtmlContent": { | |
1745 "description": "HTML content for a creative.", | |
1746 "id": "HtmlContent", | |
1747 "properties": { | |
1748 "height": { | |
1749 "description": "The height of the HTML snippet in pixels.", | |
1750 "format": "int32", | |
1751 "type": "integer" | |
1752 }, | |
1753 "width": { | |
1754 "description": "The width of the HTML snippet in pixels.", | |
1755 "format": "int32", | |
1756 "type": "integer" | |
1757 }, | |
1758 "snippet": { | |
1759 "description": "The HTML snippet that displays the ad when i
nserted in the web page.", | |
1760 "type": "string" | |
1761 } | |
1762 }, | |
1763 "type": "object" | |
1764 }, | |
1765 "ServingContext": { | |
1766 "description": "The serving context for this restriction.", | |
1767 "id": "ServingContext", | |
1768 "properties": { | |
1769 "auctionType": { | |
1770 "$ref": "AuctionContext", | |
1771 "description": "Matches impressions for a particular auction
type." | |
1772 }, | |
1773 "all": { | |
1774 "description": "Matches all contexts.", | |
1775 "enum": [ | |
1776 "SIMPLE_CONTEXT" | |
1777 ], | |
1778 "enumDescriptions": [ | |
1779 "A simple context." | |
1780 ], | |
1781 "type": "string" | |
1782 }, | |
1783 "appType": { | |
1784 "$ref": "AppContext", | |
1785 "description": "Matches impressions for a particular app typ
e." | |
1786 }, | |
1787 "securityType": { | |
1788 "$ref": "SecurityContext", | |
1789 "description": "Matches impressions for a particular securit
y type." | |
1790 }, | |
1791 "platform": { | |
1792 "$ref": "PlatformContext", | |
1793 "description": "Matches impressions coming from a particular
platform." | |
1794 }, | |
1795 "location": { | |
1796 "$ref": "LocationContext", | |
1797 "description": "Matches impressions coming from users *or* p
ublishers in a specific\nlocation." | |
1798 } | |
1799 }, | |
1800 "type": "object" | |
1801 }, | |
1802 "Image": { | |
1803 "description": "An image resource. You may provide a larger image th
an was requested,\nso long as the aspect ratio is preserved.", | |
1804 "id": "Image", | |
1805 "properties": { | |
1806 "width": { | |
1807 "description": "Image width in pixels.", | |
1808 "format": "int32", | |
1809 "type": "integer" | |
1810 }, | |
1811 "url": { | |
1812 "description": "The URL of the image.", | |
1813 "type": "string" | |
1814 }, | |
1815 "height": { | |
1816 "description": "Image height in pixels.", | |
1817 "format": "int32", | |
1818 "type": "integer" | |
1819 } | |
1820 }, | |
1821 "type": "object" | |
1822 }, | |
1823 "Reason": { | |
1824 "description": "A specific filtering status and how many times it oc
curred.", | |
1825 "id": "Reason", | |
1826 "properties": { | |
1827 "count": { | |
1828 "description": "The number of times the creative was filtere
d for the status. The\ncount is aggregated across all publishers on the exchange
.", | |
1829 "format": "int64", | |
1830 "type": "string" | |
1831 }, | |
1832 "status": { | |
1833 "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.", | |
1834 "format": "int32", | |
1835 "type": "integer" | |
1836 } | |
1837 }, | |
1838 "type": "object" | |
1839 }, | |
1840 "VideoContent": { | |
1841 "description": "Video content for a creative.", | |
1842 "id": "VideoContent", | |
1843 "properties": { | |
1844 "videoUrl": { | |
1845 "description": "The URL to fetch a video ad.", | |
1846 "type": "string" | |
1847 } | |
1848 }, | |
1849 "type": "object" | |
1850 }, | |
1851 "ClientUserInvitation": { | |
1852 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", | |
1853 "id": "ClientUserInvitation", | |
1854 "properties": { | |
1855 "email": { | |
1856 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", | |
1857 "type": "string" | |
1858 }, | |
1859 "clientAccountId": { | |
1860 "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.", | |
1861 "format": "int64", | |
1862 "type": "string" | |
1863 }, | |
1864 "invitationId": { | |
1865 "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
.", | |
1866 "format": "int64", | |
1867 "type": "string" | |
1868 } | |
1869 }, | |
1870 "type": "object" | |
1871 }, | |
1872 "AuctionContext": { | |
1873 "description": "@OutputOnly The auction type the restriction applies
to.", | |
1874 "id": "AuctionContext", | |
1875 "properties": { | |
1876 "auctionTypes": { | |
1877 "description": "The auction types this restriction applies t
o.", | |
1878 "enumDescriptions": [ | |
1879 "The restriction applies to open auction.", | |
1880 "The restriction applies to direct deals." | |
1881 ], | |
1882 "items": { | |
1883 "enum": [ | |
1884 "OPEN_AUCTION", | |
1885 "DIRECT_DEALS" | |
1886 ], | |
1887 "type": "string" | |
1888 }, | |
1889 "type": "array" | |
1890 } | |
1891 }, | |
1892 "type": "object" | |
1893 }, | |
1894 "ListClientUserInvitationsResponse": { | |
1895 "id": "ListClientUserInvitationsResponse", | |
1896 "properties": { | |
1897 "nextPageToken": { | |
1898 "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.", | |
1899 "type": "string" | |
1900 }, | |
1901 "invitations": { | |
1902 "description": "The returned list of client users.", | |
1903 "items": { | |
1904 "$ref": "ClientUserInvitation" | |
1905 }, | |
1906 "type": "array" | |
1907 } | |
1908 }, | |
1909 "type": "object" | |
1910 }, | |
1911 "ListClientUsersResponse": { | |
1912 "id": "ListClientUsersResponse", | |
1913 "properties": { | |
1914 "nextPageToken": { | |
1915 "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.", | |
1916 "type": "string" | |
1917 }, | |
1918 "users": { | |
1919 "description": "The returned list of client users.", | |
1920 "items": { | |
1921 "$ref": "ClientUser" | |
1922 }, | |
1923 "type": "array" | |
1924 } | |
1925 }, | |
1926 "type": "object" | |
1927 }, | |
1928 "LocationContext": { | |
1929 "description": "@OutputOnly The Geo criteria the restriction applies
to.", | |
1930 "id": "LocationContext", | |
1931 "properties": { | |
1932 "geoCriteriaIds": { | |
1933 "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.", | |
1934 "items": { | |
1935 "format": "int32", | |
1936 "type": "integer" | |
1937 }, | |
1938 "type": "array" | |
1939 } | |
1940 }, | |
1941 "type": "object" | |
1942 }, | |
1943 "PlatformContext": { | |
1944 "description": "@OutputOnly The type of platform the restriction app
lies to.", | |
1945 "id": "PlatformContext", | |
1946 "properties": { | |
1947 "platforms": { | |
1948 "description": "The platforms this restriction applies to.", | |
1949 "enumDescriptions": [ | |
1950 "Desktop platform.", | |
1951 "Android platform.", | |
1952 "iOS platform." | |
1953 ], | |
1954 "items": { | |
1955 "enum": [ | |
1956 "DESKTOP", | |
1957 "ANDROID", | |
1958 "IOS" | |
1959 ], | |
1960 "type": "string" | |
1961 }, | |
1962 "type": "array" | |
1963 } | 1963 } |
1964 }, | 1964 }, |
1965 "type": "object" | 1965 "type": "object" |
1966 } | 1966 } |
1967 }, | 1967 }, |
1968 "servicePath": "", | 1968 "servicePath": "", |
1969 "title": "Ad Exchange Buyer API II", | 1969 "title": "Ad Exchange Buyer API II", |
1970 "version": "v2beta1" | 1970 "version": "v2beta1" |
1971 } | 1971 } |
OLD | NEW |