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

Side by Side Diff: discovery/googleapis/adexchangeseller__v2.0.json

Issue 612053002: Api roll 2: 2014-09-29 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Addressed more review comments Created 6 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/adexchange.seller": { 5 "https://www.googleapis.com/auth/adexchange.seller": {
6 "description": "View and manage your Ad Exchange data" 6 "description": "View and manage your Ad Exchange data"
7 }, 7 },
8 "https://www.googleapis.com/auth/adexchange.seller.readonly": { 8 "https://www.googleapis.com/auth/adexchange.seller.readonly": {
9 "description": "View your Ad Exchange data" 9 "description": "View your Ad Exchange data"
10 } 10 }
11 } 11 }
12 } 12 }
13 }, 13 },
14 "basePath": "/adexchangeseller/v1.1/", 14 "basePath": "/adexchangeseller/v2.0/",
15 "baseUrl": "https://www.googleapis.com/adexchangeseller/v1.1/", 15 "baseUrl": "https://www.googleapis.com/adexchangeseller/v2.0/",
16 "batchPath": "batch", 16 "batchPath": "batch",
17 "canonicalName": "Ad Exchange Seller", 17 "canonicalName": "Ad Exchange Seller",
18 "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports", 18 "description": "Gives Ad Exchange seller users access to their inventory and the ability to generate reports",
19 "discoveryVersion": "v1", 19 "discoveryVersion": "v1",
20 "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/ ", 20 "documentationLink": "https://developers.google.com/ad-exchange/seller-rest/ ",
21 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/bok_hcSdBm1EdbGDzvvOPwoa2gI\"", 21 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/0shkiGXf4cKks9c34Wn8kZ2sXrA\"",
22 "icons": { 22 "icons": {
23 "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif", 23 "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
24 "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif" 24 "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
25 }, 25 },
26 "id": "adexchangeseller:v1.1", 26 "id": "adexchangeseller:v2.0",
27 "kind": "discovery#restDescription", 27 "kind": "discovery#restDescription",
28 "name": "adexchangeseller", 28 "name": "adexchangeseller",
29 "ownerDomain": "google.com", 29 "ownerDomain": "google.com",
30 "ownerName": "Google", 30 "ownerName": "Google",
31 "parameters": { 31 "parameters": {
32 "alt": { 32 "alt": {
33 "default": "json", 33 "default": "json",
34 "description": "Data format for the response.", 34 "description": "Data format for the response.",
35 "enum": [ 35 "enum": [
36 "csv", 36 "csv",
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
95 } 95 }
96 }, 96 },
97 "path": "accounts/{accountId}", 97 "path": "accounts/{accountId}",
98 "response": { 98 "response": {
99 "$ref": "Account" 99 "$ref": "Account"
100 }, 100 },
101 "scopes": [ 101 "scopes": [
102 "https://www.googleapis.com/auth/adexchange.seller", 102 "https://www.googleapis.com/auth/adexchange.seller",
103 "https://www.googleapis.com/auth/adexchange.seller.reado nly" 103 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
104 ] 104 ]
105 } 105 },
106 }
107 },
108 "adclients": {
109 "methods": {
110 "list": { 106 "list": {
111 "description": "List all ad clients in this Ad Exchange acco unt.", 107 "description": "List all accounts available to this Ad Excha nge account.",
112 "httpMethod": "GET", 108 "httpMethod": "GET",
113 "id": "adexchangeseller.adclients.list", 109 "id": "adexchangeseller.accounts.list",
114 "parameters": { 110 "parameters": {
115 "maxResults": { 111 "maxResults": {
116 "description": "The maximum number of ad clients to include in the response, used for paging.", 112 "description": "The maximum number of accounts to in clude in the response, used for paging.",
117 "format": "uint32", 113 "format": "int32",
118 "location": "query", 114 "location": "query",
119 "maximum": "10000", 115 "maximum": "10000",
120 "minimum": "0", 116 "minimum": "0",
121 "type": "integer" 117 "type": "integer"
122 }, 118 },
123 "pageToken": { 119 "pageToken": {
124 "description": "A continuation token, used to page t hrough ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.", 120 "description": "A continuation token, used to page t hrough accounts. To retrieve the next page, set this parameter to the value of \ "nextPageToken\" from the previous response.",
125 "location": "query", 121 "location": "query",
126 "type": "string" 122 "type": "string"
127 } 123 }
128 }, 124 },
129 "path": "adclients", 125 "path": "accounts",
130 "response": { 126 "response": {
131 "$ref": "AdClients" 127 "$ref": "Accounts"
132 }, 128 },
133 "scopes": [ 129 "scopes": [
134 "https://www.googleapis.com/auth/adexchange.seller", 130 "https://www.googleapis.com/auth/adexchange.seller",
135 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
136 ]
137 }
138 }
139 },
140 "adunits": {
141 "methods": {
142 "get": {
143 "description": "Gets the specified ad unit in the specified ad client.",
144 "httpMethod": "GET",
145 "id": "adexchangeseller.adunits.get",
146 "parameterOrder": [
147 "adClientId",
148 "adUnitId"
149 ],
150 "parameters": {
151 "adClientId": {
152 "description": "Ad client for which to get the ad un it.",
153 "location": "path",
154 "required": true,
155 "type": "string"
156 },
157 "adUnitId": {
158 "description": "Ad unit to retrieve.",
159 "location": "path",
160 "required": true,
161 "type": "string"
162 }
163 },
164 "path": "adclients/{adClientId}/adunits/{adUnitId}",
165 "response": {
166 "$ref": "AdUnit"
167 },
168 "scopes": [
169 "https://www.googleapis.com/auth/adexchange.seller",
170 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
171 ]
172 },
173 "list": {
174 "description": "List all ad units in the specified ad client for this Ad Exchange account.",
175 "httpMethod": "GET",
176 "id": "adexchangeseller.adunits.list",
177 "parameterOrder": [
178 "adClientId"
179 ],
180 "parameters": {
181 "adClientId": {
182 "description": "Ad client for which to list ad units .",
183 "location": "path",
184 "required": true,
185 "type": "string"
186 },
187 "includeInactive": {
188 "description": "Whether to include inactive ad units . Default: true.",
189 "location": "query",
190 "type": "boolean"
191 },
192 "maxResults": {
193 "description": "The maximum number of ad units to in clude in the response, used for paging.",
194 "format": "uint32",
195 "location": "query",
196 "maximum": "10000",
197 "minimum": "0",
198 "type": "integer"
199 },
200 "pageToken": {
201 "description": "A continuation token, used to page t hrough ad units. To retrieve the next page, set this parameter to the value of \ "nextPageToken\" from the previous response.",
202 "location": "query",
203 "type": "string"
204 }
205 },
206 "path": "adclients/{adClientId}/adunits",
207 "response": {
208 "$ref": "AdUnits"
209 },
210 "scopes": [
211 "https://www.googleapis.com/auth/adexchange.seller",
212 "https://www.googleapis.com/auth/adexchange.seller.reado nly" 131 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
213 ] 132 ]
214 } 133 }
215 }, 134 },
216 "resources": { 135 "resources": {
217 "customchannels": { 136 "adclients": {
218 "methods": { 137 "methods": {
219 "list": { 138 "list": {
220 "description": "List all custom channels which the s pecified ad unit belongs to.", 139 "description": "List all ad clients in this Ad Excha nge account.",
221 "httpMethod": "GET", 140 "httpMethod": "GET",
222 "id": "adexchangeseller.adunits.customchannels.list" , 141 "id": "adexchangeseller.accounts.adclients.list",
223 "parameterOrder": [ 142 "parameterOrder": [
224 "adClientId", 143 "accountId"
225 "adUnitId"
226 ], 144 ],
227 "parameters": { 145 "parameters": {
228 "adClientId": { 146 "accountId": {
229 "description": "Ad client which contains the ad unit.", 147 "description": "Account to which the ad clie nt belongs.",
230 "location": "path",
231 "required": true,
232 "type": "string"
233 },
234 "adUnitId": {
235 "description": "Ad unit for which to list cu stom channels.",
236 "location": "path", 148 "location": "path",
237 "required": true, 149 "required": true,
238 "type": "string" 150 "type": "string"
239 }, 151 },
240 "maxResults": { 152 "maxResults": {
241 "description": "The maximum number of custom channels to include in the response, used for paging.", 153 "description": "The maximum number of ad cli ents to include in the response, used for paging.",
242 "format": "uint32", 154 "format": "uint32",
243 "location": "query", 155 "location": "query",
244 "maximum": "10000", 156 "maximum": "10000",
245 "minimum": "0", 157 "minimum": "0",
246 "type": "integer" 158 "type": "integer"
247 }, 159 },
248 "pageToken": { 160 "pageToken": {
249 "description": "A continuation token, used t o page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.", 161 "description": "A continuation token, used t o page through ad clients. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
250 "location": "query", 162 "location": "query",
251 "type": "string" 163 "type": "string"
252 } 164 }
253 }, 165 },
254 "path": "adclients/{adClientId}/adunits/{adUnitId}/c ustomchannels", 166 "path": "accounts/{accountId}/adclients",
255 "response": { 167 "response": {
256 "$ref": "CustomChannels" 168 "$ref": "AdClients"
257 }, 169 },
258 "scopes": [ 170 "scopes": [
259 "https://www.googleapis.com/auth/adexchange.sell er", 171 "https://www.googleapis.com/auth/adexchange.sell er",
260 "https://www.googleapis.com/auth/adexchange.sell er.readonly" 172 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
261 ] 173 ]
262 } 174 }
263 } 175 }
264 }
265 }
266 },
267 "alerts": {
268 "methods": {
269 "list": {
270 "description": "List the alerts for this Ad Exchange account .",
271 "httpMethod": "GET",
272 "id": "adexchangeseller.alerts.list",
273 "parameters": {
274 "locale": {
275 "description": "The locale to use for translating al ert messages. The account locale will be used if this is not supplied. The AdSen se default (English) will be used if the supplied locale is invalid or unsupport ed.",
276 "location": "query",
277 "type": "string"
278 }
279 },
280 "path": "alerts",
281 "response": {
282 "$ref": "Alerts"
283 },
284 "scopes": [
285 "https://www.googleapis.com/auth/adexchange.seller",
286 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
287 ]
288 }
289 }
290 },
291 "customchannels": {
292 "methods": {
293 "get": {
294 "description": "Get the specified custom channel from the sp ecified ad client.",
295 "httpMethod": "GET",
296 "id": "adexchangeseller.customchannels.get",
297 "parameterOrder": [
298 "adClientId",
299 "customChannelId"
300 ],
301 "parameters": {
302 "adClientId": {
303 "description": "Ad client which contains the custom channel.",
304 "location": "path",
305 "required": true,
306 "type": "string"
307 },
308 "customChannelId": {
309 "description": "Custom channel to retrieve.",
310 "location": "path",
311 "required": true,
312 "type": "string"
313 }
314 },
315 "path": "adclients/{adClientId}/customchannels/{customChanne lId}",
316 "response": {
317 "$ref": "CustomChannel"
318 },
319 "scopes": [
320 "https://www.googleapis.com/auth/adexchange.seller",
321 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
322 ]
323 }, 176 },
324 "list": { 177 "alerts": {
325 "description": "List all custom channels in the specified ad client for this Ad Exchange account.",
326 "httpMethod": "GET",
327 "id": "adexchangeseller.customchannels.list",
328 "parameterOrder": [
329 "adClientId"
330 ],
331 "parameters": {
332 "adClientId": {
333 "description": "Ad client for which to list custom c hannels.",
334 "location": "path",
335 "required": true,
336 "type": "string"
337 },
338 "maxResults": {
339 "description": "The maximum number of custom channel s to include in the response, used for paging.",
340 "format": "uint32",
341 "location": "query",
342 "maximum": "10000",
343 "minimum": "0",
344 "type": "integer"
345 },
346 "pageToken": {
347 "description": "A continuation token, used to page t hrough custom channels. To retrieve the next page, set this parameter to the val ue of \"nextPageToken\" from the previous response.",
348 "location": "query",
349 "type": "string"
350 }
351 },
352 "path": "adclients/{adClientId}/customchannels",
353 "response": {
354 "$ref": "CustomChannels"
355 },
356 "scopes": [
357 "https://www.googleapis.com/auth/adexchange.seller",
358 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
359 ]
360 }
361 },
362 "resources": {
363 "adunits": {
364 "methods": { 178 "methods": {
365 "list": { 179 "list": {
366 "description": "List all ad units in the specified c ustom channel.", 180 "description": "List the alerts for this Ad Exchange account.",
367 "httpMethod": "GET", 181 "httpMethod": "GET",
368 "id": "adexchangeseller.customchannels.adunits.list" , 182 "id": "adexchangeseller.accounts.alerts.list",
369 "parameterOrder": [ 183 "parameterOrder": [
184 "accountId"
185 ],
186 "parameters": {
187 "accountId": {
188 "description": "Account owning the alerts.",
189 "location": "path",
190 "required": true,
191 "type": "string"
192 },
193 "locale": {
194 "description": "The locale to use for transl ating alert messages. The account locale will be used if this is not supplied. T he AdSense default (English) will be used if the supplied locale is invalid or u nsupported.",
195 "location": "query",
196 "type": "string"
197 }
198 },
199 "path": "accounts/{accountId}/alerts",
200 "response": {
201 "$ref": "Alerts"
202 },
203 "scopes": [
204 "https://www.googleapis.com/auth/adexchange.sell er",
205 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
206 ]
207 }
208 }
209 },
210 "customchannels": {
211 "methods": {
212 "get": {
213 "description": "Get the specified custom channel fro m the specified ad client.",
214 "httpMethod": "GET",
215 "id": "adexchangeseller.accounts.customchannels.get" ,
216 "parameterOrder": [
217 "accountId",
370 "adClientId", 218 "adClientId",
371 "customChannelId" 219 "customChannelId"
372 ], 220 ],
373 "parameters": { 221 "parameters": {
222 "accountId": {
223 "description": "Account to which the ad clie nt belongs.",
224 "location": "path",
225 "required": true,
226 "type": "string"
227 },
374 "adClientId": { 228 "adClientId": {
375 "description": "Ad client which contains the custom channel.", 229 "description": "Ad client which contains the custom channel.",
376 "location": "path", 230 "location": "path",
377 "required": true, 231 "required": true,
378 "type": "string" 232 "type": "string"
379 }, 233 },
380 "customChannelId": { 234 "customChannelId": {
381 "description": "Custom channel for which to list ad units.", 235 "description": "Custom channel to retrieve." ,
236 "location": "path",
237 "required": true,
238 "type": "string"
239 }
240 },
241 "path": "accounts/{accountId}/adclients/{adClientId} /customchannels/{customChannelId}",
242 "response": {
243 "$ref": "CustomChannel"
244 },
245 "scopes": [
246 "https://www.googleapis.com/auth/adexchange.sell er",
247 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
248 ]
249 },
250 "list": {
251 "description": "List all custom channels in the spec ified ad client for this Ad Exchange account.",
252 "httpMethod": "GET",
253 "id": "adexchangeseller.accounts.customchannels.list ",
254 "parameterOrder": [
255 "accountId",
256 "adClientId"
257 ],
258 "parameters": {
259 "accountId": {
260 "description": "Account to which the ad clie nt belongs.",
382 "location": "path", 261 "location": "path",
383 "required": true, 262 "required": true,
384 "type": "string" 263 "type": "string"
385 }, 264 },
386 "includeInactive": { 265 "adClientId": {
387 "description": "Whether to include inactive ad units. Default: true.", 266 "description": "Ad client for which to list custom channels.",
388 "location": "query", 267 "location": "path",
389 "type": "boolean" 268 "required": true,
269 "type": "string"
390 }, 270 },
391 "maxResults": { 271 "maxResults": {
392 "description": "The maximum number of ad uni ts to include in the response, used for paging.", 272 "description": "The maximum number of custom channels to include in the response, used for paging.",
393 "format": "uint32", 273 "format": "uint32",
394 "location": "query", 274 "location": "query",
395 "maximum": "10000", 275 "maximum": "10000",
396 "minimum": "0", 276 "minimum": "0",
397 "type": "integer" 277 "type": "integer"
398 }, 278 },
399 "pageToken": { 279 "pageToken": {
400 "description": "A continuation token, used t o page through ad units. To retrieve the next page, set this parameter to the va lue of \"nextPageToken\" from the previous response.", 280 "description": "A continuation token, used t o page through custom channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
401 "location": "query", 281 "location": "query",
402 "type": "string" 282 "type": "string"
403 } 283 }
404 }, 284 },
405 "path": "adclients/{adClientId}/customchannels/{cust omChannelId}/adunits", 285 "path": "accounts/{accountId}/adclients/{adClientId} /customchannels",
406 "response": { 286 "response": {
407 "$ref": "AdUnits" 287 "$ref": "CustomChannels"
408 }, 288 },
409 "scopes": [ 289 "scopes": [
410 "https://www.googleapis.com/auth/adexchange.sell er", 290 "https://www.googleapis.com/auth/adexchange.sell er",
411 "https://www.googleapis.com/auth/adexchange.sell er.readonly" 291 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
412 ] 292 ]
413 } 293 }
414 } 294 }
415 } 295 },
416 } 296 "metadata": {
417 }, 297 "resources": {
418 "metadata": { 298 "dimensions": {
419 "resources": { 299 "methods": {
420 "dimensions": { 300 "list": {
301 "description": "List the metadata for the di mensions available to this AdExchange account.",
302 "httpMethod": "GET",
303 "id": "adexchangeseller.accounts.metadata.di mensions.list",
304 "parameterOrder": [
305 "accountId"
306 ],
307 "parameters": {
308 "accountId": {
309 "description": "Account with visibil ity to the dimensions.",
310 "location": "path",
311 "required": true,
312 "type": "string"
313 }
314 },
315 "path": "accounts/{accountId}/metadata/dimen sions",
316 "response": {
317 "$ref": "Metadata"
318 },
319 "scopes": [
320 "https://www.googleapis.com/auth/adexcha nge.seller",
321 "https://www.googleapis.com/auth/adexcha nge.seller.readonly"
322 ]
323 }
324 }
325 },
326 "metrics": {
327 "methods": {
328 "list": {
329 "description": "List the metadata for the me trics available to this AdExchange account.",
330 "httpMethod": "GET",
331 "id": "adexchangeseller.accounts.metadata.me trics.list",
332 "parameterOrder": [
333 "accountId"
334 ],
335 "parameters": {
336 "accountId": {
337 "description": "Account with visibil ity to the metrics.",
338 "location": "path",
339 "required": true,
340 "type": "string"
341 }
342 },
343 "path": "accounts/{accountId}/metadata/metri cs",
344 "response": {
345 "$ref": "Metadata"
346 },
347 "scopes": [
348 "https://www.googleapis.com/auth/adexcha nge.seller",
349 "https://www.googleapis.com/auth/adexcha nge.seller.readonly"
350 ]
351 }
352 }
353 }
354 }
355 },
356 "preferreddeals": {
421 "methods": { 357 "methods": {
422 "list": { 358 "get": {
423 "description": "List the metadata for the dimensions available to this AdExchange account.", 359 "description": "Get information about the selected A d Exchange Preferred Deal.",
424 "httpMethod": "GET", 360 "httpMethod": "GET",
425 "id": "adexchangeseller.metadata.dimensions.list", 361 "id": "adexchangeseller.accounts.preferreddeals.get" ,
426 "path": "metadata/dimensions", 362 "parameterOrder": [
363 "accountId",
364 "dealId"
365 ],
366 "parameters": {
367 "accountId": {
368 "description": "Account owning the deal.",
369 "location": "path",
370 "required": true,
371 "type": "string"
372 },
373 "dealId": {
374 "description": "Preferred deal to get inform ation about.",
375 "location": "path",
376 "required": true,
377 "type": "string"
378 }
379 },
380 "path": "accounts/{accountId}/preferreddeals/{dealId }",
427 "response": { 381 "response": {
428 "$ref": "Metadata" 382 "$ref": "PreferredDeal"
429 }, 383 },
430 "scopes": [ 384 "scopes": [
431 "https://www.googleapis.com/auth/adexchange.sell er", 385 "https://www.googleapis.com/auth/adexchange.sell er",
432 "https://www.googleapis.com/auth/adexchange.sell er.readonly" 386 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
433 ] 387 ]
434 } 388 },
435 }
436 },
437 "metrics": {
438 "methods": {
439 "list": { 389 "list": {
440 "description": "List the metadata for the metrics av ailable to this AdExchange account.", 390 "description": "List the preferred deals for this Ad Exchange account.",
441 "httpMethod": "GET", 391 "httpMethod": "GET",
442 "id": "adexchangeseller.metadata.metrics.list", 392 "id": "adexchangeseller.accounts.preferreddeals.list ",
443 "path": "metadata/metrics", 393 "parameterOrder": [
394 "accountId"
395 ],
396 "parameters": {
397 "accountId": {
398 "description": "Account owning the deals.",
399 "location": "path",
400 "required": true,
401 "type": "string"
402 }
403 },
404 "path": "accounts/{accountId}/preferreddeals",
444 "response": { 405 "response": {
445 "$ref": "Metadata" 406 "$ref": "PreferredDeals"
446 }, 407 },
447 "scopes": [ 408 "scopes": [
448 "https://www.googleapis.com/auth/adexchange.sell er", 409 "https://www.googleapis.com/auth/adexchange.sell er",
449 "https://www.googleapis.com/auth/adexchange.sell er.readonly" 410 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
450 ] 411 ]
451 } 412 }
452 } 413 }
453 }
454 }
455 },
456 "preferreddeals": {
457 "methods": {
458 "get": {
459 "description": "Get information about the selected Ad Exchan ge Preferred Deal.",
460 "httpMethod": "GET",
461 "id": "adexchangeseller.preferreddeals.get",
462 "parameterOrder": [
463 "dealId"
464 ],
465 "parameters": {
466 "dealId": {
467 "description": "Preferred deal to get information ab out.",
468 "location": "path",
469 "required": true,
470 "type": "string"
471 }
472 },
473 "path": "preferreddeals/{dealId}",
474 "response": {
475 "$ref": "PreferredDeal"
476 },
477 "scopes": [
478 "https://www.googleapis.com/auth/adexchange.seller",
479 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
480 ]
481 }, 414 },
482 "list": { 415 "reports": {
483 "description": "List the preferred deals for this Ad Exchang e account.",
484 "httpMethod": "GET",
485 "id": "adexchangeseller.preferreddeals.list",
486 "path": "preferreddeals",
487 "response": {
488 "$ref": "PreferredDeals"
489 },
490 "scopes": [
491 "https://www.googleapis.com/auth/adexchange.seller",
492 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
493 ]
494 }
495 }
496 },
497 "reports": {
498 "methods": {
499 "generate": {
500 "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retr ieve output in CSV format specify \"alt=csv\" as a query parameter.",
501 "httpMethod": "GET",
502 "id": "adexchangeseller.reports.generate",
503 "parameterOrder": [
504 "startDate",
505 "endDate"
506 ],
507 "parameters": {
508 "dimension": {
509 "description": "Dimensions to base the report on.",
510 "location": "query",
511 "pattern": "[a-zA-Z_]+",
512 "repeated": true,
513 "type": "string"
514 },
515 "endDate": {
516 "description": "End of the date range to report on i n \"YYYY-MM-DD\" format, inclusive.",
517 "location": "query",
518 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth |startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
519 "required": true,
520 "type": "string"
521 },
522 "filter": {
523 "description": "Filters to be run on the report.",
524 "location": "query",
525 "pattern": "[a-zA-Z_]+(==|=@).+",
526 "repeated": true,
527 "type": "string"
528 },
529 "locale": {
530 "description": "Optional locale to use for translati ng report output to a local language. Defaults to \"en_US\" if not specified.",
531 "location": "query",
532 "pattern": "[a-zA-Z_]+",
533 "type": "string"
534 },
535 "maxResults": {
536 "description": "The maximum number of rows of report data to return.",
537 "format": "uint32",
538 "location": "query",
539 "maximum": "50000",
540 "minimum": "0",
541 "type": "integer"
542 },
543 "metric": {
544 "description": "Numeric columns to include in the re port.",
545 "location": "query",
546 "pattern": "[a-zA-Z_]+",
547 "repeated": true,
548 "type": "string"
549 },
550 "sort": {
551 "description": "The name of a dimension or metric to sort the resulting report on, optionally prefixed with \"+\" to sort ascending or \"-\" to sort descending. If no prefix is specified, the column is sorted asc ending.",
552 "location": "query",
553 "pattern": "(\\+|-)?[a-zA-Z_]+",
554 "repeated": true,
555 "type": "string"
556 },
557 "startDate": {
558 "description": "Start of the date range to report on in \"YYYY-MM-DD\" format, inclusive.",
559 "location": "query",
560 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|startOfMonth |startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
561 "required": true,
562 "type": "string"
563 },
564 "startIndex": {
565 "description": "Index of the first row of report dat a to return.",
566 "format": "uint32",
567 "location": "query",
568 "maximum": "5000",
569 "minimum": "0",
570 "type": "integer"
571 }
572 },
573 "path": "reports",
574 "response": {
575 "$ref": "Report"
576 },
577 "scopes": [
578 "https://www.googleapis.com/auth/adexchange.seller",
579 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
580 ],
581 "supportsMediaDownload": true
582 }
583 },
584 "resources": {
585 "saved": {
586 "methods": { 416 "methods": {
587 "generate": { 417 "generate": {
588 "description": "Generate an Ad Exchange report based on the saved report ID sent in the query parameters.", 418 "description": "Generate an Ad Exchange report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify \"alt=csv\" as a query parameter.",
589 "httpMethod": "GET", 419 "httpMethod": "GET",
590 "id": "adexchangeseller.reports.saved.generate", 420 "id": "adexchangeseller.accounts.reports.generate",
591 "parameterOrder": [ 421 "parameterOrder": [
592 "savedReportId" 422 "accountId",
423 "startDate",
424 "endDate"
593 ], 425 ],
594 "parameters": { 426 "parameters": {
427 "accountId": {
428 "description": "Account which owns the gener ated report.",
429 "location": "path",
430 "required": true,
431 "type": "string"
432 },
433 "dimension": {
434 "description": "Dimensions to base the repor t on.",
435 "location": "query",
436 "pattern": "[a-zA-Z_]+",
437 "repeated": true,
438 "type": "string"
439 },
440 "endDate": {
441 "description": "End of the date range to rep ort on in \"YYYY-MM-DD\" format, inclusive.",
442 "location": "query",
443 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|star tOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
444 "required": true,
445 "type": "string"
446 },
447 "filter": {
448 "description": "Filters to be run on the rep ort.",
449 "location": "query",
450 "pattern": "[a-zA-Z_]+(==|=@).+",
451 "repeated": true,
452 "type": "string"
453 },
595 "locale": { 454 "locale": {
596 "description": "Optional locale to use for t ranslating report output to a local language. Defaults to \"en_US\" if not speci fied.", 455 "description": "Optional locale to use for t ranslating report output to a local language. Defaults to \"en_US\" if not speci fied.",
597 "location": "query", 456 "location": "query",
598 "pattern": "[a-zA-Z_]+", 457 "pattern": "[a-zA-Z_]+",
599 "type": "string" 458 "type": "string"
600 }, 459 },
601 "maxResults": { 460 "maxResults": {
602 "description": "The maximum number of rows o f report data to return.", 461 "description": "The maximum number of rows o f report data to return.",
603 "format": "int32", 462 "format": "uint32",
604 "location": "query", 463 "location": "query",
605 "maximum": "50000", 464 "maximum": "50000",
606 "minimum": "0", 465 "minimum": "0",
607 "type": "integer" 466 "type": "integer"
608 }, 467 },
609 "savedReportId": { 468 "metric": {
610 "description": "The saved report to retrieve .", 469 "description": "Numeric columns to include i n the report.",
611 "location": "path", 470 "location": "query",
471 "pattern": "[a-zA-Z_]+",
472 "repeated": true,
473 "type": "string"
474 },
475 "sort": {
476 "description": "The name of a dimension or m etric to sort the resulting report on, optionally prefixed with \"+\" to sort as cending or \"-\" to sort descending. If no prefix is specified, the column is so rted ascending.",
477 "location": "query",
478 "pattern": "(\\+|-)?[a-zA-Z_]+",
479 "repeated": true,
480 "type": "string"
481 },
482 "startDate": {
483 "description": "Start of the date range to r eport on in \"YYYY-MM-DD\" format, inclusive.",
484 "location": "query",
485 "pattern": "\\d{4}-\\d{2}-\\d{2}|(today|star tOfMonth|startOfYear)(([\\-\\+]\\d+[dwmy]){0,3}?)",
612 "required": true, 486 "required": true,
613 "type": "string" 487 "type": "string"
614 }, 488 },
615 "startIndex": { 489 "startIndex": {
616 "description": "Index of the first row of re port data to return.", 490 "description": "Index of the first row of re port data to return.",
617 "format": "int32", 491 "format": "uint32",
618 "location": "query", 492 "location": "query",
619 "maximum": "5000", 493 "maximum": "5000",
620 "minimum": "0", 494 "minimum": "0",
621 "type": "integer" 495 "type": "integer"
622 } 496 }
623 }, 497 },
624 "path": "reports/{savedReportId}", 498 "path": "accounts/{accountId}/reports",
625 "response": { 499 "response": {
626 "$ref": "Report" 500 "$ref": "Report"
627 }, 501 },
628 "scopes": [ 502 "scopes": [
629 "https://www.googleapis.com/auth/adexchange.sell er", 503 "https://www.googleapis.com/auth/adexchange.sell er",
630 "https://www.googleapis.com/auth/adexchange.sell er.readonly" 504 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
631 ] 505 ],
632 }, 506 "supportsMediaDownload": true
507 }
508 },
509 "resources": {
510 "saved": {
511 "methods": {
512 "generate": {
513 "description": "Generate an Ad Exchange repo rt based on the saved report ID sent in the query parameters.",
514 "httpMethod": "GET",
515 "id": "adexchangeseller.accounts.reports.sav ed.generate",
516 "parameterOrder": [
517 "accountId",
518 "savedReportId"
519 ],
520 "parameters": {
521 "accountId": {
522 "description": "Account owning the s aved report.",
523 "location": "path",
524 "required": true,
525 "type": "string"
526 },
527 "locale": {
528 "description": "Optional locale to u se for translating report output to a local language. Defaults to \"en_US\" if n ot specified.",
529 "location": "query",
530 "pattern": "[a-zA-Z_]+",
531 "type": "string"
532 },
533 "maxResults": {
534 "description": "The maximum number o f rows of report data to return.",
535 "format": "int32",
536 "location": "query",
537 "maximum": "50000",
538 "minimum": "0",
539 "type": "integer"
540 },
541 "savedReportId": {
542 "description": "The saved report to retrieve.",
543 "location": "path",
544 "required": true,
545 "type": "string"
546 },
547 "startIndex": {
548 "description": "Index of the first r ow of report data to return.",
549 "format": "int32",
550 "location": "query",
551 "maximum": "5000",
552 "minimum": "0",
553 "type": "integer"
554 }
555 },
556 "path": "accounts/{accountId}/reports/{saved ReportId}",
557 "response": {
558 "$ref": "Report"
559 },
560 "scopes": [
561 "https://www.googleapis.com/auth/adexcha nge.seller",
562 "https://www.googleapis.com/auth/adexcha nge.seller.readonly"
563 ]
564 },
565 "list": {
566 "description": "List all saved reports in th is Ad Exchange account.",
567 "httpMethod": "GET",
568 "id": "adexchangeseller.accounts.reports.sav ed.list",
569 "parameterOrder": [
570 "accountId"
571 ],
572 "parameters": {
573 "accountId": {
574 "description": "Account owning the s aved reports.",
575 "location": "path",
576 "required": true,
577 "type": "string"
578 },
579 "maxResults": {
580 "description": "The maximum number o f saved reports to include in the response, used for paging.",
581 "format": "int32",
582 "location": "query",
583 "maximum": "100",
584 "minimum": "0",
585 "type": "integer"
586 },
587 "pageToken": {
588 "description": "A continuation token , used to page through saved reports. To retrieve the next page, set this parame ter to the value of \"nextPageToken\" from the previous response.",
589 "location": "query",
590 "type": "string"
591 }
592 },
593 "path": "accounts/{accountId}/reports/saved" ,
594 "response": {
595 "$ref": "SavedReports"
596 },
597 "scopes": [
598 "https://www.googleapis.com/auth/adexcha nge.seller",
599 "https://www.googleapis.com/auth/adexcha nge.seller.readonly"
600 ]
601 }
602 }
603 }
604 }
605 },
606 "urlchannels": {
607 "methods": {
633 "list": { 608 "list": {
634 "description": "List all saved reports in this Ad Ex change account.", 609 "description": "List all URL channels in the specifi ed ad client for this Ad Exchange account.",
635 "httpMethod": "GET", 610 "httpMethod": "GET",
636 "id": "adexchangeseller.reports.saved.list", 611 "id": "adexchangeseller.accounts.urlchannels.list",
612 "parameterOrder": [
613 "accountId",
614 "adClientId"
615 ],
637 "parameters": { 616 "parameters": {
617 "accountId": {
618 "description": "Account to which the ad clie nt belongs.",
619 "location": "path",
620 "required": true,
621 "type": "string"
622 },
623 "adClientId": {
624 "description": "Ad client for which to list URL channels.",
625 "location": "path",
626 "required": true,
627 "type": "string"
628 },
638 "maxResults": { 629 "maxResults": {
639 "description": "The maximum number of saved reports to include in the response, used for paging.", 630 "description": "The maximum number of URL ch annels to include in the response, used for paging.",
640 "format": "int32", 631 "format": "uint32",
641 "location": "query", 632 "location": "query",
642 "maximum": "100", 633 "maximum": "10000",
643 "minimum": "0", 634 "minimum": "0",
644 "type": "integer" 635 "type": "integer"
645 }, 636 },
646 "pageToken": { 637 "pageToken": {
647 "description": "A continuation token, used t o page through saved reports. To retrieve the next page, set this parameter to t he value of \"nextPageToken\" from the previous response.", 638 "description": "A continuation token, used t o page through URL channels. To retrieve the next page, set this parameter to th e value of \"nextPageToken\" from the previous response.",
648 "location": "query", 639 "location": "query",
649 "type": "string" 640 "type": "string"
650 } 641 }
651 }, 642 },
652 "path": "reports/saved", 643 "path": "accounts/{accountId}/adclients/{adClientId} /urlchannels",
653 "response": { 644 "response": {
654 "$ref": "SavedReports" 645 "$ref": "UrlChannels"
655 }, 646 },
656 "scopes": [ 647 "scopes": [
657 "https://www.googleapis.com/auth/adexchange.sell er", 648 "https://www.googleapis.com/auth/adexchange.sell er",
658 "https://www.googleapis.com/auth/adexchange.sell er.readonly" 649 "https://www.googleapis.com/auth/adexchange.sell er.readonly"
659 ] 650 ]
660 } 651 }
661 } 652 }
662 } 653 }
663 } 654 }
664 },
665 "urlchannels": {
666 "methods": {
667 "list": {
668 "description": "List all URL channels in the specified ad cl ient for this Ad Exchange account.",
669 "httpMethod": "GET",
670 "id": "adexchangeseller.urlchannels.list",
671 "parameterOrder": [
672 "adClientId"
673 ],
674 "parameters": {
675 "adClientId": {
676 "description": "Ad client for which to list URL chan nels.",
677 "location": "path",
678 "required": true,
679 "type": "string"
680 },
681 "maxResults": {
682 "description": "The maximum number of URL channels t o include in the response, used for paging.",
683 "format": "uint32",
684 "location": "query",
685 "maximum": "10000",
686 "minimum": "0",
687 "type": "integer"
688 },
689 "pageToken": {
690 "description": "A continuation token, used to page t hrough URL channels. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response.",
691 "location": "query",
692 "type": "string"
693 }
694 },
695 "path": "adclients/{adClientId}/urlchannels",
696 "response": {
697 "$ref": "UrlChannels"
698 },
699 "scopes": [
700 "https://www.googleapis.com/auth/adexchange.seller",
701 "https://www.googleapis.com/auth/adexchange.seller.reado nly"
702 ]
703 }
704 }
705 } 655 }
706 }, 656 },
707 "revision": "20140921", 657 "revision": "20140924",
708 "rootUrl": "https://www.googleapis.com/", 658 "rootUrl": "https://www.googleapis.com/",
709 "schemas": { 659 "schemas": {
710 "Account": { 660 "Account": {
711 "id": "Account", 661 "id": "Account",
712 "properties": { 662 "properties": {
713 "id": { 663 "id": {
714 "description": "Unique identifier of this account.", 664 "description": "Unique identifier of this account.",
715 "type": "string" 665 "type": "string"
716 }, 666 },
717 "kind": { 667 "kind": {
718 "default": "adexchangeseller#account", 668 "default": "adexchangeseller#account",
719 "description": "Kind of resource this is, in this case adexc hangeseller#account.", 669 "description": "Kind of resource this is, in this case adexc hangeseller#account.",
720 "type": "string" 670 "type": "string"
721 }, 671 },
722 "name": { 672 "name": {
723 "description": "Name of this account.", 673 "description": "Name of this account.",
724 "type": "string" 674 "type": "string"
725 } 675 }
726 }, 676 },
727 "type": "object" 677 "type": "object"
728 }, 678 },
679 "Accounts": {
680 "id": "Accounts",
681 "properties": {
682 "etag": {
683 "description": "ETag of this response for caching purposes." ,
684 "type": "string"
685 },
686 "items": {
687 "description": "The accounts returned in this list response. ",
688 "items": {
689 "$ref": "Account"
690 },
691 "type": "array"
692 },
693 "kind": {
694 "default": "adexchangeseller#accounts",
695 "description": "Kind of list this is, in this case adexchang eseller#accounts.",
696 "type": "string"
697 },
698 "nextPageToken": {
699 "description": "Continuation token used to page through acco unts. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
700 "type": "string"
701 }
702 },
703 "type": "object"
704 },
729 "AdClient": { 705 "AdClient": {
730 "id": "AdClient", 706 "id": "AdClient",
731 "properties": { 707 "properties": {
732 "arcOptIn": { 708 "arcOptIn": {
733 "description": "Whether this ad client is opted in to ARC.", 709 "description": "Whether this ad client is opted in to ARC.",
734 "type": "boolean" 710 "type": "boolean"
735 }, 711 },
736 "id": { 712 "id": {
737 "description": "Unique identifier of this ad client.", 713 "description": "Unique identifier of this ad client.",
738 "type": "string" 714 "type": "string"
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after
772 "description": "Kind of list this is, in this case adexchang eseller#adClients.", 748 "description": "Kind of list this is, in this case adexchang eseller#adClients.",
773 "type": "string" 749 "type": "string"
774 }, 750 },
775 "nextPageToken": { 751 "nextPageToken": {
776 "description": "Continuation token used to page through ad c lients. To retrieve the next page of results, set the next request's \"pageToken \" value to this.", 752 "description": "Continuation token used to page through ad c lients. To retrieve the next page of results, set the next request's \"pageToken \" value to this.",
777 "type": "string" 753 "type": "string"
778 } 754 }
779 }, 755 },
780 "type": "object" 756 "type": "object"
781 }, 757 },
782 "AdUnit": {
783 "id": "AdUnit",
784 "properties": {
785 "code": {
786 "description": "Identity code of this ad unit, not necessari ly unique across ad clients.",
787 "type": "string"
788 },
789 "id": {
790 "description": "Unique identifier of this ad unit. This shou ld be considered an opaque identifier; it is not safe to rely on it being in any particular format.",
791 "type": "string"
792 },
793 "kind": {
794 "default": "adexchangeseller#adUnit",
795 "description": "Kind of resource this is, in this case adexc hangeseller#adUnit.",
796 "type": "string"
797 },
798 "name": {
799 "description": "Name of this ad unit.",
800 "type": "string"
801 },
802 "status": {
803 "description": "Status of this ad unit. Possible values are: \nNEW: Indicates that the ad unit was created within the last seven days and doe s not yet have any activity associated with it.\n\nACTIVE: Indicates that there has been activity on this ad unit in the last seven days.\n\nINACTIVE: Indicates that there has been no activity on this ad unit in the last seven days.",
804 "type": "string"
805 }
806 },
807 "type": "object"
808 },
809 "AdUnits": {
810 "id": "AdUnits",
811 "properties": {
812 "etag": {
813 "description": "ETag of this response for caching purposes." ,
814 "type": "string"
815 },
816 "items": {
817 "description": "The ad units returned in this list response. ",
818 "items": {
819 "$ref": "AdUnit"
820 },
821 "type": "array"
822 },
823 "kind": {
824 "default": "adexchangeseller#adUnits",
825 "description": "Kind of list this is, in this case adexchang eseller#adUnits.",
826 "type": "string"
827 },
828 "nextPageToken": {
829 "description": "Continuation token used to page through ad u nits. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
830 "type": "string"
831 }
832 },
833 "type": "object"
834 },
835 "Alert": { 758 "Alert": {
836 "id": "Alert", 759 "id": "Alert",
837 "properties": { 760 "properties": {
838 "id": { 761 "id": {
839 "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any p articular format.", 762 "description": "Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any p articular format.",
840 "type": "string" 763 "type": "string"
841 }, 764 },
842 "kind": { 765 "kind": {
843 "default": "adexchangeseller#alert", 766 "default": "adexchangeseller#alert",
844 "description": "Kind of resource this is, in this case adexc hangeseller#alert.", 767 "description": "Kind of resource this is, in this case adexc hangeseller#alert.",
(...skipping 383 matching lines...) Expand 10 before | Expand all | Expand 10 after
1228 "type": "string" 1151 "type": "string"
1229 }, 1152 },
1230 "nextPageToken": { 1153 "nextPageToken": {
1231 "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageTok en\" value to this.", 1154 "description": "Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's \"pageTok en\" value to this.",
1232 "type": "string" 1155 "type": "string"
1233 } 1156 }
1234 }, 1157 },
1235 "type": "object" 1158 "type": "object"
1236 } 1159 }
1237 }, 1160 },
1238 "servicePath": "adexchangeseller/v1.1/", 1161 "servicePath": "adexchangeseller/v2.0/",
1239 "title": "Ad Exchange Seller API", 1162 "title": "Ad Exchange Seller API",
1240 "version": "v1.1" 1163 "version": "v2.0"
1241 } 1164 }
OLDNEW
« no previous file with comments | « discovery/googleapis/adexchangeseller__v1.1.json ('k') | discovery/googleapis/adsense__v1.4.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698