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

Issues Search
    My Issues | Starred     Open | Closed | All

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

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

Powered by Google App Engine
This is Rietveld 408576698