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

Side by Side Diff: discovery/googleapis/youtubereporting__v1.json

Issue 2649893002: Api-roll 44: 2017-01-23 (Closed)
Patch Set: Created 3 years, 11 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/yt-analytics.readonly": {
6 "description": "View YouTube Analytics reports for your YouT ube content"
7 },
5 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly" : { 8 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly" : {
6 "description": "View monetary and non-monetary YouTube Analy tics reports for your YouTube content" 9 "description": "View monetary and non-monetary YouTube Analy tics reports for your YouTube content"
7 },
8 "https://www.googleapis.com/auth/yt-analytics.readonly": {
9 "description": "View YouTube Analytics reports for your YouT ube content"
10 } 10 }
11 } 11 }
12 } 12 }
13 }, 13 },
14 "basePath": "", 14 "basePath": "",
15 "baseUrl": "https://youtubereporting.googleapis.com/", 15 "baseUrl": "https://youtubereporting.googleapis.com/",
16 "batchPath": "batch", 16 "batchPath": "batch",
17 "canonicalName": "YouTube Reporting", 17 "canonicalName": "YouTube Reporting",
18 "description": "Schedules reporting jobs containing your YouTube Analytics d ata and downloads the resulting bulk data reports in the form of CSV files.", 18 "description": "Schedules reporting jobs containing your YouTube Analytics d ata and downloads the resulting bulk data reports in the form of CSV files.",
19 "discoveryVersion": "v1", 19 "discoveryVersion": "v1",
20 "documentationLink": "https://developers.google.com/youtube/reporting/v1/rep orts/", 20 "documentationLink": "https://developers.google.com/youtube/reporting/v1/rep orts/",
21 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/ym0RISeffUziZ77agVd4GWAEUYI\"",
22 "icons": { 21 "icons": {
23 "x16": "http://www.google.com/images/icons/product/search-16.gif", 22 "x16": "http://www.google.com/images/icons/product/search-16.gif",
24 "x32": "http://www.google.com/images/icons/product/search-32.gif" 23 "x32": "http://www.google.com/images/icons/product/search-32.gif"
25 }, 24 },
26 "id": "youtubereporting:v1", 25 "id": "youtubereporting:v1",
27 "kind": "discovery#restDescription", 26 "kind": "discovery#restDescription",
28 "name": "youtubereporting", 27 "name": "youtubereporting",
29 "ownerDomain": "google.com", 28 "ownerDomain": "google.com",
30 "ownerName": "Google", 29 "ownerName": "Google",
31 "parameters": { 30 "parameters": {
32 "access_token": { 31 "access_token": {
33 "description": "OAuth access token.", 32 "description": "OAuth access token.",
34 "location": "query", 33 "location": "query",
35 "type": "string" 34 "type": "string"
36 }, 35 },
36 "prettyPrint": {
37 "default": "true",
38 "description": "Returns response with indentations and line breaks." ,
39 "location": "query",
40 "type": "boolean"
41 },
42 "key": {
43 "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.",
44 "location": "query",
45 "type": "string"
46 },
47 "quotaUser": {
48 "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.",
49 "location": "query",
50 "type": "string"
51 },
52 "pp": {
53 "default": "true",
54 "description": "Pretty-print response.",
55 "location": "query",
56 "type": "boolean"
57 },
58 "fields": {
59 "description": "Selector specifying which fields to include in a par tial response.",
60 "location": "query",
61 "type": "string"
62 },
37 "alt": { 63 "alt": {
38 "default": "json", 64 "default": "json",
39 "description": "Data format for response.", 65 "description": "Data format for response.",
66 "enum": [
67 "json",
68 "media",
69 "proto"
70 ],
40 "enumDescriptions": [ 71 "enumDescriptions": [
41 "Responses with Content-Type of application/json", 72 "Responses with Content-Type of application/json",
42 "Media download with context-dependent Content-Type", 73 "Media download with context-dependent Content-Type",
43 "Responses with Content-Type of application/x-protobuf" 74 "Responses with Content-Type of application/x-protobuf"
44 ], 75 ],
45 "location": "query", 76 "location": "query",
46 "type": "string" 77 "type": "string"
47 }, 78 },
48 "bearer_token": { 79 "$.xgafv": {
49 "description": "OAuth bearer token.", 80 "description": "V1 error format.",
81 "enum": [
82 "1",
83 "2"
84 ],
85 "enumDescriptions": [
86 "v1 error format",
87 "v2 error format"
88 ],
50 "location": "query", 89 "location": "query",
51 "type": "string" 90 "type": "string"
52 }, 91 },
53 "callback": { 92 "callback": {
54 "description": "JSONP", 93 "description": "JSONP",
55 "location": "query", 94 "location": "query",
56 "type": "string" 95 "type": "string"
57 }, 96 },
58 "fields": {
59 "description": "Selector specifying which fields to include in a par tial response.",
60 "location": "query",
61 "type": "string"
62 },
63 "key": {
64 "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.",
65 "location": "query",
66 "type": "string"
67 },
68 "oauth_token": { 97 "oauth_token": {
69 "description": "OAuth 2.0 token for the current user.", 98 "description": "OAuth 2.0 token for the current user.",
70 "location": "query", 99 "location": "query",
71 "type": "string" 100 "type": "string"
72 }, 101 },
73 "pp": { 102 "uploadType": {
74 "default": "true", 103 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
75 "description": "Pretty-print response.",
76 "location": "query",
77 "type": "boolean"
78 },
79 "prettyPrint": {
80 "default": "true",
81 "description": "Returns response with indentations and line breaks." ,
82 "location": "query",
83 "type": "boolean"
84 },
85 "quotaUser": {
86 "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.",
87 "location": "query", 104 "location": "query",
88 "type": "string" 105 "type": "string"
89 }, 106 },
107 "bearer_token": {
108 "description": "OAuth bearer token.",
109 "location": "query",
110 "type": "string"
111 },
90 "upload_protocol": { 112 "upload_protocol": {
91 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
92 "location": "query", 114 "location": "query",
93 "type": "string" 115 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "$.xgafv": {
101 "description": "V1 error format.",
102 "enumDescriptions": [
103 "v1 error format",
104 "v2 error format"
105 ],
106 "location": "query",
107 "type": "string"
108 } 116 }
109 }, 117 },
110 "protocol": "rest", 118 "protocol": "rest",
111 "resources": { 119 "resources": {
112 "media": {
113 "methods": {
114 "download": {
115 "description": "Method for media download. Download is suppo rted on the URI `/v1/media/{+name}?alt=media`.",
116 "httpMethod": "GET",
117 "id": "youtubereporting.media.download",
118 "parameterOrder": [
119 "resourceName"
120 ],
121 "parameters": {
122 "resourceName": {
123 "description": "Name of the media that is being down loaded. See ReadRequest.resource_name.",
124 "location": "path",
125 "pattern": "^.*$",
126 "required": true,
127 "type": "string"
128 }
129 },
130 "path": "v1/media/{+resourceName}",
131 "response": {
132 "$ref": "Media"
133 },
134 "scopes": [
135 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
136 "https://www.googleapis.com/auth/yt-analytics.readonly"
137 ],
138 "supportsMediaDownload": true
139 }
140 }
141 },
142 "reportTypes": { 120 "reportTypes": {
143 "methods": { 121 "methods": {
144 "list": { 122 "list": {
145 "description": "Lists report types.", 123 "description": "Lists report types.",
146 "httpMethod": "GET", 124 "httpMethod": "GET",
147 "id": "youtubereporting.reportTypes.list", 125 "id": "youtubereporting.reportTypes.list",
126 "parameterOrder": [],
148 "parameters": { 127 "parameters": {
149 "onBehalfOfContentOwner": {
150 "description": "The content owner's external ID on w hich behalf the user is acting on. If not set, the user is acting for himself (h is own channel).",
151 "location": "query",
152 "type": "string"
153 },
154 "pageSize": { 128 "pageSize": {
155 "description": "Requested page size. Server may retu rn fewer report types than requested. If unspecified, server will pick an approp riate default.", 129 "description": "Requested page size. Server may retu rn fewer report types than requested.\nIf unspecified, server will pick an appro priate default.",
156 "format": "int32", 130 "format": "int32",
157 "location": "query", 131 "location": "query",
158 "type": "integer" 132 "type": "integer"
159 }, 133 },
160 "pageToken": { 134 "includeSystemManaged": {
161 "description": "A token identifying a page of result s the server should return. Typically, this is the value of ListReportTypesRespo nse.next_page_token returned in response to the previous call to the `ListReport Types` method.", 135 "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.",
136 "location": "query",
137 "type": "boolean"
138 },
139 "onBehalfOfContentOwner": {
140 "description": "The content owner's external ID on w hich behalf the user is acting on. If\nnot set, the user is acting for himself ( his own channel).",
162 "location": "query", 141 "location": "query",
163 "type": "string" 142 "type": "string"
164 }, 143 },
165 "includeSystemManaged": { 144 "pageToken": {
166 "description": "If set to true, also system-managed report types will be returned; otherwise only the report types that can be used to create new reporting jobs will be returned.", 145 "description": "A token identifying a page of result s the server should return. Typically,\nthis is the value of\nListReportTypesRes ponse.next_page_token\nreturned in response to the previous call to the `ListRep ortTypes` method.",
167 "location": "query", 146 "location": "query",
168 "type": "boolean" 147 "type": "string"
169 } 148 }
170 }, 149 },
171 "path": "v1/reportTypes", 150 "path": "v1/reportTypes",
172 "response": { 151 "response": {
173 "$ref": "ListReportTypesResponse" 152 "$ref": "ListReportTypesResponse"
174 }, 153 },
175 "scopes": [ 154 "scopes": [
176 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly", 155 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
177 "https://www.googleapis.com/auth/yt-analytics.readonly" 156 "https://www.googleapis.com/auth/yt-analytics.readonly"
178 ] 157 ]
179 } 158 }
180 } 159 }
181 }, 160 },
161 "media": {
162 "methods": {
163 "download": {
164 "description": "Method for media download. Download is suppo rted\non the URI `/v1/media/{+name}?alt=media`.",
165 "httpMethod": "GET",
166 "id": "youtubereporting.media.download",
167 "parameterOrder": [
168 "resourceName"
169 ],
170 "parameters": {
171 "resourceName": {
172 "description": "Name of the media that is being down loaded. See\nReadRequest.resource_name.",
173 "location": "path",
174 "pattern": "^.+$",
175 "required": true,
176 "type": "string"
177 }
178 },
179 "path": "v1/media/{+resourceName}",
180 "response": {
181 "$ref": "Media"
182 },
183 "scopes": [
184 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
185 "https://www.googleapis.com/auth/yt-analytics.readonly"
186 ],
187 "supportsMediaDownload": true
188 }
189 }
190 },
182 "jobs": { 191 "jobs": {
183 "methods": { 192 "methods": {
184 "create": { 193 "create": {
185 "description": "Creates a job and returns it.", 194 "description": "Creates a job and returns it.",
186 "httpMethod": "POST", 195 "httpMethod": "POST",
187 "id": "youtubereporting.jobs.create", 196 "id": "youtubereporting.jobs.create",
197 "parameterOrder": [],
188 "parameters": { 198 "parameters": {
189 "onBehalfOfContentOwner": { 199 "onBehalfOfContentOwner": {
190 "description": "The content owner's external ID on w hich behalf the user is acting on. If not set, the user is acting for himself (h is own channel).", 200 "description": "The content owner's external ID on w hich behalf the user is acting on. If\nnot set, the user is acting for himself ( his own channel).",
191 "location": "query", 201 "location": "query",
192 "type": "string" 202 "type": "string"
193 } 203 }
194 }, 204 },
195 "path": "v1/jobs", 205 "path": "v1/jobs",
196 "request": { 206 "request": {
197 "$ref": "Job" 207 "$ref": "Job"
198 }, 208 },
199 "response": { 209 "response": {
200 "$ref": "Job" 210 "$ref": "Job"
201 }, 211 },
202 "scopes": [ 212 "scopes": [
203 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly", 213 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
204 "https://www.googleapis.com/auth/yt-analytics.readonly" 214 "https://www.googleapis.com/auth/yt-analytics.readonly"
205 ] 215 ]
206 }, 216 },
207 "list": {
208 "description": "Lists jobs.",
209 "httpMethod": "GET",
210 "id": "youtubereporting.jobs.list",
211 "parameters": {
212 "onBehalfOfContentOwner": {
213 "description": "The content owner's external ID on w hich behalf the user is acting on. If not set, the user is acting for himself (h is own channel).",
214 "location": "query",
215 "type": "string"
216 },
217 "pageSize": {
218 "description": "Requested page size. Server may retu rn fewer jobs than requested. If unspecified, server will pick an appropriate de fault.",
219 "format": "int32",
220 "location": "query",
221 "type": "integer"
222 },
223 "pageToken": {
224 "description": "A token identifying a page of result s the server should return. Typically, this is the value of ListReportTypesRespo nse.next_page_token returned in response to the previous call to the `ListJobs` method.",
225 "location": "query",
226 "type": "string"
227 },
228 "includeSystemManaged": {
229 "description": "If set to true, also system-managed jobs will be returned; otherwise only user-created jobs will be returned. System -managed jobs can neither be modified nor deleted.",
230 "location": "query",
231 "type": "boolean"
232 }
233 },
234 "path": "v1/jobs",
235 "response": {
236 "$ref": "ListJobsResponse"
237 },
238 "scopes": [
239 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
240 "https://www.googleapis.com/auth/yt-analytics.readonly"
241 ]
242 },
243 "get": { 217 "get": {
244 "description": "Gets a job.", 218 "description": "Gets a job.",
245 "httpMethod": "GET", 219 "httpMethod": "GET",
246 "id": "youtubereporting.jobs.get", 220 "id": "youtubereporting.jobs.get",
247 "parameterOrder": [ 221 "parameterOrder": [
248 "jobId" 222 "jobId"
249 ], 223 ],
250 "parameters": { 224 "parameters": {
251 "jobId": { 225 "jobId": {
252 "description": "The ID of the job to retrieve.", 226 "description": "The ID of the job to retrieve.",
253 "location": "path", 227 "location": "path",
254 "required": true, 228 "required": true,
255 "type": "string" 229 "type": "string"
256 }, 230 },
257 "onBehalfOfContentOwner": { 231 "onBehalfOfContentOwner": {
258 "description": "The content owner's external ID on w hich behalf the user is acting on. If not set, the user is acting for himself (h is own channel).", 232 "description": "The content owner's external ID on w hich behalf the user is acting on. If\nnot set, the user is acting for himself ( his own channel).",
259 "location": "query", 233 "location": "query",
260 "type": "string" 234 "type": "string"
261 } 235 }
262 }, 236 },
263 "path": "v1/jobs/{jobId}", 237 "path": "v1/jobs/{jobId}",
264 "response": { 238 "response": {
265 "$ref": "Job" 239 "$ref": "Job"
266 }, 240 },
267 "scopes": [ 241 "scopes": [
268 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly", 242 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
243 "https://www.googleapis.com/auth/yt-analytics.readonly"
244 ]
245 },
246 "list": {
247 "description": "Lists jobs.",
248 "httpMethod": "GET",
249 "id": "youtubereporting.jobs.list",
250 "parameterOrder": [],
251 "parameters": {
252 "pageSize": {
253 "description": "Requested page size. Server may retu rn fewer jobs than requested.\nIf unspecified, server will pick an appropriate d efault.",
254 "format": "int32",
255 "location": "query",
256 "type": "integer"
257 },
258 "includeSystemManaged": {
259 "description": "If set to true, also system-managed jobs will be returned; otherwise only\nuser-created jobs will be returned. Syste m-managed jobs can neither be\nmodified nor deleted.",
260 "location": "query",
261 "type": "boolean"
262 },
263 "onBehalfOfContentOwner": {
264 "description": "The content owner's external ID on w hich behalf the user is acting on. If\nnot set, the user is acting for himself ( his own channel).",
265 "location": "query",
266 "type": "string"
267 },
268 "pageToken": {
269 "description": "A token identifying a page of result s the server should return. Typically,\nthis is the value of\nListReportTypesRes ponse.next_page_token\nreturned in response to the previous call to the `ListJob s` method.",
270 "location": "query",
271 "type": "string"
272 }
273 },
274 "path": "v1/jobs",
275 "response": {
276 "$ref": "ListJobsResponse"
277 },
278 "scopes": [
279 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
269 "https://www.googleapis.com/auth/yt-analytics.readonly" 280 "https://www.googleapis.com/auth/yt-analytics.readonly"
270 ] 281 ]
271 }, 282 },
272 "delete": { 283 "delete": {
273 "description": "Deletes a job.", 284 "description": "Deletes a job.",
274 "httpMethod": "DELETE", 285 "httpMethod": "DELETE",
275 "id": "youtubereporting.jobs.delete", 286 "id": "youtubereporting.jobs.delete",
276 "parameterOrder": [ 287 "parameterOrder": [
277 "jobId" 288 "jobId"
278 ], 289 ],
279 "parameters": { 290 "parameters": {
280 "jobId": { 291 "jobId": {
281 "description": "The ID of the job to delete.", 292 "description": "The ID of the job to delete.",
282 "location": "path", 293 "location": "path",
283 "required": true, 294 "required": true,
284 "type": "string" 295 "type": "string"
285 }, 296 },
286 "onBehalfOfContentOwner": { 297 "onBehalfOfContentOwner": {
287 "description": "The content owner's external ID on w hich behalf the user is acting on. If not set, the user is acting for himself (h is own channel).", 298 "description": "The content owner's external ID on w hich behalf the user is acting on. If\nnot set, the user is acting for himself ( his own channel).",
288 "location": "query", 299 "location": "query",
289 "type": "string" 300 "type": "string"
290 } 301 }
291 }, 302 },
292 "path": "v1/jobs/{jobId}", 303 "path": "v1/jobs/{jobId}",
293 "response": { 304 "response": {
294 "$ref": "Empty" 305 "$ref": "Empty"
295 }, 306 },
296 "scopes": [ 307 "scopes": [
297 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly", 308 "https://www.googleapis.com/auth/yt-analytics-monetary.r eadonly",
298 "https://www.googleapis.com/auth/yt-analytics.readonly" 309 "https://www.googleapis.com/auth/yt-analytics.readonly"
299 ] 310 ]
300 } 311 }
301 }, 312 },
302 "resources": { 313 "resources": {
303 "reports": { 314 "reports": {
304 "methods": { 315 "methods": {
305 "list": { 316 "get": {
306 "description": "Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.", 317 "description": "Gets the metadata of a specific repo rt.",
307 "httpMethod": "GET", 318 "httpMethod": "GET",
308 "id": "youtubereporting.jobs.reports.list", 319 "id": "youtubereporting.jobs.reports.get",
309 "parameterOrder": [ 320 "parameterOrder": [
310 "jobId" 321 "jobId",
322 "reportId"
311 ], 323 ],
312 "parameters": { 324 "parameters": {
313 "jobId": { 325 "jobId": {
314 "description": "The ID of the job.", 326 "description": "The ID of the job.",
315 "location": "path", 327 "location": "path",
316 "required": true, 328 "required": true,
317 "type": "string" 329 "type": "string"
318 }, 330 },
331 "reportId": {
332 "description": "The ID of the report to retr ieve.",
333 "location": "path",
334 "required": true,
335 "type": "string"
336 },
319 "onBehalfOfContentOwner": { 337 "onBehalfOfContentOwner": {
320 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for hi mself (his own channel).", 338 "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for h imself (his own channel).",
339 "location": "query",
340 "type": "string"
341 }
342 },
343 "path": "v1/jobs/{jobId}/reports/{reportId}",
344 "response": {
345 "$ref": "Report"
346 },
347 "scopes": [
348 "https://www.googleapis.com/auth/yt-analytics-mo netary.readonly",
349 "https://www.googleapis.com/auth/yt-analytics.re adonly"
350 ]
351 },
352 "list": {
353 "description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.",
354 "httpMethod": "GET",
355 "id": "youtubereporting.jobs.reports.list",
356 "parameterOrder": [
357 "jobId"
358 ],
359 "parameters": {
360 "onBehalfOfContentOwner": {
361 "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for h imself (his own channel).",
362 "location": "query",
363 "type": "string"
364 },
365 "startTimeAtOrAfter": {
366 "description": "If set, only reports whose s tart time is greater than or equal the\nspecified date/time are returned.",
367 "format": "google-datetime",
368 "location": "query",
369 "type": "string"
370 },
371 "startTimeBefore": {
372 "description": "If set, only reports whose s tart time is smaller than the specified\ndate/time are returned.",
373 "format": "google-datetime",
321 "location": "query", 374 "location": "query",
322 "type": "string" 375 "type": "string"
323 }, 376 },
324 "pageSize": { 377 "pageSize": {
325 "description": "Requested page size. Server may return fewer report types than requested. If unspecified, server will pick a n appropriate default.", 378 "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
326 "format": "int32", 379 "format": "int32",
327 "location": "query", 380 "location": "query",
328 "type": "integer" 381 "type": "integer"
329 }, 382 },
330 "pageToken": { 383 "createdAfter": {
331 "description": "A token identifying a page o f results the server should return. Typically, this is the value of ListReportsR esponse.next_page_token returned in response to the previous call to the `ListRe ports` method.", 384 "description": "If set, only reports created after the specified date/time are returned.",
385 "format": "google-datetime",
332 "location": "query", 386 "location": "query",
333 "type": "string" 387 "type": "string"
334 }, 388 },
335 "createdAfter": { 389 "jobId": {
336 "description": "If set, only reports created after the specified date/time are returned.", 390 "description": "The ID of the job.",
337 "location": "query", 391 "location": "path",
392 "required": true,
338 "type": "string" 393 "type": "string"
339 }, 394 },
340 "startTimeAtOrAfter": { 395 "pageToken": {
341 "description": "If set, only reports whose s tart time is greater than or equal the specified date/time are returned.", 396 "description": "A token identifying a page o f results the server should return. Typically,\nthis is the value of\nListReport sResponse.next_page_token\nreturned in response to the previous call to the `Lis tReports` method.",
342 "location": "query",
343 "type": "string"
344 },
345 "startTimeBefore": {
346 "description": "If set, only reports whose s tart time is smaller than the specified date/time are returned.",
347 "location": "query", 397 "location": "query",
348 "type": "string" 398 "type": "string"
349 } 399 }
350 }, 400 },
351 "path": "v1/jobs/{jobId}/reports", 401 "path": "v1/jobs/{jobId}/reports",
352 "response": { 402 "response": {
353 "$ref": "ListReportsResponse" 403 "$ref": "ListReportsResponse"
354 }, 404 },
355 "scopes": [ 405 "scopes": [
356 "https://www.googleapis.com/auth/yt-analytics-mo netary.readonly", 406 "https://www.googleapis.com/auth/yt-analytics-mo netary.readonly",
357 "https://www.googleapis.com/auth/yt-analytics.re adonly"
358 ]
359 },
360 "get": {
361 "description": "Gets the metadata of a specific repo rt.",
362 "httpMethod": "GET",
363 "id": "youtubereporting.jobs.reports.get",
364 "parameterOrder": [
365 "jobId",
366 "reportId"
367 ],
368 "parameters": {
369 "jobId": {
370 "description": "The ID of the job.",
371 "location": "path",
372 "required": true,
373 "type": "string"
374 },
375 "reportId": {
376 "description": "The ID of the report to retr ieve.",
377 "location": "path",
378 "required": true,
379 "type": "string"
380 },
381 "onBehalfOfContentOwner": {
382 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for hi mself (his own channel).",
383 "location": "query",
384 "type": "string"
385 }
386 },
387 "path": "v1/jobs/{jobId}/reports/{reportId}",
388 "response": {
389 "$ref": "Report"
390 },
391 "scopes": [
392 "https://www.googleapis.com/auth/yt-analytics-mo netary.readonly",
393 "https://www.googleapis.com/auth/yt-analytics.re adonly" 407 "https://www.googleapis.com/auth/yt-analytics.re adonly"
394 ] 408 ]
395 } 409 }
396 } 410 }
397 } 411 }
398 } 412 }
399 } 413 }
400 }, 414 },
401 "revision": "20160719", 415 "revision": "20170118",
402 "rootUrl": "https://youtubereporting.googleapis.com/", 416 "rootUrl": "https://youtubereporting.googleapis.com/",
403 "schemas": { 417 "schemas": {
418 "Report": {
419 "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
420 "id": "Report",
421 "properties": {
422 "id": {
423 "description": "The server-generated ID of the report.",
424 "type": "string"
425 },
426 "downloadUrl": {
427 "description": "The URL from which the report can be downloa ded (max. 1000 characters).",
428 "type": "string"
429 },
430 "endTime": {
431 "description": "The end of the time period that the report i nstance covers. The value is\nexclusive.",
432 "format": "google-datetime",
433 "type": "string"
434 },
435 "createTime": {
436 "description": "The date/time when this report was created." ,
437 "format": "google-datetime",
438 "type": "string"
439 },
440 "startTime": {
441 "description": "The start of the time period that the report instance covers. The value is\ninclusive.",
442 "format": "google-datetime",
443 "type": "string"
444 },
445 "jobExpireTime": {
446 "description": "The date/time when the job this report belon gs to will expire/expired.",
447 "format": "google-datetime",
448 "type": "string"
449 },
450 "jobId": {
451 "description": "The ID of the job that created this report." ,
452 "type": "string"
453 }
454 },
455 "type": "object"
456 },
457 "ListJobsResponse": {
458 "description": "Response message for ReportingService.ListJobs.",
459 "id": "ListJobsResponse",
460 "properties": {
461 "nextPageToken": {
462 "description": "A token to retrieve next page of results.\nP ass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results.",
463 "type": "string"
464 },
465 "jobs": {
466 "description": "The list of jobs.",
467 "items": {
468 "$ref": "Job"
469 },
470 "type": "array"
471 }
472 },
473 "type": "object"
474 },
404 "Media": { 475 "Media": {
405 "description": "Media resource.", 476 "description": "Media resource.",
406 "id": "Media", 477 "id": "Media",
407 "properties": { 478 "properties": {
408 "resourceName": { 479 "resourceName": {
409 "description": "Name of the media resource.", 480 "description": "Name of the media resource.",
410 "type": "string" 481 "type": "string"
411 } 482 }
412 }, 483 },
413 "type": "object" 484 "type": "object"
414 },
415 "ListReportTypesResponse": {
416 "description": "Response message for ReportingService.ListReportType s.",
417 "id": "ListReportTypesResponse",
418 "properties": {
419 "reportTypes": {
420 "description": "The list of report types.",
421 "items": {
422 "$ref": "ReportType"
423 },
424 "type": "array"
425 },
426 "nextPageToken": {
427 "description": "A token to retrieve next page of results. Pa ss this value in the ListReportTypesRequest.page_token field in the subsequent c all to `ListReportTypes` method to retrieve the next page of results.",
428 "type": "string"
429 }
430 },
431 "type": "object"
432 },
433 "ReportType": {
434 "description": "A report type.",
435 "id": "ReportType",
436 "properties": {
437 "id": {
438 "description": "The ID of the report type (max. 100 characte rs).",
439 "type": "string"
440 },
441 "name": {
442 "description": "The name of the report type (max. 100 charac ters).",
443 "type": "string"
444 },
445 "deprecateTime": {
446 "description": "The date/time when this report type was/will be deprecated.",
447 "type": "string"
448 },
449 "systemManaged": {
450 "description": "True if this a system-managed report type; o therwise false. Reporting jobs for system-managed report types are created autom atically and can thus not be used in the `CreateJob` method.",
451 "type": "boolean"
452 }
453 },
454 "type": "object"
455 }, 485 },
456 "Job": { 486 "Job": {
457 "description": "A job creating reports of a specific type.", 487 "description": "A job creating reports of a specific type.",
458 "id": "Job", 488 "id": "Job",
459 "properties": { 489 "properties": {
460 "id": { 490 "id": {
461 "description": "The server-generated ID of the job (max. 40 characters).", 491 "description": "The server-generated ID of the job (max. 40 characters).",
462 "type": "string" 492 "type": "string"
463 }, 493 },
464 "reportTypeId": { 494 "createTime": {
465 "description": "The type of reports this job creates. Corres ponds to the ID of a ReportType.", 495 "description": "The creation date/time of the job.",
496 "format": "google-datetime",
497 "type": "string"
498 },
499 "systemManaged": {
500 "description": "True if this a system-managed job that canno t be modified by the user;\notherwise false.",
501 "type": "boolean"
502 },
503 "expireTime": {
504 "description": "The date/time when this job will expire/expi red. After a job expired, no\nnew reports are generated.",
505 "format": "google-datetime",
466 "type": "string" 506 "type": "string"
467 }, 507 },
468 "name": { 508 "name": {
469 "description": "The name of the job (max. 100 characters).", 509 "description": "The name of the job (max. 100 characters).",
470 "type": "string" 510 "type": "string"
471 }, 511 },
472 "createTime": { 512 "reportTypeId": {
473 "description": "The creation date/time of the job.", 513 "description": "The type of reports this job creates. Corres ponds to the ID of a\nReportType.",
474 "type": "string"
475 },
476 "expireTime": {
477 "description": "The date/time when this job will expire/expi red. After a job expired, no new reports are generated.",
478 "type": "string"
479 },
480 "systemManaged": {
481 "description": "True if this a system-managed job that canno t be modified by the user; otherwise false.",
482 "type": "boolean"
483 }
484 },
485 "type": "object"
486 },
487 "ListJobsResponse": {
488 "description": "Response message for ReportingService.ListJobs.",
489 "id": "ListJobsResponse",
490 "properties": {
491 "jobs": {
492 "description": "The list of jobs.",
493 "items": {
494 "$ref": "Job"
495 },
496 "type": "array"
497 },
498 "nextPageToken": {
499 "description": "A token to retrieve next page of results. Pa ss this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results.",
500 "type": "string" 514 "type": "string"
501 } 515 }
502 }, 516 },
503 "type": "object" 517 "type": "object"
504 }, 518 },
505 "Empty": { 519 "Empty": {
506 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re presentation for `Empty` is empty JSON object `{}`.", 520 "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use i t as the request\nor the response type of an API method. For instance:\n\n se rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty );\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
507 "id": "Empty", 521 "id": "Empty",
522 "properties": {},
523 "type": "object"
524 },
525 "ReportType": {
526 "description": "A report type.",
527 "id": "ReportType",
528 "properties": {
529 "systemManaged": {
530 "description": "True if this a system-managed report type; o therwise false. Reporting jobs\nfor system-managed report types are created auto matically and can thus not\nbe used in the `CreateJob` method.",
531 "type": "boolean"
532 },
533 "deprecateTime": {
534 "description": "The date/time when this report type was/will be deprecated.",
535 "format": "google-datetime",
536 "type": "string"
537 },
538 "id": {
539 "description": "The ID of the report type (max. 100 characte rs).",
540 "type": "string"
541 },
542 "name": {
543 "description": "The name of the report type (max. 100 charac ters).",
544 "type": "string"
545 }
546 },
508 "type": "object" 547 "type": "object"
509 }, 548 },
510 "ListReportsResponse": { 549 "ListReportsResponse": {
511 "description": "Response message for ReportingService.ListReports.", 550 "description": "Response message for ReportingService.ListReports.",
512 "id": "ListReportsResponse", 551 "id": "ListReportsResponse",
513 "properties": { 552 "properties": {
553 "nextPageToken": {
554 "description": "A token to retrieve next page of results.\nP ass this value in the\nListReportsRequest.page_token\nfield in the subsequent ca ll to `ListReports` method to retrieve the next\npage of results.",
555 "type": "string"
556 },
514 "reports": { 557 "reports": {
515 "description": "The list of report types.", 558 "description": "The list of report types.",
516 "items": { 559 "items": {
517 "$ref": "Report" 560 "$ref": "Report"
518 }, 561 },
519 "type": "array" 562 "type": "array"
520 },
521 "nextPageToken": {
522 "description": "A token to retrieve next page of results. Pa ss this value in the ListReportsRequest.page_token field in the subsequent call to `ListReports` method to retrieve the next page of results.",
523 "type": "string"
524 } 563 }
525 }, 564 },
526 "type": "object" 565 "type": "object"
527 }, 566 },
528 "Report": { 567 "ListReportTypesResponse": {
529 "description": "A report's metadata including the URL from which the report itself can be downloaded.", 568 "description": "Response message for ReportingService.ListReportType s.",
530 "id": "Report", 569 "id": "ListReportTypesResponse",
531 "properties": { 570 "properties": {
532 "id": { 571 "reportTypes": {
533 "description": "The server-generated ID of the report.", 572 "description": "The list of report types.",
534 "type": "string" 573 "items": {
574 "$ref": "ReportType"
575 },
576 "type": "array"
535 }, 577 },
536 "jobId": { 578 "nextPageToken": {
537 "description": "The ID of the job that created this report." , 579 "description": "A token to retrieve next page of results.\nP ass this value in the\nListReportTypesRequest.page_token\nfield in the subsequen t call to `ListReportTypes` method to retrieve the next\npage of results.",
538 "type": "string"
539 },
540 "jobExpireTime": {
541 "description": "The date/time when the job this report belon gs to will expire/expired.",
542 "type": "string"
543 },
544 "startTime": {
545 "description": "The start of the time period that the report instance covers. The value is inclusive.",
546 "type": "string"
547 },
548 "endTime": {
549 "description": "The end of the time period that the report i nstance covers. The value is exclusive.",
550 "type": "string"
551 },
552 "createTime": {
553 "description": "The date/time when this report was created." ,
554 "type": "string"
555 },
556 "downloadUrl": {
557 "description": "The URL from which the report can be downloa ded (max. 1000 characters).",
558 "type": "string" 580 "type": "string"
559 } 581 }
560 }, 582 },
561 "type": "object" 583 "type": "object"
562 } 584 }
563 }, 585 },
564 "servicePath": "", 586 "servicePath": "",
565 "title": "YouTube Reporting API", 587 "title": "YouTube Reporting API",
566 "version": "v1" 588 "version": "v1"
567 } 589 }
OLDNEW
« no previous file with comments | « discovery/googleapis/youtubeAnalytics__v1.json ('k') | discovery/googleapis_beta/adexchangebuyer2__v2beta1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698