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 "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 }, |
28 "upload_protocol": { | 44 "upload_protocol": { |
29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
30 "location": "query", | 46 "location": "query", |
31 "type": "string" | 47 "type": "string" |
32 }, | 48 }, |
33 "prettyPrint": { | 49 "prettyPrint": { |
34 "default": "true", | 50 "default": "true", |
35 "description": "Returns response with indentations and line breaks."
, | 51 "description": "Returns response with indentations and line breaks."
, |
36 "location": "query", | 52 "location": "query", |
37 "type": "boolean" | 53 "type": "boolean" |
38 }, | 54 }, |
| 55 "fields": { |
| 56 "description": "Selector specifying which fields to include in a par
tial response.", |
| 57 "location": "query", |
| 58 "type": "string" |
| 59 }, |
39 "uploadType": { | 60 "uploadType": { |
40 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 61 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
41 "location": "query", | 62 "location": "query", |
42 "type": "string" | 63 "type": "string" |
43 }, | 64 }, |
44 "fields": { | |
45 "description": "Selector specifying which fields to include in a par
tial response.", | |
46 "location": "query", | |
47 "type": "string" | |
48 }, | |
49 "callback": { | 65 "callback": { |
50 "description": "JSONP", | 66 "description": "JSONP", |
51 "location": "query", | 67 "location": "query", |
52 "type": "string" | 68 "type": "string" |
53 }, | 69 }, |
54 "$.xgafv": { | 70 "$.xgafv": { |
55 "description": "V1 error format.", | 71 "description": "V1 error format.", |
56 "enum": [ | 72 "enum": [ |
57 "1", | 73 "1", |
58 "2" | 74 "2" |
(...skipping 14 matching lines...) Expand all Loading... |
73 "proto" | 89 "proto" |
74 ], | 90 ], |
75 "enumDescriptions": [ | 91 "enumDescriptions": [ |
76 "Responses with Content-Type of application/json", | 92 "Responses with Content-Type of application/json", |
77 "Media download with context-dependent Content-Type", | 93 "Media download with context-dependent Content-Type", |
78 "Responses with Content-Type of application/x-protobuf" | 94 "Responses with Content-Type of application/x-protobuf" |
79 ], | 95 ], |
80 "location": "query", | 96 "location": "query", |
81 "type": "string" | 97 "type": "string" |
82 }, | 98 }, |
| 99 "access_token": { |
| 100 "description": "OAuth access token.", |
| 101 "location": "query", |
| 102 "type": "string" |
| 103 }, |
83 "key": { | 104 "key": { |
84 "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.", | 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.", |
85 "location": "query", | 106 "location": "query", |
86 "type": "string" | 107 "type": "string" |
87 }, | 108 }, |
88 "access_token": { | |
89 "description": "OAuth access token.", | |
90 "location": "query", | |
91 "type": "string" | |
92 }, | |
93 "quotaUser": { | 109 "quotaUser": { |
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.", | 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.", |
95 "location": "query", | 111 "location": "query", |
96 "type": "string" | 112 "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 "filterSets": { | 119 "filterSets": { |
120 "methods": { | 120 "methods": { |
121 "get": { | 121 "get": { |
122 "description": "Retrieves the requested filter set f
or the account with the given account\nID.", | 122 "description": "Retrieves the requested filter set f
or the account with the given account\nID.", |
123 "httpMethod": "GET", | 123 "httpMethod": "GET", |
124 "id": "adexchangebuyer2.accounts.filterSets.get", | 124 "id": "adexchangebuyer2.accounts.filterSets.get", |
125 "parameterOrder": [ | 125 "parameterOrder": [ |
126 "accountId", | 126 "accountId", |
127 "filterSetId" | 127 "filterSetId" |
128 ], | 128 ], |
129 "parameters": { | 129 "parameters": { |
| 130 "filterSetId": { |
| 131 "description": "The ID of the filter set to
get.", |
| 132 "format": "int64", |
| 133 "location": "path", |
| 134 "required": true, |
| 135 "type": "string" |
| 136 }, |
130 "accountId": { | 137 "accountId": { |
131 "description": "Account ID of the buyer.", | 138 "description": "Account ID of the buyer.", |
132 "format": "int64", | 139 "format": "int64", |
133 "location": "path", | 140 "location": "path", |
134 "required": true, | 141 "required": true, |
135 "type": "string" | |
136 }, | |
137 "filterSetId": { | |
138 "description": "The ID of the filter set to
get.", | |
139 "format": "int64", | |
140 "location": "path", | |
141 "required": true, | |
142 "type": "string" | 142 "type": "string" |
143 } | 143 } |
144 }, | 144 }, |
145 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}", | 145 "path": "v2beta1/accounts/{accountId}/filterSets/{fi
lterSetId}", |
146 "response": { | 146 "response": { |
147 "$ref": "FilterSet" | 147 "$ref": "FilterSet" |
148 }, | 148 }, |
149 "scopes": [ | 149 "scopes": [ |
150 "https://www.googleapis.com/auth/adexchange.buye
r" | 150 "https://www.googleapis.com/auth/adexchange.buye
r" |
151 ] | 151 ] |
152 }, | 152 }, |
153 "list": { | 153 "list": { |
154 "description": "Lists all filter sets for the accoun
t with the given account ID.", | 154 "description": "Lists all filter sets for the accoun
t with the given account ID.", |
155 "httpMethod": "GET", | 155 "httpMethod": "GET", |
156 "id": "adexchangebuyer2.accounts.filterSets.list", | 156 "id": "adexchangebuyer2.accounts.filterSets.list", |
157 "parameterOrder": [ | 157 "parameterOrder": [ |
158 "accountId" | 158 "accountId" |
159 ], | 159 ], |
160 "parameters": { | 160 "parameters": { |
161 "pageToken": { | 161 "pageToken": { |
162 "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.rtb
Breakout.filterSets.list\nmethod.", | 162 "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.", |
163 "location": "query", | 163 "location": "query", |
164 "type": "string" | 164 "type": "string" |
165 }, | 165 }, |
166 "accountId": { | 166 "accountId": { |
167 "description": "Account ID of the buyer.", | 167 "description": "Account ID of the buyer.", |
168 "format": "int64", | 168 "format": "int64", |
169 "location": "path", | 169 "location": "path", |
170 "required": true, | 170 "required": true, |
171 "type": "string" | 171 "type": "string" |
172 }, | 172 }, |
173 "pageSize": { | 173 "pageSize": { |
174 "description": "Requested page size. The ser
ver may return fewer than requested.\nIf unspecified, the server will pick an ap
propriate default.", | 174 "description": "Requested page size. The ser
ver may return fewer results than requested.\nIf unspecified, the server will pi
ck an appropriate default.", |
175 "format": "int32", | 175 "format": "int32", |
176 "location": "query", | 176 "location": "query", |
177 "type": "integer" | 177 "type": "integer" |
178 } | 178 } |
179 }, | 179 }, |
180 "path": "v2beta1/accounts/{accountId}/filterSets", | 180 "path": "v2beta1/accounts/{accountId}/filterSets", |
181 "response": { | 181 "response": { |
182 "$ref": "ListFilterSetsResponse" | 182 "$ref": "ListFilterSetsResponse" |
183 }, | 183 }, |
184 "scopes": [ | 184 "scopes": [ |
(...skipping 70 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
255 "methods": { | 255 "methods": { |
256 "list": { | 256 "list": { |
257 "description": "List all reasons for which b
ids were filtered, with the number of bids\nfiltered for each reason.", | 257 "description": "List all reasons for which b
ids were filtered, with the number of bids\nfiltered for each reason.", |
258 "httpMethod": "GET", | 258 "httpMethod": "GET", |
259 "id": "adexchangebuyer2.accounts.filterSets.
filteredBids.list", | 259 "id": "adexchangebuyer2.accounts.filterSets.
filteredBids.list", |
260 "parameterOrder": [ | 260 "parameterOrder": [ |
261 "accountId", | 261 "accountId", |
262 "filterSetId" | 262 "filterSetId" |
263 ], | 263 ], |
264 "parameters": { | 264 "parameters": { |
265 "pageToken": { | |
266 "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.", | |
267 "location": "query", | |
268 "type": "string" | |
269 }, | |
270 "accountId": { | 265 "accountId": { |
271 "description": "Account ID of the bu
yer.", | 266 "description": "Account ID of the bu
yer.", |
272 "format": "int64", | 267 "format": "int64", |
273 "location": "path", | 268 "location": "path", |
274 "required": true, | 269 "required": true, |
275 "type": "string" | 270 "type": "string" |
276 }, | 271 }, |
277 "pageSize": { | 272 "pageSize": { |
278 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 273 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
279 "format": "int32", | 274 "format": "int32", |
280 "location": "query", | 275 "location": "query", |
281 "type": "integer" | 276 "type": "integer" |
282 }, | 277 }, |
283 "filterSetId": { | 278 "filterSetId": { |
284 "description": "The ID of the filter
set to apply.", | 279 "description": "The ID of the filter
set to apply.", |
285 "format": "int64", | 280 "format": "int64", |
286 "location": "path", | 281 "location": "path", |
287 "required": true, | 282 "required": true, |
288 "type": "string" | 283 "type": "string" |
| 284 }, |
| 285 "pageToken": { |
| 286 "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.", |
| 287 "location": "query", |
| 288 "type": "string" |
289 } | 289 } |
290 }, | 290 }, |
291 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredBids", | 291 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredBids", |
292 "response": { | 292 "response": { |
293 "$ref": "ListFilteredBidsResponse" | 293 "$ref": "ListFilteredBidsResponse" |
294 }, | 294 }, |
295 "scopes": [ | 295 "scopes": [ |
296 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 296 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
297 ] | 297 ] |
298 } | 298 } |
299 }, | 299 }, |
300 "resources": { | 300 "resources": { |
| 301 "details": { |
| 302 "methods": { |
| 303 "list": { |
| 304 "description": "List all details ass
ociated with a specific reason for which bids were\nfiltered, with the number of
bids filtered for each detail.", |
| 305 "httpMethod": "GET", |
| 306 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.details.list", |
| 307 "parameterOrder": [ |
| 308 "accountId", |
| 309 "filterSetId", |
| 310 "creativeStatusId" |
| 311 ], |
| 312 "parameters": { |
| 313 "creativeStatusId": { |
| 314 "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).", |
| 315 "format": "int32", |
| 316 "location": "path", |
| 317 "required": true, |
| 318 "type": "integer" |
| 319 }, |
| 320 "pageToken": { |
| 321 "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."
, |
| 322 "location": "query", |
| 323 "type": "string" |
| 324 }, |
| 325 "accountId": { |
| 326 "description": "Account ID o
f the buyer.", |
| 327 "format": "int64", |
| 328 "location": "path", |
| 329 "required": true, |
| 330 "type": "string" |
| 331 }, |
| 332 "pageSize": { |
| 333 "description": "Requested pa
ge size. The server may return fewer results than requested.\nIf unspecified, th
e server will pick an appropriate default.", |
| 334 "format": "int32", |
| 335 "location": "query", |
| 336 "type": "integer" |
| 337 }, |
| 338 "filterSetId": { |
| 339 "description": "The ID of th
e filter set to apply.", |
| 340 "format": "int64", |
| 341 "location": "path", |
| 342 "required": true, |
| 343 "type": "string" |
| 344 } |
| 345 }, |
| 346 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details", |
| 347 "response": { |
| 348 "$ref": "ListCreativeStatusBreak
downByDetailResponse" |
| 349 }, |
| 350 "scopes": [ |
| 351 "https://www.googleapis.com/auth
/adexchange.buyer" |
| 352 ] |
| 353 } |
| 354 } |
| 355 }, |
301 "creatives": { | 356 "creatives": { |
302 "methods": { | 357 "methods": { |
303 "list": { | 358 "list": { |
304 "description": "List all creatives a
ssociated with a specific reason for which bids were\nfiltered, with the number
of bids filtered for each creative.", | 359 "description": "List all creatives a
ssociated with a specific reason for which bids were\nfiltered, with the number
of bids filtered for each creative.", |
305 "httpMethod": "GET", | 360 "httpMethod": "GET", |
306 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.creatives.list", | 361 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.creatives.list", |
307 "parameterOrder": [ | 362 "parameterOrder": [ |
308 "accountId", | 363 "accountId", |
309 "filterSetId", | 364 "filterSetId", |
310 "creativeStatusId" | 365 "creativeStatusId" |
311 ], | 366 ], |
312 "parameters": { | 367 "parameters": { |
313 "filterSetId": { | |
314 "description": "The ID of th
e filter set to apply.", | |
315 "format": "int64", | |
316 "location": "path", | |
317 "required": true, | |
318 "type": "string" | |
319 }, | |
320 "creativeStatusId": { | 368 "creativeStatusId": { |
321 "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).", | 369 "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).", |
322 "format": "int32", | 370 "format": "int32", |
323 "location": "path", | 371 "location": "path", |
324 "required": true, | 372 "required": true, |
325 "type": "integer" | 373 "type": "integer" |
326 }, | 374 }, |
327 "pageToken": { | 375 "pageToken": { |
328 "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.", | 376 "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.", |
329 "location": "query", | 377 "location": "query", |
330 "type": "string" | 378 "type": "string" |
331 }, | 379 }, |
332 "accountId": { | 380 "accountId": { |
333 "description": "Account ID o
f the buyer.", | 381 "description": "Account ID o
f the buyer.", |
334 "format": "int64", | 382 "format": "int64", |
335 "location": "path", | 383 "location": "path", |
336 "required": true, | 384 "required": true, |
337 "type": "string" | 385 "type": "string" |
338 }, | 386 }, |
339 "pageSize": { | 387 "pageSize": { |
340 "description": "Requested pa
ge size. The server may return fewer than requested.\nIf unspecified, the server
will pick an appropriate default.", | 388 "description": "Requested pa
ge size. The server may return fewer results than requested.\nIf unspecified, th
e server will pick an appropriate default.", |
341 "format": "int32", | 389 "format": "int32", |
342 "location": "query", | 390 "location": "query", |
343 "type": "integer" | 391 "type": "integer" |
| 392 }, |
| 393 "filterSetId": { |
| 394 "description": "The ID of th
e filter set to apply.", |
| 395 "format": "int64", |
| 396 "location": "path", |
| 397 "required": true, |
| 398 "type": "string" |
344 } | 399 } |
345 }, | 400 }, |
346 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives", | 401 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives", |
347 "response": { | 402 "response": { |
348 "$ref": "ListCreativeStatusBreak
downByCreativeResponse" | 403 "$ref": "ListCreativeStatusBreak
downByCreativeResponse" |
349 }, | 404 }, |
350 "scopes": [ | 405 "scopes": [ |
351 "https://www.googleapis.com/auth
/adexchange.buyer" | 406 "https://www.googleapis.com/auth
/adexchange.buyer" |
352 ] | 407 ] |
353 } | 408 } |
354 }, | 409 }, |
355 "resources": { | 410 "resources": { |
356 "details": { | 411 "details": { |
357 "methods": { | 412 "methods": { |
358 "list": { | 413 "list": { |
359 "description": "List all det
ails associated with a specific reason for which bids were\nfiltered and a speci
fic creative that was filtered for that reason, with\nthe number of bids filtere
d for each detail.", | 414 "description": "List all det
ails associated with a specific reason for which bids were\nfiltered and a speci
fic creative that was filtered for that reason, with\nthe number of bids filtere
d for each detail.", |
360 "httpMethod": "GET", | 415 "httpMethod": "GET", |
361 "id": "adexchangebuyer2.acco
unts.filterSets.filteredBids.creatives.details.list", | 416 "id": "adexchangebuyer2.acco
unts.filterSets.filteredBids.creatives.details.list", |
362 "parameterOrder": [ | 417 "parameterOrder": [ |
363 "accountId", | 418 "accountId", |
364 "filterSetId", | 419 "filterSetId", |
365 "creativeStatusId", | 420 "creativeStatusId", |
366 "creativeId" | 421 "creativeId" |
367 ], | 422 ], |
368 "parameters": { | 423 "parameters": { |
| 424 "pageToken": { |
| 425 "description": "A to
ken identifying a page of results the server should return.\nTypically, this is
the value of\nListCreativeStatusAndCreativeBreakdownByDetailResponse.nextPageTok
en\nreturned from the previous call to the\naccounts.filterSets.filteredBids.cre
atives.details.list\nmethod.", |
| 426 "location": "query", |
| 427 "type": "string" |
| 428 }, |
369 "pageSize": { | 429 "pageSize": { |
370 "description": "Requ
ested page size. The server may return fewer than requested.\nIf unspecified, th
e server will pick an appropriate default.", | 430 "description": "Requ
ested page size. The server may return fewer results than requested.\nIf unspeci
fied, the server will pick an appropriate default.", |
371 "format": "int32", | 431 "format": "int32", |
372 "location": "query", | 432 "location": "query", |
373 "type": "integer" | 433 "type": "integer" |
374 }, | 434 }, |
375 "creativeId": { | 435 "creativeId": { |
376 "description": "The
creative ID for which to retrieve a breakdown by detail.", | 436 "description": "The
creative ID for which to retrieve a breakdown by detail.", |
377 "location": "path", | 437 "location": "path", |
378 "required": true, | 438 "required": true, |
379 "type": "string" | 439 "type": "string" |
380 }, | 440 }, |
(...skipping 10 matching lines...) Expand all Loading... |
391 "location": "path", | 451 "location": "path", |
392 "required": true, | 452 "required": true, |
393 "type": "string" | 453 "type": "string" |
394 }, | 454 }, |
395 "filterSetId": { | 455 "filterSetId": { |
396 "description": "The
ID of the filter set to apply.", | 456 "description": "The
ID of the filter set to apply.", |
397 "format": "int64", | 457 "format": "int64", |
398 "location": "path", | 458 "location": "path", |
399 "required": true, | 459 "required": true, |
400 "type": "string" | 460 "type": "string" |
401 }, | |
402 "pageToken": { | |
403 "description": "A to
ken identifying a page of results the server should return.\nTypically, this is
the value of\nListCreativeStatusAndCreativeBreakdownByDetailResponse.nextPageTok
en\nreturned from the previous call to the\naccounts.filterSets.filteredBids.cre
atives.details.list\nmethod.", | |
404 "location": "query", | |
405 "type": "string" | |
406 } | 461 } |
407 }, | 462 }, |
408 "path": "v2beta1/accounts/{a
ccountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives/{cr
eativeId}/details", | 463 "path": "v2beta1/accounts/{a
ccountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives/{cr
eativeId}/details", |
409 "response": { | 464 "response": { |
410 "$ref": "ListCreativeSta
tusAndCreativeBreakdownByDetailResponse" | 465 "$ref": "ListCreativeSta
tusAndCreativeBreakdownByDetailResponse" |
411 }, | 466 }, |
412 "scopes": [ | 467 "scopes": [ |
413 "https://www.googleapis.
com/auth/adexchange.buyer" | 468 "https://www.googleapis.
com/auth/adexchange.buyer" |
414 ] | 469 ] |
415 } | 470 } |
416 } | 471 } |
417 } | 472 } |
418 } | 473 } |
419 }, | |
420 "details": { | |
421 "methods": { | |
422 "list": { | |
423 "description": "List all details ass
ociated with a specific reason for which bids were\nfiltered, with the number of
bids filtered for each detail.", | |
424 "httpMethod": "GET", | |
425 "id": "adexchangebuyer2.accounts.fil
terSets.filteredBids.details.list", | |
426 "parameterOrder": [ | |
427 "accountId", | |
428 "filterSetId", | |
429 "creativeStatusId" | |
430 ], | |
431 "parameters": { | |
432 "filterSetId": { | |
433 "description": "The ID of th
e filter set to apply.", | |
434 "format": "int64", | |
435 "location": "path", | |
436 "required": true, | |
437 "type": "string" | |
438 }, | |
439 "creativeStatusId": { | |
440 "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).", | |
441 "format": "int32", | |
442 "location": "path", | |
443 "required": true, | |
444 "type": "integer" | |
445 }, | |
446 "pageToken": { | |
447 "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."
, | |
448 "location": "query", | |
449 "type": "string" | |
450 }, | |
451 "accountId": { | |
452 "description": "Account ID o
f the buyer.", | |
453 "format": "int64", | |
454 "location": "path", | |
455 "required": true, | |
456 "type": "string" | |
457 }, | |
458 "pageSize": { | |
459 "description": "Requested pa
ge size. The server may return fewer than requested.\nIf unspecified, the server
will pick an appropriate default.", | |
460 "format": "int32", | |
461 "location": "query", | |
462 "type": "integer" | |
463 } | |
464 }, | |
465 "path": "v2beta1/accounts/{accountId
}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/details", | |
466 "response": { | |
467 "$ref": "ListCreativeStatusBreak
downByDetailResponse" | |
468 }, | |
469 "scopes": [ | |
470 "https://www.googleapis.com/auth
/adexchange.buyer" | |
471 ] | |
472 } | |
473 } | |
474 } | 474 } |
475 } | 475 } |
476 }, | 476 }, |
477 "filteredImpressions": { | 477 "nonBillableWinningBids": { |
478 "methods": { | 478 "methods": { |
479 "list": { | 479 "list": { |
480 "description": "List all reasons that caused
an impression to be filtered (i.e. not\nconsidered as an inventory match), with
the number of impressions that were\nfiltered for each reason.", | 480 "description": "List all reasons for which w
inning bids were not billable, with the number\nof bids not billed for each reas
on.", |
481 "httpMethod": "GET", | 481 "httpMethod": "GET", |
482 "id": "adexchangebuyer2.accounts.filterSets.
filteredImpressions.list", | 482 "id": "adexchangebuyer2.accounts.filterSets.
nonBillableWinningBids.list", |
483 "parameterOrder": [ | 483 "parameterOrder": [ |
484 "accountId", | 484 "accountId", |
485 "filterSetId" | 485 "filterSetId" |
486 ], | 486 ], |
487 "parameters": { | 487 "parameters": { |
488 "pageToken": { | 488 "pageToken": { |
489 "description": "A token identifying
a page of results the server should return.\nTypically, this is the value of\nLi
stFilteredImpressionsResponse.nextPageToken\nreturned from the previous call to
the\naccounts.filterSets.filteredImpressions.list\nmethod.", | 489 "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.", |
490 "location": "query", | 490 "location": "query", |
491 "type": "string" | 491 "type": "string" |
492 }, | 492 }, |
493 "accountId": { | 493 "accountId": { |
494 "description": "Account ID of the bu
yer.", | 494 "description": "Account ID of the bu
yer.", |
495 "format": "int64", | 495 "format": "int64", |
496 "location": "path", | 496 "location": "path", |
497 "required": true, | 497 "required": true, |
498 "type": "string" | 498 "type": "string" |
499 }, | 499 }, |
500 "pageSize": { | 500 "pageSize": { |
501 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 501 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
502 "format": "int32", | 502 "format": "int32", |
503 "location": "query", | 503 "location": "query", |
504 "type": "integer" | 504 "type": "integer" |
505 }, | 505 }, |
506 "filterSetId": { | 506 "filterSetId": { |
507 "description": "The ID of the filter
set to apply.", | 507 "description": "The ID of the filter
set to apply.", |
508 "format": "int64", | 508 "format": "int64", |
509 "location": "path", | 509 "location": "path", |
510 "required": true, | 510 "required": true, |
511 "type": "string" | 511 "type": "string" |
512 } | 512 } |
513 }, | 513 }, |
514 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/filteredImpressions", | 514 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/nonBillableWinningBids", |
515 "response": { | 515 "response": { |
516 "$ref": "ListFilteredImpressionsResponse
" | 516 "$ref": "ListNonBillableWinningBidsRespo
nse" |
517 }, | 517 }, |
518 "scopes": [ | 518 "scopes": [ |
519 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 519 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
520 ] | 520 ] |
521 } | 521 } |
522 } | 522 } |
523 }, | 523 }, |
524 "losingBids": { | 524 "losingBids": { |
525 "methods": { | 525 "methods": { |
526 "list": { | 526 "list": { |
(...skipping 11 matching lines...) Expand all Loading... |
538 "type": "string" | 538 "type": "string" |
539 }, | 539 }, |
540 "accountId": { | 540 "accountId": { |
541 "description": "Account ID of the bu
yer.", | 541 "description": "Account ID of the bu
yer.", |
542 "format": "int64", | 542 "format": "int64", |
543 "location": "path", | 543 "location": "path", |
544 "required": true, | 544 "required": true, |
545 "type": "string" | 545 "type": "string" |
546 }, | 546 }, |
547 "pageSize": { | 547 "pageSize": { |
548 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 548 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
549 "format": "int32", | 549 "format": "int32", |
550 "location": "query", | 550 "location": "query", |
551 "type": "integer" | 551 "type": "integer" |
552 }, | 552 }, |
553 "filterSetId": { | 553 "filterSetId": { |
554 "description": "The ID of the filter
set to apply.", | 554 "description": "The ID of the filter
set to apply.", |
555 "format": "int64", | 555 "format": "int64", |
556 "location": "path", | 556 "location": "path", |
557 "required": true, | 557 "required": true, |
558 "type": "string" | 558 "type": "string" |
559 } | 559 } |
560 }, | 560 }, |
561 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/losingBids", | 561 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/losingBids", |
562 "response": { | 562 "response": { |
563 "$ref": "ListLosingBidsResponse" | 563 "$ref": "ListLosingBidsResponse" |
564 }, | 564 }, |
565 "scopes": [ | 565 "scopes": [ |
566 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 566 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
567 ] | 567 ] |
568 } | 568 } |
569 } | 569 } |
570 }, | 570 }, |
571 "bidMetrics": { | 571 "impressionMetrics": { |
572 "methods": { | 572 "methods": { |
573 "list": { | 573 "list": { |
574 "description": "Lists all metrics that are m
easured in terms of number of bids.", | 574 "description": "Lists all metrics that are m
easured in terms of number of impressions.", |
575 "httpMethod": "GET", | 575 "httpMethod": "GET", |
576 "id": "adexchangebuyer2.accounts.filterSets.
bidMetrics.list", | 576 "id": "adexchangebuyer2.accounts.filterSets.
impressionMetrics.list", |
577 "parameterOrder": [ | 577 "parameterOrder": [ |
578 "accountId", | 578 "accountId", |
579 "filterSetId" | 579 "filterSetId" |
580 ], | 580 ], |
581 "parameters": { | 581 "parameters": { |
582 "filterSetId": { | |
583 "description": "The ID of the filter
set to apply.", | |
584 "format": "int64", | |
585 "location": "path", | |
586 "required": true, | |
587 "type": "string" | |
588 }, | |
589 "pageToken": { | 582 "pageToken": { |
590 "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.", | 583 "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.", |
591 "location": "query", | 584 "location": "query", |
592 "type": "string" | 585 "type": "string" |
593 }, | 586 }, |
594 "accountId": { | 587 "accountId": { |
595 "description": "Account ID of the bu
yer.", | 588 "description": "Account ID of the bu
yer.", |
596 "format": "int64", | 589 "format": "int64", |
597 "location": "path", | 590 "location": "path", |
598 "required": true, | 591 "required": true, |
599 "type": "string" | 592 "type": "string" |
600 }, | 593 }, |
601 "pageSize": { | 594 "pageSize": { |
602 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 595 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
603 "format": "int32", | 596 "format": "int32", |
604 "location": "query", | 597 "location": "query", |
605 "type": "integer" | 598 "type": "integer" |
| 599 }, |
| 600 "filterSetId": { |
| 601 "description": "The ID of the filter
set to apply.", |
| 602 "format": "int64", |
| 603 "location": "path", |
| 604 "required": true, |
| 605 "type": "string" |
606 } | 606 } |
607 }, | 607 }, |
608 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidMetrics", | 608 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/impressionMetrics", |
609 "response": { | 609 "response": { |
610 "$ref": "ListBidMetricsResponse" | 610 "$ref": "ListImpressionMetricsResponse" |
611 }, | 611 }, |
612 "scopes": [ | 612 "scopes": [ |
613 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 613 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
614 ] | 614 ] |
615 } | 615 } |
616 } | 616 } |
617 }, | 617 }, |
618 "impressionMetrics": { | 618 "bidMetrics": { |
619 "methods": { | 619 "methods": { |
620 "list": { | 620 "list": { |
621 "description": "Lists all metrics that are m
easured in terms of number of impressions.", | 621 "description": "Lists all metrics that are m
easured in terms of number of bids.", |
622 "httpMethod": "GET", | 622 "httpMethod": "GET", |
623 "id": "adexchangebuyer2.accounts.filterSets.
impressionMetrics.list", | 623 "id": "adexchangebuyer2.accounts.filterSets.
bidMetrics.list", |
624 "parameterOrder": [ | 624 "parameterOrder": [ |
625 "accountId", | 625 "accountId", |
626 "filterSetId" | 626 "filterSetId" |
627 ], | 627 ], |
628 "parameters": { | 628 "parameters": { |
629 "pageToken": { | 629 "pageToken": { |
630 "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.", | 630 "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.", |
631 "location": "query", | 631 "location": "query", |
632 "type": "string" | 632 "type": "string" |
633 }, | 633 }, |
634 "accountId": { | 634 "accountId": { |
635 "description": "Account ID of the bu
yer.", | 635 "description": "Account ID of the bu
yer.", |
636 "format": "int64", | 636 "format": "int64", |
637 "location": "path", | 637 "location": "path", |
638 "required": true, | 638 "required": true, |
639 "type": "string" | 639 "type": "string" |
640 }, | 640 }, |
641 "pageSize": { | 641 "pageSize": { |
642 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 642 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
643 "format": "int32", | 643 "format": "int32", |
644 "location": "query", | 644 "location": "query", |
645 "type": "integer" | 645 "type": "integer" |
646 }, | 646 }, |
647 "filterSetId": { | 647 "filterSetId": { |
648 "description": "The ID of the filter
set to apply.", | 648 "description": "The ID of the filter
set to apply.", |
649 "format": "int64", | 649 "format": "int64", |
650 "location": "path", | 650 "location": "path", |
651 "required": true, | 651 "required": true, |
652 "type": "string" | 652 "type": "string" |
653 } | 653 } |
654 }, | 654 }, |
655 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/impressionMetrics", | 655 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidMetrics", |
656 "response": { | 656 "response": { |
657 "$ref": "ListImpressionMetricsResponse" | 657 "$ref": "ListBidMetricsResponse" |
658 }, | 658 }, |
659 "scopes": [ | 659 "scopes": [ |
660 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 660 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
661 ] | 661 ] |
662 } | 662 } |
663 } | 663 } |
664 }, | 664 }, |
665 "bidResponseErrors": { | 665 "bidResponseErrors": { |
666 "methods": { | 666 "methods": { |
667 "list": { | 667 "list": { |
668 "description": "List all errors that occurre
d in bid responses, with the number of bid\nresponses affected for each reason."
, | 668 "description": "List all errors that occurre
d in bid responses, with the number of bid\nresponses affected for each reason."
, |
669 "httpMethod": "GET", | 669 "httpMethod": "GET", |
670 "id": "adexchangebuyer2.accounts.filterSets.
bidResponseErrors.list", | 670 "id": "adexchangebuyer2.accounts.filterSets.
bidResponseErrors.list", |
671 "parameterOrder": [ | 671 "parameterOrder": [ |
672 "accountId", | 672 "accountId", |
673 "filterSetId" | 673 "filterSetId" |
674 ], | 674 ], |
675 "parameters": { | 675 "parameters": { |
| 676 "filterSetId": { |
| 677 "description": "The ID of the filter
set to apply.", |
| 678 "format": "int64", |
| 679 "location": "path", |
| 680 "required": true, |
| 681 "type": "string" |
| 682 }, |
676 "pageToken": { | 683 "pageToken": { |
677 "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.", | 684 "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.", |
678 "location": "query", | 685 "location": "query", |
679 "type": "string" | 686 "type": "string" |
680 }, | 687 }, |
681 "accountId": { | 688 "accountId": { |
682 "description": "Account ID of the bu
yer.", | 689 "description": "Account ID of the bu
yer.", |
683 "format": "int64", | 690 "format": "int64", |
684 "location": "path", | 691 "location": "path", |
685 "required": true, | 692 "required": true, |
686 "type": "string" | 693 "type": "string" |
687 }, | 694 }, |
688 "pageSize": { | 695 "pageSize": { |
689 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 696 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
690 "format": "int32", | 697 "format": "int32", |
691 "location": "query", | 698 "location": "query", |
692 "type": "integer" | 699 "type": "integer" |
693 }, | |
694 "filterSetId": { | |
695 "description": "The ID of the filter
set to apply.", | |
696 "format": "int64", | |
697 "location": "path", | |
698 "required": true, | |
699 "type": "string" | |
700 } | 700 } |
701 }, | 701 }, |
702 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponseErrors", | 702 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponseErrors", |
703 "response": { | 703 "response": { |
704 "$ref": "ListBidResponseErrorsResponse" | 704 "$ref": "ListBidResponseErrorsResponse" |
705 }, | 705 }, |
706 "scopes": [ | 706 "scopes": [ |
707 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 707 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
708 ] | 708 ] |
709 } | 709 } |
710 } | 710 } |
711 }, | 711 }, |
712 "bidResponsesWithoutBids": { | 712 "bidResponsesWithoutBids": { |
713 "methods": { | 713 "methods": { |
714 "list": { | 714 "list": { |
715 "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.", | 715 "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.", |
716 "httpMethod": "GET", | 716 "httpMethod": "GET", |
717 "id": "adexchangebuyer2.accounts.filterSets.
bidResponsesWithoutBids.list", | 717 "id": "adexchangebuyer2.accounts.filterSets.
bidResponsesWithoutBids.list", |
718 "parameterOrder": [ | 718 "parameterOrder": [ |
719 "accountId", | 719 "accountId", |
720 "filterSetId" | 720 "filterSetId" |
721 ], | 721 ], |
722 "parameters": { | 722 "parameters": { |
| 723 "filterSetId": { |
| 724 "description": "The ID of the filter
set to apply.", |
| 725 "format": "int64", |
| 726 "location": "path", |
| 727 "required": true, |
| 728 "type": "string" |
| 729 }, |
723 "pageToken": { | 730 "pageToken": { |
724 "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.", | 731 "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.", |
725 "location": "query", | 732 "location": "query", |
726 "type": "string" | 733 "type": "string" |
727 }, | 734 }, |
728 "accountId": { | 735 "accountId": { |
729 "description": "Account ID of the bu
yer.", | 736 "description": "Account ID of the bu
yer.", |
730 "format": "int64", | 737 "format": "int64", |
731 "location": "path", | 738 "location": "path", |
732 "required": true, | 739 "required": true, |
733 "type": "string" | 740 "type": "string" |
734 }, | 741 }, |
735 "pageSize": { | 742 "pageSize": { |
736 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 743 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
737 "format": "int32", | 744 "format": "int32", |
738 "location": "query", | 745 "location": "query", |
739 "type": "integer" | 746 "type": "integer" |
740 }, | |
741 "filterSetId": { | |
742 "description": "The ID of the filter
set to apply.", | |
743 "format": "int64", | |
744 "location": "path", | |
745 "required": true, | |
746 "type": "string" | |
747 } | 747 } |
748 }, | 748 }, |
749 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponsesWithoutBids", | 749 "path": "v2beta1/accounts/{accountId}/filter
Sets/{filterSetId}/bidResponsesWithoutBids", |
750 "response": { | 750 "response": { |
751 "$ref": "ListBidResponsesWithoutBidsResp
onse" | 751 "$ref": "ListBidResponsesWithoutBidsResp
onse" |
752 }, | 752 }, |
753 "scopes": [ | 753 "scopes": [ |
754 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 754 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
755 ] | 755 ] |
756 } | 756 } |
(...skipping 16 matching lines...) Expand all Loading... |
773 "type": "string" | 773 "type": "string" |
774 }, | 774 }, |
775 "accountId": { | 775 "accountId": { |
776 "description": "Account ID of the bu
yer.", | 776 "description": "Account ID of the bu
yer.", |
777 "format": "int64", | 777 "format": "int64", |
778 "location": "path", | 778 "location": "path", |
779 "required": true, | 779 "required": true, |
780 "type": "string" | 780 "type": "string" |
781 }, | 781 }, |
782 "pageSize": { | 782 "pageSize": { |
783 "description": "Requested page size.
The server may return fewer than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 783 "description": "Requested page size.
The server may return fewer results than requested.\nIf unspecified, the server
will pick an appropriate default.", |
784 "format": "int32", | 784 "format": "int32", |
785 "location": "query", | 785 "location": "query", |
786 "type": "integer" | 786 "type": "integer" |
787 }, | 787 }, |
788 "filterSetId": { | 788 "filterSetId": { |
789 "description": "The ID of the filter
set to apply.", | 789 "description": "The ID of the filter
set to apply.", |
790 "format": "int64", | 790 "format": "int64", |
791 "location": "path", | 791 "location": "path", |
792 "required": true, | 792 "required": true, |
793 "type": "string" | 793 "type": "string" |
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
840 ] | 840 ] |
841 }, | 841 }, |
842 "list": { | 842 "list": { |
843 "description": "Lists all the clients for the curren
t sponsor buyer.", | 843 "description": "Lists all the clients for the curren
t sponsor buyer.", |
844 "httpMethod": "GET", | 844 "httpMethod": "GET", |
845 "id": "adexchangebuyer2.accounts.clients.list", | 845 "id": "adexchangebuyer2.accounts.clients.list", |
846 "parameterOrder": [ | 846 "parameterOrder": [ |
847 "accountId" | 847 "accountId" |
848 ], | 848 ], |
849 "parameters": { | 849 "parameters": { |
850 "pageToken": { | |
851 "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.", | |
852 "location": "query", | |
853 "type": "string" | |
854 }, | |
855 "accountId": { | 850 "accountId": { |
856 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", | 851 "description": "Unique numerical account ID
of the sponsor buyer to list the clients for.", |
857 "format": "int64", | 852 "format": "int64", |
858 "location": "path", | 853 "location": "path", |
859 "required": true, | 854 "required": true, |
860 "type": "string" | 855 "type": "string" |
861 }, | 856 }, |
862 "pageSize": { | 857 "pageSize": { |
863 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", | 858 "description": "Requested page size. The ser
ver may return fewer clients than requested.\nIf unspecified, the server will pi
ck an appropriate default.", |
864 "format": "int32", | 859 "format": "int32", |
865 "location": "query", | 860 "location": "query", |
866 "type": "integer" | 861 "type": "integer" |
| 862 }, |
| 863 "pageToken": { |
| 864 "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.", |
| 865 "location": "query", |
| 866 "type": "string" |
867 } | 867 } |
868 }, | 868 }, |
869 "path": "v2beta1/accounts/{accountId}/clients", | 869 "path": "v2beta1/accounts/{accountId}/clients", |
870 "response": { | 870 "response": { |
871 "$ref": "ListClientsResponse" | 871 "$ref": "ListClientsResponse" |
872 }, | 872 }, |
873 "scopes": [ | 873 "scopes": [ |
874 "https://www.googleapis.com/auth/adexchange.buye
r" | 874 "https://www.googleapis.com/auth/adexchange.buye
r" |
875 ] | 875 ] |
876 }, | 876 }, |
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
933 "$ref": "Client" | 933 "$ref": "Client" |
934 }, | 934 }, |
935 "scopes": [ | 935 "scopes": [ |
936 "https://www.googleapis.com/auth/adexchange.buye
r" | 936 "https://www.googleapis.com/auth/adexchange.buye
r" |
937 ] | 937 ] |
938 } | 938 } |
939 }, | 939 }, |
940 "resources": { | 940 "resources": { |
941 "invitations": { | 941 "invitations": { |
942 "methods": { | 942 "methods": { |
| 943 "create": { |
| 944 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", |
| 945 "httpMethod": "POST", |
| 946 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", |
| 947 "parameterOrder": [ |
| 948 "accountId", |
| 949 "clientAccountId" |
| 950 ], |
| 951 "parameters": { |
| 952 "accountId": { |
| 953 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
| 954 "format": "int64", |
| 955 "location": "path", |
| 956 "required": true, |
| 957 "type": "string" |
| 958 }, |
| 959 "clientAccountId": { |
| 960 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", |
| 961 "format": "int64", |
| 962 "location": "path", |
| 963 "required": true, |
| 964 "type": "string" |
| 965 } |
| 966 }, |
| 967 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
| 968 "request": { |
| 969 "$ref": "ClientUserInvitation" |
| 970 }, |
| 971 "response": { |
| 972 "$ref": "ClientUserInvitation" |
| 973 }, |
| 974 "scopes": [ |
| 975 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
| 976 ] |
| 977 }, |
943 "get": { | 978 "get": { |
944 "description": "Retrieves an existing client
user invitation.", | 979 "description": "Retrieves an existing client
user invitation.", |
945 "httpMethod": "GET", | 980 "httpMethod": "GET", |
946 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", | 981 "id": "adexchangebuyer2.accounts.clients.inv
itations.get", |
947 "parameterOrder": [ | 982 "parameterOrder": [ |
948 "accountId", | 983 "accountId", |
949 "clientAccountId", | 984 "clientAccountId", |
950 "invitationId" | 985 "invitationId" |
951 ], | 986 ], |
952 "parameters": { | 987 "parameters": { |
| 988 "invitationId": { |
| 989 "description": "Numerical identifier
of the user invitation to retrieve. (required)", |
| 990 "format": "int64", |
| 991 "location": "path", |
| 992 "required": true, |
| 993 "type": "string" |
| 994 }, |
953 "accountId": { | 995 "accountId": { |
954 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 996 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
955 "format": "int64", | 997 "format": "int64", |
956 "location": "path", | 998 "location": "path", |
957 "required": true, | 999 "required": true, |
958 "type": "string" | 1000 "type": "string" |
959 }, | 1001 }, |
960 "clientAccountId": { | 1002 "clientAccountId": { |
961 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", | 1003 "description": "Numerical account ID
of the client buyer that the user invitation\nto be retrieved is associated wit
h. (required)", |
962 "format": "int64", | 1004 "format": "int64", |
963 "location": "path", | 1005 "location": "path", |
964 "required": true, | 1006 "required": true, |
965 "type": "string" | |
966 }, | |
967 "invitationId": { | |
968 "description": "Numerical identifier
of the user invitation to retrieve. (required)", | |
969 "format": "int64", | |
970 "location": "path", | |
971 "required": true, | |
972 "type": "string" | 1007 "type": "string" |
973 } | 1008 } |
974 }, | 1009 }, |
975 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", | 1010 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations/{invitationId}", |
976 "response": { | 1011 "response": { |
977 "$ref": "ClientUserInvitation" | 1012 "$ref": "ClientUserInvitation" |
978 }, | 1013 }, |
979 "scopes": [ | 1014 "scopes": [ |
980 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1015 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
981 ] | 1016 ] |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1014 "type": "string" | 1049 "type": "string" |
1015 } | 1050 } |
1016 }, | 1051 }, |
1017 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 1052 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", |
1018 "response": { | 1053 "response": { |
1019 "$ref": "ListClientUserInvitationsRespon
se" | 1054 "$ref": "ListClientUserInvitationsRespon
se" |
1020 }, | 1055 }, |
1021 "scopes": [ | 1056 "scopes": [ |
1022 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1057 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1023 ] | 1058 ] |
1024 }, | 1059 } |
1025 "create": { | 1060 } |
1026 "description": "Creates and sends out an ema
il invitation to access\nan Ad Exchange client buyer account.", | 1061 }, |
1027 "httpMethod": "POST", | 1062 "users": { |
1028 "id": "adexchangebuyer2.accounts.clients.inv
itations.create", | 1063 "methods": { |
| 1064 "update": { |
| 1065 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", |
| 1066 "httpMethod": "PUT", |
| 1067 "id": "adexchangebuyer2.accounts.clients.use
rs.update", |
1029 "parameterOrder": [ | 1068 "parameterOrder": [ |
1030 "accountId", | 1069 "accountId", |
1031 "clientAccountId" | 1070 "clientAccountId", |
| 1071 "userId" |
1032 ], | 1072 ], |
1033 "parameters": { | 1073 "parameters": { |
| 1074 "userId": { |
| 1075 "description": "Numerical identifier
of the user to retrieve. (required)", |
| 1076 "format": "int64", |
| 1077 "location": "path", |
| 1078 "required": true, |
| 1079 "type": "string" |
| 1080 }, |
1034 "accountId": { | 1081 "accountId": { |
1035 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | 1082 "description": "Numerical account ID
of the client's sponsor buyer. (required)", |
1036 "format": "int64", | 1083 "format": "int64", |
1037 "location": "path", | 1084 "location": "path", |
1038 "required": true, | 1085 "required": true, |
1039 "type": "string" | 1086 "type": "string" |
1040 }, | 1087 }, |
1041 "clientAccountId": { | 1088 "clientAccountId": { |
1042 "description": "Numerical account ID
of the client buyer that the user\nshould be associated with. (required)", | 1089 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", |
1043 "format": "int64", | 1090 "format": "int64", |
1044 "location": "path", | 1091 "location": "path", |
1045 "required": true, | 1092 "required": true, |
1046 "type": "string" | 1093 "type": "string" |
1047 } | 1094 } |
1048 }, | 1095 }, |
1049 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/invitations", | 1096 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
1050 "request": { | 1097 "request": { |
1051 "$ref": "ClientUserInvitation" | 1098 "$ref": "ClientUser" |
1052 }, | 1099 }, |
1053 "response": { | 1100 "response": { |
1054 "$ref": "ClientUserInvitation" | 1101 "$ref": "ClientUser" |
1055 }, | 1102 }, |
1056 "scopes": [ | 1103 "scopes": [ |
1057 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1104 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1058 ] | 1105 ] |
1059 } | 1106 }, |
1060 } | |
1061 }, | |
1062 "users": { | |
1063 "methods": { | |
1064 "list": { | 1107 "list": { |
1065 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", | 1108 "description": "Lists all the known client u
sers for a specified\nsponsor buyer account ID.", |
1066 "httpMethod": "GET", | 1109 "httpMethod": "GET", |
1067 "id": "adexchangebuyer2.accounts.clients.use
rs.list", | 1110 "id": "adexchangebuyer2.accounts.clients.use
rs.list", |
1068 "parameterOrder": [ | 1111 "parameterOrder": [ |
1069 "accountId", | 1112 "accountId", |
1070 "clientAccountId" | 1113 "clientAccountId" |
1071 ], | 1114 ], |
1072 "parameters": { | 1115 "parameters": { |
1073 "clientAccountId": { | |
1074 "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.", | |
1075 "location": "path", | |
1076 "required": true, | |
1077 "type": "string" | |
1078 }, | |
1079 "pageToken": { | 1116 "pageToken": { |
1080 "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.", | 1117 "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.", |
1081 "location": "query", | 1118 "location": "query", |
1082 "type": "string" | 1119 "type": "string" |
1083 }, | 1120 }, |
1084 "accountId": { | 1121 "accountId": { |
1085 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", | 1122 "description": "Numerical account ID
of the sponsor buyer of the client to list users for.\n(required)", |
1086 "format": "int64", | 1123 "format": "int64", |
1087 "location": "path", | 1124 "location": "path", |
1088 "required": true, | 1125 "required": true, |
1089 "type": "string" | 1126 "type": "string" |
1090 }, | 1127 }, |
1091 "pageSize": { | 1128 "pageSize": { |
1092 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", | 1129 "description": "Requested page size.
The server may return fewer clients than requested.\nIf unspecified, the server
will pick an appropriate default.", |
1093 "format": "int32", | 1130 "format": "int32", |
1094 "location": "query", | 1131 "location": "query", |
1095 "type": "integer" | 1132 "type": "integer" |
| 1133 }, |
| 1134 "clientAccountId": { |
| 1135 "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.", |
| 1136 "location": "path", |
| 1137 "required": true, |
| 1138 "type": "string" |
1096 } | 1139 } |
1097 }, | 1140 }, |
1098 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", | 1141 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users", |
1099 "response": { | 1142 "response": { |
1100 "$ref": "ListClientUsersResponse" | 1143 "$ref": "ListClientUsersResponse" |
1101 }, | 1144 }, |
1102 "scopes": [ | 1145 "scopes": [ |
1103 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1146 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1104 ] | 1147 ] |
1105 }, | 1148 }, |
(...skipping 29 matching lines...) Expand all Loading... |
1135 "type": "string" | 1178 "type": "string" |
1136 } | 1179 } |
1137 }, | 1180 }, |
1138 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | 1181 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", |
1139 "response": { | 1182 "response": { |
1140 "$ref": "ClientUser" | 1183 "$ref": "ClientUser" |
1141 }, | 1184 }, |
1142 "scopes": [ | 1185 "scopes": [ |
1143 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1186 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1144 ] | 1187 ] |
1145 }, | |
1146 "update": { | |
1147 "description": "Updates an existing client u
ser.\nOnly the user status can be changed on update.", | |
1148 "httpMethod": "PUT", | |
1149 "id": "adexchangebuyer2.accounts.clients.use
rs.update", | |
1150 "parameterOrder": [ | |
1151 "accountId", | |
1152 "clientAccountId", | |
1153 "userId" | |
1154 ], | |
1155 "parameters": { | |
1156 "userId": { | |
1157 "description": "Numerical identifier
of the user to retrieve. (required)", | |
1158 "format": "int64", | |
1159 "location": "path", | |
1160 "required": true, | |
1161 "type": "string" | |
1162 }, | |
1163 "accountId": { | |
1164 "description": "Numerical account ID
of the client's sponsor buyer. (required)", | |
1165 "format": "int64", | |
1166 "location": "path", | |
1167 "required": true, | |
1168 "type": "string" | |
1169 }, | |
1170 "clientAccountId": { | |
1171 "description": "Numerical account ID
of the client buyer that the user to be retrieved\nis associated with. (require
d)", | |
1172 "format": "int64", | |
1173 "location": "path", | |
1174 "required": true, | |
1175 "type": "string" | |
1176 } | |
1177 }, | |
1178 "path": "v2beta1/accounts/{accountId}/client
s/{clientAccountId}/users/{userId}", | |
1179 "request": { | |
1180 "$ref": "ClientUser" | |
1181 }, | |
1182 "response": { | |
1183 "$ref": "ClientUser" | |
1184 }, | |
1185 "scopes": [ | |
1186 "https://www.googleapis.com/auth/adexcha
nge.buyer" | |
1187 ] | |
1188 } | 1188 } |
1189 } | 1189 } |
1190 } | 1190 } |
1191 } | 1191 } |
1192 }, | 1192 }, |
1193 "creatives": { | 1193 "creatives": { |
1194 "methods": { | 1194 "methods": { |
1195 "list": { | |
1196 "description": "Lists creatives.", | |
1197 "httpMethod": "GET", | |
1198 "id": "adexchangebuyer2.accounts.creatives.list", | |
1199 "parameterOrder": [ | |
1200 "accountId" | |
1201 ], | |
1202 "parameters": { | |
1203 "pageToken": { | |
1204 "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.", | |
1205 "location": "query", | |
1206 "type": "string" | |
1207 }, | |
1208 "accountId": { | |
1209 "description": "The account to list the crea
tives from.\nSpecify \"-\" to list all creatives the current user has access to.
", | |
1210 "location": "path", | |
1211 "required": true, | |
1212 "type": "string" | |
1213 }, | |
1214 "pageSize": { | |
1215 "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.", | |
1216 "format": "int32", | |
1217 "location": "query", | |
1218 "type": "integer" | |
1219 }, | |
1220 "query": { | |
1221 "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'", | |
1222 "location": "query", | |
1223 "type": "string" | |
1224 } | |
1225 }, | |
1226 "path": "v2beta1/accounts/{accountId}/creatives", | |
1227 "response": { | |
1228 "$ref": "ListCreativesResponse" | |
1229 }, | |
1230 "scopes": [ | |
1231 "https://www.googleapis.com/auth/adexchange.buye
r" | |
1232 ] | |
1233 }, | |
1234 "create": { | 1195 "create": { |
1235 "description": "Creates a creative.", | 1196 "description": "Creates a creative.", |
1236 "httpMethod": "POST", | 1197 "httpMethod": "POST", |
1237 "id": "adexchangebuyer2.accounts.creatives.create", | 1198 "id": "adexchangebuyer2.accounts.creatives.create", |
1238 "parameterOrder": [ | 1199 "parameterOrder": [ |
1239 "accountId" | 1200 "accountId" |
1240 ], | 1201 ], |
1241 "parameters": { | 1202 "parameters": { |
1242 "duplicateIdMode": { | 1203 "duplicateIdMode": { |
1243 "description": "Indicates if multiple creati
ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", | 1204 "description": "Indicates if multiple creati
ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", |
(...skipping 24 matching lines...) Expand all Loading... |
1268 }, | 1229 }, |
1269 "stopWatching": { | 1230 "stopWatching": { |
1270 "description": "Stops watching a creative. Will stop
push notifications being sent to the\ntopics when the creative changes status."
, | 1231 "description": "Stops watching a creative. Will stop
push notifications being sent to the\ntopics when the creative changes status."
, |
1271 "httpMethod": "POST", | 1232 "httpMethod": "POST", |
1272 "id": "adexchangebuyer2.accounts.creatives.stopWatch
ing", | 1233 "id": "adexchangebuyer2.accounts.creatives.stopWatch
ing", |
1273 "parameterOrder": [ | 1234 "parameterOrder": [ |
1274 "accountId", | 1235 "accountId", |
1275 "creativeId" | 1236 "creativeId" |
1276 ], | 1237 ], |
1277 "parameters": { | 1238 "parameters": { |
| 1239 "accountId": { |
| 1240 "description": "The account of the creative
to stop notifications for.", |
| 1241 "location": "path", |
| 1242 "required": true, |
| 1243 "type": "string" |
| 1244 }, |
1278 "creativeId": { | 1245 "creativeId": { |
1279 "description": "The creative ID of the creat
ive to stop notifications for.\nSpecify \"-\" to specify stopping account level
notifications.", | 1246 "description": "The creative ID of the creat
ive to stop notifications for.\nSpecify \"-\" to specify stopping account level
notifications.", |
1280 "location": "path", | 1247 "location": "path", |
1281 "required": true, | 1248 "required": true, |
1282 "type": "string" | 1249 "type": "string" |
1283 }, | |
1284 "accountId": { | |
1285 "description": "The account of the creative
to stop notifications for.", | |
1286 "location": "path", | |
1287 "required": true, | |
1288 "type": "string" | |
1289 } | 1250 } |
1290 }, | 1251 }, |
1291 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:stopWatching", | 1252 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}:stopWatching", |
1292 "request": { | 1253 "request": { |
1293 "$ref": "StopWatchingCreativeRequest" | 1254 "$ref": "StopWatchingCreativeRequest" |
1294 }, | 1255 }, |
1295 "response": { | 1256 "response": { |
1296 "$ref": "Empty" | 1257 "$ref": "Empty" |
1297 }, | 1258 }, |
1298 "scopes": [ | 1259 "scopes": [ |
(...skipping 65 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1364 }, | 1325 }, |
1365 "update": { | 1326 "update": { |
1366 "description": "Updates a creative.", | 1327 "description": "Updates a creative.", |
1367 "httpMethod": "PUT", | 1328 "httpMethod": "PUT", |
1368 "id": "adexchangebuyer2.accounts.creatives.update", | 1329 "id": "adexchangebuyer2.accounts.creatives.update", |
1369 "parameterOrder": [ | 1330 "parameterOrder": [ |
1370 "accountId", | 1331 "accountId", |
1371 "creativeId" | 1332 "creativeId" |
1372 ], | 1333 ], |
1373 "parameters": { | 1334 "parameters": { |
| 1335 "creativeId": { |
| 1336 "description": "The buyer-defined creative I
D of this creative.\nCan be used to filter the response of the\ncreatives.list\n
method.", |
| 1337 "location": "path", |
| 1338 "required": true, |
| 1339 "type": "string" |
| 1340 }, |
1374 "accountId": { | 1341 "accountId": { |
1375 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", | 1342 "description": "The account that this creati
ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho
d.", |
1376 "location": "path", | 1343 "location": "path", |
1377 "required": true, | 1344 "required": true, |
1378 "type": "string" | 1345 "type": "string" |
1379 }, | |
1380 "creativeId": { | |
1381 "description": "The buyer-defined creative I
D of this creative.\nCan be used to filter the response of the\ncreatives.list\n
method.", | |
1382 "location": "path", | |
1383 "required": true, | |
1384 "type": "string" | |
1385 } | 1346 } |
1386 }, | 1347 }, |
1387 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", | 1348 "path": "v2beta1/accounts/{accountId}/creatives/{cre
ativeId}", |
1388 "request": { | 1349 "request": { |
1389 "$ref": "Creative" | 1350 "$ref": "Creative" |
1390 }, | 1351 }, |
1391 "response": { | 1352 "response": { |
1392 "$ref": "Creative" | 1353 "$ref": "Creative" |
1393 }, | 1354 }, |
1394 "scopes": [ | 1355 "scopes": [ |
1395 "https://www.googleapis.com/auth/adexchange.buye
r" | 1356 "https://www.googleapis.com/auth/adexchange.buye
r" |
1396 ] | 1357 ] |
| 1358 }, |
| 1359 "list": { |
| 1360 "description": "Lists creatives.", |
| 1361 "httpMethod": "GET", |
| 1362 "id": "adexchangebuyer2.accounts.creatives.list", |
| 1363 "parameterOrder": [ |
| 1364 "accountId" |
| 1365 ], |
| 1366 "parameters": { |
| 1367 "pageToken": { |
| 1368 "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.", |
| 1369 "location": "query", |
| 1370 "type": "string" |
| 1371 }, |
| 1372 "accountId": { |
| 1373 "description": "The account to list the crea
tives from.\nSpecify \"-\" to list all creatives the current user has access to.
", |
| 1374 "location": "path", |
| 1375 "required": true, |
| 1376 "type": "string" |
| 1377 }, |
| 1378 "pageSize": { |
| 1379 "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.", |
| 1380 "format": "int32", |
| 1381 "location": "query", |
| 1382 "type": "integer" |
| 1383 }, |
| 1384 "query": { |
| 1385 "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'", |
| 1386 "location": "query", |
| 1387 "type": "string" |
| 1388 } |
| 1389 }, |
| 1390 "path": "v2beta1/accounts/{accountId}/creatives", |
| 1391 "response": { |
| 1392 "$ref": "ListCreativesResponse" |
| 1393 }, |
| 1394 "scopes": [ |
| 1395 "https://www.googleapis.com/auth/adexchange.buye
r" |
| 1396 ] |
1397 } | 1397 } |
1398 }, | 1398 }, |
1399 "resources": { | 1399 "resources": { |
1400 "dealAssociations": { | 1400 "dealAssociations": { |
1401 "methods": { | 1401 "methods": { |
1402 "add": { | 1402 "add": { |
1403 "description": "Associate an existing deal w
ith a creative.", | 1403 "description": "Associate an existing deal w
ith a creative.", |
1404 "httpMethod": "POST", | 1404 "httpMethod": "POST", |
1405 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.add", | 1405 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.add", |
1406 "parameterOrder": [ | 1406 "parameterOrder": [ |
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1467 }, | 1467 }, |
1468 "list": { | 1468 "list": { |
1469 "description": "List all creative-deal assoc
iations.", | 1469 "description": "List all creative-deal assoc
iations.", |
1470 "httpMethod": "GET", | 1470 "httpMethod": "GET", |
1471 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.list", | 1471 "id": "adexchangebuyer2.accounts.creatives.d
ealAssociations.list", |
1472 "parameterOrder": [ | 1472 "parameterOrder": [ |
1473 "accountId", | 1473 "accountId", |
1474 "creativeId" | 1474 "creativeId" |
1475 ], | 1475 ], |
1476 "parameters": { | 1476 "parameters": { |
| 1477 "query": { |
| 1478 "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'", |
| 1479 "location": "query", |
| 1480 "type": "string" |
| 1481 }, |
1477 "creativeId": { | 1482 "creativeId": { |
1478 "description": "The creative ID to l
ist the associations from.\nSpecify \"-\" to list all creatives under the above
account.", | 1483 "description": "The creative ID to l
ist the associations from.\nSpecify \"-\" to list all creatives under the above
account.", |
1479 "location": "path", | 1484 "location": "path", |
1480 "required": true, | 1485 "required": true, |
1481 "type": "string" | 1486 "type": "string" |
1482 }, | 1487 }, |
1483 "pageToken": { | 1488 "pageToken": { |
1484 "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.", | 1489 "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.", |
1485 "location": "query", | 1490 "location": "query", |
1486 "type": "string" | 1491 "type": "string" |
1487 }, | 1492 }, |
1488 "accountId": { | 1493 "accountId": { |
1489 "description": "The account to list
the associations from.\nSpecify \"-\" to list all creatives the current user has
access to.", | 1494 "description": "The account to list
the associations from.\nSpecify \"-\" to list all creatives the current user has
access to.", |
1490 "location": "path", | 1495 "location": "path", |
1491 "required": true, | 1496 "required": true, |
1492 "type": "string" | 1497 "type": "string" |
1493 }, | 1498 }, |
1494 "pageSize": { | 1499 "pageSize": { |
1495 "description": "Requested page size.
Server may return fewer associations than requested.\nIf unspecified, server wi
ll pick an appropriate default.", | 1500 "description": "Requested page size.
Server may return fewer associations than requested.\nIf unspecified, server wi
ll pick an appropriate default.", |
1496 "format": "int32", | 1501 "format": "int32", |
1497 "location": "query", | 1502 "location": "query", |
1498 "type": "integer" | 1503 "type": "integer" |
1499 }, | |
1500 "query": { | |
1501 "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'", | |
1502 "location": "query", | |
1503 "type": "string" | |
1504 } | 1504 } |
1505 }, | 1505 }, |
1506 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations", | 1506 "path": "v2beta1/accounts/{accountId}/creati
ves/{creativeId}/dealAssociations", |
1507 "response": { | 1507 "response": { |
1508 "$ref": "ListDealAssociationsResponse" | 1508 "$ref": "ListDealAssociationsResponse" |
1509 }, | 1509 }, |
1510 "scopes": [ | 1510 "scopes": [ |
1511 "https://www.googleapis.com/auth/adexcha
nge.buyer" | 1511 "https://www.googleapis.com/auth/adexcha
nge.buyer" |
1512 ] | 1512 ] |
1513 } | 1513 } |
1514 } | 1514 } |
1515 } | 1515 } |
1516 } | 1516 } |
1517 } | 1517 } |
1518 } | 1518 } |
1519 } | 1519 } |
1520 }, | 1520 }, |
1521 "revision": "20170608", | 1521 "revision": "20170623", |
1522 "rootUrl": "https://adexchangebuyer.googleapis.com/", | 1522 "rootUrl": "https://adexchangebuyer.googleapis.com/", |
1523 "schemas": { | 1523 "schemas": { |
| 1524 "WatchCreativeRequest": { |
| 1525 "description": "A request for watching changes to creative Status.", |
| 1526 "id": "WatchCreativeRequest", |
| 1527 "properties": { |
| 1528 "topic": { |
| 1529 "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.", |
| 1530 "type": "string" |
| 1531 } |
| 1532 }, |
| 1533 "type": "object" |
| 1534 }, |
| 1535 "TimeInterval": { |
| 1536 "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.", |
| 1537 "id": "TimeInterval", |
| 1538 "properties": { |
| 1539 "endTime": { |
| 1540 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", |
| 1541 "format": "google-datetime", |
| 1542 "type": "string" |
| 1543 }, |
| 1544 "startTime": { |
| 1545 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", |
| 1546 "format": "google-datetime", |
| 1547 "type": "string" |
| 1548 } |
| 1549 }, |
| 1550 "type": "object" |
| 1551 }, |
| 1552 "FilteredBidCreativeRow": { |
| 1553 "description": "The number of filtered bids with the specified dimen
sion values that have the\nspecified creative.", |
| 1554 "id": "FilteredBidCreativeRow", |
| 1555 "properties": { |
| 1556 "bidCount": { |
| 1557 "$ref": "MetricValue", |
| 1558 "description": "The number of bids with the specified creati
ve." |
| 1559 }, |
| 1560 "creativeId": { |
| 1561 "description": "The ID of the creative.", |
| 1562 "type": "string" |
| 1563 }, |
| 1564 "rowDimensions": { |
| 1565 "$ref": "RowDimensions", |
| 1566 "description": "The values of all dimensions associated with
metric values in this row." |
| 1567 } |
| 1568 }, |
| 1569 "type": "object" |
| 1570 }, |
| 1571 "RelativeDateRange": { |
| 1572 "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", |
| 1573 "id": "RelativeDateRange", |
| 1574 "properties": { |
| 1575 "durationDays": { |
| 1576 "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
.", |
| 1577 "format": "int32", |
| 1578 "type": "integer" |
| 1579 }, |
| 1580 "offsetDays": { |
| 1581 "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.", |
| 1582 "format": "int32", |
| 1583 "type": "integer" |
| 1584 } |
| 1585 }, |
| 1586 "type": "object" |
| 1587 }, |
| 1588 "NativeContent": { |
| 1589 "description": "Native content for a creative.", |
| 1590 "id": "NativeContent", |
| 1591 "properties": { |
| 1592 "callToAction": { |
| 1593 "description": "A label for the button that the user is supp
osed to click.", |
| 1594 "type": "string" |
| 1595 }, |
| 1596 "body": { |
| 1597 "description": "A long description of the ad.", |
| 1598 "type": "string" |
| 1599 }, |
| 1600 "starRating": { |
| 1601 "description": "The app rating in the app store. Must be in
the range [0-5].", |
| 1602 "format": "double", |
| 1603 "type": "number" |
| 1604 }, |
| 1605 "videoUrl": { |
| 1606 "description": "The URL to fetch a native video ad.", |
| 1607 "type": "string" |
| 1608 }, |
| 1609 "clickLinkUrl": { |
| 1610 "description": "The URL that the browser/SDK will load when
the user clicks the ad.", |
| 1611 "type": "string" |
| 1612 }, |
| 1613 "logo": { |
| 1614 "$ref": "Image", |
| 1615 "description": "A smaller image, for the advertiser's logo." |
| 1616 }, |
| 1617 "priceDisplayText": { |
| 1618 "description": "The price of the promoted app including curr
ency info.", |
| 1619 "type": "string" |
| 1620 }, |
| 1621 "image": { |
| 1622 "$ref": "Image", |
| 1623 "description": "A large image." |
| 1624 }, |
| 1625 "clickTrackingUrl": { |
| 1626 "description": "The URL to use for click tracking.", |
| 1627 "type": "string" |
| 1628 }, |
| 1629 "advertiserName": { |
| 1630 "description": "The name of the advertiser or sponsor, to be
displayed in the ad creative.", |
| 1631 "type": "string" |
| 1632 }, |
| 1633 "storeUrl": { |
| 1634 "description": "The URL to the app store to purchase/downloa
d the promoted app.", |
| 1635 "type": "string" |
| 1636 }, |
| 1637 "headline": { |
| 1638 "description": "A short title for the ad.", |
| 1639 "type": "string" |
| 1640 }, |
| 1641 "appIcon": { |
| 1642 "$ref": "Image", |
| 1643 "description": "The app icon, for app download ads." |
| 1644 } |
| 1645 }, |
| 1646 "type": "object" |
| 1647 }, |
| 1648 "ListClientsResponse": { |
| 1649 "id": "ListClientsResponse", |
| 1650 "properties": { |
| 1651 "nextPageToken": { |
| 1652 "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
.", |
| 1653 "type": "string" |
| 1654 }, |
| 1655 "clients": { |
| 1656 "description": "The returned list of clients.", |
| 1657 "items": { |
| 1658 "$ref": "Client" |
| 1659 }, |
| 1660 "type": "array" |
| 1661 } |
| 1662 }, |
| 1663 "type": "object" |
| 1664 }, |
| 1665 "ListBidResponsesWithoutBidsResponse": { |
| 1666 "description": "Response message for listing all reasons that bid re
sponses were considered\nto have no applicable bids.", |
| 1667 "id": "ListBidResponsesWithoutBidsResponse", |
| 1668 "properties": { |
| 1669 "bidResponseWithoutBidsStatusRows": { |
| 1670 "description": "List of rows, with counts of bid responses w
ithout bids aggregated by\nstatus.", |
| 1671 "items": { |
| 1672 "$ref": "BidResponseWithoutBidsStatusRow" |
| 1673 }, |
| 1674 "type": "array" |
| 1675 }, |
| 1676 "nextPageToken": { |
| 1677 "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.", |
| 1678 "type": "string" |
| 1679 } |
| 1680 }, |
| 1681 "type": "object" |
| 1682 }, |
| 1683 "ServingContext": { |
| 1684 "description": "The serving context for this restriction.", |
| 1685 "id": "ServingContext", |
| 1686 "properties": { |
| 1687 "appType": { |
| 1688 "$ref": "AppContext", |
| 1689 "description": "Matches impressions for a particular app typ
e." |
| 1690 }, |
| 1691 "securityType": { |
| 1692 "$ref": "SecurityContext", |
| 1693 "description": "Matches impressions for a particular securit
y type." |
| 1694 }, |
| 1695 "platform": { |
| 1696 "$ref": "PlatformContext", |
| 1697 "description": "Matches impressions coming from a particular
platform." |
| 1698 }, |
| 1699 "location": { |
| 1700 "$ref": "LocationContext", |
| 1701 "description": "Matches impressions coming from users *or* p
ublishers in a specific\nlocation." |
| 1702 }, |
| 1703 "auctionType": { |
| 1704 "$ref": "AuctionContext", |
| 1705 "description": "Matches impressions for a particular auction
type." |
| 1706 }, |
| 1707 "all": { |
| 1708 "description": "Matches all contexts.", |
| 1709 "enum": [ |
| 1710 "SIMPLE_CONTEXT" |
| 1711 ], |
| 1712 "enumDescriptions": [ |
| 1713 "A simple context." |
| 1714 ], |
| 1715 "type": "string" |
| 1716 } |
| 1717 }, |
| 1718 "type": "object" |
| 1719 }, |
| 1720 "Image": { |
| 1721 "description": "An image resource. You may provide a larger image th
an was requested,\nso long as the aspect ratio is preserved.", |
| 1722 "id": "Image", |
| 1723 "properties": { |
| 1724 "height": { |
| 1725 "description": "Image height in pixels.", |
| 1726 "format": "int32", |
| 1727 "type": "integer" |
| 1728 }, |
| 1729 "width": { |
| 1730 "description": "Image width in pixels.", |
| 1731 "format": "int32", |
| 1732 "type": "integer" |
| 1733 }, |
| 1734 "url": { |
| 1735 "description": "The URL of the image.", |
| 1736 "type": "string" |
| 1737 } |
| 1738 }, |
| 1739 "type": "object" |
| 1740 }, |
| 1741 "ListFilterSetsResponse": { |
| 1742 "description": "Response message for listing filter sets.", |
| 1743 "id": "ListFilterSetsResponse", |
| 1744 "properties": { |
| 1745 "filterSets": { |
| 1746 "description": "The filter sets belonging to the buyer.", |
| 1747 "items": { |
| 1748 "$ref": "FilterSet" |
| 1749 }, |
| 1750 "type": "array" |
| 1751 }, |
| 1752 "nextPageToken": { |
| 1753 "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.", |
| 1754 "type": "string" |
| 1755 } |
| 1756 }, |
| 1757 "type": "object" |
| 1758 }, |
| 1759 "BidResponseWithoutBidsStatusRow": { |
| 1760 "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.", |
| 1761 "id": "BidResponseWithoutBidsStatusRow", |
| 1762 "properties": { |
| 1763 "impressionCount": { |
| 1764 "$ref": "MetricValue", |
| 1765 "description": "The number of impressions for which there wa
s a bid response with the\nspecified status." |
| 1766 }, |
| 1767 "status": { |
| 1768 "description": "The status specifying why the bid responses
were considered to have no\napplicable bids.", |
| 1769 "enum": [ |
| 1770 "STATUS_UNSPECIFIED", |
| 1771 "RESPONSES_WITHOUT_BIDS", |
| 1772 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", |
| 1773 "RESPONSES_WITHOUT_BIDS_FOR_DEAL" |
| 1774 ], |
| 1775 "enumDescriptions": [ |
| 1776 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", |
| 1777 "The response had no bids.", |
| 1778 "The response had no bids for the specified account, tho
ugh it may have\nincluded bids on behalf of other accounts.", |
| 1779 "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." |
| 1780 ], |
| 1781 "type": "string" |
| 1782 }, |
| 1783 "rowDimensions": { |
| 1784 "$ref": "RowDimensions", |
| 1785 "description": "The values of all dimensions associated with
metric values in this row." |
| 1786 } |
| 1787 }, |
| 1788 "type": "object" |
| 1789 }, |
| 1790 "ClientUserInvitation": { |
| 1791 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", |
| 1792 "id": "ClientUserInvitation", |
| 1793 "properties": { |
| 1794 "invitationId": { |
| 1795 "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
.", |
| 1796 "format": "int64", |
| 1797 "type": "string" |
| 1798 }, |
| 1799 "email": { |
| 1800 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", |
| 1801 "type": "string" |
| 1802 }, |
| 1803 "clientAccountId": { |
| 1804 "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.", |
| 1805 "format": "int64", |
| 1806 "type": "string" |
| 1807 } |
| 1808 }, |
| 1809 "type": "object" |
| 1810 }, |
| 1811 "ListClientUserInvitationsResponse": { |
| 1812 "id": "ListClientUserInvitationsResponse", |
| 1813 "properties": { |
| 1814 "nextPageToken": { |
| 1815 "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.", |
| 1816 "type": "string" |
| 1817 }, |
| 1818 "invitations": { |
| 1819 "description": "The returned list of client users.", |
| 1820 "items": { |
| 1821 "$ref": "ClientUserInvitation" |
| 1822 }, |
| 1823 "type": "array" |
| 1824 } |
| 1825 }, |
| 1826 "type": "object" |
| 1827 }, |
| 1828 "ListClientUsersResponse": { |
| 1829 "id": "ListClientUsersResponse", |
| 1830 "properties": { |
| 1831 "nextPageToken": { |
| 1832 "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.", |
| 1833 "type": "string" |
| 1834 }, |
| 1835 "users": { |
| 1836 "description": "The returned list of client users.", |
| 1837 "items": { |
| 1838 "$ref": "ClientUser" |
| 1839 }, |
| 1840 "type": "array" |
| 1841 } |
| 1842 }, |
| 1843 "type": "object" |
| 1844 }, |
| 1845 "ListCreativeStatusBreakdownByDetailResponse": { |
| 1846 "description": "Response message for listing all details associated
with a given filtered bid\nreason.", |
| 1847 "id": "ListCreativeStatusBreakdownByDetailResponse", |
| 1848 "properties": { |
| 1849 "filteredBidDetailRows": { |
| 1850 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby detail.", |
| 1851 "items": { |
| 1852 "$ref": "FilteredBidDetailRow" |
| 1853 }, |
| 1854 "type": "array" |
| 1855 }, |
| 1856 "nextPageToken": { |
| 1857 "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.", |
| 1858 "type": "string" |
| 1859 }, |
| 1860 "detailType": { |
| 1861 "description": "The type of detail that the detail IDs repre
sent.", |
| 1862 "enum": [ |
| 1863 "TYPE_UNSPECIFIED", |
| 1864 "CREATIVE_ATTRIBUTE", |
| 1865 "VENDOR", |
| 1866 "SENSITIVE_CATEGORY", |
| 1867 "PRODUCT_CATEGORY" |
| 1868 ], |
| 1869 "enumDescriptions": [ |
| 1870 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", |
| 1871 "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).", |
| 1872 "Indicates that the detail ID refers to a vendor; see\n[
vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", |
| 1873 "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).", |
| 1874 "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)." |
| 1875 ], |
| 1876 "type": "string" |
| 1877 } |
| 1878 }, |
| 1879 "type": "object" |
| 1880 }, |
| 1881 "LocationContext": { |
| 1882 "description": "@OutputOnly The Geo criteria the restriction applies
to.", |
| 1883 "id": "LocationContext", |
| 1884 "properties": { |
| 1885 "geoCriteriaIds": { |
| 1886 "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.", |
| 1887 "items": { |
| 1888 "format": "int32", |
| 1889 "type": "integer" |
| 1890 }, |
| 1891 "type": "array" |
| 1892 } |
| 1893 }, |
| 1894 "type": "object" |
| 1895 }, |
| 1896 "PlatformContext": { |
| 1897 "description": "@OutputOnly The type of platform the restriction app
lies to.", |
| 1898 "id": "PlatformContext", |
| 1899 "properties": { |
| 1900 "platforms": { |
| 1901 "description": "The platforms this restriction applies to.", |
| 1902 "enumDescriptions": [ |
| 1903 "Desktop platform.", |
| 1904 "Android platform.", |
| 1905 "iOS platform." |
| 1906 ], |
| 1907 "items": { |
| 1908 "enum": [ |
| 1909 "DESKTOP", |
| 1910 "ANDROID", |
| 1911 "IOS" |
| 1912 ], |
| 1913 "type": "string" |
| 1914 }, |
| 1915 "type": "array" |
| 1916 } |
| 1917 }, |
| 1918 "type": "object" |
| 1919 }, |
| 1920 "MetricValue": { |
| 1921 "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)
.", |
| 1922 "id": "MetricValue", |
| 1923 "properties": { |
| 1924 "variance": { |
| 1925 "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", |
| 1926 "format": "int64", |
| 1927 "type": "string" |
| 1928 }, |
| 1929 "value": { |
| 1930 "description": "The expected value of the metric.", |
| 1931 "format": "int64", |
| 1932 "type": "string" |
| 1933 } |
| 1934 }, |
| 1935 "type": "object" |
| 1936 }, |
1524 "ClientUser": { | 1937 "ClientUser": { |
1525 "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.", | 1938 "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.", |
1526 "id": "ClientUser", | 1939 "id": "ClientUser", |
1527 "properties": { | 1940 "properties": { |
1528 "userId": { | |
1529 "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.", | |
1530 "format": "int64", | |
1531 "type": "string" | |
1532 }, | |
1533 "email": { | |
1534 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", | |
1535 "type": "string" | |
1536 }, | |
1537 "clientAccountId": { | 1941 "clientAccountId": { |
1538 "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.", | 1942 "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.", |
1539 "format": "int64", | 1943 "format": "int64", |
1540 "type": "string" | 1944 "type": "string" |
1541 }, | 1945 }, |
1542 "status": { | 1946 "status": { |
1543 "description": "The status of the client user.", | 1947 "description": "The status of the client user.", |
1544 "enum": [ | 1948 "enum": [ |
1545 "USER_STATUS_UNSPECIFIED", | 1949 "USER_STATUS_UNSPECIFIED", |
1546 "PENDING", | 1950 "PENDING", |
1547 "ACTIVE", | 1951 "ACTIVE", |
1548 "DISABLED" | 1952 "DISABLED" |
1549 ], | 1953 ], |
1550 "enumDescriptions": [ | 1954 "enumDescriptions": [ |
1551 "A placeholder for an undefined user status.", | 1955 "A placeholder for an undefined user status.", |
1552 "A user who was already created but hasn't accepted the
invitation yet.", | 1956 "A user who was already created but hasn't accepted the
invitation yet.", |
1553 "A user that is currently active.", | 1957 "A user that is currently active.", |
1554 "A user that is currently disabled." | 1958 "A user that is currently disabled." |
1555 ], | 1959 ], |
1556 "type": "string" | 1960 "type": "string" |
| 1961 }, |
| 1962 "userId": { |
| 1963 "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.", |
| 1964 "format": "int64", |
| 1965 "type": "string" |
| 1966 }, |
| 1967 "email": { |
| 1968 "description": "User's email address. The value of this fiel
d\nis ignored in an update operation.", |
| 1969 "type": "string" |
1557 } | 1970 } |
1558 }, | 1971 }, |
1559 "type": "object" | 1972 "type": "object" |
1560 }, | 1973 }, |
1561 "CreativeDealAssociation": { | 1974 "CreativeDealAssociation": { |
1562 "description": "The association between a creative and a deal.", | 1975 "description": "The association between a creative and a deal.", |
1563 "id": "CreativeDealAssociation", | 1976 "id": "CreativeDealAssociation", |
1564 "properties": { | 1977 "properties": { |
| 1978 "accountId": { |
| 1979 "description": "The account the creative belongs to.", |
| 1980 "type": "string" |
| 1981 }, |
1565 "creativeId": { | 1982 "creativeId": { |
1566 "description": "The ID of the creative associated with the d
eal.", | 1983 "description": "The ID of the creative associated with the d
eal.", |
1567 "type": "string" | 1984 "type": "string" |
1568 }, | 1985 }, |
1569 "dealsId": { | 1986 "dealsId": { |
1570 "description": "The externalDealId for the deal associated w
ith the creative.", | 1987 "description": "The externalDealId for the deal associated w
ith the creative.", |
1571 "type": "string" | 1988 "type": "string" |
1572 }, | |
1573 "accountId": { | |
1574 "description": "The account the creative belongs to.", | |
1575 "type": "string" | |
1576 } | 1989 } |
1577 }, | 1990 }, |
1578 "type": "object" | 1991 "type": "object" |
1579 }, | 1992 }, |
1580 "FilteringStats": { | 1993 "FilteringStats": { |
1581 "description": "@OutputOnly Filtering reasons for this creative duri
ng a period of a single\nday (from midnight to midnight Pacific).", | 1994 "description": "@OutputOnly Filtering reasons for this creative duri
ng a period of a single\nday (from midnight to midnight Pacific).", |
1582 "id": "FilteringStats", | 1995 "id": "FilteringStats", |
1583 "properties": { | 1996 "properties": { |
1584 "reasons": { | |
1585 "description": "The set of filtering reasons for this date."
, | |
1586 "items": { | |
1587 "$ref": "Reason" | |
1588 }, | |
1589 "type": "array" | |
1590 }, | |
1591 "date": { | 1997 "date": { |
1592 "$ref": "Date", | 1998 "$ref": "Date", |
1593 "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." | 1999 "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." |
| 2000 }, |
| 2001 "reasons": { |
| 2002 "description": "The set of filtering reasons for this date."
, |
| 2003 "items": { |
| 2004 "$ref": "Reason" |
| 2005 }, |
| 2006 "type": "array" |
1594 } | 2007 } |
1595 }, | 2008 }, |
1596 "type": "object" | 2009 "type": "object" |
1597 }, | 2010 }, |
1598 "Creative": { | 2011 "Creative": { |
1599 "description": "A creative and its classification data.", | 2012 "description": "A creative and its classification data.", |
1600 "id": "Creative", | 2013 "id": "Creative", |
1601 "properties": { | 2014 "properties": { |
| 2015 "accountId": { |
| 2016 "description": "The account that this creative belongs to.\n
Can be used to filter the response of the\ncreatives.list\nmethod.", |
| 2017 "type": "string" |
| 2018 }, |
| 2019 "native": { |
| 2020 "$ref": "NativeContent", |
| 2021 "description": "A native creative." |
| 2022 }, |
| 2023 "video": { |
| 2024 "$ref": "VideoContent", |
| 2025 "description": "A video creative." |
| 2026 }, |
| 2027 "servingRestrictions": { |
| 2028 "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).", |
| 2029 "items": { |
| 2030 "$ref": "ServingRestriction" |
| 2031 }, |
| 2032 "type": "array" |
| 2033 }, |
| 2034 "agencyId": { |
| 2035 "description": "The agency ID for this creative.", |
| 2036 "format": "int64", |
| 2037 "type": "string" |
| 2038 }, |
| 2039 "clickThroughUrls": { |
| 2040 "description": "The set of destination URLs for the creative
.", |
| 2041 "items": { |
| 2042 "type": "string" |
| 2043 }, |
| 2044 "type": "array" |
| 2045 }, |
| 2046 "detectedSensitiveCategories": { |
| 2047 "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.", |
| 2048 "items": { |
| 2049 "format": "int32", |
| 2050 "type": "integer" |
| 2051 }, |
| 2052 "type": "array" |
| 2053 }, |
| 2054 "adChoicesDestinationUrl": { |
| 2055 "description": "The link to AdChoices destination page.", |
| 2056 "type": "string" |
| 2057 }, |
| 2058 "restrictedCategories": { |
| 2059 "description": "All restricted categories for the ads that m
ay be shown from this creative.", |
| 2060 "enumDescriptions": [ |
| 2061 "The ad has no restricted categories", |
| 2062 "The alcohol restricted category." |
| 2063 ], |
| 2064 "items": { |
| 2065 "enum": [ |
| 2066 "NO_RESTRICTED_CATEGORIES", |
| 2067 "ALCOHOL" |
| 2068 ], |
| 2069 "type": "string" |
| 2070 }, |
| 2071 "type": "array" |
| 2072 }, |
| 2073 "corrections": { |
| 2074 "description": "@OutputOnly Shows any corrections that were
applied to this creative.", |
| 2075 "items": { |
| 2076 "$ref": "Correction" |
| 2077 }, |
| 2078 "type": "array" |
| 2079 }, |
| 2080 "version": { |
| 2081 "description": "@OutputOnly The version of this creative.", |
| 2082 "format": "int32", |
| 2083 "type": "integer" |
| 2084 }, |
| 2085 "vendorIds": { |
| 2086 "description": "All vendor IDs for the ads that may be shown
from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/ve
ndors.txt\nfor possible values.", |
| 2087 "items": { |
| 2088 "format": "int32", |
| 2089 "type": "integer" |
| 2090 }, |
| 2091 "type": "array" |
| 2092 }, |
| 2093 "impressionTrackingUrls": { |
| 2094 "description": "The set of URLs to be called to record an im
pression.", |
| 2095 "items": { |
| 2096 "type": "string" |
| 2097 }, |
| 2098 "type": "array" |
| 2099 }, |
| 2100 "html": { |
| 2101 "$ref": "HtmlContent", |
| 2102 "description": "An HTML creative." |
| 2103 }, |
1602 "dealsStatus": { | 2104 "dealsStatus": { |
1603 "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.", | 2105 "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.", |
1604 "enum": [ | 2106 "enum": [ |
1605 "STATUS_UNSPECIFIED", | 2107 "STATUS_UNSPECIFIED", |
1606 "NOT_CHECKED", | 2108 "NOT_CHECKED", |
1607 "CONDITIONALLY_APPROVED", | 2109 "CONDITIONALLY_APPROVED", |
1608 "APPROVED", | 2110 "APPROVED", |
1609 "DISAPPROVED" | 2111 "DISAPPROVED" |
1610 ], | 2112 ], |
1611 "enumDescriptions": [ | 2113 "enumDescriptions": [ |
(...skipping 28 matching lines...) Expand all Loading... |
1640 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", | 2142 "The creative has been conditionally approved.\nSee serv
ing_restrictions for details.", |
1641 "The creative has been approved.", | 2143 "The creative has been approved.", |
1642 "The creative has been disapproved." | 2144 "The creative has been disapproved." |
1643 ], | 2145 ], |
1644 "type": "string" | 2146 "type": "string" |
1645 }, | 2147 }, |
1646 "advertiserName": { | 2148 "advertiserName": { |
1647 "description": "The name of the company being advertised in
the creative.", | 2149 "description": "The name of the company being advertised in
the creative.", |
1648 "type": "string" | 2150 "type": "string" |
1649 }, | 2151 }, |
| 2152 "detectedAdvertiserIds": { |
| 2153 "description": "@OutputOnly Detected advertiser IDs, if any.
", |
| 2154 "items": { |
| 2155 "format": "int64", |
| 2156 "type": "string" |
| 2157 }, |
| 2158 "type": "array" |
| 2159 }, |
1650 "detectedDomains": { | 2160 "detectedDomains": { |
1651 "description": "@OutputOnly\nThe detected domains for this c
reative.", | 2161 "description": "@OutputOnly\nThe detected domains for this c
reative.", |
1652 "items": { | 2162 "items": { |
1653 "type": "string" | 2163 "type": "string" |
1654 }, | 2164 }, |
1655 "type": "array" | 2165 "type": "array" |
1656 }, | 2166 }, |
1657 "detectedAdvertiserIds": { | |
1658 "description": "@OutputOnly Detected advertiser IDs, if any.
", | |
1659 "items": { | |
1660 "format": "int64", | |
1661 "type": "string" | |
1662 }, | |
1663 "type": "array" | |
1664 }, | |
1665 "filteringStats": { | 2167 "filteringStats": { |
1666 "$ref": "FilteringStats", | 2168 "$ref": "FilteringStats", |
1667 "description": "@OutputOnly The filtering stats for this cre
ative." | 2169 "description": "@OutputOnly The filtering stats for this cre
ative." |
1668 }, | 2170 }, |
1669 "attributes": { | 2171 "attributes": { |
1670 "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.", | 2172 "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.", |
1671 "enumDescriptions": [ | 2173 "enumDescriptions": [ |
1672 "Do not use. This is a placeholder value only.", | 2174 "Do not use. This is a placeholder value only.", |
1673 "The creative is tagged.", | 2175 "The creative is tagged.", |
1674 "The creative is cookie targeted.", | 2176 "The creative is cookie targeted.", |
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1733 "detectedLanguages": { | 2235 "detectedLanguages": { |
1734 "description": "@OutputOnly\nThe detected languages for this
creative. The order is arbitrary. The codes\nare 2 or 5 characters and are docu
mented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes
.", | 2236 "description": "@OutputOnly\nThe detected languages for this
creative. The order is arbitrary. The codes\nare 2 or 5 characters and are docu
mented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes
.", |
1735 "items": { | 2237 "items": { |
1736 "type": "string" | 2238 "type": "string" |
1737 }, | 2239 }, |
1738 "type": "array" | 2240 "type": "array" |
1739 }, | 2241 }, |
1740 "creativeId": { | 2242 "creativeId": { |
1741 "description": "The buyer-defined creative ID of this creati
ve.\nCan be used to filter the response of the\ncreatives.list\nmethod.", | 2243 "description": "The buyer-defined creative ID of this creati
ve.\nCan be used to filter the response of the\ncreatives.list\nmethod.", |
1742 "type": "string" | 2244 "type": "string" |
1743 }, | |
1744 "accountId": { | |
1745 "description": "The account that this creative belongs to.\n
Can be used to filter the response of the\ncreatives.list\nmethod.", | |
1746 "type": "string" | |
1747 }, | |
1748 "native": { | |
1749 "$ref": "NativeContent", | |
1750 "description": "A native creative." | |
1751 }, | |
1752 "video": { | |
1753 "$ref": "VideoContent", | |
1754 "description": "A video creative." | |
1755 }, | |
1756 "servingRestrictions": { | |
1757 "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).", | |
1758 "items": { | |
1759 "$ref": "ServingRestriction" | |
1760 }, | |
1761 "type": "array" | |
1762 }, | |
1763 "agencyId": { | |
1764 "description": "The agency ID for this creative.", | |
1765 "format": "int64", | |
1766 "type": "string" | |
1767 }, | |
1768 "clickThroughUrls": { | |
1769 "description": "The set of destination URLs for the creative
.", | |
1770 "items": { | |
1771 "type": "string" | |
1772 }, | |
1773 "type": "array" | |
1774 }, | |
1775 "adChoicesDestinationUrl": { | |
1776 "description": "The link to AdChoices destination page.", | |
1777 "type": "string" | |
1778 }, | |
1779 "detectedSensitiveCategories": { | |
1780 "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.", | |
1781 "items": { | |
1782 "format": "int32", | |
1783 "type": "integer" | |
1784 }, | |
1785 "type": "array" | |
1786 }, | |
1787 "restrictedCategories": { | |
1788 "description": "All restricted categories for the ads that m
ay be shown from this creative.", | |
1789 "enumDescriptions": [ | |
1790 "The ad has no restricted categories", | |
1791 "The alcohol restricted category." | |
1792 ], | |
1793 "items": { | |
1794 "enum": [ | |
1795 "NO_RESTRICTED_CATEGORIES", | |
1796 "ALCOHOL" | |
1797 ], | |
1798 "type": "string" | |
1799 }, | |
1800 "type": "array" | |
1801 }, | |
1802 "corrections": { | |
1803 "description": "@OutputOnly Shows any corrections that were
applied to this creative.", | |
1804 "items": { | |
1805 "$ref": "Correction" | |
1806 }, | |
1807 "type": "array" | |
1808 }, | |
1809 "version": { | |
1810 "description": "@OutputOnly The version of this creative.", | |
1811 "format": "int32", | |
1812 "type": "integer" | |
1813 }, | |
1814 "vendorIds": { | |
1815 "description": "All vendor IDs for the ads that may be shown
from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/ve
ndors.txt\nfor possible values.", | |
1816 "items": { | |
1817 "format": "int32", | |
1818 "type": "integer" | |
1819 }, | |
1820 "type": "array" | |
1821 }, | |
1822 "impressionTrackingUrls": { | |
1823 "description": "The set of URLs to be called to record an im
pression.", | |
1824 "items": { | |
1825 "type": "string" | |
1826 }, | |
1827 "type": "array" | |
1828 }, | |
1829 "html": { | |
1830 "$ref": "HtmlContent", | |
1831 "description": "An HTML creative." | |
1832 } | |
1833 }, | |
1834 "type": "object" | |
1835 }, | |
1836 "ListFilteredImpressionsResponse": { | |
1837 "description": "Response message for listing all reasons that impres
sions were filtered (i.e.\nnot considered as an inventory match) for the buyer."
, | |
1838 "id": "ListFilteredImpressionsResponse", | |
1839 "properties": { | |
1840 "nextPageToken": { | |
1841 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListFilteredImpressionsRequest.pageToken\nfield in th
e subsequent call to the\naccounts.filterSets.filteredImpressions.list\nmethod t
o retrieve the next page of results.", | |
1842 "type": "string" | |
1843 }, | |
1844 "impressionsStatusRows": { | |
1845 "description": "List of rows, with counts of filtered impres
sions aggregated by status.", | |
1846 "items": { | |
1847 "$ref": "ImpressionStatusRow" | |
1848 }, | |
1849 "type": "array" | |
1850 } | 2245 } |
1851 }, | 2246 }, |
1852 "type": "object" | 2247 "type": "object" |
1853 }, | 2248 }, |
1854 "RemoveDealAssociationRequest": { | 2249 "RemoveDealAssociationRequest": { |
1855 "description": "A request for removing the association between a dea
l and a creative.", | 2250 "description": "A request for removing the association between a dea
l and a creative.", |
1856 "id": "RemoveDealAssociationRequest", | 2251 "id": "RemoveDealAssociationRequest", |
1857 "properties": { | 2252 "properties": { |
1858 "association": { | 2253 "association": { |
1859 "$ref": "CreativeDealAssociation", | 2254 "$ref": "CreativeDealAssociation", |
1860 "description": "The association between a creative and a dea
l that should be removed." | 2255 "description": "The association between a creative and a dea
l that should be removed." |
1861 } | 2256 } |
1862 }, | 2257 }, |
1863 "type": "object" | 2258 "type": "object" |
1864 }, | 2259 }, |
1865 "ListCreativeStatusBreakdownByCreativeResponse": { | 2260 "ListCreativeStatusBreakdownByCreativeResponse": { |
1866 "description": "Response message for listing all creatives associate
d with a given filtered\nbid reason.", | 2261 "description": "Response message for listing all creatives associate
d with a given filtered\nbid reason.", |
1867 "id": "ListCreativeStatusBreakdownByCreativeResponse", | 2262 "id": "ListCreativeStatusBreakdownByCreativeResponse", |
1868 "properties": { | 2263 "properties": { |
| 2264 "filteredBidCreativeRows": { |
| 2265 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby creative.", |
| 2266 "items": { |
| 2267 "$ref": "FilteredBidCreativeRow" |
| 2268 }, |
| 2269 "type": "array" |
| 2270 }, |
1869 "nextPageToken": { | 2271 "nextPageToken": { |
1870 "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.", | 2272 "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.", |
1871 "type": "string" | 2273 "type": "string" |
1872 }, | |
1873 "filteredBidCreativeRows": { | |
1874 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby creative.", | |
1875 "items": { | |
1876 "$ref": "FilteredBidCreativeRow" | |
1877 }, | |
1878 "type": "array" | |
1879 } | 2274 } |
1880 }, | 2275 }, |
1881 "type": "object" | 2276 "type": "object" |
1882 }, | 2277 }, |
1883 "Client": { | 2278 "Client": { |
1884 "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.", | 2279 "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.", |
1885 "id": "Client", | 2280 "id": "Client", |
1886 "properties": { | 2281 "properties": { |
| 2282 "role": { |
| 2283 "description": "The role which is assigned to the client buy
er. Each role implies a set of\npermissions granted to the client. Must be one o
f `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", |
| 2284 "enum": [ |
| 2285 "CLIENT_ROLE_UNSPECIFIED", |
| 2286 "CLIENT_DEAL_VIEWER", |
| 2287 "CLIENT_DEAL_NEGOTIATOR", |
| 2288 "CLIENT_DEAL_APPROVER" |
| 2289 ], |
| 2290 "enumDescriptions": [ |
| 2291 "A placeholder for an undefined client role.", |
| 2292 "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.", |
| 2293 "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.", |
| 2294 "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." |
| 2295 ], |
| 2296 "type": "string" |
| 2297 }, |
| 2298 "visibleToSeller": { |
| 2299 "description": "Whether the client buyer will be visible to
sellers.", |
| 2300 "type": "boolean" |
| 2301 }, |
| 2302 "entityId": { |
| 2303 "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.", |
| 2304 "format": "int64", |
| 2305 "type": "string" |
| 2306 }, |
| 2307 "clientAccountId": { |
| 2308 "description": "The globally-unique numerical ID of the clie
nt.\nThe value of this field is ignored in create and update operations.", |
| 2309 "format": "int64", |
| 2310 "type": "string" |
| 2311 }, |
| 2312 "entityName": { |
| 2313 "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.", |
| 2314 "type": "string" |
| 2315 }, |
1887 "status": { | 2316 "status": { |
1888 "description": "The status of the client buyer.", | 2317 "description": "The status of the client buyer.", |
1889 "enum": [ | 2318 "enum": [ |
1890 "CLIENT_STATUS_UNSPECIFIED", | 2319 "CLIENT_STATUS_UNSPECIFIED", |
1891 "DISABLED", | 2320 "DISABLED", |
1892 "ACTIVE" | 2321 "ACTIVE" |
1893 ], | 2322 ], |
1894 "enumDescriptions": [ | 2323 "enumDescriptions": [ |
1895 "A placeholder for an undefined client status.", | 2324 "A placeholder for an undefined client status.", |
1896 "A client that is currently disabled.", | 2325 "A client that is currently disabled.", |
(...skipping 13 matching lines...) Expand all Loading... |
1910 "A placeholder for an undefined client entity type. Shou
ld not be used.", | 2339 "A placeholder for an undefined client entity type. Shou
ld not be used.", |
1911 "An advertiser.", | 2340 "An advertiser.", |
1912 "A brand.", | 2341 "A brand.", |
1913 "An advertising agency." | 2342 "An advertising agency." |
1914 ], | 2343 ], |
1915 "type": "string" | 2344 "type": "string" |
1916 }, | 2345 }, |
1917 "clientName": { | 2346 "clientName": { |
1918 "description": "Name used to represent this client to publis
hers.\nYou may have multiple clients that map to the same entity,\nbut for each
client the combination of `clientName` and entity\nmust be unique.\nYou can spec
ify this field as empty.", | 2347 "description": "Name used to represent this client to publis
hers.\nYou may have multiple clients that map to the same entity,\nbut for each
client the combination of `clientName` and entity\nmust be unique.\nYou can spec
ify this field as empty.", |
1919 "type": "string" | 2348 "type": "string" |
1920 }, | |
1921 "role": { | |
1922 "description": "The role which is assigned to the client buy
er. Each role implies a set of\npermissions granted to the client. Must be one o
f `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", | |
1923 "enum": [ | |
1924 "CLIENT_ROLE_UNSPECIFIED", | |
1925 "CLIENT_DEAL_VIEWER", | |
1926 "CLIENT_DEAL_NEGOTIATOR", | |
1927 "CLIENT_DEAL_APPROVER" | |
1928 ], | |
1929 "enumDescriptions": [ | |
1930 "A placeholder for an undefined client role.", | |
1931 "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.", | |
1932 "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.", | |
1933 "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." | |
1934 ], | |
1935 "type": "string" | |
1936 }, | |
1937 "visibleToSeller": { | |
1938 "description": "Whether the client buyer will be visible to
sellers.", | |
1939 "type": "boolean" | |
1940 }, | |
1941 "entityId": { | |
1942 "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.", | |
1943 "format": "int64", | |
1944 "type": "string" | |
1945 }, | |
1946 "clientAccountId": { | |
1947 "description": "The globally-unique numerical ID of the clie
nt.\nThe value of this field is ignored in create and update operations.", | |
1948 "format": "int64", | |
1949 "type": "string" | |
1950 }, | |
1951 "entityName": { | |
1952 "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.", | |
1953 "type": "string" | |
1954 } | 2349 } |
1955 }, | 2350 }, |
1956 "type": "object" | 2351 "type": "object" |
1957 }, | 2352 }, |
1958 "Correction": { | 2353 "Correction": { |
1959 "description": "@OutputOnly Shows any corrections that were applied
to this creative.", | 2354 "description": "@OutputOnly Shows any corrections that were applied
to this creative.", |
1960 "id": "Correction", | 2355 "id": "Correction", |
1961 "properties": { | 2356 "properties": { |
| 2357 "details": { |
| 2358 "description": "Additional details about what was corrected.
", |
| 2359 "items": { |
| 2360 "type": "string" |
| 2361 }, |
| 2362 "type": "array" |
| 2363 }, |
1962 "type": { | 2364 "type": { |
1963 "description": "The type of correction that was applied to t
he creative.", | 2365 "description": "The type of correction that was applied to t
he creative.", |
1964 "enum": [ | 2366 "enum": [ |
1965 "CORRECTION_TYPE_UNSPECIFIED", | 2367 "CORRECTION_TYPE_UNSPECIFIED", |
1966 "VENDOR_IDS_ADDED", | 2368 "VENDOR_IDS_ADDED", |
1967 "SSL_ATTRIBUTE_REMOVED", | 2369 "SSL_ATTRIBUTE_REMOVED", |
1968 "FLASH_FREE_ATTRIBUTE_REMOVED", | 2370 "FLASH_FREE_ATTRIBUTE_REMOVED", |
1969 "FLASH_FREE_ATTRIBUTE_ADDED", | 2371 "FLASH_FREE_ATTRIBUTE_ADDED", |
1970 "REQUIRED_ATTRIBUTE_ADDED", | 2372 "REQUIRED_ATTRIBUTE_ADDED", |
1971 "REQUIRED_VENDOR_ADDED", | 2373 "REQUIRED_VENDOR_ADDED", |
(...skipping 18 matching lines...) Expand all Loading... |
1990 "The ad contains video content." | 2392 "The ad contains video content." |
1991 ], | 2393 ], |
1992 "type": "string" | 2394 "type": "string" |
1993 }, | 2395 }, |
1994 "contexts": { | 2396 "contexts": { |
1995 "description": "The contexts for the correction.", | 2397 "description": "The contexts for the correction.", |
1996 "items": { | 2398 "items": { |
1997 "$ref": "ServingContext" | 2399 "$ref": "ServingContext" |
1998 }, | 2400 }, |
1999 "type": "array" | 2401 "type": "array" |
2000 }, | |
2001 "details": { | |
2002 "description": "Additional details about what was corrected.
", | |
2003 "items": { | |
2004 "type": "string" | |
2005 }, | |
2006 "type": "array" | |
2007 } | 2402 } |
2008 }, | 2403 }, |
2009 "type": "object" | 2404 "type": "object" |
2010 }, | 2405 }, |
2011 "FilterSet": { | 2406 "FilterSet": { |
2012 "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)\"", | 2407 "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)\"", |
2013 "id": "FilterSet", | 2408 "id": "FilterSet", |
2014 "properties": { | 2409 "properties": { |
| 2410 "sellerNetworkIds": { |
| 2411 "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.", |
| 2412 "items": { |
| 2413 "format": "int32", |
| 2414 "type": "integer" |
| 2415 }, |
| 2416 "type": "array" |
| 2417 }, |
| 2418 "ownerAccountId": { |
| 2419 "description": "The account ID of the buyer who owns this fi
lter set.\nThe value of this field is ignored in create operations.", |
| 2420 "format": "int64", |
| 2421 "type": "string" |
| 2422 }, |
| 2423 "absoluteDateRange": { |
| 2424 "$ref": "AbsoluteDateRange", |
| 2425 "description": "An absolute date range, defined by a start d
ate and an end date.\nInterpreted relative to Pacific time zone." |
| 2426 }, |
| 2427 "buyerAccountId": { |
| 2428 "description": "The ID of the buyer account on which to filt
er; optional.", |
| 2429 "format": "int64", |
| 2430 "type": "string" |
| 2431 }, |
| 2432 "environment": { |
| 2433 "description": "The environment on which to filter; optional
.", |
| 2434 "enum": [ |
| 2435 "ENVIRONMENT_UNSPECIFIED", |
| 2436 "WEB", |
| 2437 "APP" |
| 2438 ], |
| 2439 "enumDescriptions": [ |
| 2440 "A placeholder for an undefined environment; indicates t
hat no environment\nfilter will be applied.", |
| 2441 "The ad impression appears on the web.", |
| 2442 "The ad impression appears in an app." |
| 2443 ], |
| 2444 "type": "string" |
| 2445 }, |
| 2446 "dealId": { |
| 2447 "description": "The ID of the deal on which to filter; optio
nal.", |
| 2448 "format": "int64", |
| 2449 "type": "string" |
| 2450 }, |
| 2451 "format": { |
| 2452 "description": "The format on which to filter; optional.", |
| 2453 "enum": [ |
| 2454 "FORMAT_UNSPECIFIED", |
| 2455 "DISPLAY", |
| 2456 "VIDEO" |
| 2457 ], |
| 2458 "enumDescriptions": [ |
| 2459 "A placeholder for an undefined format; indicates that n
o format filter\nwill be applied.", |
| 2460 "The ad impression is display format (i.e. an image).", |
| 2461 "The ad impression is video format." |
| 2462 ], |
| 2463 "type": "string" |
| 2464 }, |
| 2465 "timeSeriesGranularity": { |
| 2466 "description": "The granularity of time intervals if a time
series breakdown is desired;\noptional.", |
| 2467 "enum": [ |
| 2468 "INTERVAL_UNSPECIFIED", |
| 2469 "HOURLY", |
| 2470 "DAILY" |
| 2471 ], |
| 2472 "enumDescriptions": [ |
| 2473 "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.", |
| 2474 "Indicates that data will be broken down by the hour.", |
| 2475 "Indicates that data will be broken down by the day." |
| 2476 ], |
| 2477 "type": "string" |
| 2478 }, |
| 2479 "filterSetId": { |
| 2480 "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.", |
| 2481 "format": "int64", |
| 2482 "type": "string" |
| 2483 }, |
| 2484 "realtimeTimeRange": { |
| 2485 "$ref": "RealtimeTimeRange", |
| 2486 "description": "An open-ended realtime time range, defined b
y the aggregation start\ntimestamp." |
| 2487 }, |
2015 "creativeId": { | 2488 "creativeId": { |
2016 "description": "The ID of the creative on which to filter; o
ptional.", | 2489 "description": "The ID of the creative on which to filter; o
ptional.", |
2017 "type": "string" | 2490 "type": "string" |
2018 }, | 2491 }, |
2019 "relativeDateRange": { | 2492 "relativeDateRange": { |
2020 "$ref": "RelativeDateRange", | 2493 "$ref": "RelativeDateRange", |
2021 "description": "A relative date range, defined by an offset
from today and a duration.\nInterpreted relative to Pacific time zone." | 2494 "description": "A relative date range, defined by an offset
from today and a duration.\nInterpreted relative to Pacific time zone." |
2022 }, | 2495 }, |
2023 "platforms": { | 2496 "platforms": { |
2024 "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).", | 2497 "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).", |
2025 "enumDescriptions": [ | 2498 "enumDescriptions": [ |
2026 "A placeholder for an undefined platform; indicates that
no platform\nfilter will be applied.", | 2499 "A placeholder for an undefined platform; indicates that
no platform\nfilter will be applied.", |
2027 "The ad impression appears on a desktop.", | 2500 "The ad impression appears on a desktop.", |
2028 "The ad impression appears on a tablet.", | 2501 "The ad impression appears on a tablet.", |
2029 "The ad impression appears on a mobile device." | 2502 "The ad impression appears on a mobile device." |
2030 ], | 2503 ], |
2031 "items": { | 2504 "items": { |
2032 "enum": [ | 2505 "enum": [ |
2033 "PLATFORM_UNSPECIFIED", | 2506 "PLATFORM_UNSPECIFIED", |
2034 "DESKTOP", | 2507 "DESKTOP", |
2035 "TABLET", | 2508 "TABLET", |
2036 "MOBILE" | 2509 "MOBILE" |
2037 ], | 2510 ], |
2038 "type": "string" | 2511 "type": "string" |
2039 }, | 2512 }, |
2040 "type": "array" | 2513 "type": "array" |
2041 }, | |
2042 "sellerNetworkIds": { | |
2043 "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.", | |
2044 "items": { | |
2045 "format": "int32", | |
2046 "type": "integer" | |
2047 }, | |
2048 "type": "array" | |
2049 }, | |
2050 "ownerAccountId": { | |
2051 "description": "The account ID of the buyer who owns this fi
lter set.\nThe value of this field is ignored in create operations.", | |
2052 "format": "int64", | |
2053 "type": "string" | |
2054 }, | |
2055 "absoluteDateRange": { | |
2056 "$ref": "AbsoluteDateRange", | |
2057 "description": "An absolute date range, defined by a start d
ate and an end date.\nInterpreted relative to Pacific time zone." | |
2058 }, | |
2059 "buyerAccountId": { | |
2060 "description": "The ID of the buyer account on which to filt
er; optional.", | |
2061 "format": "int64", | |
2062 "type": "string" | |
2063 }, | |
2064 "environment": { | |
2065 "description": "The environment on which to filter; optional
.", | |
2066 "enum": [ | |
2067 "ENVIRONMENT_UNSPECIFIED", | |
2068 "WEB", | |
2069 "APP" | |
2070 ], | |
2071 "enumDescriptions": [ | |
2072 "A placeholder for an undefined environment; indicates t
hat no environment\nfilter will be applied.", | |
2073 "The ad impression appears on the web.", | |
2074 "The ad impression appears in an app." | |
2075 ], | |
2076 "type": "string" | |
2077 }, | |
2078 "dealId": { | |
2079 "description": "The ID of the deal on which to filter; optio
nal.", | |
2080 "format": "int64", | |
2081 "type": "string" | |
2082 }, | |
2083 "format": { | |
2084 "description": "The format on which to filter; optional.", | |
2085 "enum": [ | |
2086 "FORMAT_UNSPECIFIED", | |
2087 "DISPLAY", | |
2088 "VIDEO" | |
2089 ], | |
2090 "enumDescriptions": [ | |
2091 "A placeholder for an undefined format; indicates that n
o format filter\nwill be applied.", | |
2092 "The ad impression is display format (i.e. an image).", | |
2093 "The ad impression is video format." | |
2094 ], | |
2095 "type": "string" | |
2096 }, | |
2097 "timeSeriesGranularity": { | |
2098 "description": "The granularity of time intervals if a time
series breakdown is desired;\noptional.", | |
2099 "enum": [ | |
2100 "INTERVAL_UNSPECIFIED", | |
2101 "HOURLY", | |
2102 "DAILY" | |
2103 ], | |
2104 "enumDescriptions": [ | |
2105 "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.", | |
2106 "Indicates that data will be broken down by the hour.", | |
2107 "Indicates that data will be broken down by the day." | |
2108 ], | |
2109 "type": "string" | |
2110 }, | |
2111 "filterSetId": { | |
2112 "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.", | |
2113 "format": "int64", | |
2114 "type": "string" | |
2115 }, | |
2116 "realtimeTimeRange": { | |
2117 "$ref": "RealtimeTimeRange", | |
2118 "description": "An open-ended realtime time range, defined b
y the aggregation start\ntimestamp." | |
2119 } | 2514 } |
2120 }, | 2515 }, |
2121 "type": "object" | 2516 "type": "object" |
2122 }, | 2517 }, |
2123 "ListDealAssociationsResponse": { | 2518 "ListDealAssociationsResponse": { |
2124 "description": "A response for listing creative and deal association
s", | 2519 "description": "A response for listing creative and deal association
s", |
2125 "id": "ListDealAssociationsResponse", | 2520 "id": "ListDealAssociationsResponse", |
2126 "properties": { | 2521 "properties": { |
2127 "associations": { | 2522 "associations": { |
2128 "description": "The list of associations.", | 2523 "description": "The list of associations.", |
(...skipping 26 matching lines...) Expand all Loading... |
2155 "$ref": "MetricValue", | 2550 "$ref": "MetricValue", |
2156 "description": "The number of impressions for which there wa
s a bid request or bid response\nwith the specified callout status." | 2551 "description": "The number of impressions for which there wa
s a bid request or bid response\nwith the specified callout status." |
2157 } | 2552 } |
2158 }, | 2553 }, |
2159 "type": "object" | 2554 "type": "object" |
2160 }, | 2555 }, |
2161 "Disapproval": { | 2556 "Disapproval": { |
2162 "description": "@OutputOnly The reason and details for a disapproval
.", | 2557 "description": "@OutputOnly The reason and details for a disapproval
.", |
2163 "id": "Disapproval", | 2558 "id": "Disapproval", |
2164 "properties": { | 2559 "properties": { |
| 2560 "details": { |
| 2561 "description": "Additional details about the reason for disa
pproval.", |
| 2562 "items": { |
| 2563 "type": "string" |
| 2564 }, |
| 2565 "type": "array" |
| 2566 }, |
2165 "reason": { | 2567 "reason": { |
2166 "description": "The categorized reason for disapproval.", | 2568 "description": "The categorized reason for disapproval.", |
2167 "enum": [ | 2569 "enum": [ |
2168 "LENGTH_OF_IMAGE_ANIMATION", | 2570 "LENGTH_OF_IMAGE_ANIMATION", |
2169 "BROKEN_URL", | 2571 "BROKEN_URL", |
2170 "MEDIA_NOT_FUNCTIONAL", | 2572 "MEDIA_NOT_FUNCTIONAL", |
2171 "INVALID_FOURTH_PARTY_CALL", | 2573 "INVALID_FOURTH_PARTY_CALL", |
2172 "INCORRECT_REMARKETING_DECLARATION", | 2574 "INCORRECT_REMARKETING_DECLARATION", |
2173 "LANDING_PAGE_ERROR", | 2575 "LANDING_PAGE_ERROR", |
2174 "AD_SIZE_DOES_NOT_MATCH_AD_SLOT", | 2576 "AD_SIZE_DOES_NOT_MATCH_AD_SLOT", |
(...skipping 175 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2350 "Restricted in China.", | 2752 "Restricted in China.", |
2351 "Unacceptable content: Korean healthcare.", | 2753 "Unacceptable content: Korean healthcare.", |
2352 "Non-family safe or adult content.", | 2754 "Non-family safe or adult content.", |
2353 "Clinical trial recruitment.", | 2755 "Clinical trial recruitment.", |
2354 "Maximum number of HTTP calls exceeded.", | 2756 "Maximum number of HTTP calls exceeded.", |
2355 "Maximum number of cookies exceeded.", | 2757 "Maximum number of cookies exceeded.", |
2356 "Financial service ad does not adhere to specifications.
", | 2758 "Financial service ad does not adhere to specifications.
", |
2357 "Flash content was found in an unsupported context." | 2759 "Flash content was found in an unsupported context." |
2358 ], | 2760 ], |
2359 "type": "string" | 2761 "type": "string" |
2360 }, | |
2361 "details": { | |
2362 "description": "Additional details about the reason for disa
pproval.", | |
2363 "items": { | |
2364 "type": "string" | |
2365 }, | |
2366 "type": "array" | |
2367 } | 2762 } |
2368 }, | 2763 }, |
2369 "type": "object" | 2764 "type": "object" |
2370 }, | 2765 }, |
2371 "StopWatchingCreativeRequest": { | 2766 "StopWatchingCreativeRequest": { |
2372 "description": "A request for stopping notifications for changes to
creative Status.", | 2767 "description": "A request for stopping notifications for changes to
creative Status.", |
2373 "id": "StopWatchingCreativeRequest", | 2768 "id": "StopWatchingCreativeRequest", |
2374 "properties": {}, | 2769 "properties": {}, |
2375 "type": "object" | 2770 "type": "object" |
2376 }, | 2771 }, |
2377 "ServingRestriction": { | 2772 "ServingRestriction": { |
2378 "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).", | 2773 "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).", |
2379 "id": "ServingRestriction", | 2774 "id": "ServingRestriction", |
2380 "properties": { | 2775 "properties": { |
2381 "disapprovalReasons": { | |
2382 "description": "Any disapprovals bound to this restriction.\
nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\
ncreatives.list\nmethod.", | |
2383 "items": { | |
2384 "$ref": "Disapproval" | |
2385 }, | |
2386 "type": "array" | |
2387 }, | |
2388 "contexts": { | |
2389 "description": "The contexts for the restriction.", | |
2390 "items": { | |
2391 "$ref": "ServingContext" | |
2392 }, | |
2393 "type": "array" | |
2394 }, | |
2395 "status": { | 2776 "status": { |
2396 "description": "The status of the creative in this context (
for example, it has been\nexplicitly disapproved or is pending review).", | 2777 "description": "The status of the creative in this context (
for example, it has been\nexplicitly disapproved or is pending review).", |
2397 "enum": [ | 2778 "enum": [ |
2398 "STATUS_UNSPECIFIED", | 2779 "STATUS_UNSPECIFIED", |
2399 "DISAPPROVAL", | 2780 "DISAPPROVAL", |
2400 "PENDING_REVIEW" | 2781 "PENDING_REVIEW" |
2401 ], | 2782 ], |
2402 "enumDescriptions": [ | 2783 "enumDescriptions": [ |
2403 "The status is not known.", | 2784 "The status is not known.", |
2404 "The ad was disapproved in this context.", | 2785 "The ad was disapproved in this context.", |
2405 "The ad is pending review in this context." | 2786 "The ad is pending review in this context." |
2406 ], | 2787 ], |
2407 "type": "string" | 2788 "type": "string" |
| 2789 }, |
| 2790 "disapprovalReasons": { |
| 2791 "description": "Any disapprovals bound to this restriction.\
nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\
ncreatives.list\nmethod.", |
| 2792 "items": { |
| 2793 "$ref": "Disapproval" |
| 2794 }, |
| 2795 "type": "array" |
| 2796 }, |
| 2797 "contexts": { |
| 2798 "description": "The contexts for the restriction.", |
| 2799 "items": { |
| 2800 "$ref": "ServingContext" |
| 2801 }, |
| 2802 "type": "array" |
2408 } | 2803 } |
2409 }, | 2804 }, |
2410 "type": "object" | 2805 "type": "object" |
2411 }, | 2806 }, |
2412 "Date": { | 2807 "Date": { |
2413 "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`.", | 2808 "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`.", |
2414 "id": "Date", | 2809 "id": "Date", |
2415 "properties": { | 2810 "properties": { |
| 2811 "year": { |
| 2812 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
| 2813 "format": "int32", |
| 2814 "type": "integer" |
| 2815 }, |
| 2816 "day": { |
| 2817 "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.", |
| 2818 "format": "int32", |
| 2819 "type": "integer" |
| 2820 }, |
2416 "month": { | 2821 "month": { |
2417 "description": "Month of year. Must be from 1 to 12.", | 2822 "description": "Month of year. Must be from 1 to 12.", |
2418 "format": "int32", | 2823 "format": "int32", |
2419 "type": "integer" | 2824 "type": "integer" |
2420 }, | |
2421 "year": { | |
2422 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | |
2423 "format": "int32", | |
2424 "type": "integer" | |
2425 }, | |
2426 "day": { | |
2427 "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.", | |
2428 "format": "int32", | |
2429 "type": "integer" | |
2430 } | 2825 } |
2431 }, | 2826 }, |
2432 "type": "object" | 2827 "type": "object" |
2433 }, | 2828 }, |
2434 "RowDimensions": { | 2829 "RowDimensions": { |
2435 "description": "A response may include multiple rows, breaking down
along various dimensions.\nEncapsulates the values of all dimensions for a given
row.", | 2830 "description": "A response may include multiple rows, breaking down
along various dimensions.\nEncapsulates the values of all dimensions for a given
row.", |
2436 "id": "RowDimensions", | 2831 "id": "RowDimensions", |
2437 "properties": { | 2832 "properties": { |
2438 "timeInterval": { | 2833 "timeInterval": { |
2439 "$ref": "TimeInterval", | 2834 "$ref": "TimeInterval", |
2440 "description": "The time interval that this row represents." | 2835 "description": "The time interval that this row represents." |
2441 } | 2836 } |
2442 }, | 2837 }, |
2443 "type": "object" | 2838 "type": "object" |
2444 }, | 2839 }, |
2445 "Empty": { | 2840 "Empty": { |
2446 "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 `{}`.", | 2841 "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 `{}`.", |
2447 "id": "Empty", | 2842 "id": "Empty", |
2448 "properties": {}, | 2843 "properties": {}, |
2449 "type": "object" | 2844 "type": "object" |
2450 }, | 2845 }, |
2451 "ListCreativeStatusAndCreativeBreakdownByDetailResponse": { | 2846 "ListCreativeStatusAndCreativeBreakdownByDetailResponse": { |
2452 "description": "Response message for listing all details associated
with a given filtered bid\nreason and a given creative.", | 2847 "description": "Response message for listing all details associated
with a given filtered bid\nreason and a given creative.", |
2453 "id": "ListCreativeStatusAndCreativeBreakdownByDetailResponse", | 2848 "id": "ListCreativeStatusAndCreativeBreakdownByDetailResponse", |
2454 "properties": { | 2849 "properties": { |
2455 "filteredBidDetailRows": { | |
2456 "description": "List of rows, with counts of bids with a giv
en creative status and\ncreative, aggregated by detail.", | |
2457 "items": { | |
2458 "$ref": "FilteredBidDetailRow" | |
2459 }, | |
2460 "type": "array" | |
2461 }, | |
2462 "nextPageToken": { | |
2463 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativeStatusAndCreativeBreakdownByDetailRequest
.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBid
s.creatives.details.list\nmethod to retrieve the next page of results.", | |
2464 "type": "string" | |
2465 }, | |
2466 "detailType": { | 2850 "detailType": { |
2467 "description": "The type of detail that the detail IDs repre
sent.", | 2851 "description": "The type of detail that the detail IDs repre
sent.", |
2468 "enum": [ | 2852 "enum": [ |
2469 "TYPE_UNSPECIFIED", | 2853 "TYPE_UNSPECIFIED", |
2470 "CREATIVE_ATTRIBUTE", | 2854 "CREATIVE_ATTRIBUTE", |
2471 "VENDOR", | 2855 "VENDOR", |
2472 "SENSITIVE_CATEGORY", | 2856 "SENSITIVE_CATEGORY", |
2473 "PRODUCT_CATEGORY" | 2857 "PRODUCT_CATEGORY" |
2474 ], | 2858 ], |
2475 "enumDescriptions": [ | 2859 "enumDescriptions": [ |
2476 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | 2860 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", |
2477 "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).", | 2861 "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).", |
2478 "Indicates that the detail ID refers to a vendor; see\n[
vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", | 2862 "Indicates that the detail ID refers to a vendor; see\n[
vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", |
2479 "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).", | 2863 "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).", |
2480 "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)." | 2864 "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)." |
2481 ], | 2865 ], |
2482 "type": "string" | 2866 "type": "string" |
| 2867 }, |
| 2868 "filteredBidDetailRows": { |
| 2869 "description": "List of rows, with counts of bids with a giv
en creative status and\ncreative, aggregated by detail.", |
| 2870 "items": { |
| 2871 "$ref": "FilteredBidDetailRow" |
| 2872 }, |
| 2873 "type": "array" |
| 2874 }, |
| 2875 "nextPageToken": { |
| 2876 "description": "A token to retrieve the next page of results
.\nPass this value in the\nListCreativeStatusAndCreativeBreakdownByDetailRequest
.pageToken\nfield in the subsequent call to the\naccounts.filterSets.filteredBid
s.creatives.details.list\nmethod to retrieve the next page of results.", |
| 2877 "type": "string" |
2483 } | 2878 } |
2484 }, | 2879 }, |
2485 "type": "object" | 2880 "type": "object" |
2486 }, | 2881 }, |
2487 "AppContext": { | 2882 "AppContext": { |
2488 "description": "@OutputOnly The app type the restriction applies to
for mobile device.", | 2883 "description": "@OutputOnly The app type the restriction applies to
for mobile device.", |
2489 "id": "AppContext", | 2884 "id": "AppContext", |
2490 "properties": { | 2885 "properties": { |
2491 "appTypes": { | 2886 "appTypes": { |
2492 "description": "The app types this restriction applies to.", | 2887 "description": "The app types this restriction applies to.", |
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2543 }, | 2938 }, |
2544 "type": "array" | 2939 "type": "array" |
2545 } | 2940 } |
2546 }, | 2941 }, |
2547 "type": "object" | 2942 "type": "object" |
2548 }, | 2943 }, |
2549 "HtmlContent": { | 2944 "HtmlContent": { |
2550 "description": "HTML content for a creative.", | 2945 "description": "HTML content for a creative.", |
2551 "id": "HtmlContent", | 2946 "id": "HtmlContent", |
2552 "properties": { | 2947 "properties": { |
2553 "snippet": { | |
2554 "description": "The HTML snippet that displays the ad when i
nserted in the web page.", | |
2555 "type": "string" | |
2556 }, | |
2557 "height": { | 2948 "height": { |
2558 "description": "The height of the HTML snippet in pixels.", | 2949 "description": "The height of the HTML snippet in pixels.", |
2559 "format": "int32", | 2950 "format": "int32", |
2560 "type": "integer" | 2951 "type": "integer" |
2561 }, | 2952 }, |
2562 "width": { | 2953 "width": { |
2563 "description": "The width of the HTML snippet in pixels.", | 2954 "description": "The width of the HTML snippet in pixels.", |
2564 "format": "int32", | 2955 "format": "int32", |
2565 "type": "integer" | 2956 "type": "integer" |
| 2957 }, |
| 2958 "snippet": { |
| 2959 "description": "The HTML snippet that displays the ad when i
nserted in the web page.", |
| 2960 "type": "string" |
2566 } | 2961 } |
2567 }, | 2962 }, |
2568 "type": "object" | 2963 "type": "object" |
2569 }, | 2964 }, |
2570 "ListCreativesResponse": { | 2965 "ListCreativesResponse": { |
2571 "description": "A response for listing creatives.", | 2966 "description": "A response for listing creatives.", |
2572 "id": "ListCreativesResponse", | 2967 "id": "ListCreativesResponse", |
2573 "properties": { | 2968 "properties": { |
| 2969 "creatives": { |
| 2970 "description": "The list of creatives.", |
| 2971 "items": { |
| 2972 "$ref": "Creative" |
| 2973 }, |
| 2974 "type": "array" |
| 2975 }, |
2574 "nextPageToken": { | 2976 "nextPageToken": { |
2575 "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.", | 2977 "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.", |
2576 "type": "string" | 2978 "type": "string" |
2577 }, | |
2578 "creatives": { | |
2579 "description": "The list of creatives.", | |
2580 "items": { | |
2581 "$ref": "Creative" | |
2582 }, | |
2583 "type": "array" | |
2584 } | 2979 } |
2585 }, | 2980 }, |
2586 "type": "object" | 2981 "type": "object" |
2587 }, | 2982 }, |
2588 "ListFilteredBidRequestsResponse": { | 2983 "ListFilteredBidRequestsResponse": { |
2589 "description": "Response message for listing all reasons that bid re
quests were filtered and\nnot sent to the buyer.", | 2984 "description": "Response message for listing all reasons that bid re
quests were filtered and\nnot sent to the buyer.", |
2590 "id": "ListFilteredBidRequestsResponse", | 2985 "id": "ListFilteredBidRequestsResponse", |
2591 "properties": { | 2986 "properties": { |
2592 "calloutStatusRows": { | 2987 "calloutStatusRows": { |
2593 "description": "List of rows, with counts of filtered bid re
quests aggregated by callout\nstatus.", | 2988 "description": "List of rows, with counts of filtered bid re
quests aggregated by callout\nstatus.", |
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2631 "type": "string" | 3026 "type": "string" |
2632 }, | 3027 }, |
2633 "status": { | 3028 "status": { |
2634 "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.", | 3029 "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.", |
2635 "format": "int32", | 3030 "format": "int32", |
2636 "type": "integer" | 3031 "type": "integer" |
2637 } | 3032 } |
2638 }, | 3033 }, |
2639 "type": "object" | 3034 "type": "object" |
2640 }, | 3035 }, |
| 3036 "VideoContent": { |
| 3037 "description": "Video content for a creative.", |
| 3038 "id": "VideoContent", |
| 3039 "properties": { |
| 3040 "videoUrl": { |
| 3041 "description": "The URL to fetch a video ad.", |
| 3042 "type": "string" |
| 3043 } |
| 3044 }, |
| 3045 "type": "object" |
| 3046 }, |
2641 "ListLosingBidsResponse": { | 3047 "ListLosingBidsResponse": { |
2642 "description": "Response message for listing all reasons that bids l
ost in the auction.", | 3048 "description": "Response message for listing all reasons that bids l
ost in the auction.", |
2643 "id": "ListLosingBidsResponse", | 3049 "id": "ListLosingBidsResponse", |
2644 "properties": { | 3050 "properties": { |
2645 "creativeStatusRows": { | 3051 "creativeStatusRows": { |
2646 "description": "List of rows, with counts of losing bids agg
regated by loss reason (i.e.\ncreative status).", | 3052 "description": "List of rows, with counts of losing bids agg
regated by loss reason (i.e.\ncreative status).", |
2647 "items": { | 3053 "items": { |
2648 "$ref": "CreativeStatusRow" | 3054 "$ref": "CreativeStatusRow" |
2649 }, | 3055 }, |
2650 "type": "array" | 3056 "type": "array" |
2651 }, | 3057 }, |
2652 "nextPageToken": { | 3058 "nextPageToken": { |
2653 "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.", | 3059 "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.", |
2654 "type": "string" | 3060 "type": "string" |
2655 } | 3061 } |
2656 }, | 3062 }, |
2657 "type": "object" | 3063 "type": "object" |
2658 }, | 3064 }, |
2659 "VideoContent": { | 3065 "ListNonBillableWinningBidsResponse": { |
2660 "description": "Video content for a creative.", | 3066 "description": "Response message for listing all reasons for which a
buyer was not billed for\na winning bid.", |
2661 "id": "VideoContent", | 3067 "id": "ListNonBillableWinningBidsResponse", |
2662 "properties": { | 3068 "properties": { |
2663 "videoUrl": { | 3069 "nextPageToken": { |
2664 "description": "The URL to fetch a video ad.", | 3070 "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.", |
2665 "type": "string" | 3071 "type": "string" |
| 3072 }, |
| 3073 "nonBillableWinningBidStatusRows": { |
| 3074 "description": "List of rows, with counts of bids not billed
aggregated by reason.", |
| 3075 "items": { |
| 3076 "$ref": "NonBillableWinningBidStatusRow" |
| 3077 }, |
| 3078 "type": "array" |
2666 } | 3079 } |
2667 }, | 3080 }, |
2668 "type": "object" | 3081 "type": "object" |
2669 }, | 3082 }, |
2670 "ImpressionMetricsRow": { | 3083 "ImpressionMetricsRow": { |
2671 "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.", | 3084 "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.", |
2672 "id": "ImpressionMetricsRow", | 3085 "id": "ImpressionMetricsRow", |
2673 "properties": { | 3086 "properties": { |
2674 "rowDimensions": { | 3087 "rowDimensions": { |
2675 "$ref": "RowDimensions", | 3088 "$ref": "RowDimensions", |
2676 "description": "The values of all dimensions associated with
metric values in this row." | 3089 "description": "The values of all dimensions associated with
metric values in this row." |
2677 }, | 3090 }, |
2678 "availableImpressions": { | 3091 "availableImpressions": { |
2679 "$ref": "MetricValue", | 3092 "$ref": "MetricValue", |
2680 "description": "The number of impressions available to the b
uyer on Ad Exchange.\nIn some cases this value may be unavailable." | 3093 "description": "The number of impressions available to the b
uyer on Ad Exchange.\nIn some cases this value may be unavailable." |
2681 }, | 3094 }, |
| 3095 "inventoryMatches": { |
| 3096 "$ref": "MetricValue", |
| 3097 "description": "The number of impressions that match the buy
er's inventory pretargeting." |
| 3098 }, |
2682 "bidRequests": { | 3099 "bidRequests": { |
2683 "$ref": "MetricValue", | 3100 "$ref": "MetricValue", |
2684 "description": "The number of impressions for which Ad Excha
nge sent the buyer a bid\nrequest." | 3101 "description": "The number of impressions for which Ad Excha
nge sent the buyer a bid\nrequest." |
2685 }, | 3102 }, |
2686 "inventoryMatches": { | |
2687 "$ref": "MetricValue", | |
2688 "description": "The number of impressions that match the buy
er's inventory pretargeting." | |
2689 }, | |
2690 "responsesWithBids": { | 3103 "responsesWithBids": { |
2691 "$ref": "MetricValue", | 3104 "$ref": "MetricValue", |
2692 "description": "The number of impressions for which Ad Excha
nge received a response from\nthe buyer that contained at least one applicable b
id." | 3105 "description": "The number of impressions for which Ad Excha
nge received a response from\nthe buyer that contained at least one applicable b
id." |
2693 }, | 3106 }, |
2694 "successfulResponses": { | 3107 "successfulResponses": { |
2695 "$ref": "MetricValue", | 3108 "$ref": "MetricValue", |
2696 "description": "The number of impressions for which the buye
r successfully sent a response\nto Ad Exchange." | 3109 "description": "The number of impressions for which the buye
r successfully sent a response\nto Ad Exchange." |
2697 } | 3110 } |
2698 }, | 3111 }, |
2699 "type": "object" | 3112 "type": "object" |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2731 "impressionMetricsRows": { | 3144 "impressionMetricsRows": { |
2732 "description": "List of rows, each containing a set of impre
ssion metrics.", | 3145 "description": "List of rows, each containing a set of impre
ssion metrics.", |
2733 "items": { | 3146 "items": { |
2734 "$ref": "ImpressionMetricsRow" | 3147 "$ref": "ImpressionMetricsRow" |
2735 }, | 3148 }, |
2736 "type": "array" | 3149 "type": "array" |
2737 } | 3150 } |
2738 }, | 3151 }, |
2739 "type": "object" | 3152 "type": "object" |
2740 }, | 3153 }, |
2741 "ImpressionStatusRow": { | 3154 "BidMetricsRow": { |
2742 "description": "The number of impressions with the specified dimensi
on values that were\nfiltered due to the specified filtering status.", | 3155 "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;", |
2743 "id": "ImpressionStatusRow", | 3156 "id": "BidMetricsRow", |
2744 "properties": { | 3157 "properties": { |
2745 "impressionCount": { | 3158 "bidsInAuction": { |
2746 "$ref": "MetricValue", | 3159 "$ref": "MetricValue", |
2747 "description": "The number of impressions that were filtered
with the specified status." | 3160 "description": "The number of bids that were permitted to co
mpete in the auction." |
2748 }, | |
2749 "status": { | |
2750 "description": "The status for which impressions were filter
ed.", | |
2751 "enum": [ | |
2752 "STATUS_UNSPECIFIED", | |
2753 "PRETARGETING_CONFIGURATIONS" | |
2754 ], | |
2755 "enumDescriptions": [ | |
2756 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
2757 "The impression was filtered because it did not match th
e buyer's\npretargeting configurations." | |
2758 ], | |
2759 "type": "string" | |
2760 }, | 3161 }, |
2761 "rowDimensions": { | 3162 "rowDimensions": { |
2762 "$ref": "RowDimensions", | 3163 "$ref": "RowDimensions", |
2763 "description": "The values of all dimensions associated with
metric values in this row." | 3164 "description": "The values of all dimensions associated with
metric values in this row." |
2764 } | |
2765 }, | |
2766 "type": "object" | |
2767 }, | |
2768 "BidMetricsRow": { | |
2769 "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;", | |
2770 "id": "BidMetricsRow", | |
2771 "properties": { | |
2772 "rowDimensions": { | |
2773 "$ref": "RowDimensions", | |
2774 "description": "The values of all dimensions associated with
metric values in this row." | |
2775 }, | 3165 }, |
2776 "viewableImpressions": { | 3166 "viewableImpressions": { |
2777 "$ref": "MetricValue", | 3167 "$ref": "MetricValue", |
2778 "description": "The number of bids for which the correspondi
ng impression was viewable (as\ndefined by Active View)." | 3168 "description": "The number of bids for which the correspondi
ng impression was viewable (as\ndefined by Active View)." |
2779 }, | 3169 }, |
2780 "impressionsWon": { | 3170 "impressionsWon": { |
2781 "$ref": "MetricValue", | 3171 "$ref": "MetricValue", |
2782 "description": "The number of bids that won an impression." | 3172 "description": "The number of bids that won an impression." |
2783 }, | 3173 }, |
| 3174 "measurableImpressions": { |
| 3175 "$ref": "MetricValue", |
| 3176 "description": "The number of bids for which the correspondi
ng impression was measurable\nfor viewability (as defined by Active View)." |
| 3177 }, |
2784 "bids": { | 3178 "bids": { |
2785 "$ref": "MetricValue", | 3179 "$ref": "MetricValue", |
2786 "description": "The number of bids that Ad Exchange received
from the buyer." | 3180 "description": "The number of bids that Ad Exchange received
from the buyer." |
2787 }, | 3181 }, |
2788 "billedImpressions": { | 3182 "billedImpressions": { |
2789 "$ref": "MetricValue", | 3183 "$ref": "MetricValue", |
2790 "description": "The number of bids for which the buyer was b
illed." | 3184 "description": "The number of bids for which the buyer was b
illed." |
2791 }, | |
2792 "bidsInAuction": { | |
2793 "$ref": "MetricValue", | |
2794 "description": "The number of bids that were permitted to co
mpete in the auction." | |
2795 } | 3185 } |
2796 }, | 3186 }, |
2797 "type": "object" | 3187 "type": "object" |
2798 }, | 3188 }, |
2799 "ListBidResponseErrorsResponse": { | 3189 "ListBidResponseErrorsResponse": { |
2800 "description": "Response message for listing all reasons that bid re
sponses resulted in an\nerror.", | 3190 "description": "Response message for listing all reasons that bid re
sponses resulted in an\nerror.", |
2801 "id": "ListBidResponseErrorsResponse", | 3191 "id": "ListBidResponseErrorsResponse", |
2802 "properties": { | 3192 "properties": { |
2803 "calloutStatusRows": { | 3193 "calloutStatusRows": { |
2804 "description": "List of rows, with counts of bid responses a
ggregated by callout status.", | 3194 "description": "List of rows, with counts of bid responses a
ggregated by callout status.", |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2839 "id": "RealtimeTimeRange", | 3229 "id": "RealtimeTimeRange", |
2840 "properties": { | 3230 "properties": { |
2841 "startTimestamp": { | 3231 "startTimestamp": { |
2842 "description": "The start timestamp of the real-time RTB met
rics aggregation.", | 3232 "description": "The start timestamp of the real-time RTB met
rics aggregation.", |
2843 "format": "google-datetime", | 3233 "format": "google-datetime", |
2844 "type": "string" | 3234 "type": "string" |
2845 } | 3235 } |
2846 }, | 3236 }, |
2847 "type": "object" | 3237 "type": "object" |
2848 }, | 3238 }, |
| 3239 "NonBillableWinningBidStatusRow": { |
| 3240 "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.", |
| 3241 "id": "NonBillableWinningBidStatusRow", |
| 3242 "properties": { |
| 3243 "bidCount": { |
| 3244 "$ref": "MetricValue", |
| 3245 "description": "The number of bids with the specified status
." |
| 3246 }, |
| 3247 "status": { |
| 3248 "description": "The status specifying why the winning bids w
ere not billed.", |
| 3249 "enum": [ |
| 3250 "STATUS_UNSPECIFIED", |
| 3251 "AD_NOT_RENDERED", |
| 3252 "INVALID_IMPRESSION" |
| 3253 ], |
| 3254 "enumDescriptions": [ |
| 3255 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", |
| 3256 "The buyer was not billed because the ad was not rendere
d by the\npublisher.", |
| 3257 "The buyer was not billed because the impression won by
the bid was\ndetermined to be invalid." |
| 3258 ], |
| 3259 "type": "string" |
| 3260 }, |
| 3261 "rowDimensions": { |
| 3262 "$ref": "RowDimensions", |
| 3263 "description": "The values of all dimensions associated with
metric values in this row." |
| 3264 } |
| 3265 }, |
| 3266 "type": "object" |
| 3267 }, |
2849 "FilteredBidDetailRow": { | 3268 "FilteredBidDetailRow": { |
2850 "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.", | 3269 "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.", |
2851 "id": "FilteredBidDetailRow", | 3270 "id": "FilteredBidDetailRow", |
2852 "properties": { | 3271 "properties": { |
2853 "rowDimensions": { | |
2854 "$ref": "RowDimensions", | |
2855 "description": "The values of all dimensions associated with
metric values in this row." | |
2856 }, | |
2857 "bidCount": { | 3272 "bidCount": { |
2858 "$ref": "MetricValue", | 3273 "$ref": "MetricValue", |
2859 "description": "The number of bids with the specified detail
." | 3274 "description": "The number of bids with the specified detail
." |
2860 }, | 3275 }, |
2861 "detailId": { | 3276 "detailId": { |
2862 "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.", | 3277 "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.", |
2863 "format": "int32", | 3278 "format": "int32", |
2864 "type": "integer" | 3279 "type": "integer" |
| 3280 }, |
| 3281 "rowDimensions": { |
| 3282 "$ref": "RowDimensions", |
| 3283 "description": "The values of all dimensions associated with
metric values in this row." |
2865 } | 3284 } |
2866 }, | 3285 }, |
2867 "type": "object" | 3286 "type": "object" |
2868 }, | 3287 }, |
2869 "AbsoluteDateRange": { | 3288 "AbsoluteDateRange": { |
2870 "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.", | 3289 "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.", |
2871 "id": "AbsoluteDateRange", | 3290 "id": "AbsoluteDateRange", |
2872 "properties": { | 3291 "properties": { |
2873 "startDate": { | 3292 "startDate": { |
2874 "$ref": "Date", | 3293 "$ref": "Date", |
2875 "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." | 3294 "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." |
2876 }, | 3295 }, |
2877 "endDate": { | 3296 "endDate": { |
2878 "$ref": "Date", | 3297 "$ref": "Date", |
2879 "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." | 3298 "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." |
2880 } | 3299 } |
2881 }, | 3300 }, |
2882 "type": "object" | 3301 "type": "object" |
2883 }, | 3302 }, |
2884 "AddDealAssociationRequest": { | 3303 "AddDealAssociationRequest": { |
2885 "description": "A request for associating a deal and a creative.", | 3304 "description": "A request for associating a deal and a creative.", |
2886 "id": "AddDealAssociationRequest", | 3305 "id": "AddDealAssociationRequest", |
2887 "properties": { | 3306 "properties": { |
2888 "association": { | 3307 "association": { |
2889 "$ref": "CreativeDealAssociation", | 3308 "$ref": "CreativeDealAssociation", |
2890 "description": "The association between a creative and a dea
l that should be added." | 3309 "description": "The association between a creative and a dea
l that should be added." |
2891 } | 3310 } |
2892 }, | 3311 }, |
2893 "type": "object" | 3312 "type": "object" |
2894 }, | |
2895 "WatchCreativeRequest": { | |
2896 "description": "A request for watching changes to creative Status.", | |
2897 "id": "WatchCreativeRequest", | |
2898 "properties": { | |
2899 "topic": { | |
2900 "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.", | |
2901 "type": "string" | |
2902 } | |
2903 }, | |
2904 "type": "object" | |
2905 }, | |
2906 "TimeInterval": { | |
2907 "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.", | |
2908 "id": "TimeInterval", | |
2909 "properties": { | |
2910 "endTime": { | |
2911 "description": "The timestamp marking the end of the range (
exclusive) for which data is\nincluded.", | |
2912 "format": "google-datetime", | |
2913 "type": "string" | |
2914 }, | |
2915 "startTime": { | |
2916 "description": "The timestamp marking the start of the range
(inclusive) for which data is\nincluded.", | |
2917 "format": "google-datetime", | |
2918 "type": "string" | |
2919 } | |
2920 }, | |
2921 "type": "object" | |
2922 }, | |
2923 "FilteredBidCreativeRow": { | |
2924 "description": "The number of filtered bids with the specified dimen
sion values that have the\nspecified creative.", | |
2925 "id": "FilteredBidCreativeRow", | |
2926 "properties": { | |
2927 "rowDimensions": { | |
2928 "$ref": "RowDimensions", | |
2929 "description": "The values of all dimensions associated with
metric values in this row." | |
2930 }, | |
2931 "bidCount": { | |
2932 "$ref": "MetricValue", | |
2933 "description": "The number of bids with the specified creati
ve." | |
2934 }, | |
2935 "creativeId": { | |
2936 "description": "The ID of the creative.", | |
2937 "type": "string" | |
2938 } | |
2939 }, | |
2940 "type": "object" | |
2941 }, | |
2942 "RelativeDateRange": { | |
2943 "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", | |
2944 "id": "RelativeDateRange", | |
2945 "properties": { | |
2946 "durationDays": { | |
2947 "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
.", | |
2948 "format": "int32", | |
2949 "type": "integer" | |
2950 }, | |
2951 "offsetDays": { | |
2952 "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.", | |
2953 "format": "int32", | |
2954 "type": "integer" | |
2955 } | |
2956 }, | |
2957 "type": "object" | |
2958 }, | |
2959 "NativeContent": { | |
2960 "description": "Native content for a creative.", | |
2961 "id": "NativeContent", | |
2962 "properties": { | |
2963 "advertiserName": { | |
2964 "description": "The name of the advertiser or sponsor, to be
displayed in the ad creative.", | |
2965 "type": "string" | |
2966 }, | |
2967 "storeUrl": { | |
2968 "description": "The URL to the app store to purchase/downloa
d the promoted app.", | |
2969 "type": "string" | |
2970 }, | |
2971 "headline": { | |
2972 "description": "A short title for the ad.", | |
2973 "type": "string" | |
2974 }, | |
2975 "appIcon": { | |
2976 "$ref": "Image", | |
2977 "description": "The app icon, for app download ads." | |
2978 }, | |
2979 "callToAction": { | |
2980 "description": "A label for the button that the user is supp
osed to click.", | |
2981 "type": "string" | |
2982 }, | |
2983 "body": { | |
2984 "description": "A long description of the ad.", | |
2985 "type": "string" | |
2986 }, | |
2987 "starRating": { | |
2988 "description": "The app rating in the app store. Must be in
the range [0-5].", | |
2989 "format": "double", | |
2990 "type": "number" | |
2991 }, | |
2992 "videoUrl": { | |
2993 "description": "The URL to fetch a native video ad.", | |
2994 "type": "string" | |
2995 }, | |
2996 "logo": { | |
2997 "$ref": "Image", | |
2998 "description": "A smaller image, for the advertiser's logo." | |
2999 }, | |
3000 "clickLinkUrl": { | |
3001 "description": "The URL that the browser/SDK will load when
the user clicks the ad.", | |
3002 "type": "string" | |
3003 }, | |
3004 "priceDisplayText": { | |
3005 "description": "The price of the promoted app including curr
ency info.", | |
3006 "type": "string" | |
3007 }, | |
3008 "clickTrackingUrl": { | |
3009 "description": "The URL to use for click tracking.", | |
3010 "type": "string" | |
3011 }, | |
3012 "image": { | |
3013 "$ref": "Image", | |
3014 "description": "A large image." | |
3015 } | |
3016 }, | |
3017 "type": "object" | |
3018 }, | |
3019 "ListClientsResponse": { | |
3020 "id": "ListClientsResponse", | |
3021 "properties": { | |
3022 "nextPageToken": { | |
3023 "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
.", | |
3024 "type": "string" | |
3025 }, | |
3026 "clients": { | |
3027 "description": "The returned list of clients.", | |
3028 "items": { | |
3029 "$ref": "Client" | |
3030 }, | |
3031 "type": "array" | |
3032 } | |
3033 }, | |
3034 "type": "object" | |
3035 }, | |
3036 "ListBidResponsesWithoutBidsResponse": { | |
3037 "description": "Response message for listing all reasons that bid re
sponses were considered\nto have no applicable bids.", | |
3038 "id": "ListBidResponsesWithoutBidsResponse", | |
3039 "properties": { | |
3040 "bidResponseWithoutBidsStatusRows": { | |
3041 "description": "List of rows, with counts of bid responses w
ithout bids aggregated by\nstatus.", | |
3042 "items": { | |
3043 "$ref": "BidResponseWithoutBidsStatusRow" | |
3044 }, | |
3045 "type": "array" | |
3046 }, | |
3047 "nextPageToken": { | |
3048 "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.", | |
3049 "type": "string" | |
3050 } | |
3051 }, | |
3052 "type": "object" | |
3053 }, | |
3054 "ServingContext": { | |
3055 "description": "The serving context for this restriction.", | |
3056 "id": "ServingContext", | |
3057 "properties": { | |
3058 "auctionType": { | |
3059 "$ref": "AuctionContext", | |
3060 "description": "Matches impressions for a particular auction
type." | |
3061 }, | |
3062 "all": { | |
3063 "description": "Matches all contexts.", | |
3064 "enum": [ | |
3065 "SIMPLE_CONTEXT" | |
3066 ], | |
3067 "enumDescriptions": [ | |
3068 "A simple context." | |
3069 ], | |
3070 "type": "string" | |
3071 }, | |
3072 "appType": { | |
3073 "$ref": "AppContext", | |
3074 "description": "Matches impressions for a particular app typ
e." | |
3075 }, | |
3076 "securityType": { | |
3077 "$ref": "SecurityContext", | |
3078 "description": "Matches impressions for a particular securit
y type." | |
3079 }, | |
3080 "platform": { | |
3081 "$ref": "PlatformContext", | |
3082 "description": "Matches impressions coming from a particular
platform." | |
3083 }, | |
3084 "location": { | |
3085 "$ref": "LocationContext", | |
3086 "description": "Matches impressions coming from users *or* p
ublishers in a specific\nlocation." | |
3087 } | |
3088 }, | |
3089 "type": "object" | |
3090 }, | |
3091 "Image": { | |
3092 "description": "An image resource. You may provide a larger image th
an was requested,\nso long as the aspect ratio is preserved.", | |
3093 "id": "Image", | |
3094 "properties": { | |
3095 "height": { | |
3096 "description": "Image height in pixels.", | |
3097 "format": "int32", | |
3098 "type": "integer" | |
3099 }, | |
3100 "width": { | |
3101 "description": "Image width in pixels.", | |
3102 "format": "int32", | |
3103 "type": "integer" | |
3104 }, | |
3105 "url": { | |
3106 "description": "The URL of the image.", | |
3107 "type": "string" | |
3108 } | |
3109 }, | |
3110 "type": "object" | |
3111 }, | |
3112 "ListFilterSetsResponse": { | |
3113 "description": "Response message for listing filter sets.", | |
3114 "id": "ListFilterSetsResponse", | |
3115 "properties": { | |
3116 "filterSets": { | |
3117 "description": "The filter sets belonging to the buyer.", | |
3118 "items": { | |
3119 "$ref": "FilterSet" | |
3120 }, | |
3121 "type": "array" | |
3122 }, | |
3123 "nextPageToken": { | |
3124 "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.", | |
3125 "type": "string" | |
3126 } | |
3127 }, | |
3128 "type": "object" | |
3129 }, | |
3130 "BidResponseWithoutBidsStatusRow": { | |
3131 "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.", | |
3132 "id": "BidResponseWithoutBidsStatusRow", | |
3133 "properties": { | |
3134 "impressionCount": { | |
3135 "$ref": "MetricValue", | |
3136 "description": "The number of impressions for which there wa
s a bid response with the\nspecified status." | |
3137 }, | |
3138 "status": { | |
3139 "description": "The status that caused the bid response to b
e considered to have no\napplicable bids.", | |
3140 "enum": [ | |
3141 "STATUS_UNSPECIFIED", | |
3142 "RESPONSES_WITHOUT_BIDS", | |
3143 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", | |
3144 "RESPONSES_WITHOUT_BIDS_FOR_DEAL" | |
3145 ], | |
3146 "enumDescriptions": [ | |
3147 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
3148 "The response had no bids.", | |
3149 "The response had no bids for the specified account, tho
ugh it may have\nincluded bids on behalf of other accounts.", | |
3150 "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." | |
3151 ], | |
3152 "type": "string" | |
3153 }, | |
3154 "rowDimensions": { | |
3155 "$ref": "RowDimensions", | |
3156 "description": "The values of all dimensions associated with
metric values in this row." | |
3157 } | |
3158 }, | |
3159 "type": "object" | |
3160 }, | |
3161 "ClientUserInvitation": { | |
3162 "description": "An invitation for a new client user to get access to
the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.
", | |
3163 "id": "ClientUserInvitation", | |
3164 "properties": { | |
3165 "invitationId": { | |
3166 "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
.", | |
3167 "format": "int64", | |
3168 "type": "string" | |
3169 }, | |
3170 "email": { | |
3171 "description": "The email address to which the invitation is
sent. Email\naddresses should be unique among all client users under each spons
or\nbuyer.", | |
3172 "type": "string" | |
3173 }, | |
3174 "clientAccountId": { | |
3175 "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.", | |
3176 "format": "int64", | |
3177 "type": "string" | |
3178 } | |
3179 }, | |
3180 "type": "object" | |
3181 }, | |
3182 "ListCreativeStatusBreakdownByDetailResponse": { | |
3183 "description": "Response message for listing all details associated
with a given filtered bid\nreason.", | |
3184 "id": "ListCreativeStatusBreakdownByDetailResponse", | |
3185 "properties": { | |
3186 "detailType": { | |
3187 "description": "The type of detail that the detail IDs repre
sent.", | |
3188 "enum": [ | |
3189 "TYPE_UNSPECIFIED", | |
3190 "CREATIVE_ATTRIBUTE", | |
3191 "VENDOR", | |
3192 "SENSITIVE_CATEGORY", | |
3193 "PRODUCT_CATEGORY" | |
3194 ], | |
3195 "enumDescriptions": [ | |
3196 "A placeholder for an undefined status.\nThis value will
never be returned in responses.", | |
3197 "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).", | |
3198 "Indicates that the detail ID refers to a vendor; see\n[
vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", | |
3199 "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).", | |
3200 "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)." | |
3201 ], | |
3202 "type": "string" | |
3203 }, | |
3204 "filteredBidDetailRows": { | |
3205 "description": "List of rows, with counts of bids with a giv
en creative status aggregated\nby detail.", | |
3206 "items": { | |
3207 "$ref": "FilteredBidDetailRow" | |
3208 }, | |
3209 "type": "array" | |
3210 }, | |
3211 "nextPageToken": { | |
3212 "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.", | |
3213 "type": "string" | |
3214 } | |
3215 }, | |
3216 "type": "object" | |
3217 }, | |
3218 "ListClientUsersResponse": { | |
3219 "id": "ListClientUsersResponse", | |
3220 "properties": { | |
3221 "nextPageToken": { | |
3222 "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.", | |
3223 "type": "string" | |
3224 }, | |
3225 "users": { | |
3226 "description": "The returned list of client users.", | |
3227 "items": { | |
3228 "$ref": "ClientUser" | |
3229 }, | |
3230 "type": "array" | |
3231 } | |
3232 }, | |
3233 "type": "object" | |
3234 }, | |
3235 "ListClientUserInvitationsResponse": { | |
3236 "id": "ListClientUserInvitationsResponse", | |
3237 "properties": { | |
3238 "nextPageToken": { | |
3239 "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.", | |
3240 "type": "string" | |
3241 }, | |
3242 "invitations": { | |
3243 "description": "The returned list of client users.", | |
3244 "items": { | |
3245 "$ref": "ClientUserInvitation" | |
3246 }, | |
3247 "type": "array" | |
3248 } | |
3249 }, | |
3250 "type": "object" | |
3251 }, | |
3252 "LocationContext": { | |
3253 "description": "@OutputOnly The Geo criteria the restriction applies
to.", | |
3254 "id": "LocationContext", | |
3255 "properties": { | |
3256 "geoCriteriaIds": { | |
3257 "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.", | |
3258 "items": { | |
3259 "format": "int32", | |
3260 "type": "integer" | |
3261 }, | |
3262 "type": "array" | |
3263 } | |
3264 }, | |
3265 "type": "object" | |
3266 }, | |
3267 "PlatformContext": { | |
3268 "description": "@OutputOnly The type of platform the restriction app
lies to.", | |
3269 "id": "PlatformContext", | |
3270 "properties": { | |
3271 "platforms": { | |
3272 "description": "The platforms this restriction applies to.", | |
3273 "enumDescriptions": [ | |
3274 "Desktop platform.", | |
3275 "Android platform.", | |
3276 "iOS platform." | |
3277 ], | |
3278 "items": { | |
3279 "enum": [ | |
3280 "DESKTOP", | |
3281 "ANDROID", | |
3282 "IOS" | |
3283 ], | |
3284 "type": "string" | |
3285 }, | |
3286 "type": "array" | |
3287 } | |
3288 }, | |
3289 "type": "object" | |
3290 }, | |
3291 "MetricValue": { | |
3292 "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)
.", | |
3293 "id": "MetricValue", | |
3294 "properties": { | |
3295 "variance": { | |
3296 "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", | |
3297 "format": "int64", | |
3298 "type": "string" | |
3299 }, | |
3300 "value": { | |
3301 "description": "The expected value of the metric.", | |
3302 "format": "int64", | |
3303 "type": "string" | |
3304 } | |
3305 }, | |
3306 "type": "object" | |
3307 } | 3313 } |
3308 }, | 3314 }, |
3309 "servicePath": "", | 3315 "servicePath": "", |
3310 "title": "Ad Exchange Buyer API II", | 3316 "title": "Ad Exchange Buyer API II", |
3311 "version": "v2beta1" | 3317 "version": "v2beta1" |
3312 } | 3318 } |
OLD | NEW |