@googleapis/youtube 29.0.0 → 30.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v3.ts CHANGED
@@ -520,6 +520,23 @@ export namespace youtube_v3 {
520
520
  */
521
521
  type?: string | null;
522
522
  }
523
+ /**
524
+ * Response for the Videos.stats API. Returns VideoStat information about a batch of videos. VideoStat contains a subset of the information in Video that is relevant to statistics and content details.
525
+ */
526
+ export interface Schema$BatchGetStatsResponse {
527
+ /**
528
+ * Output only. Etag of this resource.
529
+ */
530
+ etag?: string | null;
531
+ /**
532
+ * Output only. The videos' stats information.
533
+ */
534
+ items?: Schema$VideoStat[];
535
+ /**
536
+ * Output only. Identifies what kind of resource this is. Value: the fixed string "youtube#batchGetStatsResponse".
537
+ */
538
+ kind?: string | null;
539
+ }
523
540
  /**
524
541
  * A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
525
542
  */
@@ -4560,6 +4577,35 @@ export namespace youtube_v3 {
4560
4577
  */
4561
4578
  title?: string | null;
4562
4579
  }
4580
+ /**
4581
+ * A *VideoStat* resource represents a YouTube video's stats.
4582
+ */
4583
+ export interface Schema$VideoStat {
4584
+ /**
4585
+ * Output only. The VideoStatsContentDetails object contains information about the video content, including the length of the video.
4586
+ */
4587
+ contentDetails?: Schema$VideoStatsContentDetails;
4588
+ /**
4589
+ * Output only. Etag of this resource.
4590
+ */
4591
+ etag?: string | null;
4592
+ /**
4593
+ * Output only. The ID that YouTube uses to uniquely identify the video.
4594
+ */
4595
+ id?: string | null;
4596
+ /**
4597
+ * Output only. Identifies what kind of resource this is. Value: the fixed string "youtube#videoStats".
4598
+ */
4599
+ kind?: string | null;
4600
+ /**
4601
+ * Output only. The VideoStatsSnippet object contains basic details about the video, such publish time.
4602
+ */
4603
+ snippet?: Schema$VideoStatsSnippet;
4604
+ /**
4605
+ * Output only. The VideoStatsStatistics object contains statistics about the video.
4606
+ */
4607
+ statistics?: Schema$VideoStatsStatistics;
4608
+ }
4563
4609
  /**
4564
4610
  * Statistics about the video, such as the number of times the video was viewed or liked.
4565
4611
  */
@@ -4585,6 +4631,41 @@ export namespace youtube_v3 {
4585
4631
  */
4586
4632
  viewCount?: string | null;
4587
4633
  }
4634
+ /**
4635
+ * Details about the content of a YouTube Video. This is a subset of the information in VideoContentDetails specifically for the Videos.stats API.
4636
+ */
4637
+ export interface Schema$VideoStatsContentDetails {
4638
+ /**
4639
+ * Output only. The length of the video. The property value is a [`google.protobuf.Duration`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) object.
4640
+ */
4641
+ duration?: string | null;
4642
+ }
4643
+ /**
4644
+ * Basic details about a video. This is a subset of the information in VideoSnippet specifically for the Videos.stats API.
4645
+ */
4646
+ export interface Schema$VideoStatsSnippet {
4647
+ /**
4648
+ * Output only. The date and time that the video was uploaded. The property value is a [`google.protobuf.Timestamp`](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp) object.
4649
+ */
4650
+ publishTime?: string | null;
4651
+ }
4652
+ /**
4653
+ * Statistics about the video, such as the number of times the video was viewed or liked.
4654
+ */
4655
+ export interface Schema$VideoStatsStatistics {
4656
+ /**
4657
+ * Output only. The number of comments for the video.
4658
+ */
4659
+ commentCount?: string | null;
4660
+ /**
4661
+ * Output only. The number of users who have indicated that they liked the video by giving it a positive rating.
4662
+ */
4663
+ likeCount?: string | null;
4664
+ /**
4665
+ * Output only. The number of times the video has been viewed.
4666
+ */
4667
+ viewCount?: string | null;
4668
+ }
4588
4669
  /**
4589
4670
  * Basic details about a video category, such as its localized title. Next Id: 19
4590
4671
  */
@@ -4883,8 +4964,7 @@ export namespace youtube_v3 {
4883
4964
  }
4884
4965
  }
4885
4966
 
4886
- export interface Params$Resource$Abusereports$Insert
4887
- extends StandardParameters {
4967
+ export interface Params$Resource$Abusereports$Insert extends StandardParameters {
4888
4968
  /**
4889
4969
  * 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.
4890
4970
  */
@@ -5889,8 +5969,7 @@ export namespace youtube_v3 {
5889
5969
  */
5890
5970
  onBehalfOfContentOwner?: string;
5891
5971
  }
5892
- export interface Params$Resource$Captions$Download
5893
- extends StandardParameters {
5972
+ export interface Params$Resource$Captions$Download extends StandardParameters {
5894
5973
  /**
5895
5974
  * The ID of the caption track to download, required for One Platform.
5896
5975
  */
@@ -6184,8 +6263,7 @@ export namespace youtube_v3 {
6184
6263
  }
6185
6264
  }
6186
6265
 
6187
- export interface Params$Resource$Channelbanners$Insert
6188
- extends StandardParameters {
6266
+ export interface Params$Resource$Channelbanners$Insert extends StandardParameters {
6189
6267
  /**
6190
6268
  * Unused, channel_id is currently derived from the security context of the requestor.
6191
6269
  */
@@ -7269,8 +7347,7 @@ export namespace youtube_v3 {
7269
7347
  }
7270
7348
  }
7271
7349
 
7272
- export interface Params$Resource$Channelsections$Delete
7273
- extends StandardParameters {
7350
+ export interface Params$Resource$Channelsections$Delete extends StandardParameters {
7274
7351
  /**
7275
7352
  *
7276
7353
  */
@@ -7280,8 +7357,7 @@ export namespace youtube_v3 {
7280
7357
  */
7281
7358
  onBehalfOfContentOwner?: string;
7282
7359
  }
7283
- export interface Params$Resource$Channelsections$Insert
7284
- extends StandardParameters {
7360
+ export interface Params$Resource$Channelsections$Insert extends StandardParameters {
7285
7361
  /**
7286
7362
  * *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.
7287
7363
  */
@@ -7300,8 +7376,7 @@ export namespace youtube_v3 {
7300
7376
  */
7301
7377
  requestBody?: Schema$ChannelSection;
7302
7378
  }
7303
- export interface Params$Resource$Channelsections$List
7304
- extends StandardParameters {
7379
+ export interface Params$Resource$Channelsections$List extends StandardParameters {
7305
7380
  /**
7306
7381
  * Return the ChannelSections owned by the specified channel ID.
7307
7382
  */
@@ -7327,8 +7402,7 @@ export namespace youtube_v3 {
7327
7402
  */
7328
7403
  part?: string[];
7329
7404
  }
7330
- export interface Params$Resource$Channelsections$Update
7331
- extends StandardParameters {
7405
+ export interface Params$Resource$Channelsections$Update extends StandardParameters {
7332
7406
  /**
7333
7407
  * *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.
7334
7408
  */
@@ -8239,15 +8313,13 @@ export namespace youtube_v3 {
8239
8313
  */
8240
8314
  textFormat?: string;
8241
8315
  }
8242
- export interface Params$Resource$Comments$Markasspam
8243
- extends StandardParameters {
8316
+ export interface Params$Resource$Comments$Markasspam extends StandardParameters {
8244
8317
  /**
8245
8318
  * Flags the comments with the given IDs as spam in the caller's opinion.
8246
8319
  */
8247
8320
  id?: string[];
8248
8321
  }
8249
- export interface Params$Resource$Comments$Setmoderationstatus
8250
- extends StandardParameters {
8322
+ export interface Params$Resource$Comments$Setmoderationstatus extends StandardParameters {
8251
8323
  /**
8252
8324
  * If set to true the author of the comment gets added to the ban list. This means all future comments of the author will autmomatically be rejected. Only valid in combination with STATUS_REJECTED.
8253
8325
  */
@@ -8603,8 +8675,7 @@ export namespace youtube_v3 {
8603
8675
  }
8604
8676
  }
8605
8677
 
8606
- export interface Params$Resource$Commentthreads$Insert
8607
- extends StandardParameters {
8678
+ export interface Params$Resource$Commentthreads$Insert extends StandardParameters {
8608
8679
  /**
8609
8680
  * 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.
8610
8681
  */
@@ -8615,8 +8686,7 @@ export namespace youtube_v3 {
8615
8686
  */
8616
8687
  requestBody?: Schema$CommentThread;
8617
8688
  }
8618
- export interface Params$Resource$Commentthreads$List
8619
- extends StandardParameters {
8689
+ export interface Params$Resource$Commentthreads$List extends StandardParameters {
8620
8690
  /**
8621
8691
  * Returns the comment threads of all videos of the channel and the channel comments as well.
8622
8692
  */
@@ -8823,8 +8893,7 @@ export namespace youtube_v3 {
8823
8893
  }
8824
8894
  }
8825
8895
 
8826
- export interface Params$Resource$I18nlanguages$List
8827
- extends StandardParameters {
8896
+ export interface Params$Resource$I18nlanguages$List extends StandardParameters {
8828
8897
  /**
8829
8898
  *
8830
8899
  */
@@ -10121,8 +10190,7 @@ export namespace youtube_v3 {
10121
10190
  }
10122
10191
  }
10123
10192
 
10124
- export interface Params$Resource$Livebroadcasts$Bind
10125
- extends StandardParameters {
10193
+ export interface Params$Resource$Livebroadcasts$Bind extends StandardParameters {
10126
10194
  /**
10127
10195
  * Broadcast to bind to the stream
10128
10196
  */
@@ -10144,8 +10212,7 @@ export namespace youtube_v3 {
10144
10212
  */
10145
10213
  streamId?: string;
10146
10214
  }
10147
- export interface Params$Resource$Livebroadcasts$Delete
10148
- extends StandardParameters {
10215
+ export interface Params$Resource$Livebroadcasts$Delete extends StandardParameters {
10149
10216
  /**
10150
10217
  * Broadcast to delete.
10151
10218
  */
@@ -10159,8 +10226,7 @@ export namespace youtube_v3 {
10159
10226
  */
10160
10227
  onBehalfOfContentOwnerChannel?: string;
10161
10228
  }
10162
- export interface Params$Resource$Livebroadcasts$Insert
10163
- extends StandardParameters {
10229
+ export interface Params$Resource$Livebroadcasts$Insert extends StandardParameters {
10164
10230
  /**
10165
10231
  * *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.
10166
10232
  */
@@ -10179,8 +10245,7 @@ export namespace youtube_v3 {
10179
10245
  */
10180
10246
  requestBody?: Schema$LiveBroadcast;
10181
10247
  }
10182
- export interface Params$Resource$Livebroadcasts$Insertcuepoint
10183
- extends StandardParameters {
10248
+ export interface Params$Resource$Livebroadcasts$Insertcuepoint extends StandardParameters {
10184
10249
  /**
10185
10250
  * Broadcast to insert ads to, or equivalently `external_video_id` for internal use.
10186
10251
  */
@@ -10203,8 +10268,7 @@ export namespace youtube_v3 {
10203
10268
  */
10204
10269
  requestBody?: Schema$Cuepoint;
10205
10270
  }
10206
- export interface Params$Resource$Livebroadcasts$List
10207
- extends StandardParameters {
10271
+ export interface Params$Resource$Livebroadcasts$List extends StandardParameters {
10208
10272
  /**
10209
10273
  * Return broadcasts with a certain status, e.g. active broadcasts.
10210
10274
  */
@@ -10242,8 +10306,7 @@ export namespace youtube_v3 {
10242
10306
  */
10243
10307
  part?: string[];
10244
10308
  }
10245
- export interface Params$Resource$Livebroadcasts$Transition
10246
- extends StandardParameters {
10309
+ export interface Params$Resource$Livebroadcasts$Transition extends StandardParameters {
10247
10310
  /**
10248
10311
  * The status to which the broadcast is going to transition.
10249
10312
  */
@@ -10265,8 +10328,7 @@ export namespace youtube_v3 {
10265
10328
  */
10266
10329
  part?: string[];
10267
10330
  }
10268
- export interface Params$Resource$Livebroadcasts$Update
10269
- extends StandardParameters {
10331
+ export interface Params$Resource$Livebroadcasts$Update extends StandardParameters {
10270
10332
  /**
10271
10333
  * *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.
10272
10334
  */
@@ -10579,15 +10641,13 @@ export namespace youtube_v3 {
10579
10641
  }
10580
10642
  }
10581
10643
 
10582
- export interface Params$Resource$Livechatbans$Delete
10583
- extends StandardParameters {
10644
+ export interface Params$Resource$Livechatbans$Delete extends StandardParameters {
10584
10645
  /**
10585
10646
  *
10586
10647
  */
10587
10648
  id?: string;
10588
10649
  }
10589
- export interface Params$Resource$Livechatbans$Insert
10590
- extends StandardParameters {
10650
+ export interface Params$Resource$Livechatbans$Insert extends StandardParameters {
10591
10651
  /**
10592
10652
  * 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 returns. Set the parameter value to snippet.
10593
10653
  */
@@ -11205,15 +11265,13 @@ export namespace youtube_v3 {
11205
11265
  }
11206
11266
  }
11207
11267
 
11208
- export interface Params$Resource$Livechatmessages$Delete
11209
- extends StandardParameters {
11268
+ export interface Params$Resource$Livechatmessages$Delete extends StandardParameters {
11210
11269
  /**
11211
11270
  *
11212
11271
  */
11213
11272
  id?: string;
11214
11273
  }
11215
- export interface Params$Resource$Livechatmessages$Insert
11216
- extends StandardParameters {
11274
+ export interface Params$Resource$Livechatmessages$Insert extends StandardParameters {
11217
11275
  /**
11218
11276
  * The *part* parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet.
11219
11277
  */
@@ -11224,8 +11282,7 @@ export namespace youtube_v3 {
11224
11282
  */
11225
11283
  requestBody?: Schema$LiveChatMessage;
11226
11284
  }
11227
- export interface Params$Resource$Livechatmessages$List
11228
- extends StandardParameters {
11285
+ export interface Params$Resource$Livechatmessages$List extends StandardParameters {
11229
11286
  /**
11230
11287
  * Specifies the localization language in which the system messages should be returned.
11231
11288
  */
@@ -11251,8 +11308,7 @@ export namespace youtube_v3 {
11251
11308
  */
11252
11309
  profileImageSize?: number;
11253
11310
  }
11254
- export interface Params$Resource$Livechatmessages$Transition
11255
- extends StandardParameters {
11311
+ export interface Params$Resource$Livechatmessages$Transition extends StandardParameters {
11256
11312
  /**
11257
11313
  * The ID that uniquely identify the chat message event to transition.
11258
11314
  */
@@ -11717,15 +11773,13 @@ export namespace youtube_v3 {
11717
11773
  }
11718
11774
  }
11719
11775
 
11720
- export interface Params$Resource$Livechatmoderators$Delete
11721
- extends StandardParameters {
11776
+ export interface Params$Resource$Livechatmoderators$Delete extends StandardParameters {
11722
11777
  /**
11723
11778
  *
11724
11779
  */
11725
11780
  id?: string;
11726
11781
  }
11727
- export interface Params$Resource$Livechatmoderators$Insert
11728
- extends StandardParameters {
11782
+ export interface Params$Resource$Livechatmoderators$Insert extends StandardParameters {
11729
11783
  /**
11730
11784
  * 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 returns. Set the parameter value to snippet.
11731
11785
  */
@@ -11736,8 +11790,7 @@ export namespace youtube_v3 {
11736
11790
  */
11737
11791
  requestBody?: Schema$LiveChatModerator;
11738
11792
  }
11739
- export interface Params$Resource$Livechatmoderators$List
11740
- extends StandardParameters {
11793
+ export interface Params$Resource$Livechatmoderators$List extends StandardParameters {
11741
11794
  /**
11742
11795
  * The id of the live chat for which moderators should be returned.
11743
11796
  */
@@ -12389,8 +12442,7 @@ export namespace youtube_v3 {
12389
12442
  }
12390
12443
  }
12391
12444
 
12392
- export interface Params$Resource$Livestreams$Delete
12393
- extends StandardParameters {
12445
+ export interface Params$Resource$Livestreams$Delete extends StandardParameters {
12394
12446
  /**
12395
12447
  *
12396
12448
  */
@@ -12404,8 +12456,7 @@ export namespace youtube_v3 {
12404
12456
  */
12405
12457
  onBehalfOfContentOwnerChannel?: string;
12406
12458
  }
12407
- export interface Params$Resource$Livestreams$Insert
12408
- extends StandardParameters {
12459
+ export interface Params$Resource$Livestreams$Insert extends StandardParameters {
12409
12460
  /**
12410
12461
  * *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.
12411
12462
  */
@@ -12454,8 +12505,7 @@ export namespace youtube_v3 {
12454
12505
  */
12455
12506
  part?: string[];
12456
12507
  }
12457
- export interface Params$Resource$Livestreams$Update
12458
- extends StandardParameters {
12508
+ export interface Params$Resource$Livestreams$Update extends StandardParameters {
12459
12509
  /**
12460
12510
  * *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.
12461
12511
  */
@@ -12820,8 +12870,7 @@ export namespace youtube_v3 {
12820
12870
  }
12821
12871
  }
12822
12872
 
12823
- export interface Params$Resource$Membershipslevels$List
12824
- extends StandardParameters {
12873
+ export interface Params$Resource$Membershipslevels$List extends StandardParameters {
12825
12874
  /**
12826
12875
  * The *part* parameter specifies the membershipsLevel resource parts that the API response will include. Supported values are id and snippet.
12827
12876
  */
@@ -13459,8 +13508,7 @@ export namespace youtube_v3 {
13459
13508
  }
13460
13509
  }
13461
13510
 
13462
- export interface Params$Resource$Playlistimages$Delete
13463
- extends StandardParameters {
13511
+ export interface Params$Resource$Playlistimages$Delete extends StandardParameters {
13464
13512
  /**
13465
13513
  * Id to identify this image. This is returned from by the List method.
13466
13514
  */
@@ -13470,8 +13518,7 @@ export namespace youtube_v3 {
13470
13518
  */
13471
13519
  onBehalfOfContentOwner?: string;
13472
13520
  }
13473
- export interface Params$Resource$Playlistimages$Insert
13474
- extends StandardParameters {
13521
+ export interface Params$Resource$Playlistimages$Insert extends StandardParameters {
13475
13522
  /**
13476
13523
  * *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.
13477
13524
  */
@@ -13505,8 +13552,7 @@ export namespace youtube_v3 {
13505
13552
  body?: any;
13506
13553
  };
13507
13554
  }
13508
- export interface Params$Resource$Playlistimages$List
13509
- extends StandardParameters {
13555
+ export interface Params$Resource$Playlistimages$List extends StandardParameters {
13510
13556
  /**
13511
13557
  * The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
13512
13558
  */
@@ -13532,8 +13578,7 @@ export namespace youtube_v3 {
13532
13578
  */
13533
13579
  part?: string[];
13534
13580
  }
13535
- export interface Params$Resource$Playlistimages$Update
13536
- extends StandardParameters {
13581
+ export interface Params$Resource$Playlistimages$Update extends StandardParameters {
13537
13582
  /**
13538
13583
  * *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.
13539
13584
  */
@@ -14191,8 +14236,7 @@ export namespace youtube_v3 {
14191
14236
  }
14192
14237
  }
14193
14238
 
14194
- export interface Params$Resource$Playlistitems$Delete
14195
- extends StandardParameters {
14239
+ export interface Params$Resource$Playlistitems$Delete extends StandardParameters {
14196
14240
  /**
14197
14241
  *
14198
14242
  */
@@ -14202,8 +14246,7 @@ export namespace youtube_v3 {
14202
14246
  */
14203
14247
  onBehalfOfContentOwner?: string;
14204
14248
  }
14205
- export interface Params$Resource$Playlistitems$Insert
14206
- extends StandardParameters {
14249
+ export interface Params$Resource$Playlistitems$Insert extends StandardParameters {
14207
14250
  /**
14208
14251
  * *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.
14209
14252
  */
@@ -14218,8 +14261,7 @@ export namespace youtube_v3 {
14218
14261
  */
14219
14262
  requestBody?: Schema$PlaylistItem;
14220
14263
  }
14221
- export interface Params$Resource$Playlistitems$List
14222
- extends StandardParameters {
14264
+ export interface Params$Resource$Playlistitems$List extends StandardParameters {
14223
14265
  /**
14224
14266
  *
14225
14267
  */
@@ -14249,8 +14291,7 @@ export namespace youtube_v3 {
14249
14291
  */
14250
14292
  videoId?: string;
14251
14293
  }
14252
- export interface Params$Resource$Playlistitems$Update
14253
- extends StandardParameters {
14294
+ export interface Params$Resource$Playlistitems$Update extends StandardParameters {
14254
14295
  /**
14255
14296
  * *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.
14256
14297
  */
@@ -15801,15 +15842,13 @@ export namespace youtube_v3 {
15801
15842
  }
15802
15843
  }
15803
15844
 
15804
- export interface Params$Resource$Subscriptions$Delete
15805
- extends StandardParameters {
15845
+ export interface Params$Resource$Subscriptions$Delete extends StandardParameters {
15806
15846
  /**
15807
15847
  *
15808
15848
  */
15809
15849
  id?: string;
15810
15850
  }
15811
- export interface Params$Resource$Subscriptions$Insert
15812
- extends StandardParameters {
15851
+ export interface Params$Resource$Subscriptions$Insert extends StandardParameters {
15813
15852
  /**
15814
15853
  * 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.
15815
15854
  */
@@ -15820,8 +15859,7 @@ export namespace youtube_v3 {
15820
15859
  */
15821
15860
  requestBody?: Schema$Subscription;
15822
15861
  }
15823
- export interface Params$Resource$Subscriptions$List
15824
- extends StandardParameters {
15862
+ export interface Params$Resource$Subscriptions$List extends StandardParameters {
15825
15863
  /**
15826
15864
  * Return the subscriptions of the given channel owner.
15827
15865
  */
@@ -16037,8 +16075,7 @@ export namespace youtube_v3 {
16037
16075
  }
16038
16076
  }
16039
16077
 
16040
- export interface Params$Resource$Superchatevents$List
16041
- extends StandardParameters {
16078
+ export interface Params$Resource$Superchatevents$List extends StandardParameters {
16042
16079
  /**
16043
16080
  * Return rendered funding amounts in specified language.
16044
16081
  */
@@ -16832,8 +16869,7 @@ export namespace youtube_v3 {
16832
16869
  }
16833
16870
  }
16834
16871
 
16835
- export interface Params$Resource$Thirdpartylinks$Delete
16836
- extends StandardParameters {
16872
+ export interface Params$Resource$Thirdpartylinks$Delete extends StandardParameters {
16837
16873
  /**
16838
16874
  * Channel ID to which changes should be applied, for delegation.
16839
16875
  */
@@ -16851,8 +16887,7 @@ export namespace youtube_v3 {
16851
16887
  */
16852
16888
  type?: string;
16853
16889
  }
16854
- export interface Params$Resource$Thirdpartylinks$Insert
16855
- extends StandardParameters {
16890
+ export interface Params$Resource$Thirdpartylinks$Insert extends StandardParameters {
16856
16891
  /**
16857
16892
  * Channel ID to which changes should be applied, for delegation.
16858
16893
  */
@@ -16867,8 +16902,7 @@ export namespace youtube_v3 {
16867
16902
  */
16868
16903
  requestBody?: Schema$ThirdPartyLink;
16869
16904
  }
16870
- export interface Params$Resource$Thirdpartylinks$List
16871
- extends StandardParameters {
16905
+ export interface Params$Resource$Thirdpartylinks$List extends StandardParameters {
16872
16906
  /**
16873
16907
  * Channel ID to which changes should be applied, for delegation.
16874
16908
  */
@@ -16886,8 +16920,7 @@ export namespace youtube_v3 {
16886
16920
  */
16887
16921
  type?: string;
16888
16922
  }
16889
- export interface Params$Resource$Thirdpartylinks$Update
16890
- extends StandardParameters {
16923
+ export interface Params$Resource$Thirdpartylinks$Update extends StandardParameters {
16891
16924
  /**
16892
16925
  * Channel ID to which changes should be applied, for delegation.
16893
16926
  */
@@ -17265,8 +17298,7 @@ export namespace youtube_v3 {
17265
17298
  }
17266
17299
  }
17267
17300
 
17268
- export interface Params$Resource$Videoabusereportreasons$List
17269
- extends StandardParameters {
17301
+ export interface Params$Resource$Videoabusereportreasons$List extends StandardParameters {
17270
17302
  /**
17271
17303
  *
17272
17304
  */
@@ -17443,8 +17475,7 @@ export namespace youtube_v3 {
17443
17475
  }
17444
17476
  }
17445
17477
 
17446
- export interface Params$Resource$Videocategories$List
17447
- extends StandardParameters {
17478
+ export interface Params$Resource$Videocategories$List extends StandardParameters {
17448
17479
  /**
17449
17480
  *
17450
17481
  */
@@ -18713,8 +18744,7 @@ export namespace youtube_v3 {
18713
18744
  */
18714
18745
  rating?: string;
18715
18746
  }
18716
- export interface Params$Resource$Videos$Reportabuse
18717
- extends StandardParameters {
18747
+ export interface Params$Resource$Videos$Reportabuse extends StandardParameters {
18718
18748
  /**
18719
18749
  * *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.
18720
18750
  */
@@ -18893,8 +18923,7 @@ export namespace youtube_v3 {
18893
18923
  }
18894
18924
  }
18895
18925
 
18896
- export interface Params$Resource$Videotrainability$Get
18897
- extends StandardParameters {
18926
+ export interface Params$Resource$Videotrainability$Get extends StandardParameters {
18898
18927
  /**
18899
18928
  * The ID of the video to retrieve.
18900
18929
  */
@@ -19250,9 +19279,11 @@ export namespace youtube_v3 {
19250
19279
  export class Resource$Youtube$V3 {
19251
19280
  context: APIRequestContext;
19252
19281
  liveChat: Resource$Youtube$V3$Livechat;
19282
+ videos: Resource$Youtube$V3$Videos;
19253
19283
  constructor(context: APIRequestContext) {
19254
19284
  this.context = context;
19255
19285
  this.liveChat = new Resource$Youtube$V3$Livechat(this.context);
19286
+ this.videos = new Resource$Youtube$V3$Videos(this.context);
19256
19287
  }
19257
19288
 
19258
19289
  /**
@@ -19411,8 +19442,7 @@ export namespace youtube_v3 {
19411
19442
  }
19412
19443
  }
19413
19444
 
19414
- export interface Params$Resource$Youtube$V3$Updatecommentthreads
19415
- extends StandardParameters {
19445
+ export interface Params$Resource$Youtube$V3$Updatecommentthreads extends StandardParameters {
19416
19446
  /**
19417
19447
  * The *part* parameter specifies a comma-separated list of commentThread resource properties that the API response will include. You must at least include the snippet part in the parameter value since that part contains all of the properties that the API request can update.
19418
19448
  */
@@ -19605,8 +19635,7 @@ export namespace youtube_v3 {
19605
19635
  }
19606
19636
  }
19607
19637
 
19608
- export interface Params$Resource$Youtube$V3$Livechat$Messages$Stream
19609
- extends StandardParameters {
19638
+ export interface Params$Resource$Youtube$V3$Livechat$Messages$Stream extends StandardParameters {
19610
19639
  /**
19611
19640
  * Specifies the localization language in which the system messages should be returned.
19612
19641
  */
@@ -19632,4 +19661,173 @@ export namespace youtube_v3 {
19632
19661
  */
19633
19662
  profileImageSize?: number;
19634
19663
  }
19664
+
19665
+ export class Resource$Youtube$V3$Videos {
19666
+ context: APIRequestContext;
19667
+ constructor(context: APIRequestContext) {
19668
+ this.context = context;
19669
+ }
19670
+
19671
+ /**
19672
+ * Retrieves a batch of VideoStat resources, possibly filtered.
19673
+ * @example
19674
+ * ```js
19675
+ * // Before running the sample:
19676
+ * // - Enable the API at:
19677
+ * // https://console.developers.google.com/apis/api/youtube.googleapis.com
19678
+ * // - Login into gcloud by running:
19679
+ * // ```sh
19680
+ * // $ gcloud auth application-default login
19681
+ * // ```
19682
+ * // - Install the npm module by running:
19683
+ * // ```sh
19684
+ * // $ npm install googleapis
19685
+ * // ```
19686
+ *
19687
+ * const {google} = require('googleapis');
19688
+ * const youtube = google.youtube('v3');
19689
+ *
19690
+ * async function main() {
19691
+ * const auth = new google.auth.GoogleAuth({
19692
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
19693
+ * scopes: [],
19694
+ * });
19695
+ *
19696
+ * // Acquire an auth client, and bind it to all future calls
19697
+ * const authClient = await auth.getClient();
19698
+ * google.options({auth: authClient});
19699
+ *
19700
+ * // Do the magic
19701
+ * const res = await youtube.youtube.v3.videos.batchGetStats({
19702
+ * // Required. Return videos with the given ids.
19703
+ * id: 'placeholder-value',
19704
+ * // Optional. **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.
19705
+ * onBehalfOfContentOwner: 'placeholder-value',
19706
+ * // Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` 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 `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties.
19707
+ * part: 'placeholder-value',
19708
+ * });
19709
+ * console.log(res.data);
19710
+ *
19711
+ * // Example response
19712
+ * // {
19713
+ * // "etag": "my_etag",
19714
+ * // "items": [],
19715
+ * // "kind": "my_kind"
19716
+ * // }
19717
+ * }
19718
+ *
19719
+ * main().catch(e => {
19720
+ * console.error(e);
19721
+ * throw e;
19722
+ * });
19723
+ *
19724
+ * ```
19725
+ *
19726
+ * @param params - Parameters for request
19727
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
19728
+ * @param callback - Optional callback that handles the response.
19729
+ * @returns A promise if used with async/await, or void if used with a callback.
19730
+ */
19731
+ batchGetStats(
19732
+ params: Params$Resource$Youtube$V3$Videos$Batchgetstats,
19733
+ options: StreamMethodOptions
19734
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
19735
+ batchGetStats(
19736
+ params?: Params$Resource$Youtube$V3$Videos$Batchgetstats,
19737
+ options?: MethodOptions
19738
+ ): Promise<GaxiosResponseWithHTTP2<Schema$BatchGetStatsResponse>>;
19739
+ batchGetStats(
19740
+ params: Params$Resource$Youtube$V3$Videos$Batchgetstats,
19741
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
19742
+ callback: BodyResponseCallback<Readable>
19743
+ ): void;
19744
+ batchGetStats(
19745
+ params: Params$Resource$Youtube$V3$Videos$Batchgetstats,
19746
+ options:
19747
+ | MethodOptions
19748
+ | BodyResponseCallback<Schema$BatchGetStatsResponse>,
19749
+ callback: BodyResponseCallback<Schema$BatchGetStatsResponse>
19750
+ ): void;
19751
+ batchGetStats(
19752
+ params: Params$Resource$Youtube$V3$Videos$Batchgetstats,
19753
+ callback: BodyResponseCallback<Schema$BatchGetStatsResponse>
19754
+ ): void;
19755
+ batchGetStats(
19756
+ callback: BodyResponseCallback<Schema$BatchGetStatsResponse>
19757
+ ): void;
19758
+ batchGetStats(
19759
+ paramsOrCallback?:
19760
+ | Params$Resource$Youtube$V3$Videos$Batchgetstats
19761
+ | BodyResponseCallback<Schema$BatchGetStatsResponse>
19762
+ | BodyResponseCallback<Readable>,
19763
+ optionsOrCallback?:
19764
+ | MethodOptions
19765
+ | StreamMethodOptions
19766
+ | BodyResponseCallback<Schema$BatchGetStatsResponse>
19767
+ | BodyResponseCallback<Readable>,
19768
+ callback?:
19769
+ | BodyResponseCallback<Schema$BatchGetStatsResponse>
19770
+ | BodyResponseCallback<Readable>
19771
+ ):
19772
+ | void
19773
+ | Promise<GaxiosResponseWithHTTP2<Schema$BatchGetStatsResponse>>
19774
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
19775
+ let params = (paramsOrCallback ||
19776
+ {}) as Params$Resource$Youtube$V3$Videos$Batchgetstats;
19777
+ let options = (optionsOrCallback || {}) as MethodOptions;
19778
+
19779
+ if (typeof paramsOrCallback === 'function') {
19780
+ callback = paramsOrCallback;
19781
+ params = {} as Params$Resource$Youtube$V3$Videos$Batchgetstats;
19782
+ options = {};
19783
+ }
19784
+
19785
+ if (typeof optionsOrCallback === 'function') {
19786
+ callback = optionsOrCallback;
19787
+ options = {};
19788
+ }
19789
+
19790
+ const rootUrl = options.rootUrl || 'https://youtube.googleapis.com/';
19791
+ const parameters = {
19792
+ options: Object.assign(
19793
+ {
19794
+ url: (rootUrl + '/youtube/v3/videos:batchGetStats').replace(
19795
+ /([^:]\/)\/+/g,
19796
+ '$1'
19797
+ ),
19798
+ method: 'GET',
19799
+ apiVersion: '',
19800
+ },
19801
+ options
19802
+ ),
19803
+ params,
19804
+ requiredParams: [],
19805
+ pathParams: [],
19806
+ context: this.context,
19807
+ };
19808
+ if (callback) {
19809
+ createAPIRequest<Schema$BatchGetStatsResponse>(
19810
+ parameters,
19811
+ callback as BodyResponseCallback<unknown>
19812
+ );
19813
+ } else {
19814
+ return createAPIRequest<Schema$BatchGetStatsResponse>(parameters);
19815
+ }
19816
+ }
19817
+ }
19818
+
19819
+ export interface Params$Resource$Youtube$V3$Videos$Batchgetstats extends StandardParameters {
19820
+ /**
19821
+ * Required. Return videos with the given ids.
19822
+ */
19823
+ id?: string[];
19824
+ /**
19825
+ * Optional. **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.
19826
+ */
19827
+ onBehalfOfContentOwner?: string;
19828
+ /**
19829
+ * Required. The `**part**` parameter specifies a comma-separated list of one or more `videoStat` 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 `videoStat` resource, the `statistics` property contains `view_count` and `like_count`. As such, if you set `**part=snippet**`, the API response will contain all of those properties.
19830
+ */
19831
+ part?: string[];
19832
+ }
19635
19833
  }