1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
6 "description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
7 },
8 "https://www.googleapis.com/auth/yt-analytics.readonly": {
9 "description": "View YouTube Analytics reports for your YouTube content"
10 }
11 }
12 }
13 },
14 "basePath": "",
15 "baseUrl": "https://youtubereporting.googleapis.com/",
16 "batchPath": "batch",
17 "canonicalName": "YouTube Reporting",
18 "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.",
19 "discoveryVersion": "v1",
20 "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
21 "icons": {
22 "x16": "http://www.google.com/images/icons/product/search-16.gif",
23 "x32": "http://www.google.com/images/icons/product/search-32.gif"
24 },
25 "id": "youtubereporting:v1",
26 "kind": "discovery#restDescription",
27 "mtlsRootUrl": "https://youtubereporting.mtls.googleapis.com/",
28 "name": "youtubereporting",
29 "ownerDomain": "google.com",
30 "ownerName": "Google",
31 "parameters": {
32 "$.xgafv": {
33 "description": "V1 error format.",
34 "enum": [
35 "1",
36 "2"
37 ],
38 "enumDescriptions": [
39 "v1 error format",
40 "v2 error format"
41 ],
42 "location": "query",
43 "type": "string"
44 },
45 "access_token": {
46 "description": "OAuth access token.",
47 "location": "query",
48 "type": "string"
49 },
50 "alt": {
51 "default": "json",
52 "description": "Data format for response.",
53 "enum": [
54 "json",
55 "media",
56 "proto"
57 ],
58 "enumDescriptions": [
59 "Responses with Content-Type of application/json",
60 "Media download with context-dependent Content-Type",
61 "Responses with Content-Type of application/x-protobuf"
62 ],
63 "location": "query",
64 "type": "string"
65 },
66 "callback": {
67 "description": "JSONP",
68 "location": "query",
69 "type": "string"
70 },
71 "fields": {
72 "description": "Selector specifying which fields to include in a partial response.",
73 "location": "query",
74 "type": "string"
75 },
76 "key": {
77 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
78 "location": "query",
79 "type": "string"
80 },
81 "oauth_token": {
82 "description": "OAuth 2.0 token for the current user.",
83 "location": "query",
84 "type": "string"
85 },
86 "prettyPrint": {
87 "default": "true",
88 "description": "Returns response with indentations and line breaks.",
89 "location": "query",
90 "type": "boolean"
91 },
92 "quotaUser": {
93 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
94 "location": "query",
95 "type": "string"
96 },
97 "uploadType": {
98 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
99 "location": "query",
100 "type": "string"
101 },
102 "upload_protocol": {
103 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
104 "location": "query",
105 "type": "string"
106 }
107 },
108 "protocol": "rest",
109 "resources": {
110 "jobs": {
111 "methods": {
112 "create": {
113 "description": "Creates a job and returns it.",
114 "flatPath": "v1/jobs",
115 "httpMethod": "POST",
116 "id": "youtubereporting.jobs.create",
117 "parameterOrder": [],
118 "parameters": {
119 "onBehalfOfContentOwner": {
120 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).",
121 "location": "query",
122 "type": "string"
123 }
124 },
125 "path": "v1/jobs",
126 "request": {
127 "$ref": "Job"
128 },
129 "response": {
130 "$ref": "Job"
131 },
132 "scopes": [
133 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
134 "https://www.googleapis.com/auth/yt-analytics.readonly"
135 ]
136 },
137 "delete": {
138 "description": "Deletes a job.",
139 "flatPath": "v1/jobs/{jobId}",
140 "httpMethod": "DELETE",
141 "id": "youtubereporting.jobs.delete",
142 "parameterOrder": [
143 "jobId"
144 ],
145 "parameters": {
146 "jobId": {
147 "description": "The ID of the job to delete.",
148 "location": "path",
149 "required": true,
150 "type": "string"
151 },
152 "onBehalfOfContentOwner": {
153 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).",
154 "location": "query",
155 "type": "string"
156 }
157 },
158 "path": "v1/jobs/{jobId}",
159 "response": {
160 "$ref": "Empty"
161 },
162 "scopes": [
163 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
164 "https://www.googleapis.com/auth/yt-analytics.readonly"
165 ]
166 },
167 "get": {
168 "description": "Gets a job.",
169 "flatPath": "v1/jobs/{jobId}",
170 "httpMethod": "GET",
171 "id": "youtubereporting.jobs.get",
172 "parameterOrder": [
173 "jobId"
174 ],
175 "parameters": {
176 "jobId": {
177 "description": "The ID of the job to retrieve.",
178 "location": "path",
179 "required": true,
180 "type": "string"
181 },
182 "onBehalfOfContentOwner": {
183 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).",
184 "location": "query",
185 "type": "string"
186 }
187 },
188 "path": "v1/jobs/{jobId}",
189 "response": {
190 "$ref": "Job"
191 },
192 "scopes": [
193 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
194 "https://www.googleapis.com/auth/yt-analytics.readonly"
195 ]
196 },
197 "list": {
198 "description": "Lists jobs.",
199 "flatPath": "v1/jobs",
200 "httpMethod": "GET",
201 "id": "youtubereporting.jobs.list",
202 "parameterOrder": [],
203 "parameters": {
204 "includeSystemManaged": {
205 "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.",
206 "location": "query",
207 "type": "boolean"
208 },
209 "onBehalfOfContentOwner": {
210 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).",
211 "location": "query",
212 "type": "string"
213 },
214 "pageSize": {
215 "description": "Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.",
216 "format": "int32",
217 "location": "query",
218 "type": "integer"
219 },
220 "pageToken": {
221 "description": "A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListJobs` method.",
222 "location": "query",
223 "type": "string"
224 }
225 },
226 "path": "v1/jobs",
227 "response": {
228 "$ref": "ListJobsResponse"
229 },
230 "scopes": [
231 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
232 "https://www.googleapis.com/auth/yt-analytics.readonly"
233 ]
234 }
235 },
236 "resources": {
237 "reports": {
238 "methods": {
239 "get": {
240 "description": "Gets the metadata of a specific report.",
241 "flatPath": "v1/jobs/{jobId}/reports/{reportId}",
242 "httpMethod": "GET",
243 "id": "youtubereporting.jobs.reports.get",
244 "parameterOrder": [
245 "jobId",
246 "reportId"
247 ],
248 "parameters": {
249 "jobId": {
250 "description": "The ID of the job.",
251 "location": "path",
252 "required": true,
253 "type": "string"
254 },
255 "onBehalfOfContentOwner": {
256 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).",
257 "location": "query",
258 "type": "string"
259 },
260 "reportId": {
261 "description": "The ID of the report to retrieve.",
262 "location": "path",
263 "required": true,
264 "type": "string"
265 }
266 },
267 "path": "v1/jobs/{jobId}/reports/{reportId}",
268 "response": {
269 "$ref": "Report"
270 },
271 "scopes": [
272 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
273 "https://www.googleapis.com/auth/yt-analytics.readonly"
274 ]
275 },
276 "list": {
277 "description": "Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.",
278 "flatPath": "v1/jobs/{jobId}/reports",
279 "httpMethod": "GET",
280 "id": "youtubereporting.jobs.reports.list",
281 "parameterOrder": [
282 "jobId"
283 ],
284 "parameters": {
285 "createdAfter": {
286 "description": "If set, only reports created after the specified date/time are returned.",
287 "format": "google-datetime",
288 "location": "query",
289 "type": "string"
290 },
291 "jobId": {
292 "description": "The ID of the job.",
293 "location": "path",
294 "required": true,
295 "type": "string"
296 },
297 "onBehalfOfContentOwner": {
298 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).",
299 "location": "query",
300 "type": "string"
301 },
302 "pageSize": {
303 "description": "Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.",
304 "format": "int32",
305 "location": "query",
306 "type": "integer"
307 },
308 "pageToken": {
309 "description": "A token identifying a page of results the server should return. Typically, this is the value of ListReportsResponse.next_page_token returned in response to the previous call to the `ListReports` method.",
310 "location": "query",
311 "type": "string"
312 },
313 "startTimeAtOrAfter": {
314 "description": "If set, only reports whose start time is greater than or equal the specified date/time are returned.",
315 "format": "google-datetime",
316 "location": "query",
317 "type": "string"
318 },
319 "startTimeBefore": {
320 "description": "If set, only reports whose start time is smaller than the specified date/time are returned.",
321 "format": "google-datetime",
322 "location": "query",
323 "type": "string"
324 }
325 },
326 "path": "v1/jobs/{jobId}/reports",
327 "response": {
328 "$ref": "ListReportsResponse"
329 },
330 "scopes": [
331 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
332 "https://www.googleapis.com/auth/yt-analytics.readonly"
333 ]
334 }
335 }
336 }
337 }
338 },
339 "media": {
340 "methods": {
341 "download": {
342 "description": "Method for media download. Download is supported on the URI `/v1/media/{+name}?alt=media`.",
343 "flatPath": "v1/media/{mediaId}",
344 "httpMethod": "GET",
345 "id": "youtubereporting.media.download",
346 "parameterOrder": [
347 "resourceName"
348 ],
349 "parameters": {
350 "resourceName": {
351 "description": "Name of the media that is being downloaded.",
352 "location": "path",
353 "pattern": "^.*$",
354 "required": true,
355 "type": "string"
356 }
357 },
358 "path": "v1/media/{+resourceName}",
359 "response": {
360 "$ref": "GdataMedia"
361 },
362 "scopes": [
363 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
364 "https://www.googleapis.com/auth/yt-analytics.readonly"
365 ],
366 "supportsMediaDownload": true,
367 "useMediaDownloadService": true
368 }
369 }
370 },
371 "reportTypes": {
372 "methods": {
373 "list": {
374 "description": "Lists report types.",
375 "flatPath": "v1/reportTypes",
376 "httpMethod": "GET",
377 "id": "youtubereporting.reportTypes.list",
378 "parameterOrder": [],
379 "parameters": {
380 "includeSystemManaged": {
381 "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.",
382 "location": "query",
383 "type": "boolean"
384 },
385 "onBehalfOfContentOwner": {
386 "description": "The content owner's external ID on which behalf the user is acting on. If not set, the user is acting for himself (his own channel).",
387 "location": "query",
388 "type": "string"
389 },
390 "pageSize": {
391 "description": "Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.",
392 "format": "int32",
393 "location": "query",
394 "type": "integer"
395 },
396 "pageToken": {
397 "description": "A token identifying a page of results the server should return. Typically, this is the value of ListReportTypesResponse.next_page_token returned in response to the previous call to the `ListReportTypes` method.",
398 "location": "query",
399 "type": "string"
400 }
401 },
402 "path": "v1/reportTypes",
403 "response": {
404 "$ref": "ListReportTypesResponse"
405 },
406 "scopes": [
407 "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
408 "https://www.googleapis.com/auth/yt-analytics.readonly"
409 ]
410 }
411 }
412 }
413 },
414 "revision": "20230704",
415 "rootUrl": "https://youtubereporting.googleapis.com/",
416 "schemas": {
417 "Empty": {
418 "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); }",
419 "id": "Empty",
420 "properties": {},
421 "type": "object"
422 },
423 "GdataBlobstore2Info": {
424 "description": "gdata",
425 "id": "GdataBlobstore2Info",
426 "properties": {
427 "blobGeneration": {
428 "description": "gdata",
429 "format": "int64",
430 "type": "string"
431 },
432 "blobId": {
433 "description": "gdata",
434 "type": "string"
435 },
436 "downloadReadHandle": {
437 "description": "gdata",
438 "format": "byte",
439 "type": "string"
440 },
441 "readToken": {
442 "description": "gdata",
443 "type": "string"
444 },
445 "uploadMetadataContainer": {
446 "description": "gdata",
447 "format": "byte",
448 "type": "string"
449 }
450 },
451 "type": "object"
452 },
453 "GdataCompositeMedia": {
454 "description": "gdata",
455 "id": "GdataCompositeMedia",
456 "properties": {
457 "blobRef": {
458 "deprecated": true,
459 "description": "gdata",
460 "format": "byte",
461 "type": "string"
462 },
463 "blobstore2Info": {
464 "$ref": "GdataBlobstore2Info",
465 "description": "gdata"
466 },
467 "cosmoBinaryReference": {
468 "description": "gdata",
469 "format": "byte",
470 "type": "string"
471 },
472 "crc32cHash": {
473 "description": "gdata",
474 "format": "uint32",
475 "type": "integer"
476 },
477 "inline": {
478 "description": "gdata",
479 "format": "byte",
480 "type": "string"
481 },
482 "length": {
483 "description": "gdata",
484 "format": "int64",
485 "type": "string"
486 },
487 "md5Hash": {
488 "description": "gdata",
489 "format": "byte",
490 "type": "string"
491 },
492 "objectId": {
493 "$ref": "GdataObjectId",
494 "description": "gdata"
495 },
496 "path": {
497 "description": "gdata",
498 "type": "string"
499 },
500 "referenceType": {
501 "description": "gdata",
502 "enum": [
503 "PATH",
504 "BLOB_REF",
505 "INLINE",
506 "BIGSTORE_REF",
507 "COSMO_BINARY_REFERENCE"
508 ],
509 "enumDescriptions": [
510 "gdata",
511 "gdata",
512 "gdata",
513 "gdata",
514 "gdata"
515 ],
516 "type": "string"
517 },
518 "sha1Hash": {
519 "description": "gdata",
520 "format": "byte",
521 "type": "string"
522 }
523 },
524 "type": "object"
525 },
526 "GdataContentTypeInfo": {
527 "description": "gdata",
528 "id": "GdataContentTypeInfo",
529 "properties": {
530 "bestGuess": {
531 "description": "gdata",
532 "type": "string"
533 },
534 "fromBytes": {
535 "description": "gdata",
536 "type": "string"
537 },
538 "fromFileName": {
539 "description": "gdata",
540 "type": "string"
541 },
542 "fromHeader": {
543 "description": "gdata",
544 "type": "string"
545 },
546 "fromUrlPath": {
547 "description": "gdata",
548 "type": "string"
549 }
550 },
551 "type": "object"
552 },
553 "GdataDiffChecksumsResponse": {
554 "description": "gdata",
555 "id": "GdataDiffChecksumsResponse",
556 "properties": {
557 "checksumsLocation": {
558 "$ref": "GdataCompositeMedia",
559 "description": "gdata"
560 },
561 "chunkSizeBytes": {
562 "description": "gdata",
563 "format": "int64",
564 "type": "string"
565 },
566 "objectLocation": {
567 "$ref": "GdataCompositeMedia",
568 "description": "gdata"
569 },
570 "objectSizeBytes": {
571 "description": "gdata",
572 "format": "int64",
573 "type": "string"
574 },
575 "objectVersion": {
576 "description": "gdata",
577 "type": "string"
578 }
579 },
580 "type": "object"
581 },
582 "GdataDiffDownloadResponse": {
583 "description": "gdata",
584 "id": "GdataDiffDownloadResponse",
585 "properties": {
586 "objectLocation": {
587 "$ref": "GdataCompositeMedia",
588 "description": "gdata"
589 }
590 },
591 "type": "object"
592 },
593 "GdataDiffUploadRequest": {
594 "description": "gdata",
595 "id": "GdataDiffUploadRequest",
596 "properties": {
597 "checksumsInfo": {
598 "$ref": "GdataCompositeMedia",
599 "description": "gdata"
600 },
601 "objectInfo": {
602 "$ref": "GdataCompositeMedia",
603 "description": "gdata"
604 },
605 "objectVersion": {
606 "description": "gdata",
607 "type": "string"
608 }
609 },
610 "type": "object"
611 },
612 "GdataDiffUploadResponse": {
613 "description": "gdata",
614 "id": "GdataDiffUploadResponse",
615 "properties": {
616 "objectVersion": {
617 "description": "gdata",
618 "type": "string"
619 },
620 "originalObject": {
621 "$ref": "GdataCompositeMedia",
622 "description": "gdata"
623 }
624 },
625 "type": "object"
626 },
627 "GdataDiffVersionResponse": {
628 "description": "gdata",
629 "id": "GdataDiffVersionResponse",
630 "properties": {
631 "objectSizeBytes": {
632 "description": "gdata",
633 "format": "int64",
634 "type": "string"
635 },
636 "objectVersion": {
637 "description": "gdata",
638 "type": "string"
639 }
640 },
641 "type": "object"
642 },
643 "GdataDownloadParameters": {
644 "description": "gdata",
645 "id": "GdataDownloadParameters",
646 "properties": {
647 "allowGzipCompression": {
648 "description": "gdata",
649 "type": "boolean"
650 },
651 "ignoreRange": {
652 "description": "gdata",
653 "type": "boolean"
654 }
655 },
656 "type": "object"
657 },
658 "GdataMedia": {
659 "description": "gdata",
660 "id": "GdataMedia",
661 "properties": {
662 "algorithm": {
663 "deprecated": true,
664 "description": "gdata",
665 "type": "string"
666 },
667 "bigstoreObjectRef": {
668 "deprecated": true,
669 "description": "gdata",
670 "format": "byte",
671 "type": "string"
672 },
673 "blobRef": {
674 "deprecated": true,
675 "description": "gdata",
676 "format": "byte",
677 "type": "string"
678 },
679 "blobstore2Info": {
680 "$ref": "GdataBlobstore2Info",
681 "description": "gdata"
682 },
683 "compositeMedia": {
684 "description": "gdata",
685 "items": {
686 "$ref": "GdataCompositeMedia"
687 },
688 "type": "array"
689 },
690 "contentType": {
691 "description": "gdata",
692 "type": "string"
693 },
694 "contentTypeInfo": {
695 "$ref": "GdataContentTypeInfo",
696 "description": "gdata"
697 },
698 "cosmoBinaryReference": {
699 "description": "gdata",
700 "format": "byte",
701 "type": "string"
702 },
703 "crc32cHash": {
704 "description": "gdata",
705 "format": "uint32",
706 "type": "integer"
707 },
708 "diffChecksumsResponse": {
709 "$ref": "GdataDiffChecksumsResponse",
710 "description": "gdata"
711 },
712 "diffDownloadResponse": {
713 "$ref": "GdataDiffDownloadResponse",
714 "description": "gdata"
715 },
716 "diffUploadRequest": {
717 "$ref": "GdataDiffUploadRequest",
718 "description": "gdata"
719 },
720 "diffUploadResponse": {
721 "$ref": "GdataDiffUploadResponse",
722 "description": "gdata"
723 },
724 "diffVersionResponse": {
725 "$ref": "GdataDiffVersionResponse",
726 "description": "gdata"
727 },
728 "downloadParameters": {
729 "$ref": "GdataDownloadParameters",
730 "description": "gdata"
731 },
732 "filename": {
733 "description": "gdata",
734 "type": "string"
735 },
736 "hash": {
737 "deprecated": true,
738 "description": "gdata",
739 "type": "string"
740 },
741 "hashVerified": {
742 "description": "gdata",
743 "type": "boolean"
744 },
745 "inline": {
746 "description": "gdata",
747 "format": "byte",
748 "type": "string"
749 },
750 "isPotentialRetry": {
751 "description": "gdata",
752 "type": "boolean"
753 },
754 "length": {
755 "description": "gdata",
756 "format": "int64",
757 "type": "string"
758 },
759 "md5Hash": {
760 "description": "gdata",
761 "format": "byte",
762 "type": "string"
763 },
764 "mediaId": {
765 "description": "gdata",
766 "format": "byte",
767 "type": "string"
768 },
769 "objectId": {
770 "$ref": "GdataObjectId",
771 "description": "gdata"
772 },
773 "path": {
774 "description": "gdata",
775 "type": "string"
776 },
777 "referenceType": {
778 "description": "gdata",
779 "enum": [
780 "PATH",
781 "BLOB_REF",
782 "INLINE",
783 "GET_MEDIA",
784 "COMPOSITE_MEDIA",
785 "BIGSTORE_REF",
786 "DIFF_VERSION_RESPONSE",
787 "DIFF_CHECKSUMS_RESPONSE",
788 "DIFF_DOWNLOAD_RESPONSE",
789 "DIFF_UPLOAD_REQUEST",
790 "DIFF_UPLOAD_RESPONSE",
791 "COSMO_BINARY_REFERENCE",
792 "ARBITRARY_BYTES"
793 ],
794 "enumDescriptions": [
795 "gdata",
796 "gdata",
797 "gdata",
798 "gdata",
799 "gdata",
800 "gdata",
801 "gdata",
802 "gdata",
803 "gdata",
804 "gdata",
805 "gdata",
806 "gdata",
807 "gdata"
808 ],
809 "type": "string"
810 },
811 "sha1Hash": {
812 "description": "gdata",
813 "format": "byte",
814 "type": "string"
815 },
816 "sha256Hash": {
817 "description": "gdata",
818 "format": "byte",
819 "type": "string"
820 },
821 "timestamp": {
822 "description": "gdata",
823 "format": "uint64",
824 "type": "string"
825 },
826 "token": {
827 "description": "gdata",
828 "type": "string"
829 }
830 },
831 "type": "object"
832 },
833 "GdataObjectId": {
834 "description": "gdata",
835 "id": "GdataObjectId",
836 "properties": {
837 "bucketName": {
838 "description": "gdata",
839 "type": "string"
840 },
841 "generation": {
842 "description": "gdata",
843 "format": "int64",
844 "type": "string"
845 },
846 "objectName": {
847 "description": "gdata",
848 "type": "string"
849 }
850 },
851 "type": "object"
852 },
853 "Job": {
854 "description": "A job creating reports of a specific type.",
855 "id": "Job",
856 "properties": {
857 "createTime": {
858 "description": "The creation date/time of the job.",
859 "format": "google-datetime",
860 "type": "string"
861 },
862 "expireTime": {
863 "description": "The date/time when this job will expire/expired. After a job expired, no new reports are generated.",
864 "format": "google-datetime",
865 "type": "string"
866 },
867 "id": {
868 "description": "The server-generated ID of the job (max. 40 characters).",
869 "type": "string"
870 },
871 "name": {
872 "description": "The name of the job (max. 100 characters).",
873 "type": "string"
874 },
875 "reportTypeId": {
876 "description": "The type of reports this job creates. Corresponds to the ID of a ReportType.",
877 "type": "string"
878 },
879 "systemManaged": {
880 "description": "True if this a system-managed job that cannot be modified by the user; otherwise false.",
881 "type": "boolean"
882 }
883 },
884 "type": "object"
885 },
886 "ListJobsResponse": {
887 "description": "Response message for ReportingService.ListJobs.",
888 "id": "ListJobsResponse",
889 "properties": {
890 "jobs": {
891 "description": "The list of jobs.",
892 "items": {
893 "$ref": "Job"
894 },
895 "type": "array"
896 },
897 "nextPageToken": {
898 "description": "A token to retrieve next page of results. Pass this value in the ListJobsRequest.page_token field in the subsequent call to `ListJobs` method to retrieve the next page of results.",
899 "type": "string"
900 }
901 },
902 "type": "object"
903 },
904 "ListReportTypesResponse": {
905 "description": "Response message for ReportingService.ListReportTypes.",
906 "id": "ListReportTypesResponse",
907 "properties": {
908 "nextPageToken": {
909 "description": "A token to retrieve next page of results. Pass this value in the ListReportTypesRequest.page_token field in the subsequent call to `ListReportTypes` method to retrieve the next page of results.",
910 "type": "string"
911 },
912 "reportTypes": {
913 "description": "The list of report types.",
914 "items": {
915 "$ref": "ReportType"
916 },
917 "type": "array"
918 }
919 },
920 "type": "object"
921 },
922 "ListReportsResponse": {
923 "description": "Response message for ReportingService.ListReports.",
924 "id": "ListReportsResponse",
925 "properties": {
926 "nextPageToken": {
927 "description": "A token to retrieve next page of results. Pass this value in the ListReportsRequest.page_token field in the subsequent call to `ListReports` method to retrieve the next page of results.",
928 "type": "string"
929 },
930 "reports": {
931 "description": "The list of report types.",
932 "items": {
933 "$ref": "Report"
934 },
935 "type": "array"
936 }
937 },
938 "type": "object"
939 },
940 "Report": {
941 "description": "A report's metadata including the URL from which the report itself can be downloaded.",
942 "id": "Report",
943 "properties": {
944 "createTime": {
945 "description": "The date/time when this report was created.",
946 "format": "google-datetime",
947 "type": "string"
948 },
949 "downloadUrl": {
950 "description": "The URL from which the report can be downloaded (max. 1000 characters).",
951 "type": "string"
952 },
953 "endTime": {
954 "description": "The end of the time period that the report instance covers. The value is exclusive.",
955 "format": "google-datetime",
956 "type": "string"
957 },
958 "id": {
959 "description": "The server-generated ID of the report.",
960 "type": "string"
961 },
962 "jobExpireTime": {
963 "description": "The date/time when the job this report belongs to will expire/expired.",
964 "format": "google-datetime",
965 "type": "string"
966 },
967 "jobId": {
968 "description": "The ID of the job that created this report.",
969 "type": "string"
970 },
971 "startTime": {
972 "description": "The start of the time period that the report instance covers. The value is inclusive.",
973 "format": "google-datetime",
974 "type": "string"
975 }
976 },
977 "type": "object"
978 },
979 "ReportType": {
980 "description": "A report type.",
981 "id": "ReportType",
982 "properties": {
983 "deprecateTime": {
984 "description": "The date/time when this report type was/will be deprecated.",
985 "format": "google-datetime",
986 "type": "string"
987 },
988 "id": {
989 "description": "The ID of the report type (max. 100 characters).",
990 "type": "string"
991 },
992 "name": {
993 "description": "The name of the report type (max. 100 characters).",
994 "type": "string"
995 },
996 "systemManaged": {
997 "description": "True if this a system-managed report type; otherwise false. Reporting jobs for system-managed report types are created automatically and can thus not be used in the `CreateJob` method.",
998 "type": "boolean"
999 }
1000 },
1001 "type": "object"
1002 }
1003 },
1004 "servicePath": "",
1005 "title": "YouTube Reporting API",
1006 "version": "v1"
1007}
View as plain text