-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrest.json
11488 lines (11488 loc) · 451 KB
/
rest.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"baseUrl": "https://youtube.googleapis.com/",
"servicePath": "",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"ownerDomain": "google.com",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/youtube": {
"description": "Manage your YouTube account"
},
"https://www.googleapis.com/auth/youtubepartner": {
"description": "View and manage your assets and associated content on YouTube"
},
"https://www.googleapis.com/auth/youtube.channel-memberships.creator": {
"description": "See a list of your current active channel members, their current level, and when they became a member"
},
"https://www.googleapis.com/auth/youtube.readonly": {
"description": "View your YouTube account"
},
"https://www.googleapis.com/auth/youtube.force-ssl": {
"description": "See, edit, and permanently delete your YouTube videos, ratings, comments and captions"
},
"https://www.googleapis.com/auth/youtubepartner-channel-audit": {
"description": "View private information of your YouTube channel relevant during the audit process with a YouTube partner"
},
"https://www.googleapis.com/auth/youtube.upload": {
"description": "Manage your YouTube videos"
}
}
}
},
"ownerName": "Google",
"id": "youtube:v3",
"description": "The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.",
"version": "v3",
"discoveryVersion": "v1",
"kind": "discovery#restDescription",
"batchPath": "batch",
"title": "YouTube Data API v3",
"documentationLink": "https://developers.google.com/youtube/",
"name": "youtube",
"revision": "20210925",
"rootUrl": "https://youtube.googleapis.com/",
"parameters": {
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
"quotaUser": {
"location": "query",
"type": "string",
"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."
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"callback": {
"type": "string",
"location": "query",
"description": "JSONP"
},
"alt": {
"type": "string",
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
]
},
"oauth_token": {
"location": "query",
"type": "string",
"description": "OAuth 2.0 token for the current user."
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"prettyPrint": {
"default": "true",
"location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean"
},
"upload_protocol": {
"type": "string",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query"
},
"key": {
"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.",
"location": "query",
"type": "string"
},
"$.xgafv": {
"type": "string",
"location": "query",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"description": "V1 error format.",
"enum": [
"1",
"2"
]
}
},
"protocol": "rest",
"mtlsRootUrl": "https://youtube.mtls.googleapis.com/",
"schemas": {
"CaptionListResponse": {
"type": "object",
"properties": {
"kind": {
"default": "youtube#captionListResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"youtube#captionListResponse\"."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"items": {
"type": "array",
"description": "A list of captions that match the request criteria.",
"items": {
"$ref": "Caption"
}
},
"visitorId": {
"description": "The visitorId identifies the visitor.",
"type": "string"
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
}
},
"id": "CaptionListResponse"
},
"SuperChatEvent": {
"type": "object",
"description": "A `__superChatEvent__` resource represents a Super Chat purchase on a YouTube channel.",
"properties": {
"kind": {
"default": "youtube#superChatEvent",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string `\"youtube#superChatEvent\"`."
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the Super Chat event."
},
"snippet": {
"description": "The `snippet` object contains basic details about the Super Chat event.",
"$ref": "SuperChatEventSnippet"
}
},
"id": "SuperChatEvent"
},
"MembershipsDetails": {
"properties": {
"membershipsDurationAtLevels": {
"description": "Data about memberships duration on particular pricing levels.",
"items": {
"$ref": "MembershipsDurationAtLevel"
},
"type": "array"
},
"highestAccessibleLevelDisplayName": {
"description": "Display name for the highest level that the user has access to at the moment.",
"type": "string"
},
"accessibleLevels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Ids of all levels that the user has access to. This includes the currently active level and all other levels that are included because of a higher purchase."
},
"highestAccessibleLevel": {
"type": "string",
"description": "Id of the highest level that the user has access to at the moment."
},
"membershipsDuration": {
"$ref": "MembershipsDuration",
"description": "Data about memberships duration without taking into consideration pricing levels."
}
},
"id": "MembershipsDetails",
"type": "object"
},
"VideoStatus": {
"properties": {
"rejectionReason": {
"description": "This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.",
"enumDescriptions": [
"Copyright infringement.",
"Inappropriate video content.",
"Duplicate upload in the same channel.",
"Terms of use violation.",
"Uploader account was suspended.",
"Video duration was too long.",
"Blocked by content owner.",
"Uploader closed his/her account.",
"Trademark infringement.",
"An unspecified legal reason."
],
"type": "string",
"enum": [
"copyright",
"inappropriate",
"duplicate",
"termsOfUse",
"uploaderAccountSuspended",
"length",
"claim",
"uploaderAccountClosed",
"trademark",
"legal"
]
},
"failureReason": {
"enumDescriptions": [
"Unable to convert video content.",
"Invalid file format.",
"Empty file.",
"File was too small.",
"Unsupported codec.",
"Upload wasn't finished."
],
"enum": [
"conversion",
"invalidFile",
"emptyFile",
"tooSmall",
"codec",
"uploadAborted"
],
"type": "string",
"description": "This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed."
},
"privacyStatus": {
"enumDescriptions": [
"",
"",
""
],
"enum": [
"public",
"unlisted",
"private"
],
"type": "string",
"description": "The video's privacy status."
},
"publishAt": {
"type": "string",
"format": "date-time",
"description": "The date and time when the video is scheduled to publish. It can be set only if the privacy status of the video is private.."
},
"selfDeclaredMadeForKids": {
"type": "boolean"
},
"license": {
"description": "The video's license. @mutable youtube.videos.insert youtube.videos.update",
"enumDescriptions": [
"",
""
],
"enum": [
"youtube",
"creativeCommon"
],
"type": "string"
},
"madeForKids": {
"type": "boolean"
},
"uploadStatus": {
"type": "string",
"description": "The status of the uploaded video.",
"enumDescriptions": [
"Video has been uploaded but not processed yet.",
"Video has been successfully processed.",
"Processing has failed. See FailureReason.",
"Video has been rejected. See RejectionReason.",
"Video has been deleted."
],
"enum": [
"uploaded",
"processed",
"failed",
"rejected",
"deleted"
]
},
"embeddable": {
"description": "This value indicates if the video can be embedded on another website. @mutable youtube.videos.insert youtube.videos.update",
"type": "boolean"
},
"publicStatsViewable": {
"type": "boolean",
"description": "This value indicates if the extended video statistics on the watch page can be viewed by everyone. Note that the view count, likes, etc will still be visible if this is disabled. @mutable youtube.videos.insert youtube.videos.update"
}
},
"id": "VideoStatus",
"type": "object",
"description": "Basic details about a video category, such as its localized title. Next Id: 17"
},
"LiveChatModerator": {
"description": "A *liveChatModerator* resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc.",
"id": "LiveChatModerator",
"properties": {
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"kind": {
"default": "youtube#liveChatModerator",
"description": "Identifies what kind of resource this is. Value: the fixed string \"youtube#liveChatModerator\".",
"type": "string"
},
"snippet": {
"$ref": "LiveChatModeratorSnippet",
"description": "The snippet object contains basic details about the moderator."
},
"id": {
"type": "string",
"description": "The ID that YouTube assigns to uniquely identify the moderator."
}
},
"type": "object"
},
"PlaylistItemSnippet": {
"description": "Basic details about a playlist, including title, description and thumbnails. Basic details of a YouTube Playlist item provided by the author. Next ID: 15",
"properties": {
"channelTitle": {
"description": "Channel title for the channel that the playlist item belongs to.",
"type": "string"
},
"playlistId": {
"annotations": {
"required": [
"youtube.playlistItems.insert",
"youtube.playlistItems.update"
]
},
"type": "string",
"description": "The ID that YouTube uses to uniquely identify thGe playlist that the playlist item is in."
},
"thumbnails": {
"description": "A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.",
"$ref": "ThumbnailDetails"
},
"videoOwnerChannelId": {
"type": "string",
"description": "Channel id for the channel this video belongs to."
},
"resourceId": {
"description": "The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item.",
"annotations": {
"required": [
"youtube.playlistItems.insert",
"youtube.playlistItems.update"
]
},
"$ref": "ResourceId"
},
"position": {
"type": "integer",
"description": "The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth.",
"format": "uint32"
},
"videoOwnerChannelTitle": {
"type": "string",
"description": "Channel title for the channel this video belongs to."
},
"title": {
"description": "The item's title.",
"type": "string"
},
"description": {
"description": "The item's description.",
"type": "string"
},
"channelId": {
"description": "The ID that YouTube uses to uniquely identify the user that added the item to the playlist.",
"type": "string"
},
"publishedAt": {
"format": "date-time",
"description": "The date and time that the item was added to the playlist.",
"type": "string"
}
},
"id": "PlaylistItemSnippet",
"type": "object"
},
"ChannelProfileDetails": {
"properties": {
"channelId": {
"description": "The YouTube channel ID.",
"type": "string"
},
"displayName": {
"description": "The channel's display name.",
"type": "string"
},
"channelUrl": {
"type": "string",
"description": "The channel's URL."
},
"profileImageUrl": {
"type": "string",
"description": "The channels's avatar URL."
}
},
"id": "ChannelProfileDetails",
"type": "object"
},
"IngestionInfo": {
"properties": {
"backupIngestionAddress": {
"type": "string",
"description": "The backup ingestion URL that you should use to stream video to YouTube. You have the option of simultaneously streaming the content that you are sending to the ingestionAddress to this URL."
},
"streamName": {
"type": "string",
"description": "The HTTP or RTMP stream name that YouTube assigns to the video stream."
},
"rtmpsBackupIngestionAddress": {
"description": "This ingestion url may be used instead of backupIngestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.",
"type": "string"
},
"rtmpsIngestionAddress": {
"description": "This ingestion url may be used instead of ingestionAddress in order to stream via RTMPS. Not applicable to non-RTMP streams.",
"type": "string"
},
"ingestionAddress": {
"description": "The primary ingestion URL that you should use to stream video to YouTube. You must stream video to this URL. Depending on which application or tool you use to encode your video stream, you may need to enter the stream URL and stream name separately or you may need to concatenate them in the following format: *STREAM_URL/STREAM_NAME* ",
"type": "string"
}
},
"type": "object",
"description": "Describes information necessary for ingesting an RTMP or an HTTP stream.",
"id": "IngestionInfo"
},
"LiveChatMemberMilestoneChatDetails": {
"type": "object",
"properties": {
"userComment": {
"type": "string",
"description": "The comment added by the member to this Member Milestone Chat. This field is empty for messages without a comment from the member."
},
"memberMonth": {
"type": "integer",
"format": "uint32",
"description": "The total amount of months (rounded up) the viewer has been a member that granted them this Member Milestone Chat. This is the same number of months as is being displayed to YouTube users."
},
"memberLevelName": {
"type": "string",
"description": "The name of the Level at which the viever is a member. The Level names are defined by the YouTube channel offering the Membership. In some situations this field isn't filled."
}
},
"id": "LiveChatMemberMilestoneChatDetails"
},
"VideoSnippet": {
"type": "object",
"properties": {
"channelTitle": {
"description": "Channel title for the channel that the video belongs to.",
"type": "string"
},
"channelId": {
"type": "string",
"description": "The ID that YouTube uses to uniquely identify the channel that the video was uploaded to."
},
"thumbnails": {
"description": "A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.",
"$ref": "ThumbnailDetails"
},
"liveBroadcastContent": {
"description": "Indicates if the video is an upcoming/active live broadcast. Or it's \"none\" if the video is not an upcoming/active live broadcast.",
"enumDescriptions": [
"",
"The live broadcast is upcoming.",
"The live broadcast is active.",
"The live broadcast has been completed."
],
"type": "string",
"enum": [
"none",
"upcoming",
"live",
"completed"
]
},
"title": {
"description": "The video's title. @mutable youtube.videos.insert youtube.videos.update",
"type": "string"
},
"defaultAudioLanguage": {
"description": "The default_audio_language property specifies the language spoken in the video's default audio track.",
"type": "string"
},
"tags": {
"description": "A list of keyword tags associated with the video. Tags may contain spaces.",
"type": "array",
"items": {
"type": "string"
}
},
"categoryId": {
"description": "The YouTube video category associated with the video.",
"type": "string"
},
"defaultLanguage": {
"type": "string",
"description": "The language of the videos's default snippet."
},
"localized": {
"$ref": "VideoLocalization",
"description": "Localized snippet selected with the hl parameter. If no such localization exists, this field is populated with the default snippet. (Read-only)"
},
"publishedAt": {
"description": "The date and time when the video was uploaded.",
"format": "date-time",
"type": "string"
},
"description": {
"type": "string",
"description": "The video's description. @mutable youtube.videos.insert youtube.videos.update"
}
},
"description": "Basic details about a video, including title, description, uploader, thumbnails and category.",
"id": "VideoSnippet"
},
"VideoProcessingDetails": {
"properties": {
"fileDetailsAvailability": {
"description": "This value indicates whether file details are available for the uploaded video. You can retrieve a video's file details by requesting the fileDetails part in your videos.list() request.",
"type": "string"
},
"processingStatus": {
"enum": [
"processing",
"succeeded",
"failed",
"terminated"
],
"description": "The video's processing status. This value indicates whether YouTube was able to process the video or if the video is still being processed.",
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
]
},
"processingIssuesAvailability": {
"type": "string",
"description": "This value indicates whether the video processing engine has generated suggestions that might improve YouTube's ability to process the the video, warnings that explain video processing problems, or errors that cause video processing problems. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request."
},
"editorSuggestionsAvailability": {
"type": "string",
"description": "This value indicates whether video editing suggestions, which might improve video quality or the playback experience, are available for the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request."
},
"processingProgress": {
"description": "The processingProgress object contains information about the progress YouTube has made in processing the video. The values are really only relevant if the video's processing status is processing.",
"$ref": "VideoProcessingDetailsProcessingProgress"
},
"processingFailureReason": {
"description": "The reason that YouTube failed to process the video. This property will only have a value if the processingStatus property's value is failed.",
"enum": [
"uploadFailed",
"transcodeFailed",
"streamingFailed",
"other"
],
"type": "string",
"enumDescriptions": [
"",
"",
"",
""
]
},
"tagSuggestionsAvailability": {
"type": "string",
"description": "This value indicates whether keyword (tag) suggestions are available for the video. Tags can be added to a video's metadata to make it easier for other users to find the video. You can retrieve these suggestions by requesting the suggestions part in your videos.list() request."
},
"thumbnailsAvailability": {
"type": "string",
"description": "This value indicates whether thumbnail images have been generated for the video."
}
},
"description": "Describes processing status and progress and availability of some other Video resource parts.",
"id": "VideoProcessingDetails",
"type": "object"
},
"Caption": {
"description": "A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.",
"id": "Caption",
"type": "object",
"properties": {
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"youtube#caption\".",
"type": "string",
"default": "youtube#caption"
},
"etag": {
"type": "string",
"description": "Etag of this resource."
},
"snippet": {
"$ref": "CaptionSnippet",
"description": "The snippet object contains basic details about the caption."
},
"id": {
"description": "The ID that YouTube uses to uniquely identify the caption track.",
"type": "string",
"annotations": {
"required": [
"youtube.captions.update"
]
}
}
}
},
"LiveBroadcastStatistics": {
"description": "Statistics about the live broadcast. These represent a snapshot of the values at the time of the request. Statistics are only returned for live broadcasts.",
"properties": {
"totalChatCount": {
"type": "string",
"format": "uint64",
"description": "The total number of live chat messages currently on the broadcast. The property and its value will be present if the broadcast is public, has the live chat feature enabled, and has at least one message. Note that this field will not be filled after the broadcast ends. So this property would not identify the number of chat messages for an archived video of a completed live broadcast."
}
},
"id": "LiveBroadcastStatistics",
"type": "object"
},
"PageInfo": {
"type": "object",
"description": "Paging details for lists of resources, including total number of items available and number of resources returned in a single page.",
"properties": {
"resultsPerPage": {
"description": "The number of results included in the API response.",
"format": "int32",
"type": "integer"
},
"totalResults": {
"description": "The total number of results in the result set.",
"type": "integer",
"format": "int32"
}
},
"id": "PageInfo"
},
"WatchSettings": {
"description": "Branding properties for the watch. All deprecated.",
"properties": {
"featuredPlaylistId": {
"description": "An ID that uniquely identifies a playlist that displays next to the video player.",
"type": "string"
},
"textColor": {
"type": "string",
"description": "The background color for the video watch page's branded area."
},
"backgroundColor": {
"type": "string",
"description": "The text color for the video watch page's branded area."
}
},
"type": "object",
"id": "WatchSettings"
},
"CommentThreadSnippet": {
"id": "CommentThreadSnippet",
"properties": {
"channelId": {
"description": "The YouTube channel the comments in the thread refer to or the channel with the video the comments refer to. If video_id isn't set the comments refer to the channel itself.",
"type": "string"
},
"isPublic": {
"type": "boolean",
"description": "Whether the thread (and therefore all its comments) is visible to all YouTube users."
},
"canReply": {
"description": "Whether the current viewer of the thread can reply to it. This is viewer specific - other viewers may see a different value for this field.",
"type": "boolean"
},
"totalReplyCount": {
"description": "The total number of replies (not including the top level comment).",
"type": "integer",
"format": "uint32"
},
"videoId": {
"type": "string",
"description": "The ID of the video the comments refer to, if any. No video_id implies a channel discussion comment."
},
"topLevelComment": {
"$ref": "Comment",
"description": "The top level comment of this thread."
}
},
"type": "object",
"description": "Basic details about a comment thread."
},
"ChannelSectionContentDetails": {
"id": "ChannelSectionContentDetails",
"description": "Details about a channelsection, including playlists and channels.",
"type": "object",
"properties": {
"playlists": {
"items": {
"type": "string"
},
"description": "The playlist ids for type single_playlist and multiple_playlists. For singlePlaylist, only one playlistId is allowed.",
"type": "array"
},
"channels": {
"type": "array",
"description": "The channel ids for type multiple_channels.",
"items": {
"type": "string"
}
}
}
},
"ActivityContentDetailsChannelItem": {
"properties": {
"resourceId": {
"$ref": "ResourceId",
"description": "The resourceId object contains information that identifies the resource that was added to the channel."
}
},
"description": "Details about a resource which was added to a channel.",
"type": "object",
"id": "ActivityContentDetailsChannelItem"
},
"PlaylistStatus": {
"id": "PlaylistStatus",
"properties": {
"privacyStatus": {
"description": "The playlist's privacy status.",
"enumDescriptions": [
"",
"",
""
],
"enum": [
"public",
"unlisted",
"private"
],
"type": "string"
}
},
"type": "object"
},
"VideoGetRatingResponse": {
"properties": {
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"items": {
"description": "A list of ratings that match the request criteria.",
"items": {
"$ref": "VideoRating"
},
"type": "array"
},
"eventId": {
"description": "Serialized EventId of the request which produced this response.",
"type": "string"
},
"kind": {
"default": "youtube#videoGetRatingResponse",
"type": "string",
"description": "Identifies what kind of resource this is. Value: the fixed string \"youtube#videoGetRatingResponse\"."
},
"visitorId": {
"description": "The visitorId identifies the visitor.",
"type": "string"
}
},
"type": "object",
"id": "VideoGetRatingResponse"
},
"SubscriptionSnippet": {
"id": "SubscriptionSnippet",
"type": "object",
"description": "Basic details about a subscription, including title, description and thumbnails of the subscribed item.",
"properties": {
"description": {
"type": "string",
"description": "The subscription's details."
},
"channelId": {
"description": "The ID that YouTube uses to uniquely identify the subscriber's channel.",
"type": "string"
},
"publishedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time that the subscription was created."
},
"title": {
"description": "The subscription's title.",
"type": "string"
},
"thumbnails": {
"description": "A map of thumbnail images associated with the video. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail.",
"$ref": "ThumbnailDetails"
},
"channelTitle": {
"description": "Channel title for the channel that the subscription belongs to.",
"type": "string"
},
"resourceId": {
"annotations": {
"required": [
"youtube.subscriptions.insert"
]
},
"$ref": "ResourceId",
"description": "The id object contains information about the channel that the user subscribed to."
}
}
},
"ChannelTopicDetails": {
"type": "object",
"description": "Freebase topic information related to the channel.",
"id": "ChannelTopicDetails",
"properties": {
"topicCategories": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of Wikipedia URLs that describe the channel's content."
},
"topicIds": {
"description": "A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"LiveBroadcastListResponse": {
"id": "LiveBroadcastListResponse",
"type": "object",
"properties": {
"pageInfo": {
"$ref": "PageInfo",
"description": "General pagination information."
},
"nextPageToken": {
"description": "The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.",
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "LiveBroadcast"
},
"description": "A list of broadcasts that match the request criteria."
},
"kind": {
"description": "Identifies what kind of resource this is. Value: the fixed string \"youtube#liveBroadcastListResponse\".",
"default": "youtube#liveBroadcastListResponse",
"type": "string"
},
"etag": {
"description": "Etag of this resource.",
"type": "string"
},
"tokenPagination": {
"$ref": "TokenPagination"
},
"visitorId": {
"type": "string",
"description": "The visitorId identifies the visitor."
},
"eventId": {
"type": "string",
"description": "Serialized EventId of the request which produced this response."
},
"prevPageToken": {
"type": "string",
"description": "The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set."
}
}
},
"SuperChatEventSnippet": {
"id": "SuperChatEventSnippet",
"type": "object",
"properties": {
"displayString": {
"type": "string",
"description": "A rendered string that displays the purchase amount and currency (e.g., \"$1.00\"). The string is rendered for the given language."
},
"channelId": {
"description": "Channel id where the event occurred.",
"type": "string"
},
"commentText": {
"description": "The text contents of the comment left by the user.",
"type": "string"
},
"createdAt": {
"description": "The date and time when the event occurred.",
"format": "date-time",
"type": "string"
},
"superStickerMetadata": {
"$ref": "SuperStickerMetadata",
"description": "If this event is a Super Sticker event, this field will contain metadata about the Super Sticker."
},
"supporterDetails": {
"$ref": "ChannelProfileDetails",
"description": "Details about the supporter."
},
"isSuperStickerEvent": {
"description": "True if this event is a Super Sticker event.",
"type": "boolean"
},
"messageType": {
"format": "uint32",
"description": "The tier for the paid message, which is based on the amount of money spent to purchase the message.",
"type": "integer"
},
"amountMicros": {
"type": "string",
"format": "uint64",
"description": "The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000."
},
"currency": {
"description": "The currency in which the purchase was made. ISO 4217.",
"type": "string"
}
}
},
"LiveBroadcastStatus": {
"id": "LiveBroadcastStatus",
"type": "object",
"description": "Live broadcast state.",
"properties": {
"liveBroadcastPriority": {
"description": "Priority of the live broadcast event (internal state).",
"type": "string",
"enumDescriptions": [
"",
"Low priority broadcast: for low view count HoAs or other low priority broadcasts.",
"Normal priority broadcast: for regular HoAs and broadcasts.",
"High priority broadcast: for high profile HoAs, like PixelCorp ones."
],
"enum": [
"liveBroadcastPriorityUnspecified",
"low",
"normal",
"high"
]
},
"lifeCycleStatus": {
"type": "string",
"enumDescriptions": [
"No value or the value is unknown.",
"Incomplete settings, but otherwise valid",
"Complete settings",
"Visible only to partner, may need special UI treatment",
"Viper is recording; this means the \"clock\" is running",
"The broadcast is finished.",