/
youtube-v3.json
11464 lines (11464 loc) · 450 KB
/
youtube-v3.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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/youtube": {
"description": "Manage your YouTube account"
},
"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.force-ssl": {
"description": "See, edit, and permanently delete your YouTube videos, ratings, comments and captions"
},
"https://www.googleapis.com/auth/youtube.readonly": {
"description": "View your YouTube account"
},
"https://www.googleapis.com/auth/youtube.upload": {
"description": "Manage your YouTube videos"
},
"https://www.googleapis.com/auth/youtubepartner": {
"description": "View and manage your assets and associated content on YouTube"
},
"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"
}
}
}
},
"basePath": "",
"baseUrl": "https://youtube.googleapis.com/",
"batchPath": "batch",
"canonicalName": "YouTube",
"description": "The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/youtube/",
"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"
},
"id": "youtube:v3",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://youtube.mtls.googleapis.com/",
"name": "youtube",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"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"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"abuseReports": {
"methods": {
"insert": {
"description": "Inserts a new resource into this collection.",
"flatPath": "youtube/v3/abuseReports",
"httpMethod": "POST",
"id": "youtube.abuseReports.insert",
"parameterOrder": [
"part"
],
"parameters": {
"part": {
"description": "The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
}
},
"path": "youtube/v3/abuseReports",
"request": {
"$ref": "AbuseReport"
},
"response": {
"$ref": "AbuseReport"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl"
]
}
}
},
"activities": {
"methods": {
"list": {
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/activities",
"httpMethod": "GET",
"id": "youtube.activities.list",
"parameterOrder": [
"part"
],
"parameters": {
"channelId": {
"location": "query",
"type": "string"
},
"home": {
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "5",
"description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.",
"format": "uint32",
"location": "query",
"maximum": "50",
"minimum": "0",
"type": "integer"
},
"mine": {
"location": "query",
"type": "boolean"
},
"pageToken": {
"description": "The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter specifies a comma-separated list of one or more activity resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in an activity resource, the snippet property contains other properties that identify the type of activity, a display title for the activity, and so forth. If you set *part=snippet*, the API response will also contain all of those nested properties.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
},
"publishedAfter": {
"format": "google-datetime",
"location": "query",
"type": "string"
},
"publishedBefore": {
"format": "google-datetime",
"location": "query",
"type": "string"
},
"regionCode": {
"location": "query",
"type": "string"
}
},
"path": "youtube/v3/activities",
"response": {
"$ref": "ActivityListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly"
]
}
}
},
"captions": {
"methods": {
"delete": {
"description": "Deletes a resource.",
"flatPath": "youtube/v3/captions",
"httpMethod": "DELETE",
"id": "youtube.captions.delete",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"location": "query",
"required": true,
"type": "string"
},
"onBehalfOf": {
"description": "ID of the Google+ Page for the channel that the request is be on behalf of",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
}
},
"path": "youtube/v3/captions",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"download": {
"description": "Downloads a caption track.",
"flatPath": "youtube/v3/captions/{id}",
"httpMethod": "GET",
"id": "youtube.captions.download",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"description": "The ID of the caption track to download, required for One Platform.",
"location": "path",
"required": true,
"type": "string"
},
"onBehalfOf": {
"description": "ID of the Google+ Page for the channel that the request is be on behalf of",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"tfmt": {
"description": "Convert the captions into this format. Supported options are sbv, srt, and vtt.",
"location": "query",
"type": "string"
},
"tlang": {
"description": "tlang is the language code; machine translate the captions into this language.",
"location": "query",
"type": "string"
}
},
"path": "youtube/v3/captions/{id}",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"supportsMediaDownload": true,
"useMediaDownloadService": true
},
"insert": {
"description": "Inserts a new resource into this collection.",
"flatPath": "youtube/v3/captions",
"httpMethod": "POST",
"id": "youtube.captions.insert",
"mediaUpload": {
"accept": [
"text/xml",
"application/octet-stream",
"*/*"
],
"maxSize": "104857600",
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/youtube/v3/captions"
},
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/captions"
}
}
},
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOf": {
"description": "ID of the Google+ Page for the channel that the request is be on behalf of",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
},
"sync": {
"description": "Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.",
"location": "query",
"type": "boolean"
}
},
"path": "youtube/v3/captions",
"request": {
"$ref": "Caption"
},
"response": {
"$ref": "Caption"
},
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"supportsMediaUpload": true
},
"list": {
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/captions",
"httpMethod": "GET",
"id": "youtube.captions.list",
"parameterOrder": [
"part",
"videoId"
],
"parameters": {
"id": {
"description": "Returns the captions with the given IDs for Stubby or Apiary.",
"location": "query",
"repeated": true,
"type": "string"
},
"onBehalfOf": {
"description": "ID of the Google+ Page for the channel that the request is on behalf of.",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
},
"videoId": {
"description": "Returns the captions for the specified video.",
"location": "query",
"required": true,
"type": "string"
}
},
"path": "youtube/v3/captions",
"response": {
"$ref": "CaptionListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"update": {
"description": "Updates an existing resource.",
"flatPath": "youtube/v3/captions",
"httpMethod": "PUT",
"id": "youtube.captions.update",
"mediaUpload": {
"accept": [
"text/xml",
"application/octet-stream",
"*/*"
],
"maxSize": "104857600",
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/youtube/v3/captions"
},
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/captions"
}
}
},
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOf": {
"description": "ID of the Google+ Page for the channel that the request is on behalf of.",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
},
"sync": {
"description": "Extra parameter to allow automatically syncing the uploaded caption/transcript with the audio.",
"location": "query",
"type": "boolean"
}
},
"path": "youtube/v3/captions",
"request": {
"$ref": "Caption"
},
"response": {
"$ref": "Caption"
},
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
],
"supportsMediaUpload": true
}
}
},
"channelBanners": {
"methods": {
"insert": {
"description": "Inserts a new resource into this collection.",
"flatPath": "youtube/v3/channelBanners/insert",
"httpMethod": "POST",
"id": "youtube.channelBanners.insert",
"mediaUpload": {
"accept": [
"image/jpeg",
"image/png",
"application/octet-stream"
],
"maxSize": "6291456",
"protocols": {
"resumable": {
"multipart": true,
"path": "/resumable/upload/youtube/v3/channelBanners/insert"
},
"simple": {
"multipart": true,
"path": "/upload/youtube/v3/channelBanners/insert"
}
}
},
"parameterOrder": [],
"parameters": {
"channelId": {
"description": "Unused, channel_id is currently derived from the security context of the requestor.",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwnerChannel": {
"description": "This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.",
"location": "query",
"type": "string"
}
},
"path": "youtube/v3/channelBanners/insert",
"request": {
"$ref": "ChannelBannerResource"
},
"response": {
"$ref": "ChannelBannerResource"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.upload"
],
"supportsMediaUpload": true
}
}
},
"channelSections": {
"methods": {
"delete": {
"description": "Deletes a resource.",
"flatPath": "youtube/v3/channelSections",
"httpMethod": "DELETE",
"id": "youtube.channelSections.delete",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"location": "query",
"required": true,
"type": "string"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
}
},
"path": "youtube/v3/channelSections",
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"insert": {
"description": "Inserts a new resource into this collection.",
"flatPath": "youtube/v3/channelSections",
"httpMethod": "POST",
"id": "youtube.channelSections.insert",
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"onBehalfOfContentOwnerChannel": {
"description": "This parameter can only be used in a properly authorized request. *Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel* parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
}
},
"path": "youtube/v3/channelSections",
"request": {
"$ref": "ChannelSection"
},
"response": {
"$ref": "ChannelSection"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"list": {
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/channelSections",
"httpMethod": "GET",
"id": "youtube.channelSections.list",
"parameterOrder": [
"part"
],
"parameters": {
"channelId": {
"description": "Return the ChannelSections owned by the specified channel ID.",
"location": "query",
"type": "string"
},
"hl": {
"description": "Return content in specified language",
"location": "query",
"type": "string"
},
"id": {
"description": "Return the ChannelSections with the given IDs for Stubby or Apiary.",
"location": "query",
"repeated": true,
"type": "string"
},
"mine": {
"description": "Return the ChannelSections owned by the authenticated user.",
"location": "query",
"type": "boolean"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter specifies a comma-separated list of one or more channelSection resource properties that the API response will include. The part names that you can include in the parameter value are id, snippet, and contentDetails. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channelSection resource, the snippet property contains other properties, such as a display title for the channelSection. If you set *part=snippet*, the API response will also contain all of those nested properties.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
}
},
"path": "youtube/v3/channelSections",
"response": {
"$ref": "ChannelSectionListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner"
]
},
"update": {
"description": "Updates an existing resource.",
"flatPath": "youtube/v3/channelSections",
"httpMethod": "PUT",
"id": "youtube.channelSections.update",
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part names that you can include in the parameter value are snippet and contentDetails.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
}
},
"path": "youtube/v3/channelSections",
"request": {
"$ref": "ChannelSection"
},
"response": {
"$ref": "ChannelSection"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"channels": {
"methods": {
"list": {
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/channels",
"httpMethod": "GET",
"id": "youtube.channels.list",
"parameterOrder": [
"part"
],
"parameters": {
"categoryId": {
"description": "Return the channels within the specified guide category ID.",
"location": "query",
"type": "string"
},
"forUsername": {
"description": "Return the channel associated with a YouTube username.",
"location": "query",
"type": "string"
},
"hl": {
"description": "Stands for \"host language\". Specifies the localization language of the metadata to be filled into snippet.localized. The field is filled with the default metadata if there is no localization in the specified language. The parameter value must be a language code included in the list returned by the i18nLanguages.list method (e.g. en_US, es_MX).",
"location": "query",
"type": "string"
},
"id": {
"description": "Return the channels with the specified IDs.",
"location": "query",
"repeated": true,
"type": "string"
},
"managedByMe": {
"description": "Return the channels managed by the authenticated user.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "5",
"description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.",
"format": "uint32",
"location": "query",
"maximum": "50",
"minimum": "0",
"type": "integer"
},
"mine": {
"description": "Return the ids of channels owned by the authenticated user.",
"location": "query",
"type": "boolean"
},
"mySubscribers": {
"description": "Return the channels subscribed to the authenticated user",
"location": "query",
"type": "boolean"
},
"onBehalfOfContentOwner": {
"description": "*Note:* This parameter is intended exclusively for YouTube content partners. The *onBehalfOfContentOwner* parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter specifies a comma-separated list of one or more channel resource properties that the API response will include. If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a channel resource, the contentDetails property contains other properties, such as the uploads properties. As such, if you set *part=contentDetails*, the API response will also contain all of those nested properties.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
}
},
"path": "youtube/v3/channels",
"response": {
"$ref": "ChannelListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtube.readonly",
"https://www.googleapis.com/auth/youtubepartner",
"https://www.googleapis.com/auth/youtubepartner-channel-audit"
]
},
"update": {
"description": "Updates an existing resource.",
"flatPath": "youtube/v3/channels",
"httpMethod": "PUT",
"id": "youtube.channels.update",
"parameterOrder": [
"part"
],
"parameters": {
"onBehalfOfContentOwner": {
"description": "The *onBehalfOfContentOwner* parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
}
},
"path": "youtube/v3/channels",
"request": {
"$ref": "Channel"
},
"response": {
"$ref": "Channel"
},
"scopes": [
"https://www.googleapis.com/auth/youtube",
"https://www.googleapis.com/auth/youtube.force-ssl",
"https://www.googleapis.com/auth/youtubepartner"
]
}
}
},
"commentThreads": {
"methods": {
"insert": {
"description": "Inserts a new resource into this collection.",
"flatPath": "youtube/v3/commentThreads",
"httpMethod": "POST",
"id": "youtube.commentThreads.insert",
"parameterOrder": [
"part"
],
"parameters": {
"part": {
"description": "The *part* parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
}
},
"path": "youtube/v3/commentThreads",
"request": {
"$ref": "CommentThread"
},
"response": {
"$ref": "CommentThread"
},
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
]
},
"list": {
"description": "Retrieves a list of resources, possibly filtered.",
"flatPath": "youtube/v3/commentThreads",
"httpMethod": "GET",
"id": "youtube.commentThreads.list",
"parameterOrder": [
"part"
],
"parameters": {
"allThreadsRelatedToChannelId": {
"description": "Returns the comment threads of all videos of the channel and the channel comments as well.",
"location": "query",
"type": "string"
},
"channelId": {
"description": "Returns the comment threads for all the channel comments (ie does not include comments left on videos).",
"location": "query",
"type": "string"
},
"id": {
"description": "Returns the comment threads with the given IDs for Stubby or Apiary.",
"location": "query",
"repeated": true,
"type": "string"
},
"maxResults": {
"default": "20",
"description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.",
"format": "uint32",
"location": "query",
"maximum": "100",
"minimum": "1",
"type": "integer"
},
"moderationStatus": {
"default": "published",
"description": "Limits the returned comment threads to those with the specified moderation status. Not compatible with the 'id' filter. Valid values: published, heldForReview, likelySpam.",
"enum": [
"published",
"heldForReview",
"likelySpam",
"rejected"
],
"enumDescriptions": [
"The comment is available for public display.",
"The comment is awaiting review by a moderator.",
"",
"The comment is unfit for display."
],
"location": "query",
"type": "string"
},
"order": {
"default": "time",
"enum": [
"orderUnspecified",
"time",
"relevance"
],
"enumDescriptions": [
"",
"Order by time.",
"Order by relevance."
],
"location": "query",
"type": "string"
},
"pageToken": {
"description": "The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved.",
"location": "query",
"type": "string"
},
"part": {
"description": "The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.",
"location": "query",
"repeated": true,
"required": true,
"type": "string"
},
"searchTerms": {
"description": "Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.",
"location": "query",
"type": "string"
},
"textFormat": {
"default": "html",
"description": "The requested text format for the returned comments.",
"enum": [
"textFormatUnspecified",
"html",
"plainText"
],
"enumDescriptions": [
"",
"Returns the comments in HTML format. This is the default value.",
"Returns the comments in plain text format."
],
"location": "query",
"type": "string"
},
"videoId": {
"description": "Returns the comment threads of the specified video.",
"location": "query",
"type": "string"
}
},
"path": "youtube/v3/commentThreads",
"response": {
"$ref": "CommentThreadListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
]
}
}
},
"comments": {
"methods": {
"delete": {
"description": "Deletes a resource.",
"flatPath": "youtube/v3/comments",
"httpMethod": "DELETE",
"id": "youtube.comments.delete",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"location": "query",
"required": true,
"type": "string"
}
},
"path": "youtube/v3/comments",
"scopes": [
"https://www.googleapis.com/auth/youtube.force-ssl"
]
},
"insert": {
"description": "Inserts a new resource into this collection.",
"flatPath": "youtube/v3/comments",
"httpMethod": "POST",
"id": "youtube.comments.insert",
"parameterOrder": [
"part"