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

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

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/adexchange.buyer": { 5 "https://www.googleapis.com/auth/adexchange.buyer": {
6 "description": "Manage your Ad Exchange buyer account config uration" 6 "description": "Manage your Ad Exchange buyer account config uration"
7 } 7 }
8 } 8 }
9 } 9 }
10 }, 10 },
11 "basePath": "", 11 "basePath": "",
12 "baseUrl": "https://adexchangebuyer.googleapis.com/", 12 "baseUrl": "https://adexchangebuyer.googleapis.com/",
13 "batchPath": "batch", 13 "batchPath": "batch",
14 "canonicalName": "AdExchangeBuyerII", 14 "canonicalName": "AdExchangeBuyerII",
15 "description": "Accesses the latest features for managing Ad Exchange accoun ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra mmatic deals.", 15 "description": "Accesses the latest features for managing Ad Exchange accoun ts, Real-Time Bidding configurations and auction metrics, and Marketplace progra mmatic deals.",
16 "discoveryVersion": "v1", 16 "discoveryVersion": "v1",
17 "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/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 "upload_protocol": {
29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
30 "location": "query",
31 "type": "string"
32 },
33 "prettyPrint": {
34 "default": "true",
35 "description": "Returns response with indentations and line breaks." ,
36 "location": "query",
37 "type": "boolean"
38 },
39 "uploadType": {
40 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
41 "location": "query",
42 "type": "string"
43 },
44 "fields": {
45 "description": "Selector specifying which fields to include in a par tial response.",
46 "location": "query",
47 "type": "string"
48 },
49 "callback": {
50 "description": "JSONP",
51 "location": "query",
52 "type": "string"
53 },
54 "$.xgafv": {
55 "description": "V1 error format.",
56 "enum": [
57 "1",
58 "2"
59 ],
60 "enumDescriptions": [
61 "v1 error format",
62 "v2 error format"
63 ],
64 "location": "query",
65 "type": "string"
66 },
28 "alt": { 67 "alt": {
29 "default": "json", 68 "default": "json",
30 "description": "Data format for response.", 69 "description": "Data format for response.",
31 "enum": [ 70 "enum": [
32 "json", 71 "json",
33 "media", 72 "media",
34 "proto" 73 "proto"
35 ], 74 ],
36 "enumDescriptions": [ 75 "enumDescriptions": [
37 "Responses with Content-Type of application/json", 76 "Responses with Content-Type of application/json",
38 "Media download with context-dependent Content-Type", 77 "Media download with context-dependent Content-Type",
39 "Responses with Content-Type of application/x-protobuf" 78 "Responses with Content-Type of application/x-protobuf"
40 ], 79 ],
41 "location": "query", 80 "location": "query",
42 "type": "string" 81 "type": "string"
43 }, 82 },
83 "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.",
85 "location": "query",
86 "type": "string"
87 },
44 "access_token": { 88 "access_token": {
45 "description": "OAuth access token.", 89 "description": "OAuth access token.",
46 "location": "query", 90 "location": "query",
47 "type": "string" 91 "type": "string"
48 }, 92 },
49 "key": {
50 "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.",
51 "location": "query",
52 "type": "string"
53 },
54 "quotaUser": { 93 "quotaUser": {
55 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.", 94 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
56 "location": "query", 95 "location": "query",
57 "type": "string" 96 "type": "string"
58 }, 97 },
59 "pp": { 98 "pp": {
60 "default": "true", 99 "default": "true",
61 "description": "Pretty-print response.", 100 "description": "Pretty-print response.",
62 "location": "query", 101 "location": "query",
63 "type": "boolean" 102 "type": "boolean"
64 }, 103 },
65 "oauth_token": {
66 "description": "OAuth 2.0 token for the current user.",
67 "location": "query",
68 "type": "string"
69 },
70 "bearer_token": { 104 "bearer_token": {
71 "description": "OAuth bearer token.", 105 "description": "OAuth bearer token.",
72 "location": "query", 106 "location": "query",
73 "type": "string" 107 "type": "string"
74 }, 108 },
75 "upload_protocol": { 109 "oauth_token": {
76 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 110 "description": "OAuth 2.0 token for the current user.",
77 "location": "query",
78 "type": "string"
79 },
80 "prettyPrint": {
81 "default": "true",
82 "description": "Returns response with indentations and line breaks." ,
83 "location": "query",
84 "type": "boolean"
85 },
86 "uploadType": {
87 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
88 "location": "query",
89 "type": "string"
90 },
91 "fields": {
92 "description": "Selector specifying which fields to include in a par tial response.",
93 "location": "query",
94 "type": "string"
95 },
96 "$.xgafv": {
97 "description": "V1 error format.",
98 "enum": [
99 "1",
100 "2"
101 ],
102 "enumDescriptions": [
103 "v1 error format",
104 "v2 error format"
105 ],
106 "location": "query",
107 "type": "string"
108 },
109 "callback": {
110 "description": "JSONP",
111 "location": "query", 111 "location": "query",
112 "type": "string" 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 "clients": { 119 "filterSets": {
120 "methods": { 120 "methods": {
121 "get": { 121 "get": {
122 "description": "Gets a client buyer with a given cli ent account ID.", 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.clients.get", 124 "id": "adexchangebuyer2.accounts.filterSets.get",
125 "parameterOrder": [ 125 "parameterOrder": [
126 "accountId", 126 "accountId",
127 "clientAccountId" 127 "filterSetId"
128 ], 128 ],
129 "parameters": { 129 "parameters": {
130 "accountId": { 130 "accountId": {
131 "description": "Numerical account ID of the client's sponsor buyer. (required)", 131 "description": "Account ID of the buyer.",
132 "format": "int64", 132 "format": "int64",
133 "location": "path", 133 "location": "path",
134 "required": true, 134 "required": true,
135 "type": "string" 135 "type": "string"
136 }, 136 },
137 "clientAccountId": { 137 "filterSetId": {
138 "description": "Numerical account ID of the client buyer to retrieve. (required)", 138 "description": "The ID of the filter set to get.",
139 "format": "int64", 139 "format": "int64",
140 "location": "path", 140 "location": "path",
141 "required": true, 141 "required": true,
142 "type": "string" 142 "type": "string"
143 } 143 }
144 }, 144 },
145 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}", 145 "path": "v2beta1/accounts/{accountId}/filterSets/{fi lterSetId}",
146 "response": { 146 "response": {
147 "$ref": "Client" 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 the clients for the curren t sponsor buyer.", 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.clients.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\nListClient sResponse.nextPageToken\nreturned from the previous call to the\naccounts.client s.list method.", 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.",
163 "location": "query", 163 "location": "query",
164 "type": "string" 164 "type": "string"
165 }, 165 },
166 "accountId": { 166 "accountId": {
167 "description": "Unique numerical account ID of the sponsor buyer to list the clients for.", 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 clients than requested.\nIf unspecified, the server will pi ck an appropriate default.", 174 "description": "Requested page size. The ser ver may return fewer than requested.\nIf unspecified, the server will pick an ap propriate 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}/clients", 180 "path": "v2beta1/accounts/{accountId}/filterSets",
181 "response": { 181 "response": {
182 "$ref": "ListClientsResponse" 182 "$ref": "ListFilterSetsResponse"
183 }, 183 },
184 "scopes": [ 184 "scopes": [
185 "https://www.googleapis.com/auth/adexchange.buye r" 185 "https://www.googleapis.com/auth/adexchange.buye r"
186 ] 186 ]
187 }, 187 },
188 "update": { 188 "create": {
189 "description": "Updates an existing client buyer.", 189 "description": "Creates the specified filter set for the account with the given account ID.",
190 "httpMethod": "PUT", 190 "httpMethod": "POST",
191 "id": "adexchangebuyer2.accounts.clients.update", 191 "id": "adexchangebuyer2.accounts.filterSets.create",
192 "parameterOrder": [ 192 "parameterOrder": [
193 "accountId", 193 "accountId"
194 "clientAccountId"
195 ], 194 ],
196 "parameters": { 195 "parameters": {
197 "accountId": { 196 "accountId": {
198 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd ate a client for. (required)", 197 "description": "Account ID of the buyer.",
199 "format": "int64", 198 "format": "int64",
200 "location": "path", 199 "location": "path",
201 "required": true, 200 "required": true,
202 "type": "string" 201 "type": "string"
203 }, 202 },
204 "clientAccountId": { 203 "isTransient": {
205 "description": "Unique numerical account ID of the client to update. (required)", 204 "description": "Whether the filter set is tr ansient, or should be persisted indefinitely.\nBy default, filter sets are not t ransient.\nIf transient, it will be available for at least 1 hour after creation .",
205 "location": "query",
206 "type": "boolean"
207 }
208 },
209 "path": "v2beta1/accounts/{accountId}/filterSets",
210 "request": {
211 "$ref": "FilterSet"
212 },
213 "response": {
214 "$ref": "FilterSet"
215 },
216 "scopes": [
217 "https://www.googleapis.com/auth/adexchange.buye r"
218 ]
219 },
220 "delete": {
221 "description": "Deletes the requested filter set fro m the account with the given account\nID.",
222 "httpMethod": "DELETE",
223 "id": "adexchangebuyer2.accounts.filterSets.delete",
224 "parameterOrder": [
225 "accountId",
226 "filterSetId"
227 ],
228 "parameters": {
229 "accountId": {
230 "description": "Account ID of the buyer.",
231 "format": "int64",
232 "location": "path",
233 "required": true,
234 "type": "string"
235 },
236 "filterSetId": {
237 "description": "The ID of the filter set to delete.",
206 "format": "int64", 238 "format": "int64",
207 "location": "path", 239 "location": "path",
208 "required": true, 240 "required": true,
209 "type": "string" 241 "type": "string"
210 } 242 }
211 }, 243 },
212 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}", 244 "path": "v2beta1/accounts/{accountId}/filterSets/{fi lterSetId}",
213 "request": {
214 "$ref": "Client"
215 },
216 "response": { 245 "response": {
217 "$ref": "Client" 246 "$ref": "Empty"
218 }, 247 },
219 "scopes": [ 248 "scopes": [
220 "https://www.googleapis.com/auth/adexchange.buye r" 249 "https://www.googleapis.com/auth/adexchange.buye r"
221 ]
222 },
223 "create": {
224 "description": "Creates a new client buyer.",
225 "httpMethod": "POST",
226 "id": "adexchangebuyer2.accounts.clients.create",
227 "parameterOrder": [
228 "accountId"
229 ],
230 "parameters": {
231 "accountId": {
232 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre ate a client for. (required)",
233 "format": "int64",
234 "location": "path",
235 "required": true,
236 "type": "string"
237 }
238 },
239 "path": "v2beta1/accounts/{accountId}/clients",
240 "request": {
241 "$ref": "Client"
242 },
243 "response": {
244 "$ref": "Client"
245 },
246 "scopes": [
247 "https://www.googleapis.com/auth/adexchange.buye r"
248 ] 250 ]
249 } 251 }
250 }, 252 },
251 "resources": { 253 "resources": {
252 "invitations": { 254 "filteredBids": {
253 "methods": { 255 "methods": {
254 "create": { 256 "list": {
255 "description": "Creates and sends out an ema il invitation to access\nan Ad Exchange client buyer account.", 257 "description": "List all reasons for which b ids were filtered, with the number of bids\nfiltered for each reason.",
256 "httpMethod": "POST", 258 "httpMethod": "GET",
257 "id": "adexchangebuyer2.accounts.clients.inv itations.create", 259 "id": "adexchangebuyer2.accounts.filterSets. filteredBids.list",
258 "parameterOrder": [ 260 "parameterOrder": [
259 "accountId", 261 "accountId",
260 "clientAccountId" 262 "filterSetId"
261 ], 263 ],
262 "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 },
263 "accountId": { 270 "accountId": {
264 "description": "Numerical account ID of the client's sponsor buyer. (required)", 271 "description": "Account ID of the bu yer.",
265 "format": "int64", 272 "format": "int64",
266 "location": "path", 273 "location": "path",
267 "required": true, 274 "required": true,
268 "type": "string" 275 "type": "string"
269 }, 276 },
270 "clientAccountId": { 277 "pageSize": {
271 "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)", 278 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
272 "format": "int64", 279 "format": "int32",
273 "location": "path", 280 "location": "query",
274 "required": true, 281 "type": "integer"
275 "type": "string" 282 },
276 } 283 "filterSetId": {
277 }, 284 "description": "The ID of the filter set to apply.",
278 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations", 285 "format": "int64",
279 "request": { 286 "location": "path",
280 "$ref": "ClientUserInvitation" 287 "required": true,
281 }, 288 "type": "string"
289 }
290 },
291 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/filteredBids",
282 "response": { 292 "response": {
283 "$ref": "ClientUserInvitation" 293 "$ref": "ListFilteredBidsResponse"
284 }, 294 },
285 "scopes": [ 295 "scopes": [
286 "https://www.googleapis.com/auth/adexcha nge.buyer" 296 "https://www.googleapis.com/auth/adexcha nge.buyer"
287 ] 297 ]
298 }
299 },
300 "resources": {
301 "creatives": {
302 "methods": {
303 "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.",
305 "httpMethod": "GET",
306 "id": "adexchangebuyer2.accounts.fil terSets.filteredBids.creatives.list",
307 "parameterOrder": [
308 "accountId",
309 "filterSetId",
310 "creativeStatusId"
311 ],
312 "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": {
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).",
322 "format": "int32",
323 "location": "path",
324 "required": true,
325 "type": "integer"
326 },
327 "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.",
329 "location": "query",
330 "type": "string"
331 },
332 "accountId": {
333 "description": "Account ID o f the buyer.",
334 "format": "int64",
335 "location": "path",
336 "required": true,
337 "type": "string"
338 },
339 "pageSize": {
340 "description": "Requested pa ge size. The server may return fewer than requested.\nIf unspecified, the server will pick an appropriate default.",
341 "format": "int32",
342 "location": "query",
343 "type": "integer"
344 }
345 },
346 "path": "v2beta1/accounts/{accountId }/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives",
347 "response": {
348 "$ref": "ListCreativeStatusBreak downByCreativeResponse"
349 },
350 "scopes": [
351 "https://www.googleapis.com/auth /adexchange.buyer"
352 ]
353 }
354 },
355 "resources": {
356 "details": {
357 "methods": {
358 "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.",
360 "httpMethod": "GET",
361 "id": "adexchangebuyer2.acco unts.filterSets.filteredBids.creatives.details.list",
362 "parameterOrder": [
363 "accountId",
364 "filterSetId",
365 "creativeStatusId",
366 "creativeId"
367 ],
368 "parameters": {
369 "pageSize": {
370 "description": "Requ ested page size. The server may return fewer than requested.\nIf unspecified, th e server will pick an appropriate default.",
371 "format": "int32",
372 "location": "query",
373 "type": "integer"
374 },
375 "creativeId": {
376 "description": "The creative ID for which to retrieve a breakdown by detail.",
377 "location": "path",
378 "required": true,
379 "type": "string"
380 },
381 "creativeStatusId": {
382 "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[cr eative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/cre ative-status-codes).",
383 "format": "int32",
384 "location": "path",
385 "required": true,
386 "type": "integer"
387 },
388 "accountId": {
389 "description": "Acco unt ID of the buyer.",
390 "format": "int64",
391 "location": "path",
392 "required": true,
393 "type": "string"
394 },
395 "filterSetId": {
396 "description": "The ID of the filter set to apply.",
397 "format": "int64",
398 "location": "path",
399 "required": true,
400 "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 }
407 },
408 "path": "v2beta1/accounts/{a ccountId}/filterSets/{filterSetId}/filteredBids/{creativeStatusId}/creatives/{cr eativeId}/details",
409 "response": {
410 "$ref": "ListCreativeSta tusAndCreativeBreakdownByDetailResponse"
411 },
412 "scopes": [
413 "https://www.googleapis. com/auth/adexchange.buyer"
414 ]
415 }
416 }
417 }
418 }
288 }, 419 },
289 "get": { 420 "details": {
290 "description": "Retrieves an existing client user invitation.", 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 }
475 }
476 },
477 "filteredImpressions": {
478 "methods": {
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.",
291 "httpMethod": "GET", 481 "httpMethod": "GET",
292 "id": "adexchangebuyer2.accounts.clients.inv itations.get", 482 "id": "adexchangebuyer2.accounts.filterSets. filteredImpressions.list",
293 "parameterOrder": [ 483 "parameterOrder": [
294 "accountId", 484 "accountId",
295 "clientAccountId", 485 "filterSetId"
296 "invitationId"
297 ], 486 ],
298 "parameters": { 487 "parameters": {
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.",
490 "location": "query",
491 "type": "string"
492 },
299 "accountId": { 493 "accountId": {
300 "description": "Numerical account ID of the client's sponsor buyer. (required)", 494 "description": "Account ID of the bu yer.",
301 "format": "int64", 495 "format": "int64",
302 "location": "path", 496 "location": "path",
303 "required": true, 497 "required": true,
304 "type": "string" 498 "type": "string"
305 }, 499 },
306 "clientAccountId": { 500 "pageSize": {
307 "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated wit h. (required)", 501 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
308 "format": "int64", 502 "format": "int32",
309 "location": "path", 503 "location": "query",
310 "required": true, 504 "type": "integer"
311 "type": "string" 505 },
312 }, 506 "filterSetId": {
313 "invitationId": { 507 "description": "The ID of the filter set to apply.",
314 "description": "Numerical identifier of the user invitation to retrieve. (required)", 508 "format": "int64",
315 "format": "int64", 509 "location": "path",
316 "location": "path", 510 "required": true,
317 "required": true, 511 "type": "string"
318 "type": "string" 512 }
319 } 513 },
320 }, 514 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/filteredImpressions",
321 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations/{invitationId}",
322 "response": { 515 "response": {
323 "$ref": "ClientUserInvitation" 516 "$ref": "ListFilteredImpressionsResponse "
324 }, 517 },
325 "scopes": [ 518 "scopes": [
326 "https://www.googleapis.com/auth/adexcha nge.buyer" 519 "https://www.googleapis.com/auth/adexcha nge.buyer"
327 ] 520 ]
328 }, 521 }
522 }
523 },
524 "losingBids": {
525 "methods": {
329 "list": { 526 "list": {
330 "description": "Lists all the client users i nvitations for a client\nwith a given account ID.", 527 "description": "List all reasons for which b ids lost in the auction, with the number of\nbids that lost for each reason.",
331 "httpMethod": "GET", 528 "httpMethod": "GET",
332 "id": "adexchangebuyer2.accounts.clients.inv itations.list", 529 "id": "adexchangebuyer2.accounts.filterSets. losingBids.list",
333 "parameterOrder": [ 530 "parameterOrder": [
334 "accountId", 531 "accountId",
335 "clientAccountId" 532 "filterSetId"
336 ], 533 ],
337 "parameters": { 534 "parameters": {
338 "pageToken": { 535 "pageToken": {
339 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stClientUserInvitationsResponse.nextPageToken\nreturned from the previous call t o the\nclients.invitations.list\nmethod.", 536 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stLosingBidsResponse.nextPageToken\nreturned from the previous call to the\nacco unts.filterSets.losingBids.list\nmethod.",
340 "location": "query", 537 "location": "query",
341 "type": "string" 538 "type": "string"
342 }, 539 },
343 "accountId": { 540 "accountId": {
344 "description": "Numerical account ID of the client's sponsor buyer. (required)", 541 "description": "Account ID of the bu yer.",
345 "format": "int64", 542 "format": "int64",
346 "location": "path", 543 "location": "path",
347 "required": true, 544 "required": true,
348 "type": "string" 545 "type": "string"
349 }, 546 },
350 "pageSize": { 547 "pageSize": {
351 "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pi ck an appropriate default.", 548 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
352 "format": "int32", 549 "format": "int32",
353 "location": "query", 550 "location": "query",
354 "type": "integer" 551 "type": "integer"
355 }, 552 },
356 "clientAccountId": { 553 "filterSetId": {
357 "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either speci fy a string representation of a\nnumerical account identifier or the `-` charact er\nto list all the invitations for all the clients\nof a given sponsor buyer.", 554 "description": "The ID of the filter set to apply.",
358 "location": "path", 555 "format": "int64",
359 "required": true, 556 "location": "path",
360 "type": "string" 557 "required": true,
361 } 558 "type": "string"
362 }, 559 }
363 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations", 560 },
561 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/losingBids",
364 "response": { 562 "response": {
365 "$ref": "ListClientUserInvitationsRespon se" 563 "$ref": "ListLosingBidsResponse"
366 }, 564 },
367 "scopes": [ 565 "scopes": [
368 "https://www.googleapis.com/auth/adexcha nge.buyer" 566 "https://www.googleapis.com/auth/adexcha nge.buyer"
369 ] 567 ]
370 } 568 }
371 } 569 }
372 }, 570 },
373 "users": { 571 "bidMetrics": {
374 "methods": { 572 "methods": {
375 "list": { 573 "list": {
376 "description": "Lists all the known client u sers for a specified\nsponsor buyer account ID.", 574 "description": "Lists all metrics that are m easured in terms of number of bids.",
377 "httpMethod": "GET", 575 "httpMethod": "GET",
378 "id": "adexchangebuyer2.accounts.clients.use rs.list", 576 "id": "adexchangebuyer2.accounts.filterSets. bidMetrics.list",
379 "parameterOrder": [ 577 "parameterOrder": [
380 "accountId", 578 "accountId",
381 "clientAccountId" 579 "filterSetId"
382 ], 580 ],
383 "parameters": { 581 "parameters": {
384 "accountId": { 582 "filterSetId": {
385 "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)", 583 "description": "The ID of the filter set to apply.",
386 "format": "int64", 584 "format": "int64",
387 "location": "path", 585 "location": "path",
388 "required": true, 586 "required": true,
389 "type": "string" 587 "type": "string"
390 }, 588 },
391 "pageSize": { 589 "pageToken": {
392 "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", 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.",
393 "format": "int32", 591 "location": "query",
394 "location": "query", 592 "type": "string"
395 "type": "integer" 593 },
396 }, 594 "accountId": {
397 "clientAccountId": { 595 "description": "Account ID of the bu yer.",
398 "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.", 596 "format": "int64",
399 "location": "path", 597 "location": "path",
400 "required": true, 598 "required": true,
401 "type": "string" 599 "type": "string"
402 }, 600 },
403 "pageToken": { 601 "pageSize": {
404 "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.", 602 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
405 "location": "query", 603 "format": "int32",
406 "type": "string" 604 "location": "query",
407 } 605 "type": "integer"
408 }, 606 }
409 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users", 607 },
410 "response": { 608 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidMetrics",
411 "$ref": "ListClientUsersResponse" 609 "response": {
412 }, 610 "$ref": "ListBidMetricsResponse"
413 "scopes": [ 611 },
414 "https://www.googleapis.com/auth/adexcha nge.buyer" 612 "scopes": [
415 ] 613 "https://www.googleapis.com/auth/adexcha nge.buyer"
416 }, 614 ]
417 "get": { 615 }
418 "description": "Retrieves an existing client user.", 616 }
419 "httpMethod": "GET", 617 },
420 "id": "adexchangebuyer2.accounts.clients.use rs.get", 618 "impressionMetrics": {
421 "parameterOrder": [ 619 "methods": {
422 "accountId", 620 "list": {
423 "clientAccountId", 621 "description": "Lists all metrics that are m easured in terms of number of impressions.",
424 "userId" 622 "httpMethod": "GET",
425 ], 623 "id": "adexchangebuyer2.accounts.filterSets. impressionMetrics.list",
426 "parameters": { 624 "parameterOrder": [
427 "userId": { 625 "accountId",
428 "description": "Numerical identifier of the user to retrieve. (required)", 626 "filterSetId"
429 "format": "int64", 627 ],
430 "location": "path", 628 "parameters": {
431 "required": true, 629 "pageToken": {
432 "type": "string" 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.",
433 }, 631 "location": "query",
434 "accountId": { 632 "type": "string"
435 "description": "Numerical account ID of the client's sponsor buyer. (required)", 633 },
436 "format": "int64", 634 "accountId": {
437 "location": "path", 635 "description": "Account ID of the bu yer.",
438 "required": true, 636 "format": "int64",
439 "type": "string" 637 "location": "path",
440 }, 638 "required": true,
441 "clientAccountId": { 639 "type": "string"
442 "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (require d)", 640 },
443 "format": "int64", 641 "pageSize": {
444 "location": "path", 642 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
445 "required": true, 643 "format": "int32",
446 "type": "string" 644 "location": "query",
447 } 645 "type": "integer"
448 }, 646 },
449 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users/{userId}", 647 "filterSetId": {
450 "response": { 648 "description": "The ID of the filter set to apply.",
451 "$ref": "ClientUser" 649 "format": "int64",
452 }, 650 "location": "path",
453 "scopes": [ 651 "required": true,
454 "https://www.googleapis.com/auth/adexcha nge.buyer" 652 "type": "string"
455 ] 653 }
456 }, 654 },
457 "update": { 655 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/impressionMetrics",
458 "description": "Updates an existing client u ser.\nOnly the user status can be changed on update.", 656 "response": {
459 "httpMethod": "PUT", 657 "$ref": "ListImpressionMetricsResponse"
460 "id": "adexchangebuyer2.accounts.clients.use rs.update", 658 },
461 "parameterOrder": [ 659 "scopes": [
462 "accountId", 660 "https://www.googleapis.com/auth/adexcha nge.buyer"
463 "clientAccountId", 661 ]
464 "userId" 662 }
465 ], 663 }
466 "parameters": { 664 },
467 "userId": { 665 "bidResponseErrors": {
468 "description": "Numerical identifier of the user to retrieve. (required)", 666 "methods": {
469 "format": "int64", 667 "list": {
470 "location": "path", 668 "description": "List all errors that occurre d in bid responses, with the number of bid\nresponses affected for each reason." ,
471 "required": true, 669 "httpMethod": "GET",
472 "type": "string" 670 "id": "adexchangebuyer2.accounts.filterSets. bidResponseErrors.list",
473 }, 671 "parameterOrder": [
474 "accountId": { 672 "accountId",
475 "description": "Numerical account ID of the client's sponsor buyer. (required)", 673 "filterSetId"
476 "format": "int64", 674 ],
477 "location": "path", 675 "parameters": {
478 "required": true, 676 "pageToken": {
479 "type": "string" 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.",
480 }, 678 "location": "query",
481 "clientAccountId": { 679 "type": "string"
482 "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (require d)", 680 },
483 "format": "int64", 681 "accountId": {
484 "location": "path", 682 "description": "Account ID of the bu yer.",
485 "required": true, 683 "format": "int64",
486 "type": "string" 684 "location": "path",
487 } 685 "required": true,
488 }, 686 "type": "string"
489 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users/{userId}", 687 },
490 "request": { 688 "pageSize": {
491 "$ref": "ClientUser" 689 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
492 }, 690 "format": "int32",
493 "response": { 691 "location": "query",
494 "$ref": "ClientUser" 692 "type": "integer"
495 }, 693 },
496 "scopes": [ 694 "filterSetId": {
497 "https://www.googleapis.com/auth/adexcha nge.buyer" 695 "description": "The ID of the filter set to apply.",
696 "format": "int64",
697 "location": "path",
698 "required": true,
699 "type": "string"
700 }
701 },
702 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidResponseErrors",
703 "response": {
704 "$ref": "ListBidResponseErrorsResponse"
705 },
706 "scopes": [
707 "https://www.googleapis.com/auth/adexcha nge.buyer"
708 ]
709 }
710 }
711 },
712 "bidResponsesWithoutBids": {
713 "methods": {
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.",
716 "httpMethod": "GET",
717 "id": "adexchangebuyer2.accounts.filterSets. bidResponsesWithoutBids.list",
718 "parameterOrder": [
719 "accountId",
720 "filterSetId"
721 ],
722 "parameters": {
723 "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.",
725 "location": "query",
726 "type": "string"
727 },
728 "accountId": {
729 "description": "Account ID of the bu yer.",
730 "format": "int64",
731 "location": "path",
732 "required": true,
733 "type": "string"
734 },
735 "pageSize": {
736 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
737 "format": "int32",
738 "location": "query",
739 "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 }
748 },
749 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/bidResponsesWithoutBids",
750 "response": {
751 "$ref": "ListBidResponsesWithoutBidsResp onse"
752 },
753 "scopes": [
754 "https://www.googleapis.com/auth/adexcha nge.buyer"
755 ]
756 }
757 }
758 },
759 "filteredBidRequests": {
760 "methods": {
761 "list": {
762 "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid request s not sent for each reason.",
763 "httpMethod": "GET",
764 "id": "adexchangebuyer2.accounts.filterSets. filteredBidRequests.list",
765 "parameterOrder": [
766 "accountId",
767 "filterSetId"
768 ],
769 "parameters": {
770 "pageToken": {
771 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.filteredBidRequests.list\nmethod.",
772 "location": "query",
773 "type": "string"
774 },
775 "accountId": {
776 "description": "Account ID of the bu yer.",
777 "format": "int64",
778 "location": "path",
779 "required": true,
780 "type": "string"
781 },
782 "pageSize": {
783 "description": "Requested page size. The server may return fewer than requested.\nIf unspecified, the server will pi ck an appropriate default.",
784 "format": "int32",
785 "location": "query",
786 "type": "integer"
787 },
788 "filterSetId": {
789 "description": "The ID of the filter set to apply.",
790 "format": "int64",
791 "location": "path",
792 "required": true,
793 "type": "string"
794 }
795 },
796 "path": "v2beta1/accounts/{accountId}/filter Sets/{filterSetId}/filteredBidRequests",
797 "response": {
798 "$ref": "ListFilteredBidRequestsResponse "
799 },
800 "scopes": [
801 "https://www.googleapis.com/auth/adexcha nge.buyer"
498 ] 802 ]
499 } 803 }
500 } 804 }
501 } 805 }
502 } 806 }
503 }, 807 },
504 "creatives": { 808 "clients": {
505 "methods": { 809 "methods": {
506 "watch": { 810 "get": {
507 "description": "Watches a creative. Will result in p ush notifications being sent to the\ntopic when the creative changes status.", 811 "description": "Gets a client buyer with a given cli ent account ID.",
508 "httpMethod": "POST", 812 "httpMethod": "GET",
509 "id": "adexchangebuyer2.accounts.creatives.watch", 813 "id": "adexchangebuyer2.accounts.clients.get",
510 "parameterOrder": [ 814 "parameterOrder": [
511 "accountId", 815 "accountId",
512 "creativeId" 816 "clientAccountId"
513 ], 817 ],
514 "parameters": { 818 "parameters": {
515 "accountId": { 819 "accountId": {
516 "description": "The account of the creative to watch.", 820 "description": "Numerical account ID of the client's sponsor buyer. (required)",
821 "format": "int64",
517 "location": "path", 822 "location": "path",
518 "required": true, 823 "required": true,
519 "type": "string" 824 "type": "string"
520 }, 825 },
521 "creativeId": { 826 "clientAccountId": {
522 "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\ nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.", 827 "description": "Numerical account ID of the client buyer to retrieve. (required)",
828 "format": "int64",
523 "location": "path", 829 "location": "path",
524 "required": true, 830 "required": true,
525 "type": "string" 831 "type": "string"
526 } 832 }
527 }, 833 },
528 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:watch", 834 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}",
529 "request": {
530 "$ref": "WatchCreativeRequest"
531 },
532 "response": { 835 "response": {
533 "$ref": "Empty" 836 "$ref": "Client"
534 }, 837 },
535 "scopes": [ 838 "scopes": [
536 "https://www.googleapis.com/auth/adexchange.buye r" 839 "https://www.googleapis.com/auth/adexchange.buye r"
537 ] 840 ]
538 }, 841 },
539 "get": { 842 "list": {
540 "description": "Gets a creative.", 843 "description": "Lists all the clients for the curren t sponsor buyer.",
541 "httpMethod": "GET", 844 "httpMethod": "GET",
542 "id": "adexchangebuyer2.accounts.creatives.get", 845 "id": "adexchangebuyer2.accounts.clients.list",
543 "parameterOrder": [ 846 "parameterOrder": [
544 "accountId", 847 "accountId"
545 "creativeId"
546 ], 848 ],
547 "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 },
548 "accountId": { 855 "accountId": {
549 "description": "The account the creative bel ongs to.", 856 "description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
857 "format": "int64",
550 "location": "path", 858 "location": "path",
551 "required": true, 859 "required": true,
552 "type": "string" 860 "type": "string"
553 }, 861 },
554 "creativeId": { 862 "pageSize": {
555 "description": "The ID of the creative to re trieve.", 863 "description": "Requested page size. The ser ver may return fewer clients than requested.\nIf unspecified, the server will pi ck an appropriate default.",
556 "location": "path", 864 "format": "int32",
557 "required": true, 865 "location": "query",
558 "type": "string" 866 "type": "integer"
559 } 867 }
560 }, 868 },
561 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}", 869 "path": "v2beta1/accounts/{accountId}/clients",
562 "response": { 870 "response": {
563 "$ref": "Creative" 871 "$ref": "ListClientsResponse"
564 }, 872 },
565 "scopes": [ 873 "scopes": [
566 "https://www.googleapis.com/auth/adexchange.buye r" 874 "https://www.googleapis.com/auth/adexchange.buye r"
567 ] 875 ]
568 }, 876 },
569 "update": { 877 "update": {
570 "description": "Updates a creative.", 878 "description": "Updates an existing client buyer.",
571 "httpMethod": "PUT", 879 "httpMethod": "PUT",
572 "id": "adexchangebuyer2.accounts.creatives.update", 880 "id": "adexchangebuyer2.accounts.clients.update",
573 "parameterOrder": [ 881 "parameterOrder": [
574 "accountId", 882 "accountId",
575 "creativeId" 883 "clientAccountId"
576 ], 884 ],
577 "parameters": { 885 "parameters": {
578 "accountId": { 886 "accountId": {
579 "description": "The account that this creati ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho d.", 887 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to upd ate a client for. (required)",
888 "format": "int64",
580 "location": "path", 889 "location": "path",
581 "required": true, 890 "required": true,
582 "type": "string" 891 "type": "string"
583 }, 892 },
584 "creativeId": { 893 "clientAccountId": {
585 "description": "The buyer-defined creative I D of this creative.\nCan be used to filter the response of the\ncreatives.list\n method.", 894 "description": "Unique numerical account ID of the client to update. (required)",
895 "format": "int64",
586 "location": "path", 896 "location": "path",
587 "required": true, 897 "required": true,
588 "type": "string" 898 "type": "string"
589 } 899 }
590 }, 900 },
591 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}", 901 "path": "v2beta1/accounts/{accountId}/clients/{clien tAccountId}",
592 "request": { 902 "request": {
593 "$ref": "Creative" 903 "$ref": "Client"
594 }, 904 },
595 "response": { 905 "response": {
596 "$ref": "Creative" 906 "$ref": "Client"
597 },
598 "scopes": [
599 "https://www.googleapis.com/auth/adexchange.buye r"
600 ]
601 },
602 "list": {
603 "description": "Lists creatives.",
604 "httpMethod": "GET",
605 "id": "adexchangebuyer2.accounts.creatives.list",
606 "parameterOrder": [
607 "accountId"
608 ],
609 "parameters": {
610 "pageToken": {
611 "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.",
612 "location": "query",
613 "type": "string"
614 },
615 "accountId": {
616 "description": "The account to list the crea tives from.\nSpecify \"-\" to list all creatives the current user has access to. ",
617 "location": "path",
618 "required": true,
619 "type": "string"
620 },
621 "pageSize": {
622 "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.",
623 "format": "int32",
624 "location": "query",
625 "type": "integer"
626 },
627 "query": {
628 "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'",
629 "location": "query",
630 "type": "string"
631 }
632 },
633 "path": "v2beta1/accounts/{accountId}/creatives",
634 "response": {
635 "$ref": "ListCreativesResponse"
636 }, 907 },
637 "scopes": [ 908 "scopes": [
638 "https://www.googleapis.com/auth/adexchange.buye r" 909 "https://www.googleapis.com/auth/adexchange.buye r"
639 ] 910 ]
640 }, 911 },
641 "create": { 912 "create": {
642 "description": "Creates a creative.", 913 "description": "Creates a new client buyer.",
643 "httpMethod": "POST", 914 "httpMethod": "POST",
644 "id": "adexchangebuyer2.accounts.creatives.create", 915 "id": "adexchangebuyer2.accounts.clients.create",
645 "parameterOrder": [ 916 "parameterOrder": [
646 "accountId" 917 "accountId"
647 ], 918 ],
648 "parameters": { 919 "parameters": {
649 "accountId": { 920 "accountId": {
650 "description": "The account that this creati ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho d.", 921 "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to cre ate a client for. (required)",
651 "location": "path", 922 "format": "int64",
652 "required": true,
653 "type": "string"
654 },
655 "duplicateIdMode": {
656 "description": "Indicates if multiple creati ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
657 "enum": [
658 "NO_DUPLICATES",
659 "FORCE_ENABLE_DUPLICATE_IDS"
660 ],
661 "location": "query",
662 "type": "string"
663 }
664 },
665 "path": "v2beta1/accounts/{accountId}/creatives",
666 "request": {
667 "$ref": "Creative"
668 },
669 "response": {
670 "$ref": "Creative"
671 },
672 "scopes": [
673 "https://www.googleapis.com/auth/adexchange.buye r"
674 ]
675 },
676 "stopWatching": {
677 "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status." ,
678 "httpMethod": "POST",
679 "id": "adexchangebuyer2.accounts.creatives.stopWatch ing",
680 "parameterOrder": [
681 "accountId",
682 "creativeId"
683 ],
684 "parameters": {
685 "creativeId": {
686 "description": "The creative ID of the creat ive to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
687 "location": "path",
688 "required": true,
689 "type": "string"
690 },
691 "accountId": {
692 "description": "The account of the creative to stop notifications for.",
693 "location": "path", 923 "location": "path",
694 "required": true, 924 "required": true,
695 "type": "string" 925 "type": "string"
696 } 926 }
697 }, 927 },
698 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:stopWatching", 928 "path": "v2beta1/accounts/{accountId}/clients",
699 "request": { 929 "request": {
700 "$ref": "StopWatchingCreativeRequest" 930 "$ref": "Client"
701 }, 931 },
702 "response": { 932 "response": {
703 "$ref": "Empty" 933 "$ref": "Client"
704 }, 934 },
705 "scopes": [ 935 "scopes": [
706 "https://www.googleapis.com/auth/adexchange.buye r" 936 "https://www.googleapis.com/auth/adexchange.buye r"
707 ] 937 ]
708 } 938 }
709 }, 939 },
710 "resources": { 940 "resources": {
711 "dealAssociations": { 941 "invitations": {
942 "methods": {
943 "get": {
944 "description": "Retrieves an existing client user invitation.",
945 "httpMethod": "GET",
946 "id": "adexchangebuyer2.accounts.clients.inv itations.get",
947 "parameterOrder": [
948 "accountId",
949 "clientAccountId",
950 "invitationId"
951 ],
952 "parameters": {
953 "accountId": {
954 "description": "Numerical account ID of the client's sponsor buyer. (required)",
955 "format": "int64",
956 "location": "path",
957 "required": true,
958 "type": "string"
959 },
960 "clientAccountId": {
961 "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated wit h. (required)",
962 "format": "int64",
963 "location": "path",
964 "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"
973 }
974 },
975 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations/{invitationId}",
976 "response": {
977 "$ref": "ClientUserInvitation"
978 },
979 "scopes": [
980 "https://www.googleapis.com/auth/adexcha nge.buyer"
981 ]
982 },
983 "list": {
984 "description": "Lists all the client users i nvitations for a client\nwith a given account ID.",
985 "httpMethod": "GET",
986 "id": "adexchangebuyer2.accounts.clients.inv itations.list",
987 "parameterOrder": [
988 "accountId",
989 "clientAccountId"
990 ],
991 "parameters": {
992 "pageToken": {
993 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stClientUserInvitationsResponse.nextPageToken\nreturned from the previous call t o the\nclients.invitations.list\nmethod.",
994 "location": "query",
995 "type": "string"
996 },
997 "accountId": {
998 "description": "Numerical account ID of the client's sponsor buyer. (required)",
999 "format": "int64",
1000 "location": "path",
1001 "required": true,
1002 "type": "string"
1003 },
1004 "pageSize": {
1005 "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pi ck an appropriate default.",
1006 "format": "int32",
1007 "location": "query",
1008 "type": "integer"
1009 },
1010 "clientAccountId": {
1011 "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either speci fy a string representation of a\nnumerical account identifier or the `-` charact er\nto list all the invitations for all the clients\nof a given sponsor buyer.",
1012 "location": "path",
1013 "required": true,
1014 "type": "string"
1015 }
1016 },
1017 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations",
1018 "response": {
1019 "$ref": "ListClientUserInvitationsRespon se"
1020 },
1021 "scopes": [
1022 "https://www.googleapis.com/auth/adexcha nge.buyer"
1023 ]
1024 },
1025 "create": {
1026 "description": "Creates and sends out an ema il invitation to access\nan Ad Exchange client buyer account.",
1027 "httpMethod": "POST",
1028 "id": "adexchangebuyer2.accounts.clients.inv itations.create",
1029 "parameterOrder": [
1030 "accountId",
1031 "clientAccountId"
1032 ],
1033 "parameters": {
1034 "accountId": {
1035 "description": "Numerical account ID of the client's sponsor buyer. (required)",
1036 "format": "int64",
1037 "location": "path",
1038 "required": true,
1039 "type": "string"
1040 },
1041 "clientAccountId": {
1042 "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
1043 "format": "int64",
1044 "location": "path",
1045 "required": true,
1046 "type": "string"
1047 }
1048 },
1049 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/invitations",
1050 "request": {
1051 "$ref": "ClientUserInvitation"
1052 },
1053 "response": {
1054 "$ref": "ClientUserInvitation"
1055 },
1056 "scopes": [
1057 "https://www.googleapis.com/auth/adexcha nge.buyer"
1058 ]
1059 }
1060 }
1061 },
1062 "users": {
712 "methods": { 1063 "methods": {
713 "list": { 1064 "list": {
714 "description": "List all creative-deal assoc iations.", 1065 "description": "Lists all the known client u sers for a specified\nsponsor buyer account ID.",
715 "httpMethod": "GET", 1066 "httpMethod": "GET",
716 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.list", 1067 "id": "adexchangebuyer2.accounts.clients.use rs.list",
717 "parameterOrder": [ 1068 "parameterOrder": [
718 "accountId", 1069 "accountId",
719 "creativeId" 1070 "clientAccountId"
720 ], 1071 ],
721 "parameters": { 1072 "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 },
722 "pageToken": { 1079 "pageToken": {
723 "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nLi stDealAssociationsResponse.next_page_token\nreturned from the previous call to ' ListDealAssociations' method.", 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.",
724 "location": "query", 1081 "location": "query",
725 "type": "string" 1082 "type": "string"
726 }, 1083 },
727 "accountId": { 1084 "accountId": {
728 "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.", 1085 "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
1086 "format": "int64",
729 "location": "path", 1087 "location": "path",
730 "required": true, 1088 "required": true,
731 "type": "string" 1089 "type": "string"
732 }, 1090 },
733 "pageSize": { 1091 "pageSize": {
734 "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server wi ll pick an appropriate default.", 1092 "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
735 "format": "int32", 1093 "format": "int32",
736 "location": "query", 1094 "location": "query",
737 "type": "integer" 1095 "type": "integer"
738 }, 1096 }
739 "query": { 1097 },
740 "description": "An optional query st ring to filter deal associations. If no filter is\nspecified, all associations w ill be returned.\nSupported queries are:\n<ul>\n<li>accountId=<i>account_id_stri ng</i>\n<li>creativeId=<i>creative_id_string</i>\n<li>dealsId=<i>deals_id_string </i>\n<li>dealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n<li>openAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n</ul>\nExample: 'dealsId=12 345 AND dealsStatus:disapproved'", 1098 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users",
741 "location": "query", 1099 "response": {
742 "type": "string" 1100 "$ref": "ListClientUsersResponse"
743 }, 1101 },
744 "creativeId": { 1102 "scopes": [
745 "description": "The creative ID to l ist the associations from.\nSpecify \"-\" to list all creatives under the above account.", 1103 "https://www.googleapis.com/auth/adexcha nge.buyer"
746 "location": "path", 1104 ]
747 "required": true, 1105 },
748 "type": "string" 1106 "get": {
749 } 1107 "description": "Retrieves an existing client user.",
750 }, 1108 "httpMethod": "GET",
751 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations", 1109 "id": "adexchangebuyer2.accounts.clients.use rs.get",
752 "response": { 1110 "parameterOrder": [
753 "$ref": "ListDealAssociationsResponse" 1111 "accountId",
754 }, 1112 "clientAccountId",
755 "scopes": [ 1113 "userId"
756 "https://www.googleapis.com/auth/adexcha nge.buyer" 1114 ],
757 ] 1115 "parameters": {
758 }, 1116 "userId": {
759 "add": { 1117 "description": "Numerical identifier of the user to retrieve. (required)",
760 "description": "Associate an existing deal w ith a creative.", 1118 "format": "int64",
761 "httpMethod": "POST", 1119 "location": "path",
762 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.add", 1120 "required": true,
763 "parameterOrder": [ 1121 "type": "string"
764 "accountId", 1122 },
765 "creativeId" 1123 "accountId": {
766 ], 1124 "description": "Numerical account ID of the client's sponsor buyer. (required)",
767 "parameters": { 1125 "format": "int64",
768 "accountId": { 1126 "location": "path",
769 "description": "The account the crea tive belongs to.", 1127 "required": true,
770 "location": "path", 1128 "type": "string"
771 "required": true, 1129 },
772 "type": "string" 1130 "clientAccountId": {
773 }, 1131 "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (require d)",
774 "creativeId": { 1132 "format": "int64",
775 "description": "The ID of the creati ve associated with the deal.", 1133 "location": "path",
776 "location": "path", 1134 "required": true,
777 "required": true, 1135 "type": "string"
778 "type": "string" 1136 }
779 } 1137 },
780 }, 1138 "path": "v2beta1/accounts/{accountId}/client s/{clientAccountId}/users/{userId}",
781 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations:add", 1139 "response": {
1140 "$ref": "ClientUser"
1141 },
1142 "scopes": [
1143 "https://www.googleapis.com/auth/adexcha nge.buyer"
1144 ]
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}",
782 "request": { 1179 "request": {
783 "$ref": "AddDealAssociationRequest" 1180 "$ref": "ClientUser"
784 }, 1181 },
785 "response": { 1182 "response": {
786 "$ref": "Empty" 1183 "$ref": "ClientUser"
787 }, 1184 },
788 "scopes": [ 1185 "scopes": [
789 "https://www.googleapis.com/auth/adexcha nge.buyer" 1186 "https://www.googleapis.com/auth/adexcha nge.buyer"
790 ]
791 },
792 "remove": {
793 "description": "Remove the association betwe en a deal and a creative.",
794 "httpMethod": "POST",
795 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.remove",
796 "parameterOrder": [
797 "accountId",
798 "creativeId"
799 ],
800 "parameters": {
801 "accountId": {
802 "description": "The account the crea tive belongs to.",
803 "location": "path",
804 "required": true,
805 "type": "string"
806 },
807 "creativeId": {
808 "description": "The ID of the creati ve associated with the deal.",
809 "location": "path",
810 "required": true,
811 "type": "string"
812 }
813 },
814 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations:remove",
815 "request": {
816 "$ref": "RemoveDealAssociationRequest"
817 },
818 "response": {
819 "$ref": "Empty"
820 },
821 "scopes": [
822 "https://www.googleapis.com/auth/adexcha nge.buyer"
823 ] 1187 ]
824 } 1188 }
825 } 1189 }
826 } 1190 }
827 } 1191 }
1192 },
1193 "creatives": {
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": {
1235 "description": "Creates a creative.",
1236 "httpMethod": "POST",
1237 "id": "adexchangebuyer2.accounts.creatives.create",
1238 "parameterOrder": [
1239 "accountId"
1240 ],
1241 "parameters": {
1242 "duplicateIdMode": {
1243 "description": "Indicates if multiple creati ves can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
1244 "enum": [
1245 "NO_DUPLICATES",
1246 "FORCE_ENABLE_DUPLICATE_IDS"
1247 ],
1248 "location": "query",
1249 "type": "string"
1250 },
1251 "accountId": {
1252 "description": "The account that this creati ve belongs to.\nCan be used to filter the response of the\ncreatives.list\nmetho d.",
1253 "location": "path",
1254 "required": true,
1255 "type": "string"
1256 }
1257 },
1258 "path": "v2beta1/accounts/{accountId}/creatives",
1259 "request": {
1260 "$ref": "Creative"
1261 },
1262 "response": {
1263 "$ref": "Creative"
1264 },
1265 "scopes": [
1266 "https://www.googleapis.com/auth/adexchange.buye r"
1267 ]
1268 },
1269 "stopWatching": {
1270 "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status." ,
1271 "httpMethod": "POST",
1272 "id": "adexchangebuyer2.accounts.creatives.stopWatch ing",
1273 "parameterOrder": [
1274 "accountId",
1275 "creativeId"
1276 ],
1277 "parameters": {
1278 "creativeId": {
1279 "description": "The creative ID of the creat ive to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.",
1280 "location": "path",
1281 "required": true,
1282 "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 }
1290 },
1291 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:stopWatching",
1292 "request": {
1293 "$ref": "StopWatchingCreativeRequest"
1294 },
1295 "response": {
1296 "$ref": "Empty"
1297 },
1298 "scopes": [
1299 "https://www.googleapis.com/auth/adexchange.buye r"
1300 ]
1301 },
1302 "get": {
1303 "description": "Gets a creative.",
1304 "httpMethod": "GET",
1305 "id": "adexchangebuyer2.accounts.creatives.get",
1306 "parameterOrder": [
1307 "accountId",
1308 "creativeId"
1309 ],
1310 "parameters": {
1311 "accountId": {
1312 "description": "The account the creative bel ongs to.",
1313 "location": "path",
1314 "required": true,
1315 "type": "string"
1316 },
1317 "creativeId": {
1318 "description": "The ID of the creative to re trieve.",
1319 "location": "path",
1320 "required": true,
1321 "type": "string"
1322 }
1323 },
1324 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}",
1325 "response": {
1326 "$ref": "Creative"
1327 },
1328 "scopes": [
1329 "https://www.googleapis.com/auth/adexchange.buye r"
1330 ]
1331 },
1332 "watch": {
1333 "description": "Watches a creative. Will result in p ush notifications being sent to the\ntopic when the creative changes status.",
1334 "httpMethod": "POST",
1335 "id": "adexchangebuyer2.accounts.creatives.watch",
1336 "parameterOrder": [
1337 "accountId",
1338 "creativeId"
1339 ],
1340 "parameters": {
1341 "accountId": {
1342 "description": "The account of the creative to watch.",
1343 "location": "path",
1344 "required": true,
1345 "type": "string"
1346 },
1347 "creativeId": {
1348 "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\ nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.",
1349 "location": "path",
1350 "required": true,
1351 "type": "string"
1352 }
1353 },
1354 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}:watch",
1355 "request": {
1356 "$ref": "WatchCreativeRequest"
1357 },
1358 "response": {
1359 "$ref": "Empty"
1360 },
1361 "scopes": [
1362 "https://www.googleapis.com/auth/adexchange.buye r"
1363 ]
1364 },
1365 "update": {
1366 "description": "Updates a creative.",
1367 "httpMethod": "PUT",
1368 "id": "adexchangebuyer2.accounts.creatives.update",
1369 "parameterOrder": [
1370 "accountId",
1371 "creativeId"
1372 ],
1373 "parameters": {
1374 "accountId": {
1375 "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",
1377 "required": true,
1378 "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 }
1386 },
1387 "path": "v2beta1/accounts/{accountId}/creatives/{cre ativeId}",
1388 "request": {
1389 "$ref": "Creative"
1390 },
1391 "response": {
1392 "$ref": "Creative"
1393 },
1394 "scopes": [
1395 "https://www.googleapis.com/auth/adexchange.buye r"
1396 ]
1397 }
1398 },
1399 "resources": {
1400 "dealAssociations": {
1401 "methods": {
1402 "add": {
1403 "description": "Associate an existing deal w ith a creative.",
1404 "httpMethod": "POST",
1405 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.add",
1406 "parameterOrder": [
1407 "accountId",
1408 "creativeId"
1409 ],
1410 "parameters": {
1411 "accountId": {
1412 "description": "The account the crea tive belongs to.",
1413 "location": "path",
1414 "required": true,
1415 "type": "string"
1416 },
1417 "creativeId": {
1418 "description": "The ID of the creati ve associated with the deal.",
1419 "location": "path",
1420 "required": true,
1421 "type": "string"
1422 }
1423 },
1424 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations:add",
1425 "request": {
1426 "$ref": "AddDealAssociationRequest"
1427 },
1428 "response": {
1429 "$ref": "Empty"
1430 },
1431 "scopes": [
1432 "https://www.googleapis.com/auth/adexcha nge.buyer"
1433 ]
1434 },
1435 "remove": {
1436 "description": "Remove the association betwe en a deal and a creative.",
1437 "httpMethod": "POST",
1438 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.remove",
1439 "parameterOrder": [
1440 "accountId",
1441 "creativeId"
1442 ],
1443 "parameters": {
1444 "accountId": {
1445 "description": "The account the crea tive belongs to.",
1446 "location": "path",
1447 "required": true,
1448 "type": "string"
1449 },
1450 "creativeId": {
1451 "description": "The ID of the creati ve associated with the deal.",
1452 "location": "path",
1453 "required": true,
1454 "type": "string"
1455 }
1456 },
1457 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations:remove",
1458 "request": {
1459 "$ref": "RemoveDealAssociationRequest"
1460 },
1461 "response": {
1462 "$ref": "Empty"
1463 },
1464 "scopes": [
1465 "https://www.googleapis.com/auth/adexcha nge.buyer"
1466 ]
1467 },
1468 "list": {
1469 "description": "List all creative-deal assoc iations.",
1470 "httpMethod": "GET",
1471 "id": "adexchangebuyer2.accounts.creatives.d ealAssociations.list",
1472 "parameterOrder": [
1473 "accountId",
1474 "creativeId"
1475 ],
1476 "parameters": {
1477 "creativeId": {
1478 "description": "The creative ID to l ist the associations from.\nSpecify \"-\" to list all creatives under the above account.",
1479 "location": "path",
1480 "required": true,
1481 "type": "string"
1482 },
1483 "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.",
1485 "location": "query",
1486 "type": "string"
1487 },
1488 "accountId": {
1489 "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
1490 "location": "path",
1491 "required": true,
1492 "type": "string"
1493 },
1494 "pageSize": {
1495 "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server wi ll pick an appropriate default.",
1496 "format": "int32",
1497 "location": "query",
1498 "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 }
1505 },
1506 "path": "v2beta1/accounts/{accountId}/creati ves/{creativeId}/dealAssociations",
1507 "response": {
1508 "$ref": "ListDealAssociationsResponse"
1509 },
1510 "scopes": [
1511 "https://www.googleapis.com/auth/adexcha nge.buyer"
1512 ]
1513 }
1514 }
1515 }
1516 }
828 } 1517 }
829 } 1518 }
830 } 1519 }
831 }, 1520 },
832 "revision": "20170519", 1521 "revision": "20170608",
833 "rootUrl": "https://adexchangebuyer.googleapis.com/", 1522 "rootUrl": "https://adexchangebuyer.googleapis.com/",
834 "schemas": { 1523 "schemas": {
835 "Empty": {
836 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
837 "id": "Empty",
838 "properties": {},
839 "type": "object"
840 },
841 "WatchCreativeRequest": {
842 "description": "A request for watching changes to creative Status.",
843 "id": "WatchCreativeRequest",
844 "properties": {
845 "topic": {
846 "description": "The Pub/Sub topic to publish notifications t o.\nThis topic must already exist and must give permission to\nad-exchange-buysi de-reports@google.com to write to the topic.\nThis should be the full resource n ame in\n\"projects/{project_id}/topics/{topic_id}\" format.",
847 "type": "string"
848 }
849 },
850 "type": "object"
851 },
852 "AppContext": {
853 "description": "@OutputOnly The app type the restriction applies to for mobile device.",
854 "id": "AppContext",
855 "properties": {
856 "appTypes": {
857 "description": "The app types this restriction applies to.",
858 "enumDescriptions": [
859 "Native app context.",
860 "Mobile web app context."
861 ],
862 "items": {
863 "enum": [
864 "NATIVE",
865 "WEB"
866 ],
867 "type": "string"
868 },
869 "type": "array"
870 }
871 },
872 "type": "object"
873 },
874 "NativeContent": {
875 "description": "Native content for a creative.",
876 "id": "NativeContent",
877 "properties": {
878 "appIcon": {
879 "$ref": "Image",
880 "description": "The app icon, for app download ads."
881 },
882 "callToAction": {
883 "description": "A label for the button that the user is supp osed to click.",
884 "type": "string"
885 },
886 "body": {
887 "description": "A long description of the ad.",
888 "type": "string"
889 },
890 "starRating": {
891 "description": "The app rating in the app store. Must be in the range [0-5].",
892 "format": "double",
893 "type": "number"
894 },
895 "videoUrl": {
896 "description": "The URL to fetch a native video ad.",
897 "type": "string"
898 },
899 "logo": {
900 "$ref": "Image",
901 "description": "A smaller image, for the advertiser's logo."
902 },
903 "clickLinkUrl": {
904 "description": "The URL that the browser/SDK will load when the user clicks the ad.",
905 "type": "string"
906 },
907 "priceDisplayText": {
908 "description": "The price of the promoted app including curr ency info.",
909 "type": "string"
910 },
911 "clickTrackingUrl": {
912 "description": "The URL to use for click tracking.",
913 "type": "string"
914 },
915 "image": {
916 "$ref": "Image",
917 "description": "A large image."
918 },
919 "advertiserName": {
920 "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
921 "type": "string"
922 },
923 "storeUrl": {
924 "description": "The URL to the app store to purchase/downloa d the promoted app.",
925 "type": "string"
926 },
927 "headline": {
928 "description": "A short title for the ad.",
929 "type": "string"
930 }
931 },
932 "type": "object"
933 },
934 "ListClientsResponse": {
935 "id": "ListClientsResponse",
936 "properties": {
937 "nextPageToken": {
938 "description": "A token to retrieve the next page of results .\nPass this value in the\nListClientsRequest.pageToken\nfield in the subsequent call to the\naccounts.clients.list method\nto retrieve the next page of results .",
939 "type": "string"
940 },
941 "clients": {
942 "description": "The returned list of clients.",
943 "items": {
944 "$ref": "Client"
945 },
946 "type": "array"
947 }
948 },
949 "type": "object"
950 },
951 "SecurityContext": {
952 "description": "@OutputOnly A security context.",
953 "id": "SecurityContext",
954 "properties": {
955 "securities": {
956 "description": "The security types in this context.",
957 "enumDescriptions": [
958 "Matches impressions that require insecure compatibility .",
959 "Matches impressions that require SSL compatibility."
960 ],
961 "items": {
962 "enum": [
963 "INSECURE",
964 "SSL"
965 ],
966 "type": "string"
967 },
968 "type": "array"
969 }
970 },
971 "type": "object"
972 },
973 "HtmlContent": {
974 "description": "HTML content for a creative.",
975 "id": "HtmlContent",
976 "properties": {
977 "height": {
978 "description": "The height of the HTML snippet in pixels.",
979 "format": "int32",
980 "type": "integer"
981 },
982 "width": {
983 "description": "The width of the HTML snippet in pixels.",
984 "format": "int32",
985 "type": "integer"
986 },
987 "snippet": {
988 "description": "The HTML snippet that displays the ad when i nserted in the web page.",
989 "type": "string"
990 }
991 },
992 "type": "object"
993 },
994 "ListCreativesResponse": {
995 "description": "A response for listing creatives.",
996 "id": "ListCreativesResponse",
997 "properties": {
998 "nextPageToken": {
999 "description": "A token to retrieve the next page of results .\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequ ent call to `ListCreatives` method to retrieve the next\npage of results.",
1000 "type": "string"
1001 },
1002 "creatives": {
1003 "description": "The list of creatives.",
1004 "items": {
1005 "$ref": "Creative"
1006 },
1007 "type": "array"
1008 }
1009 },
1010 "type": "object"
1011 },
1012 "ServingContext": {
1013 "description": "The serving context for this restriction.",
1014 "id": "ServingContext",
1015 "properties": {
1016 "location": {
1017 "$ref": "LocationContext",
1018 "description": "Matches impressions coming from users *or* p ublishers in a specific\nlocation."
1019 },
1020 "auctionType": {
1021 "$ref": "AuctionContext",
1022 "description": "Matches impressions for a particular auction type."
1023 },
1024 "all": {
1025 "description": "Matches all contexts.",
1026 "enum": [
1027 "SIMPLE_CONTEXT"
1028 ],
1029 "enumDescriptions": [
1030 "A simple context."
1031 ],
1032 "type": "string"
1033 },
1034 "appType": {
1035 "$ref": "AppContext",
1036 "description": "Matches impressions for a particular app typ e."
1037 },
1038 "securityType": {
1039 "$ref": "SecurityContext",
1040 "description": "Matches impressions for a particular securit y type."
1041 },
1042 "platform": {
1043 "$ref": "PlatformContext",
1044 "description": "Matches impressions coming from a particular platform."
1045 }
1046 },
1047 "type": "object"
1048 },
1049 "Image": {
1050 "description": "An image resource. You may provide a larger image th an was requested,\nso long as the aspect ratio is preserved.",
1051 "id": "Image",
1052 "properties": {
1053 "height": {
1054 "description": "Image height in pixels.",
1055 "format": "int32",
1056 "type": "integer"
1057 },
1058 "width": {
1059 "description": "Image width in pixels.",
1060 "format": "int32",
1061 "type": "integer"
1062 },
1063 "url": {
1064 "description": "The URL of the image.",
1065 "type": "string"
1066 }
1067 },
1068 "type": "object"
1069 },
1070 "Reason": {
1071 "description": "A specific filtering status and how many times it oc curred.",
1072 "id": "Reason",
1073 "properties": {
1074 "status": {
1075 "description": "The filtering status code. Please refer to t he\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionar ies/creative-status-codes.txt)\nfile for different statuses.",
1076 "format": "int32",
1077 "type": "integer"
1078 },
1079 "count": {
1080 "description": "The number of times the creative was filtere d for the status. The\ncount is aggregated across all publishers on the exchange .",
1081 "format": "int64",
1082 "type": "string"
1083 }
1084 },
1085 "type": "object"
1086 },
1087 "VideoContent": {
1088 "description": "Video content for a creative.",
1089 "id": "VideoContent",
1090 "properties": {
1091 "videoUrl": {
1092 "description": "The URL to fetch a video ad.",
1093 "type": "string"
1094 }
1095 },
1096 "type": "object"
1097 },
1098 "ClientUserInvitation": {
1099 "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified. ",
1100 "id": "ClientUserInvitation",
1101 "properties": {
1102 "email": {
1103 "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each spons or\nbuyer.",
1104 "type": "string"
1105 },
1106 "clientAccountId": {
1107 "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.",
1108 "format": "int64",
1109 "type": "string"
1110 },
1111 "invitationId": {
1112 "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 .",
1113 "format": "int64",
1114 "type": "string"
1115 }
1116 },
1117 "type": "object"
1118 },
1119 "AuctionContext": {
1120 "description": "@OutputOnly The auction type the restriction applies to.",
1121 "id": "AuctionContext",
1122 "properties": {
1123 "auctionTypes": {
1124 "description": "The auction types this restriction applies t o.",
1125 "enumDescriptions": [
1126 "The restriction applies to open auction.",
1127 "The restriction applies to direct deals."
1128 ],
1129 "items": {
1130 "enum": [
1131 "OPEN_AUCTION",
1132 "DIRECT_DEALS"
1133 ],
1134 "type": "string"
1135 },
1136 "type": "array"
1137 }
1138 },
1139 "type": "object"
1140 },
1141 "ListClientUsersResponse": {
1142 "id": "ListClientUsersResponse",
1143 "properties": {
1144 "users": {
1145 "description": "The returned list of client users.",
1146 "items": {
1147 "$ref": "ClientUser"
1148 },
1149 "type": "array"
1150 },
1151 "nextPageToken": {
1152 "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.",
1153 "type": "string"
1154 }
1155 },
1156 "type": "object"
1157 },
1158 "ListClientUserInvitationsResponse": {
1159 "id": "ListClientUserInvitationsResponse",
1160 "properties": {
1161 "nextPageToken": {
1162 "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.",
1163 "type": "string"
1164 },
1165 "invitations": {
1166 "description": "The returned list of client users.",
1167 "items": {
1168 "$ref": "ClientUserInvitation"
1169 },
1170 "type": "array"
1171 }
1172 },
1173 "type": "object"
1174 },
1175 "LocationContext": {
1176 "description": "@OutputOnly The Geo criteria the restriction applies to.",
1177 "id": "LocationContext",
1178 "properties": {
1179 "geoCriteriaIds": {
1180 "description": "IDs representing the geo location for this c ontext.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx -rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
1181 "items": {
1182 "format": "int32",
1183 "type": "integer"
1184 },
1185 "type": "array"
1186 }
1187 },
1188 "type": "object"
1189 },
1190 "PlatformContext": {
1191 "description": "@OutputOnly The type of platform the restriction app lies to.",
1192 "id": "PlatformContext",
1193 "properties": {
1194 "platforms": {
1195 "description": "The platforms this restriction applies to.",
1196 "enumDescriptions": [
1197 "Desktop platform.",
1198 "Android platform.",
1199 "iOS platform."
1200 ],
1201 "items": {
1202 "enum": [
1203 "DESKTOP",
1204 "ANDROID",
1205 "IOS"
1206 ],
1207 "type": "string"
1208 },
1209 "type": "array"
1210 }
1211 },
1212 "type": "object"
1213 },
1214 "ClientUser": { 1524 "ClientUser": {
1215 "description": "A client user is created under a client buyer and ha s restricted access to\nthe Ad Exchange Marketplace and certain other sections\n of the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nema il invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fi elds are required unless otherwise specified.", 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.",
1216 "id": "ClientUser", 1526 "id": "ClientUser",
1217 "properties": { 1527 "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": {
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.",
1539 "format": "int64",
1540 "type": "string"
1541 },
1218 "status": { 1542 "status": {
1219 "description": "The status of the client user.", 1543 "description": "The status of the client user.",
1220 "enum": [ 1544 "enum": [
1221 "USER_STATUS_UNSPECIFIED", 1545 "USER_STATUS_UNSPECIFIED",
1222 "PENDING", 1546 "PENDING",
1223 "ACTIVE", 1547 "ACTIVE",
1224 "DISABLED" 1548 "DISABLED"
1225 ], 1549 ],
1226 "enumDescriptions": [ 1550 "enumDescriptions": [
1227 "A placeholder for an undefined user status.", 1551 "A placeholder for an undefined user status.",
1228 "A user who was already created but hasn't accepted the invitation yet.", 1552 "A user who was already created but hasn't accepted the invitation yet.",
1229 "A user that is currently active.", 1553 "A user that is currently active.",
1230 "A user that is currently disabled." 1554 "A user that is currently disabled."
1231 ], 1555 ],
1232 "type": "string" 1556 "type": "string"
1233 },
1234 "userId": {
1235 "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.",
1236 "format": "int64",
1237 "type": "string"
1238 },
1239 "email": {
1240 "description": "User's email address. The value of this fiel d\nis ignored in an update operation.",
1241 "type": "string"
1242 },
1243 "clientAccountId": {
1244 "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.",
1245 "format": "int64",
1246 "type": "string"
1247 } 1557 }
1248 }, 1558 },
1249 "type": "object" 1559 "type": "object"
1250 }, 1560 },
1251 "CreativeDealAssociation": { 1561 "CreativeDealAssociation": {
1252 "description": "The association between a creative and a deal.", 1562 "description": "The association between a creative and a deal.",
1253 "id": "CreativeDealAssociation", 1563 "id": "CreativeDealAssociation",
1254 "properties": { 1564 "properties": {
1565 "creativeId": {
1566 "description": "The ID of the creative associated with the d eal.",
1567 "type": "string"
1568 },
1569 "dealsId": {
1570 "description": "The externalDealId for the deal associated w ith the creative.",
1571 "type": "string"
1572 },
1255 "accountId": { 1573 "accountId": {
1256 "description": "The account the creative belongs to.", 1574 "description": "The account the creative belongs to.",
1257 "type": "string" 1575 "type": "string"
1258 }, 1576 }
1259 "creativeId": { 1577 },
1260 "description": "The ID of the creative associated with the d eal.", 1578 "type": "object"
1261 "type": "string" 1579 },
1262 }, 1580 "FilteringStats": {
1263 "dealsId": { 1581 "description": "@OutputOnly Filtering reasons for this creative duri ng a period of a single\nday (from midnight to midnight Pacific).",
1264 "description": "The externalDealId for the deal associated w ith the creative.", 1582 "id": "FilteringStats",
1265 "type": "string" 1583 "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": {
1592 "$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."
1266 } 1594 }
1267 }, 1595 },
1268 "type": "object" 1596 "type": "object"
1269 }, 1597 },
1270 "Creative": { 1598 "Creative": {
1271 "description": "A creative and its classification data.", 1599 "description": "A creative and its classification data.",
1272 "id": "Creative", 1600 "id": "Creative",
1273 "properties": { 1601 "properties": {
1602 "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.",
1604 "enum": [
1605 "STATUS_UNSPECIFIED",
1606 "NOT_CHECKED",
1607 "CONDITIONALLY_APPROVED",
1608 "APPROVED",
1609 "DISAPPROVED"
1610 ],
1611 "enumDescriptions": [
1612 "The status is unknown.",
1613 "The creative has not been checked.",
1614 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
1615 "The creative has been approved.",
1616 "The creative has been disapproved."
1617 ],
1618 "type": "string"
1619 },
1620 "detectedProductCategories": {
1621 "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
1622 "items": {
1623 "format": "int32",
1624 "type": "integer"
1625 },
1626 "type": "array"
1627 },
1628 "openAuctionStatus": {
1629 "description": "@OutputOnly The top-level open auction statu s of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' ( or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanc ed with other contextual restrictions, in which case,\nit may be preferable to r ead from serving_restrictions directly.\nCan be used to filter the response of t he\ncreatives.list\nmethod.",
1630 "enum": [
1631 "STATUS_UNSPECIFIED",
1632 "NOT_CHECKED",
1633 "CONDITIONALLY_APPROVED",
1634 "APPROVED",
1635 "DISAPPROVED"
1636 ],
1637 "enumDescriptions": [
1638 "The status is unknown.",
1639 "The creative has not been checked.",
1640 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
1641 "The creative has been approved.",
1642 "The creative has been disapproved."
1643 ],
1644 "type": "string"
1645 },
1646 "advertiserName": {
1647 "description": "The name of the company being advertised in the creative.",
1648 "type": "string"
1649 },
1274 "detectedDomains": { 1650 "detectedDomains": {
1275 "description": "@OutputOnly\nThe detected domains for this c reative.", 1651 "description": "@OutputOnly\nThe detected domains for this c reative.",
1276 "items": { 1652 "items": {
1277 "type": "string" 1653 "type": "string"
1278 }, 1654 },
1279 "type": "array" 1655 "type": "array"
1280 }, 1656 },
1281 "detectedAdvertiserIds": { 1657 "detectedAdvertiserIds": {
1282 "description": "@OutputOnly Detected advertiser IDs, if any. ", 1658 "description": "@OutputOnly Detected advertiser IDs, if any. ",
1283 "items": { 1659 "items": {
(...skipping 162 matching lines...) Expand 10 before | Expand all | Expand 10 after
1446 "impressionTrackingUrls": { 1822 "impressionTrackingUrls": {
1447 "description": "The set of URLs to be called to record an im pression.", 1823 "description": "The set of URLs to be called to record an im pression.",
1448 "items": { 1824 "items": {
1449 "type": "string" 1825 "type": "string"
1450 }, 1826 },
1451 "type": "array" 1827 "type": "array"
1452 }, 1828 },
1453 "html": { 1829 "html": {
1454 "$ref": "HtmlContent", 1830 "$ref": "HtmlContent",
1455 "description": "An HTML creative." 1831 "description": "An HTML creative."
1456 }, 1832 }
1457 "detectedProductCategories": { 1833 },
1458 "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.", 1834 "type": "object"
1459 "items": { 1835 },
1460 "format": "int32", 1836 "ListFilteredImpressionsResponse": {
1461 "type": "integer" 1837 "description": "Response message for listing all reasons that impres sions were filtered (i.e.\nnot considered as an inventory match) for the buyer." ,
1462 }, 1838 "id": "ListFilteredImpressionsResponse",
1463 "type": "array" 1839 "properties": {
1464 }, 1840 "nextPageToken": {
1465 "dealsStatus": { 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.",
1466 "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.", 1842 "type": "string"
1467 "enum": [ 1843 },
1468 "STATUS_UNSPECIFIED", 1844 "impressionsStatusRows": {
1469 "NOT_CHECKED", 1845 "description": "List of rows, with counts of filtered impres sions aggregated by status.",
1470 "CONDITIONALLY_APPROVED", 1846 "items": {
1471 "APPROVED", 1847 "$ref": "ImpressionStatusRow"
1472 "DISAPPROVED" 1848 },
1473 ], 1849 "type": "array"
1474 "enumDescriptions": [
1475 "The status is unknown.",
1476 "The creative has not been checked.",
1477 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
1478 "The creative has been approved.",
1479 "The creative has been disapproved."
1480 ],
1481 "type": "string"
1482 },
1483 "openAuctionStatus": {
1484 "description": "@OutputOnly The top-level open auction statu s of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' ( or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanc ed with other contextual restrictions, in which case,\nit may be preferable to r ead from serving_restrictions directly.\nCan be used to filter the response of t he\ncreatives.list\nmethod.",
1485 "enum": [
1486 "STATUS_UNSPECIFIED",
1487 "NOT_CHECKED",
1488 "CONDITIONALLY_APPROVED",
1489 "APPROVED",
1490 "DISAPPROVED"
1491 ],
1492 "enumDescriptions": [
1493 "The status is unknown.",
1494 "The creative has not been checked.",
1495 "The creative has been conditionally approved.\nSee serv ing_restrictions for details.",
1496 "The creative has been approved.",
1497 "The creative has been disapproved."
1498 ],
1499 "type": "string"
1500 },
1501 "advertiserName": {
1502 "description": "The name of the company being advertised in the creative.",
1503 "type": "string"
1504 }
1505 },
1506 "type": "object"
1507 },
1508 "FilteringStats": {
1509 "description": "@OutputOnly Filtering reasons for this creative duri ng a period of a single\nday (from midnight to midnight Pacific).",
1510 "id": "FilteringStats",
1511 "properties": {
1512 "reasons": {
1513 "description": "The set of filtering reasons for this date." ,
1514 "items": {
1515 "$ref": "Reason"
1516 },
1517 "type": "array"
1518 },
1519 "date": {
1520 "$ref": "Date",
1521 "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."
1522 } 1850 }
1523 }, 1851 },
1524 "type": "object" 1852 "type": "object"
1525 }, 1853 },
1526 "RemoveDealAssociationRequest": { 1854 "RemoveDealAssociationRequest": {
1527 "description": "A request for removing the association between a dea l and a creative.", 1855 "description": "A request for removing the association between a dea l and a creative.",
1528 "id": "RemoveDealAssociationRequest", 1856 "id": "RemoveDealAssociationRequest",
1529 "properties": { 1857 "properties": {
1530 "association": { 1858 "association": {
1531 "$ref": "CreativeDealAssociation", 1859 "$ref": "CreativeDealAssociation",
1532 "description": "The association between a creative and a dea l that should be removed." 1860 "description": "The association between a creative and a dea l that should be removed."
1533 } 1861 }
1534 }, 1862 },
1535 "type": "object" 1863 "type": "object"
1536 }, 1864 },
1865 "ListCreativeStatusBreakdownByCreativeResponse": {
1866 "description": "Response message for listing all creatives associate d with a given filtered\nbid reason.",
1867 "id": "ListCreativeStatusBreakdownByCreativeResponse",
1868 "properties": {
1869 "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.",
1871 "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 }
1880 },
1881 "type": "object"
1882 },
1537 "Client": { 1883 "Client": {
1538 "description": "A client resource represents a client buyer&mdash;an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra nted to the client buyer.\nAll fields are required unless otherwise specified.", 1884 "description": "A client resource represents a client buyer&mdash;an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associ ated with the client buyer have restricted access to\nthe Ad Exchange Marketplac e and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngra nted to the client buyer.\nAll fields are required unless otherwise specified.",
1539 "id": "Client", 1885 "id": "Client",
1540 "properties": { 1886 "properties": {
1887 "status": {
1888 "description": "The status of the client buyer.",
1889 "enum": [
1890 "CLIENT_STATUS_UNSPECIFIED",
1891 "DISABLED",
1892 "ACTIVE"
1893 ],
1894 "enumDescriptions": [
1895 "A placeholder for an undefined client status.",
1896 "A client that is currently disabled.",
1897 "A client that is currently active."
1898 ],
1899 "type": "string"
1900 },
1541 "entityType": { 1901 "entityType": {
1542 "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.", 1902 "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
1543 "enum": [ 1903 "enum": [
1544 "ENTITY_TYPE_UNSPECIFIED", 1904 "ENTITY_TYPE_UNSPECIFIED",
1545 "ADVERTISER", 1905 "ADVERTISER",
1546 "BRAND", 1906 "BRAND",
1547 "AGENCY" 1907 "AGENCY"
1548 ], 1908 ],
1549 "enumDescriptions": [ 1909 "enumDescriptions": [
1550 "A placeholder for an undefined client entity type. Shou ld not be used.", 1910 "A placeholder for an undefined client entity type. Shou ld not be used.",
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
1584 "type": "string" 1944 "type": "string"
1585 }, 1945 },
1586 "clientAccountId": { 1946 "clientAccountId": {
1587 "description": "The globally-unique numerical ID of the clie nt.\nThe value of this field is ignored in create and update operations.", 1947 "description": "The globally-unique numerical ID of the clie nt.\nThe value of this field is ignored in create and update operations.",
1588 "format": "int64", 1948 "format": "int64",
1589 "type": "string" 1949 "type": "string"
1590 }, 1950 },
1591 "entityName": { 1951 "entityName": {
1592 "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.", 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.",
1593 "type": "string" 1953 "type": "string"
1594 },
1595 "status": {
1596 "description": "The status of the client buyer.",
1597 "enum": [
1598 "CLIENT_STATUS_UNSPECIFIED",
1599 "DISABLED",
1600 "ACTIVE"
1601 ],
1602 "enumDescriptions": [
1603 "A placeholder for an undefined client status.",
1604 "A client that is currently disabled.",
1605 "A client that is currently active."
1606 ],
1607 "type": "string"
1608 } 1954 }
1609 }, 1955 },
1610 "type": "object" 1956 "type": "object"
1611 }, 1957 },
1612 "Correction": { 1958 "Correction": {
1613 "description": "@OutputOnly Shows any corrections that were applied to this creative.", 1959 "description": "@OutputOnly Shows any corrections that were applied to this creative.",
1614 "id": "Correction", 1960 "id": "Correction",
1615 "properties": { 1961 "properties": {
1616 "details": {
1617 "description": "Additional details about what was corrected. ",
1618 "items": {
1619 "type": "string"
1620 },
1621 "type": "array"
1622 },
1623 "type": { 1962 "type": {
1624 "description": "The type of correction that was applied to t he creative.", 1963 "description": "The type of correction that was applied to t he creative.",
1625 "enum": [ 1964 "enum": [
1626 "CORRECTION_TYPE_UNSPECIFIED", 1965 "CORRECTION_TYPE_UNSPECIFIED",
1627 "VENDOR_IDS_ADDED", 1966 "VENDOR_IDS_ADDED",
1628 "SSL_ATTRIBUTE_REMOVED", 1967 "SSL_ATTRIBUTE_REMOVED",
1629 "FLASH_FREE_ATTRIBUTE_REMOVED", 1968 "FLASH_FREE_ATTRIBUTE_REMOVED",
1630 "FLASH_FREE_ATTRIBUTE_ADDED", 1969 "FLASH_FREE_ATTRIBUTE_ADDED",
1631 "REQUIRED_ATTRIBUTE_ADDED", 1970 "REQUIRED_ATTRIBUTE_ADDED",
1632 "REQUIRED_VENDOR_ADDED", 1971 "REQUIRED_VENDOR_ADDED",
(...skipping 18 matching lines...) Expand all
1651 "The ad contains video content." 1990 "The ad contains video content."
1652 ], 1991 ],
1653 "type": "string" 1992 "type": "string"
1654 }, 1993 },
1655 "contexts": { 1994 "contexts": {
1656 "description": "The contexts for the correction.", 1995 "description": "The contexts for the correction.",
1657 "items": { 1996 "items": {
1658 "$ref": "ServingContext" 1997 "$ref": "ServingContext"
1659 }, 1998 },
1660 "type": "array" 1999 "type": "array"
1661 } 2000 },
1662 }, 2001 "details": {
1663 "type": "object" 2002 "description": "Additional details about what was corrected. ",
2003 "items": {
2004 "type": "string"
2005 },
2006 "type": "array"
2007 }
2008 },
2009 "type": "object"
2010 },
2011 "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)\"",
2013 "id": "FilterSet",
2014 "properties": {
2015 "creativeId": {
2016 "description": "The ID of the creative on which to filter; o ptional.",
2017 "type": "string"
2018 },
2019 "relativeDateRange": {
2020 "$ref": "RelativeDateRange",
2021 "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone."
2022 },
2023 "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).",
2025 "enumDescriptions": [
2026 "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.",
2027 "The ad impression appears on a desktop.",
2028 "The ad impression appears on a tablet.",
2029 "The ad impression appears on a mobile device."
2030 ],
2031 "items": {
2032 "enum": [
2033 "PLATFORM_UNSPECIFIED",
2034 "DESKTOP",
2035 "TABLET",
2036 "MOBILE"
2037 ],
2038 "type": "string"
2039 },
2040 "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 }
2120 },
2121 "type": "object"
2122 },
2123 "ListDealAssociationsResponse": {
2124 "description": "A response for listing creative and deal association s",
2125 "id": "ListDealAssociationsResponse",
2126 "properties": {
2127 "associations": {
2128 "description": "The list of associations.",
2129 "items": {
2130 "$ref": "CreativeDealAssociation"
2131 },
2132 "type": "array"
2133 },
2134 "nextPageToken": {
2135 "description": "A token to retrieve the next page of results .\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of re sults.",
2136 "type": "string"
2137 }
2138 },
2139 "type": "object"
2140 },
2141 "CalloutStatusRow": {
2142 "description": "The number of impressions with the specified dimensi on values where the\ncorresponding bid request or bid response was not successfu l, as described by\nthe specified callout status.",
2143 "id": "CalloutStatusRow",
2144 "properties": {
2145 "rowDimensions": {
2146 "$ref": "RowDimensions",
2147 "description": "The values of all dimensions associated with metric values in this row."
2148 },
2149 "calloutStatusId": {
2150 "description": "The ID of the callout status.\nSee [callout- status-codes](https://developers.google.com/ad-exchange/rtb/downloads/callout-st atus-codes).",
2151 "format": "int32",
2152 "type": "integer"
2153 },
2154 "impressionCount": {
2155 "$ref": "MetricValue",
2156 "description": "The number of impressions for which there wa s a bid request or bid response\nwith the specified callout status."
2157 }
2158 },
2159 "type": "object"
2160 },
2161 "Disapproval": {
2162 "description": "@OutputOnly The reason and details for a disapproval .",
2163 "id": "Disapproval",
2164 "properties": {
2165 "reason": {
2166 "description": "The categorized reason for disapproval.",
2167 "enum": [
2168 "LENGTH_OF_IMAGE_ANIMATION",
2169 "BROKEN_URL",
2170 "MEDIA_NOT_FUNCTIONAL",
2171 "INVALID_FOURTH_PARTY_CALL",
2172 "INCORRECT_REMARKETING_DECLARATION",
2173 "LANDING_PAGE_ERROR",
2174 "AD_SIZE_DOES_NOT_MATCH_AD_SLOT",
2175 "NO_BORDER",
2176 "FOURTH_PARTY_BROWSER_COOKIES",
2177 "LSO_OBJECTS",
2178 "BLANK_CREATIVE",
2179 "DESTINATION_URLS_UNDECLARED",
2180 "PROBLEM_WITH_CLICK_MACRO",
2181 "INCORRECT_AD_TECHNOLOGY_DECLARATION",
2182 "INCORRECT_DESTINATION_URL_DECLARATION",
2183 "EXPANDABLE_INCORRECT_DIRECTION",
2184 "EXPANDABLE_DIRECTION_NOT_SUPPORTED",
2185 "EXPANDABLE_INVALID_VENDOR",
2186 "EXPANDABLE_FUNCTIONALITY",
2187 "VIDEO_INVALID_VENDOR",
2188 "VIDEO_UNSUPPORTED_LENGTH",
2189 "VIDEO_UNSUPPORTED_FORMAT",
2190 "VIDEO_FUNCTIONALITY",
2191 "LANDING_PAGE_DISABLED",
2192 "MALWARE_SUSPECTED",
2193 "ADULT_IMAGE_OR_VIDEO",
2194 "INACCURATE_AD_TEXT",
2195 "COUNTERFEIT_DESIGNER_GOODS",
2196 "POP_UP",
2197 "INVALID_RTB_PROTOCOL_USAGE",
2198 "RAW_IP_ADDRESS_IN_SNIPPET",
2199 "UNACCEPTABLE_CONTENT_SOFTWARE",
2200 "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN",
2201 "UNDECLARED_FLASH_OBJECTS",
2202 "INVALID_SSL_DECLARATION",
2203 "DIRECT_DOWNLOAD_IN_AD",
2204 "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED",
2205 "DESTINATION_URL_SITE_NOT_CRAWLABLE",
2206 "BAD_URL_LEGAL_DISAPPROVAL",
2207 "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED",
2208 "DYNAMIC_DNS_AT_DESTINATION_URL",
2209 "POOR_IMAGE_OR_VIDEO_QUALITY",
2210 "UNACCEPTABLE_IMAGE_CONTENT",
2211 "INCORRECT_IMAGE_LAYOUT",
2212 "IRRELEVANT_IMAGE_OR_VIDEO",
2213 "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK",
2214 "MISLEADING_CLAIMS_IN_AD",
2215 "RESTRICTED_PRODUCTS",
2216 "UNACCEPTABLE_CONTENT",
2217 "AUTOMATED_AD_CLICKING",
2218 "INVALID_URL_PROTOCOL",
2219 "UNDECLARED_RESTRICTED_CONTENT",
2220 "INVALID_REMARKETING_LIST_USAGE",
2221 "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT",
2222 "CLICK_TO_DOWNLOAD_NOT_AN_APP",
2223 "INACCURATE_REVIEW_EXTENSION",
2224 "SEXUALLY_EXPLICIT_CONTENT",
2225 "GAINING_AN_UNFAIR_ADVANTAGE",
2226 "GAMING_THE_GOOGLE_NETWORK",
2227 "DANGEROUS_PRODUCTS_KNIVES",
2228 "DANGEROUS_PRODUCTS_EXPLOSIVES",
2229 "DANGEROUS_PRODUCTS_GUNS",
2230 "DANGEROUS_PRODUCTS_DRUGS",
2231 "DANGEROUS_PRODUCTS_TOBACCO",
2232 "DANGEROUS_PRODUCTS_WEAPONS",
2233 "UNCLEAR_OR_IRRELEVANT_AD",
2234 "PROFESSIONAL_STANDARDS",
2235 "DYSFUNCTIONAL_PROMOTION",
2236 "INVALID_INTEREST_BASED_AD",
2237 "MISUSE_OF_PERSONAL_INFORMATION",
2238 "OMISSION_OF_RELEVANT_INFORMATION",
2239 "UNAVAILABLE_PROMOTIONS",
2240 "MISLEADING_PROMOTIONS",
2241 "INAPPROPRIATE_CONTENT",
2242 "SENSITIVE_EVENTS",
2243 "SHOCKING_CONTENT",
2244 "ENABLING_DISHONEST_BEHAVIOR",
2245 "TECHNICAL_REQUIREMENTS",
2246 "RESTRICTED_POLITICAL_CONTENT",
2247 "UNSUPPORTED_CONTENT",
2248 "INVALID_BIDDING_METHOD",
2249 "VIDEO_TOO_LONG",
2250 "VIOLATES_JAPANESE_PHARMACY_LAW",
2251 "UNACCREDITED_PET_PHARMACY",
2252 "ABORTION",
2253 "CONTRACEPTIVES",
2254 "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA",
2255 "KCDSP_REGISTRATION",
2256 "NOT_FAMILY_SAFE",
2257 "CLINICAL_TRIAL_RECRUITMENT",
2258 "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED",
2259 "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
2260 "PERSONAL_LOANS",
2261 "UNSUPPORTED_FLASH_CONTENT"
2262 ],
2263 "enumDescriptions": [
2264 "The length of the image animation is longer than allowe d.",
2265 "The click through URL doesn't work properly.",
2266 "Something is wrong with the creative itself.",
2267 "The ad makes a fourth party call to an unapproved vendo r.",
2268 "The ad targets consumers using remarketing lists and/or collects\ndata for subsequent use in retargeting, but does not correctly declar e\nthat use.",
2269 "Clicking on the ad leads to an error page.",
2270 "The ad size when rendered does not match the declaratio n.",
2271 "Ads with a white background require a border, which was missing.",
2272 "The creative attempts to set cookies from a fourth part y that is not\ncertified.",
2273 "The creative sets an LSO object.",
2274 "The ad serves a blank.",
2275 "The ad uses rotation, but not all destination URLs were declared.",
2276 "There is a problem with the way the click macro is used .",
2277 "The ad technology declaration is not accurate.",
2278 "The actual destination URL does not match the declared destination URL.",
2279 "The declared expanding direction does not match the act ual direction.",
2280 "The ad does not expand in a supported direction.",
2281 "The ad uses an expandable vendor that is not supported. ",
2282 "There was an issue with the expandable ad.",
2283 "The ad uses a video vendor that is not supported.",
2284 "The length of the video ad is not supported.",
2285 "The format of the video ad is not supported.",
2286 "There was an issue with the video ad.",
2287 "The landing page does not conform to Ad Exchange policy .",
2288 "The ad or the landing page may contain malware.",
2289 "The ad contains adult images or video content.",
2290 "The ad contains text that is unclear or inaccurate.",
2291 "The ad promotes counterfeit designer goods.",
2292 "The ad causes a popup window to appear.",
2293 "The creative does not follow policies set for the RTB p rotocol.",
2294 "The ad contains a URL that uses a numeric IP address fo r the domain.",
2295 "The ad or landing page contains unacceptable content be cause it initiated\na software or executable download.",
2296 "The ad set an unauthorized cookie on a Google domain.",
2297 "Flash content found when no flash was declared.",
2298 "SSL support declared but not working correctly.",
2299 "Rich Media - Direct Download in Ad (ex. PDF download)." ,
2300 "Maximum download size exceeded.",
2301 "Bad Destination URL: Site Not Crawlable.",
2302 "Bad URL: Legal disapproval.",
2303 "Pharmaceuticals, Gambling, Alcohol not allowed and at l east one was\ndetected.",
2304 "Dynamic DNS at Destination URL.",
2305 "Poor Image / Video Quality.",
2306 "For example, Image Trick to Click.",
2307 "Incorrect Image Layout.",
2308 "Irrelevant Image / Video.",
2309 "Broken back button.",
2310 "Misleading/Inaccurate claims in ads.",
2311 "Restricted Products.",
2312 "Unacceptable content. For example, malware.",
2313 "The ad automatically redirects to the destination site without a click,\nor reports a click when none were made.",
2314 "The ad uses URL protocols that do not exist or are not allowed on AdX.",
2315 "Restricted content (for example, alcohol) was found in the ad but not\ndeclared.",
2316 "Violation of the remarketing list policy.",
2317 "The destination site's robot.txt file prevents it from being crawled.",
2318 "Click to download must link to an app.",
2319 "A review extension must be an accurate review.",
2320 "Sexually explicit content.",
2321 "The ad tries to gain an unfair traffic advantage.",
2322 "The ad tries to circumvent Google's advertising systems .",
2323 "The ad promotes dangerous knives.",
2324 "The ad promotes explosives.",
2325 "The ad promotes guns & parts.",
2326 "The ad promotes recreational drugs/services & related e quipment.",
2327 "The ad promotes tobacco products/services & related equ ipment.",
2328 "The ad promotes weapons.",
2329 "The ad is unclear or irrelevant to the destination site .",
2330 "The ad does not meet professional standards.",
2331 "The promotion is unnecessarily difficult to navigate.",
2332 "Violation of Google's policy for interest-based ads.",
2333 "Misuse of personal information.",
2334 "Omission of relevant information.",
2335 "Unavailable promotions.",
2336 "Misleading or unrealistic promotions.",
2337 "Offensive or inappropriate content.",
2338 "Capitalizing on sensitive events.",
2339 "Shocking content.",
2340 "Products & Services that enable dishonest behavior.",
2341 "The ad does not meet technical requirements.",
2342 "Restricted political content.",
2343 "Unsupported content.",
2344 "Invalid bidding method.",
2345 "Video length exceeds limits.",
2346 "Unacceptable content: Japanese healthcare.",
2347 "Online pharmacy ID required.",
2348 "Unacceptable content: Abortion.",
2349 "Unacceptable content: Birth control.",
2350 "Restricted in China.",
2351 "Unacceptable content: Korean healthcare.",
2352 "Non-family safe or adult content.",
2353 "Clinical trial recruitment.",
2354 "Maximum number of HTTP calls exceeded.",
2355 "Maximum number of cookies exceeded.",
2356 "Financial service ad does not adhere to specifications. ",
2357 "Flash content was found in an unsupported context."
2358 ],
2359 "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 }
2368 },
2369 "type": "object"
2370 },
2371 "StopWatchingCreativeRequest": {
2372 "description": "A request for stopping notifications for changes to creative Status.",
2373 "id": "StopWatchingCreativeRequest",
2374 "properties": {},
2375 "type": "object"
2376 },
2377 "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).",
2379 "id": "ServingRestriction",
2380 "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": {
2396 "description": "The status of the creative in this context ( for example, it has been\nexplicitly disapproved or is pending review).",
2397 "enum": [
2398 "STATUS_UNSPECIFIED",
2399 "DISAPPROVAL",
2400 "PENDING_REVIEW"
2401 ],
2402 "enumDescriptions": [
2403 "The status is not known.",
2404 "The ad was disapproved in this context.",
2405 "The ad is pending review in this context."
2406 ],
2407 "type": "string"
2408 }
2409 },
2410 "type": "object"
2411 },
2412 "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`.",
2414 "id": "Date",
2415 "properties": {
2416 "month": {
2417 "description": "Month of year. Must be from 1 to 12.",
2418 "format": "int32",
2419 "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 }
2431 },
2432 "type": "object"
2433 },
2434 "RowDimensions": {
2435 "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",
2437 "properties": {
2438 "timeInterval": {
2439 "$ref": "TimeInterval",
2440 "description": "The time interval that this row represents."
2441 }
2442 },
2443 "type": "object"
2444 },
2445 "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 `{}`.",
2447 "id": "Empty",
2448 "properties": {},
2449 "type": "object"
2450 },
2451 "ListCreativeStatusAndCreativeBreakdownByDetailResponse": {
2452 "description": "Response message for listing all details associated with a given filtered bid\nreason and a given creative.",
2453 "id": "ListCreativeStatusAndCreativeBreakdownByDetailResponse",
2454 "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": {
2467 "description": "The type of detail that the detail IDs repre sent.",
2468 "enum": [
2469 "TYPE_UNSPECIFIED",
2470 "CREATIVE_ATTRIBUTE",
2471 "VENDOR",
2472 "SENSITIVE_CATEGORY",
2473 "PRODUCT_CATEGORY"
2474 ],
2475 "enumDescriptions": [
2476 "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).",
2478 "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).",
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)."
2481 ],
2482 "type": "string"
2483 }
2484 },
2485 "type": "object"
2486 },
2487 "AppContext": {
2488 "description": "@OutputOnly The app type the restriction applies to for mobile device.",
2489 "id": "AppContext",
2490 "properties": {
2491 "appTypes": {
2492 "description": "The app types this restriction applies to.",
2493 "enumDescriptions": [
2494 "Native app context.",
2495 "Mobile web app context."
2496 ],
2497 "items": {
2498 "enum": [
2499 "NATIVE",
2500 "WEB"
2501 ],
2502 "type": "string"
2503 },
2504 "type": "array"
2505 }
2506 },
2507 "type": "object"
2508 },
2509 "ListFilteredBidsResponse": {
2510 "description": "Response message for listing all reasons that bids w ere filtered from the\nauction.",
2511 "id": "ListFilteredBidsResponse",
2512 "properties": {
2513 "creativeStatusRows": {
2514 "description": "List of rows, with counts of filtered bids a ggregated by filtering reason\n(i.e. creative status).",
2515 "items": {
2516 "$ref": "CreativeStatusRow"
2517 },
2518 "type": "array"
2519 },
2520 "nextPageToken": {
2521 "description": "A token to retrieve the next page of results .\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subse quent call to the\naccounts.filterSets.filteredBids.list\nmethod to retrieve the next page of results.",
2522 "type": "string"
2523 }
2524 },
2525 "type": "object"
2526 },
2527 "SecurityContext": {
2528 "description": "@OutputOnly A security context.",
2529 "id": "SecurityContext",
2530 "properties": {
2531 "securities": {
2532 "description": "The security types in this context.",
2533 "enumDescriptions": [
2534 "Matches impressions that require insecure compatibility .",
2535 "Matches impressions that require SSL compatibility."
2536 ],
2537 "items": {
2538 "enum": [
2539 "INSECURE",
2540 "SSL"
2541 ],
2542 "type": "string"
2543 },
2544 "type": "array"
2545 }
2546 },
2547 "type": "object"
2548 },
2549 "HtmlContent": {
2550 "description": "HTML content for a creative.",
2551 "id": "HtmlContent",
2552 "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": {
2558 "description": "The height of the HTML snippet in pixels.",
2559 "format": "int32",
2560 "type": "integer"
2561 },
2562 "width": {
2563 "description": "The width of the HTML snippet in pixels.",
2564 "format": "int32",
2565 "type": "integer"
2566 }
2567 },
2568 "type": "object"
2569 },
2570 "ListCreativesResponse": {
2571 "description": "A response for listing creatives.",
2572 "id": "ListCreativesResponse",
2573 "properties": {
2574 "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.",
2576 "type": "string"
2577 },
2578 "creatives": {
2579 "description": "The list of creatives.",
2580 "items": {
2581 "$ref": "Creative"
2582 },
2583 "type": "array"
2584 }
2585 },
2586 "type": "object"
2587 },
2588 "ListFilteredBidRequestsResponse": {
2589 "description": "Response message for listing all reasons that bid re quests were filtered and\nnot sent to the buyer.",
2590 "id": "ListFilteredBidRequestsResponse",
2591 "properties": {
2592 "calloutStatusRows": {
2593 "description": "List of rows, with counts of filtered bid re quests aggregated by callout\nstatus.",
2594 "items": {
2595 "$ref": "CalloutStatusRow"
2596 },
2597 "type": "array"
2598 },
2599 "nextPageToken": {
2600 "description": "A token to retrieve the next page of results .\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in th e subsequent call to the\naccounts.filterSets.filteredBidRequests.list\nmethod t o retrieve the next page of results.",
2601 "type": "string"
2602 }
2603 },
2604 "type": "object"
2605 },
2606 "ListBidMetricsResponse": {
2607 "description": "Response message for listing the metrics that are me asured in number of bids.",
2608 "id": "ListBidMetricsResponse",
2609 "properties": {
2610 "bidMetricsRows": {
2611 "description": "List of rows, each containing a set of bid m etrics.",
2612 "items": {
2613 "$ref": "BidMetricsRow"
2614 },
2615 "type": "array"
2616 },
2617 "nextPageToken": {
2618 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequ ent call to the\naccounts.filterSets.bidMetrics.list\nmethod to retrieve the nex t page of results.",
2619 "type": "string"
2620 }
2621 },
2622 "type": "object"
2623 },
2624 "Reason": {
2625 "description": "A specific filtering status and how many times it oc curred.",
2626 "id": "Reason",
2627 "properties": {
2628 "count": {
2629 "description": "The number of times the creative was filtere d for the status. The\ncount is aggregated across all publishers on the exchange .",
2630 "format": "int64",
2631 "type": "string"
2632 },
2633 "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.",
2635 "format": "int32",
2636 "type": "integer"
2637 }
2638 },
2639 "type": "object"
2640 },
2641 "ListLosingBidsResponse": {
2642 "description": "Response message for listing all reasons that bids l ost in the auction.",
2643 "id": "ListLosingBidsResponse",
2644 "properties": {
2645 "creativeStatusRows": {
2646 "description": "List of rows, with counts of losing bids agg regated by loss reason (i.e.\ncreative status).",
2647 "items": {
2648 "$ref": "CreativeStatusRow"
2649 },
2650 "type": "array"
2651 },
2652 "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.",
2654 "type": "string"
2655 }
2656 },
2657 "type": "object"
2658 },
2659 "VideoContent": {
2660 "description": "Video content for a creative.",
2661 "id": "VideoContent",
2662 "properties": {
2663 "videoUrl": {
2664 "description": "The URL to fetch a video ad.",
2665 "type": "string"
2666 }
2667 },
2668 "type": "object"
2669 },
2670 "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.",
2672 "id": "ImpressionMetricsRow",
2673 "properties": {
2674 "rowDimensions": {
2675 "$ref": "RowDimensions",
2676 "description": "The values of all dimensions associated with metric values in this row."
2677 },
2678 "availableImpressions": {
2679 "$ref": "MetricValue",
2680 "description": "The number of impressions available to the b uyer on Ad Exchange.\nIn some cases this value may be unavailable."
2681 },
2682 "bidRequests": {
2683 "$ref": "MetricValue",
2684 "description": "The number of impressions for which Ad Excha nge sent the buyer a bid\nrequest."
2685 },
2686 "inventoryMatches": {
2687 "$ref": "MetricValue",
2688 "description": "The number of impressions that match the buy er's inventory pretargeting."
2689 },
2690 "responsesWithBids": {
2691 "$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."
2693 },
2694 "successfulResponses": {
2695 "$ref": "MetricValue",
2696 "description": "The number of impressions for which the buye r successfully sent a response\nto Ad Exchange."
2697 }
2698 },
2699 "type": "object"
2700 },
2701 "AuctionContext": {
2702 "description": "@OutputOnly The auction type the restriction applies to.",
2703 "id": "AuctionContext",
2704 "properties": {
2705 "auctionTypes": {
2706 "description": "The auction types this restriction applies t o.",
2707 "enumDescriptions": [
2708 "The restriction applies to open auction.",
2709 "The restriction applies to direct deals."
2710 ],
2711 "items": {
2712 "enum": [
2713 "OPEN_AUCTION",
2714 "DIRECT_DEALS"
2715 ],
2716 "type": "string"
2717 },
2718 "type": "array"
2719 }
2720 },
2721 "type": "object"
2722 },
2723 "ListImpressionMetricsResponse": {
2724 "description": "Response message for listing the metrics that are me asured in number of\nimpressions.",
2725 "id": "ListImpressionMetricsResponse",
2726 "properties": {
2727 "nextPageToken": {
2728 "description": "A token to retrieve the next page of results .\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.impressionMetrics.list\nmethod to re trieve the next page of results.",
2729 "type": "string"
2730 },
2731 "impressionMetricsRows": {
2732 "description": "List of rows, each containing a set of impre ssion metrics.",
2733 "items": {
2734 "$ref": "ImpressionMetricsRow"
2735 },
2736 "type": "array"
2737 }
2738 },
2739 "type": "object"
2740 },
2741 "ImpressionStatusRow": {
2742 "description": "The number of impressions with the specified dimensi on values that were\nfiltered due to the specified filtering status.",
2743 "id": "ImpressionStatusRow",
2744 "properties": {
2745 "impressionCount": {
2746 "$ref": "MetricValue",
2747 "description": "The number of impressions that were filtered with the specified status."
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 },
2761 "rowDimensions": {
2762 "$ref": "RowDimensions",
2763 "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 },
2776 "viewableImpressions": {
2777 "$ref": "MetricValue",
2778 "description": "The number of bids for which the correspondi ng impression was viewable (as\ndefined by Active View)."
2779 },
2780 "impressionsWon": {
2781 "$ref": "MetricValue",
2782 "description": "The number of bids that won an impression."
2783 },
2784 "bids": {
2785 "$ref": "MetricValue",
2786 "description": "The number of bids that Ad Exchange received from the buyer."
2787 },
2788 "billedImpressions": {
2789 "$ref": "MetricValue",
2790 "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 }
2796 },
2797 "type": "object"
2798 },
2799 "ListBidResponseErrorsResponse": {
2800 "description": "Response message for listing all reasons that bid re sponses resulted in an\nerror.",
2801 "id": "ListBidResponseErrorsResponse",
2802 "properties": {
2803 "calloutStatusRows": {
2804 "description": "List of rows, with counts of bid responses a ggregated by callout status.",
2805 "items": {
2806 "$ref": "CalloutStatusRow"
2807 },
2808 "type": "array"
2809 },
2810 "nextPageToken": {
2811 "description": "A token to retrieve the next page of results .\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.bidResponseErrors.list\nmethod to re trieve the next page of results.",
2812 "type": "string"
2813 }
2814 },
2815 "type": "object"
2816 },
2817 "CreativeStatusRow": {
2818 "description": "The number of bids with the specified dimension valu es that did not win the\nauction (either were filtered pre-auction or lost the a uction), as described\nby the specified creative status.",
2819 "id": "CreativeStatusRow",
2820 "properties": {
2821 "rowDimensions": {
2822 "$ref": "RowDimensions",
2823 "description": "The values of all dimensions associated with metric values in this row."
2824 },
2825 "creativeStatusId": {
2826 "description": "The ID of the creative status.\nSee [creativ e-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative -status-codes).",
2827 "format": "int32",
2828 "type": "integer"
2829 },
2830 "bidCount": {
2831 "$ref": "MetricValue",
2832 "description": "The number of bids with the specified status ."
2833 }
2834 },
2835 "type": "object"
2836 },
2837 "RealtimeTimeRange": {
2838 "description": "An open-ended realtime time range specified by the s tart timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.",
2839 "id": "RealtimeTimeRange",
2840 "properties": {
2841 "startTimestamp": {
2842 "description": "The start timestamp of the real-time RTB met rics aggregation.",
2843 "format": "google-datetime",
2844 "type": "string"
2845 }
2846 },
2847 "type": "object"
2848 },
2849 "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.",
2851 "id": "FilteredBidDetailRow",
2852 "properties": {
2853 "rowDimensions": {
2854 "$ref": "RowDimensions",
2855 "description": "The values of all dimensions associated with metric values in this row."
2856 },
2857 "bidCount": {
2858 "$ref": "MetricValue",
2859 "description": "The number of bids with the specified detail ."
2860 },
2861 "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.",
2863 "format": "int32",
2864 "type": "integer"
2865 }
2866 },
2867 "type": "object"
2868 },
2869 "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.",
2871 "id": "AbsoluteDateRange",
2872 "properties": {
2873 "startDate": {
2874 "$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."
2876 },
2877 "endDate": {
2878 "$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."
2880 }
2881 },
2882 "type": "object"
1664 }, 2883 },
1665 "AddDealAssociationRequest": { 2884 "AddDealAssociationRequest": {
1666 "description": "A request for associating a deal and a creative.", 2885 "description": "A request for associating a deal and a creative.",
1667 "id": "AddDealAssociationRequest", 2886 "id": "AddDealAssociationRequest",
1668 "properties": { 2887 "properties": {
1669 "association": { 2888 "association": {
1670 "$ref": "CreativeDealAssociation", 2889 "$ref": "CreativeDealAssociation",
1671 "description": "The association between a creative and a dea l that should be added." 2890 "description": "The association between a creative and a dea l that should be added."
1672 } 2891 }
1673 }, 2892 },
1674 "type": "object" 2893 "type": "object"
1675 }, 2894 },
1676 "ListDealAssociationsResponse": { 2895 "WatchCreativeRequest": {
1677 "description": "A response for listing creative and deal association s", 2896 "description": "A request for watching changes to creative Status.",
1678 "id": "ListDealAssociationsResponse", 2897 "id": "WatchCreativeRequest",
1679 "properties": { 2898 "properties": {
1680 "nextPageToken": { 2899 "topic": {
1681 "description": "A token to retrieve the next page of results .\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of re sults.", 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.",
1682 "type": "string" 2901 "type": "string"
1683 }, 2902 }
1684 "associations": { 2903 },
1685 "description": "The list of associations.", 2904 "type": "object"
1686 "items": { 2905 },
1687 "$ref": "CreativeDealAssociation" 2906 "TimeInterval": {
1688 }, 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.",
1689 "type": "array" 2908 "id": "TimeInterval",
1690 } 2909 "properties": {
1691 }, 2910 "endTime": {
1692 "type": "object" 2911 "description": "The timestamp marking the end of the range ( exclusive) for which data is\nincluded.",
1693 }, 2912 "format": "google-datetime",
1694 "StopWatchingCreativeRequest": { 2913 "type": "string"
1695 "description": "A request for stopping notifications for changes to creative Status.", 2914 },
1696 "id": "StopWatchingCreativeRequest", 2915 "startTime": {
1697 "properties": {}, 2916 "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.",
1698 "type": "object" 2917 "format": "google-datetime",
1699 }, 2918 "type": "string"
1700 "Disapproval": { 2919 }
1701 "description": "@OutputOnly The reason and details for a disapproval .", 2920 },
1702 "id": "Disapproval", 2921 "type": "object"
1703 "properties": { 2922 },
1704 "details": { 2923 "FilteredBidCreativeRow": {
1705 "description": "Additional details about the reason for disa pproval.", 2924 "description": "The number of filtered bids with the specified dimen sion values that have the\nspecified creative.",
1706 "items": { 2925 "id": "FilteredBidCreativeRow",
1707 "type": "string" 2926 "properties": {
1708 }, 2927 "rowDimensions": {
1709 "type": "array" 2928 "$ref": "RowDimensions",
1710 }, 2929 "description": "The values of all dimensions associated with metric values in this row."
1711 "reason": { 2930 },
1712 "description": "The categorized reason for disapproval.", 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.",
1713 "enum": [ 3064 "enum": [
1714 "LENGTH_OF_IMAGE_ANIMATION", 3065 "SIMPLE_CONTEXT"
1715 "BROKEN_URL",
1716 "MEDIA_NOT_FUNCTIONAL",
1717 "INVALID_FOURTH_PARTY_CALL",
1718 "INCORRECT_REMARKETING_DECLARATION",
1719 "LANDING_PAGE_ERROR",
1720 "AD_SIZE_DOES_NOT_MATCH_AD_SLOT",
1721 "NO_BORDER",
1722 "FOURTH_PARTY_BROWSER_COOKIES",
1723 "LSO_OBJECTS",
1724 "BLANK_CREATIVE",
1725 "DESTINATION_URLS_UNDECLARED",
1726 "PROBLEM_WITH_CLICK_MACRO",
1727 "INCORRECT_AD_TECHNOLOGY_DECLARATION",
1728 "INCORRECT_DESTINATION_URL_DECLARATION",
1729 "EXPANDABLE_INCORRECT_DIRECTION",
1730 "EXPANDABLE_DIRECTION_NOT_SUPPORTED",
1731 "EXPANDABLE_INVALID_VENDOR",
1732 "EXPANDABLE_FUNCTIONALITY",
1733 "VIDEO_INVALID_VENDOR",
1734 "VIDEO_UNSUPPORTED_LENGTH",
1735 "VIDEO_UNSUPPORTED_FORMAT",
1736 "VIDEO_FUNCTIONALITY",
1737 "LANDING_PAGE_DISABLED",
1738 "MALWARE_SUSPECTED",
1739 "ADULT_IMAGE_OR_VIDEO",
1740 "INACCURATE_AD_TEXT",
1741 "COUNTERFEIT_DESIGNER_GOODS",
1742 "POP_UP",
1743 "INVALID_RTB_PROTOCOL_USAGE",
1744 "RAW_IP_ADDRESS_IN_SNIPPET",
1745 "UNACCEPTABLE_CONTENT_SOFTWARE",
1746 "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN",
1747 "UNDECLARED_FLASH_OBJECTS",
1748 "INVALID_SSL_DECLARATION",
1749 "DIRECT_DOWNLOAD_IN_AD",
1750 "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED",
1751 "DESTINATION_URL_SITE_NOT_CRAWLABLE",
1752 "BAD_URL_LEGAL_DISAPPROVAL",
1753 "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED",
1754 "DYNAMIC_DNS_AT_DESTINATION_URL",
1755 "POOR_IMAGE_OR_VIDEO_QUALITY",
1756 "UNACCEPTABLE_IMAGE_CONTENT",
1757 "INCORRECT_IMAGE_LAYOUT",
1758 "IRRELEVANT_IMAGE_OR_VIDEO",
1759 "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK",
1760 "MISLEADING_CLAIMS_IN_AD",
1761 "RESTRICTED_PRODUCTS",
1762 "UNACCEPTABLE_CONTENT",
1763 "AUTOMATED_AD_CLICKING",
1764 "INVALID_URL_PROTOCOL",
1765 "UNDECLARED_RESTRICTED_CONTENT",
1766 "INVALID_REMARKETING_LIST_USAGE",
1767 "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT",
1768 "CLICK_TO_DOWNLOAD_NOT_AN_APP",
1769 "INACCURATE_REVIEW_EXTENSION",
1770 "SEXUALLY_EXPLICIT_CONTENT",
1771 "GAINING_AN_UNFAIR_ADVANTAGE",
1772 "GAMING_THE_GOOGLE_NETWORK",
1773 "DANGEROUS_PRODUCTS_KNIVES",
1774 "DANGEROUS_PRODUCTS_EXPLOSIVES",
1775 "DANGEROUS_PRODUCTS_GUNS",
1776 "DANGEROUS_PRODUCTS_DRUGS",
1777 "DANGEROUS_PRODUCTS_TOBACCO",
1778 "DANGEROUS_PRODUCTS_WEAPONS",
1779 "UNCLEAR_OR_IRRELEVANT_AD",
1780 "PROFESSIONAL_STANDARDS",
1781 "DYSFUNCTIONAL_PROMOTION",
1782 "INVALID_INTEREST_BASED_AD",
1783 "MISUSE_OF_PERSONAL_INFORMATION",
1784 "OMISSION_OF_RELEVANT_INFORMATION",
1785 "UNAVAILABLE_PROMOTIONS",
1786 "MISLEADING_PROMOTIONS",
1787 "INAPPROPRIATE_CONTENT",
1788 "SENSITIVE_EVENTS",
1789 "SHOCKING_CONTENT",
1790 "ENABLING_DISHONEST_BEHAVIOR",
1791 "TECHNICAL_REQUIREMENTS",
1792 "RESTRICTED_POLITICAL_CONTENT",
1793 "UNSUPPORTED_CONTENT",
1794 "INVALID_BIDDING_METHOD",
1795 "VIDEO_TOO_LONG",
1796 "VIOLATES_JAPANESE_PHARMACY_LAW",
1797 "UNACCREDITED_PET_PHARMACY",
1798 "ABORTION",
1799 "CONTRACEPTIVES",
1800 "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA",
1801 "KCDSP_REGISTRATION",
1802 "NOT_FAMILY_SAFE",
1803 "CLINICAL_TRIAL_RECRUITMENT",
1804 "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED",
1805 "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
1806 "PERSONAL_LOANS",
1807 "UNSUPPORTED_FLASH_CONTENT"
1808 ], 3066 ],
1809 "enumDescriptions": [ 3067 "enumDescriptions": [
1810 "The length of the image animation is longer than allowe d.", 3068 "A simple context."
1811 "The click through URL doesn't work properly.", 3069 ],
1812 "Something is wrong with the creative itself.", 3070 "type": "string"
1813 "The ad makes a fourth party call to an unapproved vendo r.", 3071 },
1814 "The ad targets consumers using remarketing lists and/or collects\ndata for subsequent use in retargeting, but does not correctly declar e\nthat use.", 3072 "appType": {
1815 "Clicking on the ad leads to an error page.", 3073 "$ref": "AppContext",
1816 "The ad size when rendered does not match the declaratio n.", 3074 "description": "Matches impressions for a particular app typ e."
1817 "Ads with a white background require a border, which was missing.", 3075 },
1818 "The creative attempts to set cookies from a fourth part y that is not\ncertified.", 3076 "securityType": {
1819 "The creative sets an LSO object.", 3077 "$ref": "SecurityContext",
1820 "The ad serves a blank.", 3078 "description": "Matches impressions for a particular securit y type."
1821 "The ad uses rotation, but not all destination URLs were declared.", 3079 },
1822 "There is a problem with the way the click macro is used .", 3080 "platform": {
1823 "The ad technology declaration is not accurate.", 3081 "$ref": "PlatformContext",
1824 "The actual destination URL does not match the declared destination URL.", 3082 "description": "Matches impressions coming from a particular platform."
1825 "The declared expanding direction does not match the act ual direction.", 3083 },
1826 "The ad does not expand in a supported direction.", 3084 "location": {
1827 "The ad uses an expandable vendor that is not supported. ", 3085 "$ref": "LocationContext",
1828 "There was an issue with the expandable ad.", 3086 "description": "Matches impressions coming from users *or* p ublishers in a specific\nlocation."
1829 "The ad uses a video vendor that is not supported.", 3087 }
1830 "The length of the video ad is not supported.", 3088 },
1831 "The format of the video ad is not supported.", 3089 "type": "object"
1832 "There was an issue with the video ad.", 3090 },
1833 "The landing page does not conform to Ad Exchange policy .", 3091 "Image": {
1834 "The ad or the landing page may contain malware.", 3092 "description": "An image resource. You may provide a larger image th an was requested,\nso long as the aspect ratio is preserved.",
1835 "The ad contains adult images or video content.", 3093 "id": "Image",
1836 "The ad contains text that is unclear or inaccurate.", 3094 "properties": {
1837 "The ad promotes counterfeit designer goods.", 3095 "height": {
1838 "The ad causes a popup window to appear.", 3096 "description": "Image height in pixels.",
1839 "The creative does not follow policies set for the RTB p rotocol.", 3097 "format": "int32",
1840 "The ad contains a URL that uses a numeric IP address fo r the domain.", 3098 "type": "integer"
1841 "The ad or landing page contains unacceptable content be cause it initiated\na software or executable download.", 3099 },
1842 "The ad set an unauthorized cookie on a Google domain.", 3100 "width": {
1843 "Flash content found when no flash was declared.", 3101 "description": "Image width in pixels.",
1844 "SSL support declared but not working correctly.", 3102 "format": "int32",
1845 "Rich Media - Direct Download in Ad (ex. PDF download)." , 3103 "type": "integer"
1846 "Maximum download size exceeded.", 3104 },
1847 "Bad Destination URL: Site Not Crawlable.", 3105 "url": {
1848 "Bad URL: Legal disapproval.", 3106 "description": "The URL of the image.",
1849 "Pharmaceuticals, Gambling, Alcohol not allowed and at l east one was\ndetected.", 3107 "type": "string"
1850 "Dynamic DNS at Destination URL.", 3108 }
1851 "Poor Image / Video Quality.", 3109 },
1852 "For example, Image Trick to Click.", 3110 "type": "object"
1853 "Incorrect Image Layout.", 3111 },
1854 "Irrelevant Image / Video.", 3112 "ListFilterSetsResponse": {
1855 "Broken back button.", 3113 "description": "Response message for listing filter sets.",
1856 "Misleading/Inaccurate claims in ads.", 3114 "id": "ListFilterSetsResponse",
1857 "Restricted Products.", 3115 "properties": {
1858 "Unacceptable content. For example, malware.", 3116 "filterSets": {
1859 "The ad automatically redirects to the destination site without a click,\nor reports a click when none were made.", 3117 "description": "The filter sets belonging to the buyer.",
1860 "The ad uses URL protocols that do not exist or are not allowed on AdX.", 3118 "items": {
1861 "Restricted content (for example, alcohol) was found in the ad but not\ndeclared.", 3119 "$ref": "FilterSet"
1862 "Violation of the remarketing list policy.", 3120 },
1863 "The destination site's robot.txt file prevents it from being crawled.", 3121 "type": "array"
1864 "Click to download must link to an app.", 3122 },
1865 "A review extension must be an accurate review.", 3123 "nextPageToken": {
1866 "Sexually explicit content.", 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.",
1867 "The ad tries to gain an unfair traffic advantage.", 3125 "type": "string"
1868 "The ad tries to circumvent Google's advertising systems .", 3126 }
1869 "The ad promotes dangerous knives.", 3127 },
1870 "The ad promotes explosives.", 3128 "type": "object"
1871 "The ad promotes guns & parts.", 3129 },
1872 "The ad promotes recreational drugs/services & related e quipment.", 3130 "BidResponseWithoutBidsStatusRow": {
1873 "The ad promotes tobacco products/services & related equ ipment.", 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.",
1874 "The ad promotes weapons.", 3132 "id": "BidResponseWithoutBidsStatusRow",
1875 "The ad is unclear or irrelevant to the destination site .", 3133 "properties": {
1876 "The ad does not meet professional standards.", 3134 "impressionCount": {
1877 "The promotion is unnecessarily difficult to navigate.", 3135 "$ref": "MetricValue",
1878 "Violation of Google's policy for interest-based ads.", 3136 "description": "The number of impressions for which there wa s a bid response with the\nspecified status."
1879 "Misuse of personal information.", 3137 },
1880 "Omission of relevant information.",
1881 "Unavailable promotions.",
1882 "Misleading or unrealistic promotions.",
1883 "Offensive or inappropriate content.",
1884 "Capitalizing on sensitive events.",
1885 "Shocking content.",
1886 "Products & Services that enable dishonest behavior.",
1887 "The ad does not meet technical requirements.",
1888 "Restricted political content.",
1889 "Unsupported content.",
1890 "Invalid bidding method.",
1891 "Video length exceeds limits.",
1892 "Unacceptable content: Japanese healthcare.",
1893 "Online pharmacy ID required.",
1894 "Unacceptable content: Abortion.",
1895 "Unacceptable content: Birth control.",
1896 "Restricted in China.",
1897 "Unacceptable content: Korean healthcare.",
1898 "Non-family safe or adult content.",
1899 "Clinical trial recruitment.",
1900 "Maximum number of HTTP calls exceeded.",
1901 "Maximum number of cookies exceeded.",
1902 "Financial service ad does not adhere to specifications. ",
1903 "Flash content was found in an unsupported context."
1904 ],
1905 "type": "string"
1906 }
1907 },
1908 "type": "object"
1909 },
1910 "ServingRestriction": {
1911 "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately ser ves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request ,\nor the type of auction).",
1912 "id": "ServingRestriction",
1913 "properties": {
1914 "status": { 3138 "status": {
1915 "description": "The status of the creative in this context ( for example, it has been\nexplicitly disapproved or is pending review).", 3139 "description": "The status that caused the bid response to b e considered to have no\napplicable bids.",
1916 "enum": [ 3140 "enum": [
1917 "STATUS_UNSPECIFIED", 3141 "STATUS_UNSPECIFIED",
1918 "DISAPPROVAL", 3142 "RESPONSES_WITHOUT_BIDS",
1919 "PENDING_REVIEW" 3143 "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT",
3144 "RESPONSES_WITHOUT_BIDS_FOR_DEAL"
1920 ], 3145 ],
1921 "enumDescriptions": [ 3146 "enumDescriptions": [
1922 "The status is not known.", 3147 "A placeholder for an undefined status.\nThis value will never be returned in responses.",
1923 "The ad was disapproved in this context.", 3148 "The response had no bids.",
1924 "The ad is pending review in this context." 3149 "The response had no bids for the specified account, tho ugh it may have\nincluded bids on behalf of other accounts.",
1925 ], 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."
1926 "type": "string" 3151 ],
1927 }, 3152 "type": "string"
1928 "disapprovalReasons": { 3153 },
1929 "description": "Any disapprovals bound to this restriction.\ nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ ncreatives.list\nmethod.", 3154 "rowDimensions": {
1930 "items": { 3155 "$ref": "RowDimensions",
1931 "$ref": "Disapproval" 3156 "description": "The values of all dimensions associated with metric values in this row."
1932 }, 3157 }
1933 "type": "array" 3158 },
1934 }, 3159 "type": "object"
1935 "contexts": { 3160 },
1936 "description": "The contexts for the restriction.", 3161 "ClientUserInvitation": {
1937 "items": { 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. ",
1938 "$ref": "ServingContext" 3163 "id": "ClientUserInvitation",
1939 }, 3164 "properties": {
1940 "type": "array" 3165 "invitationId": {
1941 } 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 .",
1942 }, 3167 "format": "int64",
1943 "type": "object" 3168 "type": "string"
1944 }, 3169 },
1945 "Date": { 3170 "email": {
1946 "description": "Represents a whole calendar date, e.g. date of birth . The time of day and\ntime zone are either specified elsewhere or are not signi ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b e 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independe nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.", 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.",
1947 "id": "Date", 3172 "type": "string"
1948 "properties": { 3173 },
1949 "month": { 3174 "clientAccountId": {
1950 "description": "Month of year. Must be from 1 to 12.", 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.",
1951 "format": "int32", 3176 "format": "int64",
1952 "type": "integer" 3177 "type": "string"
1953 }, 3178 }
1954 "year": { 3179 },
1955 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.", 3180 "type": "object"
1956 "format": "int32", 3181 },
1957 "type": "integer" 3182 "ListCreativeStatusBreakdownByDetailResponse": {
1958 }, 3183 "description": "Response message for listing all details associated with a given filtered bid\nreason.",
1959 "day": { 3184 "id": "ListCreativeStatusBreakdownByDetailResponse",
1960 "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not s ignificant.", 3185 "properties": {
1961 "format": "int32", 3186 "detailType": {
1962 "type": "integer" 3187 "description": "The type of detail that the detail IDs repre sent.",
1963 } 3188 "enum": [
1964 }, 3189 "TYPE_UNSPECIFIED",
1965 "type": "object" 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"
1966 } 3307 }
1967 }, 3308 },
1968 "servicePath": "", 3309 "servicePath": "",
1969 "title": "Ad Exchange Buyer API II", 3310 "title": "Ad Exchange Buyer API II",
1970 "version": "v2beta1" 3311 "version": "v2beta1"
1971 } 3312 }
OLDNEW
« no previous file with comments | « discovery/googleapis/youtubereporting__v1.json ('k') | discovery/googleapis_beta/appengine__v1beta.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698