@googleapis/youtube 32.0.0 → 34.0.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,36 @@ 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. BatchGetStats is intentionally not atomic to provide a better user experience. BatchGetStatsResponse returns a summary to help users understand the outcome of the operation.
525
+ */
526
+ export interface Schema$BatchGetStatsResponse {
527
+ /**
528
+ * Etag of this resource.
529
+ */
530
+ etag?: string | null;
531
+ /**
532
+ * The videos' stats information.
533
+ */
534
+ items?: Schema$VideoStat[];
535
+ /**
536
+ * Identifies what kind of resource this is. Value: the fixed string "youtube#batchGetStatsResponse".
537
+ */
538
+ kind?: string | null;
539
+ }
540
+ /**
541
+ * Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6
542
+ */
543
+ export interface Schema$BrandPartner {
544
+ /**
545
+ * Required. Channel handle, must begin with "@"
546
+ */
547
+ channelHandle?: string | null;
548
+ /**
549
+ * Required. External Channel ID, must begin with "UC"
550
+ */
551
+ channelId?: string | null;
552
+ }
523
553
  /**
524
554
  * A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
525
555
  */
@@ -1131,6 +1161,27 @@ export namespace youtube_v3 {
1131
1161
  privacyStatus?: string | null;
1132
1162
  selfDeclaredMadeForKids?: boolean | null;
1133
1163
  }
1164
+ /**
1165
+ * Information specific to a creator in an affiliate program linked to a YouTube channel.
1166
+ */
1167
+ export interface Schema$ChannelToAffiliateProgramLinkDetails {
1168
+ /**
1169
+ * Required. Google Merchant Center ID of the partner.
1170
+ */
1171
+ merchantId?: string | null;
1172
+ /**
1173
+ * Required. Affiliate program status.
1174
+ */
1175
+ programStatus?: string | null;
1176
+ /**
1177
+ * Optional. Reason for the last update of the affiliate program status.
1178
+ */
1179
+ statusUpdateReason?: string | null;
1180
+ /**
1181
+ * Optional. Timestamp when the affiliate program status was last updated.
1182
+ */
1183
+ statusUpdateTime?: string | null;
1184
+ }
1134
1185
  /**
1135
1186
  * Freebase topic information related to the channel.
1136
1187
  */
@@ -2529,7 +2580,7 @@ export namespace youtube_v3 {
2529
2580
  */
2530
2581
  export interface Schema$LiveChatMessageSnippet {
2531
2582
  /**
2532
- * The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
2583
+ * The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll
2533
2584
  */
2534
2585
  authorChannelId?: string | null;
2535
2586
  /**
@@ -3500,7 +3551,7 @@ export namespace youtube_v3 {
3500
3551
  regionCode?: string | null;
3501
3552
  tokenPagination?: Schema$TokenPagination;
3502
3553
  /**
3503
- * The visitorId identifies the visitor.
3554
+ * The visitor ID identifies the visitor.
3504
3555
  */
3505
3556
  visitorId?: string | null;
3506
3557
  }
@@ -3842,6 +3893,10 @@ export namespace youtube_v3 {
3842
3893
  * Basic information about a third party account link, including its type and type-specific information.
3843
3894
  */
3844
3895
  export interface Schema$ThirdPartyLinkSnippet {
3896
+ /**
3897
+ * Information specific to a link between a channel and an affiliate program of a partner.
3898
+ */
3899
+ channelToAffiliateProgramLink?: Schema$ChannelToAffiliateProgramLinkDetails;
3845
3900
  /**
3846
3901
  * Information specific to a link between a channel and a store on a merchandising platform.
3847
3902
  */
@@ -3933,6 +3988,7 @@ export namespace youtube_v3 {
3933
3988
  * Age restriction details related to a video. This data can only be retrieved by the video owner.
3934
3989
  */
3935
3990
  ageGating?: Schema$VideoAgeGating;
3991
+ brandPartner?: Schema$BrandPartner;
3936
3992
  /**
3937
3993
  * The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
3938
3994
  */
@@ -4601,6 +4657,35 @@ export namespace youtube_v3 {
4601
4657
  */
4602
4658
  title?: string | null;
4603
4659
  }
4660
+ /**
4661
+ * A *VideoStat* resource represents a YouTube video's stats.
4662
+ */
4663
+ export interface Schema$VideoStat {
4664
+ /**
4665
+ * Output only. The VideoStatsContentDetails object contains information about the video content, including the length of the video.
4666
+ */
4667
+ contentDetails?: Schema$VideoStatsContentDetails;
4668
+ /**
4669
+ * Output only. Etag of this resource.
4670
+ */
4671
+ etag?: string | null;
4672
+ /**
4673
+ * Output only. The ID that YouTube uses to uniquely identify the video.
4674
+ */
4675
+ id?: string | null;
4676
+ /**
4677
+ * Output only. Identifies what kind of resource this is. Value: the fixed string "youtube#videoStats".
4678
+ */
4679
+ kind?: string | null;
4680
+ /**
4681
+ * Output only. The VideoStatsSnippet object contains basic details about the video, such publish time.
4682
+ */
4683
+ snippet?: Schema$VideoStatsSnippet;
4684
+ /**
4685
+ * Output only. The VideoStatsStatistics object contains statistics about the video.
4686
+ */
4687
+ statistics?: Schema$VideoStatsStatistics;
4688
+ }
4604
4689
  /**
4605
4690
  * Statistics about the video, such as the number of times the video was viewed or liked.
4606
4691
  */
@@ -4626,6 +4711,41 @@ export namespace youtube_v3 {
4626
4711
  */
4627
4712
  viewCount?: string | null;
4628
4713
  }
4714
+ /**
4715
+ * Details about the content of a YouTube Video. This is a subset of the information in VideoContentDetails specifically for the Videos.stats API.
4716
+ */
4717
+ export interface Schema$VideoStatsContentDetails {
4718
+ /**
4719
+ * 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.
4720
+ */
4721
+ duration?: string | null;
4722
+ }
4723
+ /**
4724
+ * Basic details about a video. This is a subset of the information in VideoSnippet specifically for the Videos.stats API.
4725
+ */
4726
+ export interface Schema$VideoStatsSnippet {
4727
+ /**
4728
+ * 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.
4729
+ */
4730
+ publishTime?: string | null;
4731
+ }
4732
+ /**
4733
+ * Statistics about the video, such as the number of times the video was viewed or liked.
4734
+ */
4735
+ export interface Schema$VideoStatsStatistics {
4736
+ /**
4737
+ * Output only. The number of comments for the video.
4738
+ */
4739
+ commentCount?: string | null;
4740
+ /**
4741
+ * Output only. The number of users who have indicated that they liked the video by giving it a positive rating.
4742
+ */
4743
+ likeCount?: string | null;
4744
+ /**
4745
+ * Output only. The number of times the video has been viewed.
4746
+ */
4747
+ viewCount?: string | null;
4748
+ }
4629
4749
  /**
4630
4750
  * Basic details about a video category, such as its localized title. Next Id: 19
4631
4751
  */
@@ -5039,8 +5159,7 @@ export namespace youtube_v3 {
5039
5159
  list(
5040
5160
  params: Params$Resource$Activities$List,
5041
5161
  options:
5042
- | MethodOptions
5043
- | BodyResponseCallback<Schema$ActivityListResponse>,
5162
+ MethodOptions | BodyResponseCallback<Schema$ActivityListResponse>,
5044
5163
  callback: BodyResponseCallback<Schema$ActivityListResponse>
5045
5164
  ): void;
5046
5165
  list(
@@ -5544,8 +5663,7 @@ export namespace youtube_v3 {
5544
5663
  | BodyResponseCallback<Schema$Caption>
5545
5664
  | BodyResponseCallback<Readable>,
5546
5665
  callback?:
5547
- | BodyResponseCallback<Schema$Caption>
5548
- | BodyResponseCallback<Readable>
5666
+ BodyResponseCallback<Schema$Caption> | BodyResponseCallback<Readable>
5549
5667
  ):
5550
5668
  | void
5551
5669
  | Promise<GaxiosResponseWithHTTP2<Schema$Caption>>
@@ -5862,8 +5980,7 @@ export namespace youtube_v3 {
5862
5980
  | BodyResponseCallback<Schema$Caption>
5863
5981
  | BodyResponseCallback<Readable>,
5864
5982
  callback?:
5865
- | BodyResponseCallback<Schema$Caption>
5866
- | BodyResponseCallback<Readable>
5983
+ BodyResponseCallback<Schema$Caption> | BodyResponseCallback<Readable>
5867
5984
  ):
5868
5985
  | void
5869
5986
  | Promise<GaxiosResponseWithHTTP2<Schema$Caption>>
@@ -6150,8 +6267,7 @@ export namespace youtube_v3 {
6150
6267
  insert(
6151
6268
  params: Params$Resource$Channelbanners$Insert,
6152
6269
  options:
6153
- | MethodOptions
6154
- | BodyResponseCallback<Schema$ChannelBannerResource>,
6270
+ MethodOptions | BodyResponseCallback<Schema$ChannelBannerResource>,
6155
6271
  callback: BodyResponseCallback<Schema$ChannelBannerResource>
6156
6272
  ): void;
6157
6273
  insert(
@@ -6562,8 +6678,7 @@ export namespace youtube_v3 {
6562
6678
  | BodyResponseCallback<Schema$Channel>
6563
6679
  | BodyResponseCallback<Readable>,
6564
6680
  callback?:
6565
- | BodyResponseCallback<Schema$Channel>
6566
- | BodyResponseCallback<Readable>
6681
+ BodyResponseCallback<Schema$Channel> | BodyResponseCallback<Readable>
6567
6682
  ):
6568
6683
  | void
6569
6684
  | Promise<GaxiosResponseWithHTTP2<Schema$Channel>>
@@ -7072,8 +7187,7 @@ export namespace youtube_v3 {
7072
7187
  list(
7073
7188
  params: Params$Resource$Channelsections$List,
7074
7189
  options:
7075
- | MethodOptions
7076
- | BodyResponseCallback<Schema$ChannelSectionListResponse>,
7190
+ MethodOptions | BodyResponseCallback<Schema$ChannelSectionListResponse>,
7077
7191
  callback: BodyResponseCallback<Schema$ChannelSectionListResponse>
7078
7192
  ): void;
7079
7193
  list(
@@ -7614,8 +7728,7 @@ export namespace youtube_v3 {
7614
7728
  | BodyResponseCallback<Schema$Comment>
7615
7729
  | BodyResponseCallback<Readable>,
7616
7730
  callback?:
7617
- | BodyResponseCallback<Schema$Comment>
7618
- | BodyResponseCallback<Readable>
7731
+ BodyResponseCallback<Schema$Comment> | BodyResponseCallback<Readable>
7619
7732
  ):
7620
7733
  | void
7621
7734
  | Promise<GaxiosResponseWithHTTP2<Schema$Comment>>
@@ -8181,8 +8294,7 @@ export namespace youtube_v3 {
8181
8294
  | BodyResponseCallback<Schema$Comment>
8182
8295
  | BodyResponseCallback<Readable>,
8183
8296
  callback?:
8184
- | BodyResponseCallback<Schema$Comment>
8185
- | BodyResponseCallback<Readable>
8297
+ BodyResponseCallback<Schema$Comment> | BodyResponseCallback<Readable>
8186
8298
  ):
8187
8299
  | void
8188
8300
  | Promise<GaxiosResponseWithHTTP2<Schema$Comment>>
@@ -8563,8 +8675,7 @@ export namespace youtube_v3 {
8563
8675
  list(
8564
8676
  params: Params$Resource$Commentthreads$List,
8565
8677
  options:
8566
- | MethodOptions
8567
- | BodyResponseCallback<Schema$CommentThreadListResponse>,
8678
+ MethodOptions | BodyResponseCallback<Schema$CommentThreadListResponse>,
8568
8679
  callback: BodyResponseCallback<Schema$CommentThreadListResponse>
8569
8680
  ): void;
8570
8681
  list(
@@ -8783,8 +8894,7 @@ export namespace youtube_v3 {
8783
8894
  list(
8784
8895
  params: Params$Resource$I18nlanguages$List,
8785
8896
  options:
8786
- | MethodOptions
8787
- | BodyResponseCallback<Schema$I18nLanguageListResponse>,
8897
+ MethodOptions | BodyResponseCallback<Schema$I18nLanguageListResponse>,
8788
8898
  callback: BodyResponseCallback<Schema$I18nLanguageListResponse>
8789
8899
  ): void;
8790
8900
  list(
@@ -8950,8 +9060,7 @@ export namespace youtube_v3 {
8950
9060
  list(
8951
9061
  params: Params$Resource$I18nregions$List,
8952
9062
  options:
8953
- | MethodOptions
8954
- | BodyResponseCallback<Schema$I18nRegionListResponse>,
9063
+ MethodOptions | BodyResponseCallback<Schema$I18nRegionListResponse>,
8955
9064
  callback: BodyResponseCallback<Schema$I18nRegionListResponse>
8956
9065
  ): void;
8957
9066
  list(
@@ -9610,8 +9719,7 @@ export namespace youtube_v3 {
9610
9719
  | BodyResponseCallback<Schema$Cuepoint>
9611
9720
  | BodyResponseCallback<Readable>,
9612
9721
  callback?:
9613
- | BodyResponseCallback<Schema$Cuepoint>
9614
- | BodyResponseCallback<Readable>
9722
+ BodyResponseCallback<Schema$Cuepoint> | BodyResponseCallback<Readable>
9615
9723
  ):
9616
9724
  | void
9617
9725
  | Promise<GaxiosResponseWithHTTP2<Schema$Cuepoint>>
@@ -9757,8 +9865,7 @@ export namespace youtube_v3 {
9757
9865
  list(
9758
9866
  params: Params$Resource$Livebroadcasts$List,
9759
9867
  options:
9760
- | MethodOptions
9761
- | BodyResponseCallback<Schema$LiveBroadcastListResponse>,
9868
+ MethodOptions | BodyResponseCallback<Schema$LiveBroadcastListResponse>,
9762
9869
  callback: BodyResponseCallback<Schema$LiveBroadcastListResponse>
9763
9870
  ): void;
9764
9871
  list(
@@ -12026,8 +12133,7 @@ export namespace youtube_v3 {
12026
12133
  | BodyResponseCallback<Schema$LiveStream>
12027
12134
  | BodyResponseCallback<Readable>,
12028
12135
  callback?:
12029
- | BodyResponseCallback<Schema$LiveStream>
12030
- | BodyResponseCallback<Readable>
12136
+ BodyResponseCallback<Schema$LiveStream> | BodyResponseCallback<Readable>
12031
12137
  ):
12032
12138
  | void
12033
12139
  | Promise<GaxiosResponseWithHTTP2<Schema$LiveStream>>
@@ -12169,8 +12275,7 @@ export namespace youtube_v3 {
12169
12275
  list(
12170
12276
  params: Params$Resource$Livestreams$List,
12171
12277
  options:
12172
- | MethodOptions
12173
- | BodyResponseCallback<Schema$LiveStreamListResponse>,
12278
+ MethodOptions | BodyResponseCallback<Schema$LiveStreamListResponse>,
12174
12279
  callback: BodyResponseCallback<Schema$LiveStreamListResponse>
12175
12280
  ): void;
12176
12281
  list(
@@ -12352,8 +12457,7 @@ export namespace youtube_v3 {
12352
12457
  | BodyResponseCallback<Schema$LiveStream>
12353
12458
  | BodyResponseCallback<Readable>,
12354
12459
  callback?:
12355
- | BodyResponseCallback<Schema$LiveStream>
12356
- | BodyResponseCallback<Readable>
12460
+ BodyResponseCallback<Schema$LiveStream> | BodyResponseCallback<Readable>
12357
12461
  ):
12358
12462
  | void
12359
12463
  | Promise<GaxiosResponseWithHTTP2<Schema$LiveStream>>
@@ -13233,8 +13337,7 @@ export namespace youtube_v3 {
13233
13337
  list(
13234
13338
  params: Params$Resource$Playlistimages$List,
13235
13339
  options:
13236
- | MethodOptions
13237
- | BodyResponseCallback<Schema$PlaylistImageListResponse>,
13340
+ MethodOptions | BodyResponseCallback<Schema$PlaylistImageListResponse>,
13238
13341
  callback: BodyResponseCallback<Schema$PlaylistImageListResponse>
13239
13342
  ): void;
13240
13343
  list(
@@ -13965,8 +14068,7 @@ export namespace youtube_v3 {
13965
14068
  list(
13966
14069
  params: Params$Resource$Playlistitems$List,
13967
14070
  options:
13968
- | MethodOptions
13969
- | BodyResponseCallback<Schema$PlaylistItemListResponse>,
14071
+ MethodOptions | BodyResponseCallback<Schema$PlaylistItemListResponse>,
13970
14072
  callback: BodyResponseCallback<Schema$PlaylistItemListResponse>
13971
14073
  ): void;
13972
14074
  list(
@@ -14525,8 +14627,7 @@ export namespace youtube_v3 {
14525
14627
  | BodyResponseCallback<Schema$Playlist>
14526
14628
  | BodyResponseCallback<Readable>,
14527
14629
  callback?:
14528
- | BodyResponseCallback<Schema$Playlist>
14529
- | BodyResponseCallback<Readable>
14630
+ BodyResponseCallback<Schema$Playlist> | BodyResponseCallback<Readable>
14530
14631
  ):
14531
14632
  | void
14532
14633
  | Promise<GaxiosResponseWithHTTP2<Schema$Playlist>>
@@ -14672,8 +14773,7 @@ export namespace youtube_v3 {
14672
14773
  list(
14673
14774
  params: Params$Resource$Playlists$List,
14674
14775
  options:
14675
- | MethodOptions
14676
- | BodyResponseCallback<Schema$PlaylistListResponse>,
14776
+ MethodOptions | BodyResponseCallback<Schema$PlaylistListResponse>,
14677
14777
  callback: BodyResponseCallback<Schema$PlaylistListResponse>
14678
14778
  ): void;
14679
14779
  list(
@@ -14856,8 +14956,7 @@ export namespace youtube_v3 {
14856
14956
  | BodyResponseCallback<Schema$Playlist>
14857
14957
  | BodyResponseCallback<Readable>,
14858
14958
  callback?:
14859
- | BodyResponseCallback<Schema$Playlist>
14860
- | BodyResponseCallback<Readable>
14959
+ BodyResponseCallback<Schema$Playlist> | BodyResponseCallback<Readable>
14861
14960
  ):
14862
14961
  | void
14863
14962
  | Promise<GaxiosResponseWithHTTP2<Schema$Playlist>>
@@ -15030,7 +15129,7 @@ export namespace youtube_v3 {
15030
15129
  *
15031
15130
  * // Do the magic
15032
15131
  * const res = await youtube.search.list({
15033
- * // Filter on resources belonging to this channelId.
15132
+ * // Filter on resources belonging to this channelId. (Force TAP rebuild)
15034
15133
  * channelId: 'placeholder-value',
15035
15134
  * // Add a filter on the channel search.
15036
15135
  * channelType: 'placeholder-value',
@@ -15204,7 +15303,7 @@ export namespace youtube_v3 {
15204
15303
 
15205
15304
  export interface Params$Resource$Search$List extends StandardParameters {
15206
15305
  /**
15207
- * Filter on resources belonging to this channelId.
15306
+ * Filter on resources belonging to this channelId. (Force TAP rebuild)
15208
15307
  */
15209
15308
  channelId?: string;
15210
15309
  /**
@@ -15732,8 +15831,7 @@ export namespace youtube_v3 {
15732
15831
  list(
15733
15832
  params: Params$Resource$Subscriptions$List,
15734
15833
  options:
15735
- | MethodOptions
15736
- | BodyResponseCallback<Schema$SubscriptionListResponse>,
15834
+ MethodOptions | BodyResponseCallback<Schema$SubscriptionListResponse>,
15737
15835
  callback: BodyResponseCallback<Schema$SubscriptionListResponse>
15738
15836
  ): void;
15739
15837
  list(
@@ -15963,8 +16061,7 @@ export namespace youtube_v3 {
15963
16061
  list(
15964
16062
  params: Params$Resource$Superchatevents$List,
15965
16063
  options:
15966
- | MethodOptions
15967
- | BodyResponseCallback<Schema$SuperChatEventListResponse>,
16064
+ MethodOptions | BodyResponseCallback<Schema$SuperChatEventListResponse>,
15968
16065
  callback: BodyResponseCallback<Schema$SuperChatEventListResponse>
15969
16066
  ): void;
15970
16067
  list(
@@ -16167,8 +16264,7 @@ export namespace youtube_v3 {
16167
16264
  | BodyResponseCallback<Schema$TestItem>
16168
16265
  | BodyResponseCallback<Readable>,
16169
16266
  callback?:
16170
- | BodyResponseCallback<Schema$TestItem>
16171
- | BodyResponseCallback<Readable>
16267
+ BodyResponseCallback<Schema$TestItem> | BodyResponseCallback<Readable>
16172
16268
  ):
16173
16269
  | void
16174
16270
  | Promise<GaxiosResponseWithHTTP2<Schema$TestItem>>
@@ -16608,8 +16704,7 @@ export namespace youtube_v3 {
16608
16704
  list(
16609
16705
  params: Params$Resource$Thirdpartylinks$List,
16610
16706
  options:
16611
- | MethodOptions
16612
- | BodyResponseCallback<Schema$ThirdPartyLinkListResponse>,
16707
+ MethodOptions | BodyResponseCallback<Schema$ThirdPartyLinkListResponse>,
16613
16708
  callback: BodyResponseCallback<Schema$ThirdPartyLinkListResponse>
16614
16709
  ): void;
16615
16710
  list(
@@ -16997,8 +17092,7 @@ export namespace youtube_v3 {
16997
17092
  set(
16998
17093
  params: Params$Resource$Thumbnails$Set,
16999
17094
  options:
17000
- | MethodOptions
17001
- | BodyResponseCallback<Schema$ThumbnailSetResponse>,
17095
+ MethodOptions | BodyResponseCallback<Schema$ThumbnailSetResponse>,
17002
17096
  callback: BodyResponseCallback<Schema$ThumbnailSetResponse>
17003
17097
  ): void;
17004
17098
  set(
@@ -17369,8 +17463,7 @@ export namespace youtube_v3 {
17369
17463
  list(
17370
17464
  params: Params$Resource$Videocategories$List,
17371
17465
  options:
17372
- | MethodOptions
17373
- | BodyResponseCallback<Schema$VideoCategoryListResponse>,
17466
+ MethodOptions | BodyResponseCallback<Schema$VideoCategoryListResponse>,
17374
17467
  callback: BodyResponseCallback<Schema$VideoCategoryListResponse>
17375
17468
  ): void;
17376
17469
  list(
@@ -17466,6 +17559,157 @@ export namespace youtube_v3 {
17466
17559
  this.context = context;
17467
17560
  }
17468
17561
 
17562
+ /**
17563
+ * Retrieves a batch of VideoStat resources, possibly filtered. BatchGetStats is intentionally not atomic to provide a better user experience.
17564
+ * @example
17565
+ * ```js
17566
+ * // Before running the sample:
17567
+ * // - Enable the API at:
17568
+ * // https://console.developers.google.com/apis/api/youtube.googleapis.com
17569
+ * // - Login into gcloud by running:
17570
+ * // ```sh
17571
+ * // $ gcloud auth application-default login
17572
+ * // ```
17573
+ * // - Install the npm module by running:
17574
+ * // ```sh
17575
+ * // $ npm install googleapis
17576
+ * // ```
17577
+ *
17578
+ * const {google} = require('googleapis');
17579
+ * const youtube = google.youtube('v3');
17580
+ *
17581
+ * async function main() {
17582
+ * const auth = new google.auth.GoogleAuth({
17583
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
17584
+ * scopes: [
17585
+ * 'https://www.googleapis.com/auth/youtube',
17586
+ * 'https://www.googleapis.com/auth/youtube.force-ssl',
17587
+ * 'https://www.googleapis.com/auth/youtube.readonly',
17588
+ * 'https://www.googleapis.com/auth/youtubepartner',
17589
+ * ],
17590
+ * });
17591
+ *
17592
+ * // Acquire an auth client, and bind it to all future calls
17593
+ * const authClient = await auth.getClient();
17594
+ * google.options({auth: authClient});
17595
+ *
17596
+ * // Do the magic
17597
+ * const res = await youtube.videos.batchGetStats({
17598
+ * // Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.
17599
+ * id: 'placeholder-value',
17600
+ * // 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.
17601
+ * onBehalfOfContentOwner: 'placeholder-value',
17602
+ * // 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.
17603
+ * part: 'placeholder-value',
17604
+ * });
17605
+ * console.log(res.data);
17606
+ *
17607
+ * // Example response
17608
+ * // {
17609
+ * // "etag": "my_etag",
17610
+ * // "items": [],
17611
+ * // "kind": "my_kind"
17612
+ * // }
17613
+ * }
17614
+ *
17615
+ * main().catch(e => {
17616
+ * console.error(e);
17617
+ * throw e;
17618
+ * });
17619
+ *
17620
+ * ```
17621
+ *
17622
+ * @param params - Parameters for request
17623
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
17624
+ * @param callback - Optional callback that handles the response.
17625
+ * @returns A promise if used with async/await, or void if used with a callback.
17626
+ */
17627
+ batchGetStats(
17628
+ params: Params$Resource$Videos$Batchgetstats,
17629
+ options: StreamMethodOptions
17630
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
17631
+ batchGetStats(
17632
+ params?: Params$Resource$Videos$Batchgetstats,
17633
+ options?: MethodOptions
17634
+ ): Promise<GaxiosResponseWithHTTP2<Schema$BatchGetStatsResponse>>;
17635
+ batchGetStats(
17636
+ params: Params$Resource$Videos$Batchgetstats,
17637
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
17638
+ callback: BodyResponseCallback<Readable>
17639
+ ): void;
17640
+ batchGetStats(
17641
+ params: Params$Resource$Videos$Batchgetstats,
17642
+ options:
17643
+ MethodOptions | BodyResponseCallback<Schema$BatchGetStatsResponse>,
17644
+ callback: BodyResponseCallback<Schema$BatchGetStatsResponse>
17645
+ ): void;
17646
+ batchGetStats(
17647
+ params: Params$Resource$Videos$Batchgetstats,
17648
+ callback: BodyResponseCallback<Schema$BatchGetStatsResponse>
17649
+ ): void;
17650
+ batchGetStats(
17651
+ callback: BodyResponseCallback<Schema$BatchGetStatsResponse>
17652
+ ): void;
17653
+ batchGetStats(
17654
+ paramsOrCallback?:
17655
+ | Params$Resource$Videos$Batchgetstats
17656
+ | BodyResponseCallback<Schema$BatchGetStatsResponse>
17657
+ | BodyResponseCallback<Readable>,
17658
+ optionsOrCallback?:
17659
+ | MethodOptions
17660
+ | StreamMethodOptions
17661
+ | BodyResponseCallback<Schema$BatchGetStatsResponse>
17662
+ | BodyResponseCallback<Readable>,
17663
+ callback?:
17664
+ | BodyResponseCallback<Schema$BatchGetStatsResponse>
17665
+ | BodyResponseCallback<Readable>
17666
+ ):
17667
+ | void
17668
+ | Promise<GaxiosResponseWithHTTP2<Schema$BatchGetStatsResponse>>
17669
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
17670
+ let params = (paramsOrCallback ||
17671
+ {}) as Params$Resource$Videos$Batchgetstats;
17672
+ let options = (optionsOrCallback || {}) as MethodOptions;
17673
+
17674
+ if (typeof paramsOrCallback === 'function') {
17675
+ callback = paramsOrCallback;
17676
+ params = {} as Params$Resource$Videos$Batchgetstats;
17677
+ options = {};
17678
+ }
17679
+
17680
+ if (typeof optionsOrCallback === 'function') {
17681
+ callback = optionsOrCallback;
17682
+ options = {};
17683
+ }
17684
+
17685
+ const rootUrl = options.rootUrl || 'https://youtube.googleapis.com/';
17686
+ const parameters = {
17687
+ options: Object.assign(
17688
+ {
17689
+ url: (rootUrl + '/youtube/v3/videos:batchGetStats').replace(
17690
+ /([^:]\/)\/+/g,
17691
+ '$1'
17692
+ ),
17693
+ method: 'GET',
17694
+ apiVersion: '',
17695
+ },
17696
+ options
17697
+ ),
17698
+ params,
17699
+ requiredParams: [],
17700
+ pathParams: [],
17701
+ context: this.context,
17702
+ };
17703
+ if (callback) {
17704
+ createAPIRequest<Schema$BatchGetStatsResponse>(
17705
+ parameters,
17706
+ callback as BodyResponseCallback<unknown>
17707
+ );
17708
+ } else {
17709
+ return createAPIRequest<Schema$BatchGetStatsResponse>(parameters);
17710
+ }
17711
+ }
17712
+
17469
17713
  /**
17470
17714
  * Deletes a resource.
17471
17715
  * @example
@@ -17676,8 +17920,7 @@ export namespace youtube_v3 {
17676
17920
  getRating(
17677
17921
  params: Params$Resource$Videos$Getrating,
17678
17922
  options:
17679
- | MethodOptions
17680
- | BodyResponseCallback<Schema$VideoGetRatingResponse>,
17923
+ MethodOptions | BodyResponseCallback<Schema$VideoGetRatingResponse>,
17681
17924
  callback: BodyResponseCallback<Schema$VideoGetRatingResponse>
17682
17925
  ): void;
17683
17926
  getRating(
@@ -17800,6 +18043,7 @@ export namespace youtube_v3 {
17800
18043
  * // request body parameters
17801
18044
  * // {
17802
18045
  * // "ageGating": {},
18046
+ * // "brandPartner": {},
17803
18047
  * // "contentDetails": {},
17804
18048
  * // "etag": "my_etag",
17805
18049
  * // "fileDetails": {},
@@ -17830,6 +18074,7 @@ export namespace youtube_v3 {
17830
18074
  * // Example response
17831
18075
  * // {
17832
18076
  * // "ageGating": {},
18077
+ * // "brandPartner": {},
17833
18078
  * // "contentDetails": {},
17834
18079
  * // "etag": "my_etag",
17835
18080
  * // "fileDetails": {},
@@ -17897,8 +18142,7 @@ export namespace youtube_v3 {
17897
18142
  | BodyResponseCallback<Schema$Video>
17898
18143
  | BodyResponseCallback<Readable>,
17899
18144
  callback?:
17900
- | BodyResponseCallback<Schema$Video>
17901
- | BodyResponseCallback<Readable>
18145
+ BodyResponseCallback<Schema$Video> | BodyResponseCallback<Readable>
17902
18146
  ):
17903
18147
  | void
17904
18148
  | Promise<GaxiosResponseWithHTTP2<Schema$Video>>
@@ -18441,6 +18685,7 @@ export namespace youtube_v3 {
18441
18685
  * // request body parameters
18442
18686
  * // {
18443
18687
  * // "ageGating": {},
18688
+ * // "brandPartner": {},
18444
18689
  * // "contentDetails": {},
18445
18690
  * // "etag": "my_etag",
18446
18691
  * // "fileDetails": {},
@@ -18467,6 +18712,7 @@ export namespace youtube_v3 {
18467
18712
  * // Example response
18468
18713
  * // {
18469
18714
  * // "ageGating": {},
18715
+ * // "brandPartner": {},
18470
18716
  * // "contentDetails": {},
18471
18717
  * // "etag": "my_etag",
18472
18718
  * // "fileDetails": {},
@@ -18534,8 +18780,7 @@ export namespace youtube_v3 {
18534
18780
  | BodyResponseCallback<Schema$Video>
18535
18781
  | BodyResponseCallback<Readable>,
18536
18782
  callback?:
18537
- | BodyResponseCallback<Schema$Video>
18538
- | BodyResponseCallback<Readable>
18783
+ BodyResponseCallback<Schema$Video> | BodyResponseCallback<Readable>
18539
18784
  ):
18540
18785
  | void
18541
18786
  | Promise<GaxiosResponseWithHTTP2<Schema$Video>>
@@ -18580,6 +18825,20 @@ export namespace youtube_v3 {
18580
18825
  }
18581
18826
  }
18582
18827
 
18828
+ export interface Params$Resource$Videos$Batchgetstats extends StandardParameters {
18829
+ /**
18830
+ * Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.
18831
+ */
18832
+ id?: string[];
18833
+ /**
18834
+ * 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.
18835
+ */
18836
+ onBehalfOfContentOwner?: string;
18837
+ /**
18838
+ * 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.
18839
+ */
18840
+ part?: string[];
18841
+ }
18583
18842
  export interface Params$Resource$Videos$Delete extends StandardParameters {
18584
18843
  /**
18585
18844
  *
@@ -19249,173 +19508,6 @@ export namespace youtube_v3 {
19249
19508
  this.context = context;
19250
19509
  this.liveChat = new Resource$Youtube$V3$Livechat(this.context);
19251
19510
  }
19252
-
19253
- /**
19254
- * Updates an existing resource.
19255
- * @example
19256
- * ```js
19257
- * // Before running the sample:
19258
- * // - Enable the API at:
19259
- * // https://console.developers.google.com/apis/api/youtube.googleapis.com
19260
- * // - Login into gcloud by running:
19261
- * // ```sh
19262
- * // $ gcloud auth application-default login
19263
- * // ```
19264
- * // - Install the npm module by running:
19265
- * // ```sh
19266
- * // $ npm install googleapis
19267
- * // ```
19268
- *
19269
- * const {google} = require('googleapis');
19270
- * const youtube = google.youtube('v3');
19271
- *
19272
- * async function main() {
19273
- * const auth = new google.auth.GoogleAuth({
19274
- * // Scopes can be specified either as an array or as a single, space-delimited string.
19275
- * scopes: [],
19276
- * });
19277
- *
19278
- * // Acquire an auth client, and bind it to all future calls
19279
- * const authClient = await auth.getClient();
19280
- * google.options({auth: authClient});
19281
- *
19282
- * // Do the magic
19283
- * const res = await youtube.youtube.v3.updateCommentThreads({
19284
- * // 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.
19285
- * part: 'placeholder-value',
19286
- *
19287
- * // Request body metadata
19288
- * requestBody: {
19289
- * // request body parameters
19290
- * // {
19291
- * // "etag": "my_etag",
19292
- * // "id": "my_id",
19293
- * // "kind": "my_kind",
19294
- * // "replies": {},
19295
- * // "snippet": {}
19296
- * // }
19297
- * },
19298
- * });
19299
- * console.log(res.data);
19300
- *
19301
- * // Example response
19302
- * // {
19303
- * // "etag": "my_etag",
19304
- * // "id": "my_id",
19305
- * // "kind": "my_kind",
19306
- * // "replies": {},
19307
- * // "snippet": {}
19308
- * // }
19309
- * }
19310
- *
19311
- * main().catch(e => {
19312
- * console.error(e);
19313
- * throw e;
19314
- * });
19315
- *
19316
- * ```
19317
- *
19318
- * @param params - Parameters for request
19319
- * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
19320
- * @param callback - Optional callback that handles the response.
19321
- * @returns A promise if used with async/await, or void if used with a callback.
19322
- */
19323
- updateCommentThreads(
19324
- params: Params$Resource$Youtube$V3$Updatecommentthreads,
19325
- options: StreamMethodOptions
19326
- ): Promise<GaxiosResponseWithHTTP2<Readable>>;
19327
- updateCommentThreads(
19328
- params?: Params$Resource$Youtube$V3$Updatecommentthreads,
19329
- options?: MethodOptions
19330
- ): Promise<GaxiosResponseWithHTTP2<Schema$CommentThread>>;
19331
- updateCommentThreads(
19332
- params: Params$Resource$Youtube$V3$Updatecommentthreads,
19333
- options: StreamMethodOptions | BodyResponseCallback<Readable>,
19334
- callback: BodyResponseCallback<Readable>
19335
- ): void;
19336
- updateCommentThreads(
19337
- params: Params$Resource$Youtube$V3$Updatecommentthreads,
19338
- options: MethodOptions | BodyResponseCallback<Schema$CommentThread>,
19339
- callback: BodyResponseCallback<Schema$CommentThread>
19340
- ): void;
19341
- updateCommentThreads(
19342
- params: Params$Resource$Youtube$V3$Updatecommentthreads,
19343
- callback: BodyResponseCallback<Schema$CommentThread>
19344
- ): void;
19345
- updateCommentThreads(
19346
- callback: BodyResponseCallback<Schema$CommentThread>
19347
- ): void;
19348
- updateCommentThreads(
19349
- paramsOrCallback?:
19350
- | Params$Resource$Youtube$V3$Updatecommentthreads
19351
- | BodyResponseCallback<Schema$CommentThread>
19352
- | BodyResponseCallback<Readable>,
19353
- optionsOrCallback?:
19354
- | MethodOptions
19355
- | StreamMethodOptions
19356
- | BodyResponseCallback<Schema$CommentThread>
19357
- | BodyResponseCallback<Readable>,
19358
- callback?:
19359
- | BodyResponseCallback<Schema$CommentThread>
19360
- | BodyResponseCallback<Readable>
19361
- ):
19362
- | void
19363
- | Promise<GaxiosResponseWithHTTP2<Schema$CommentThread>>
19364
- | Promise<GaxiosResponseWithHTTP2<Readable>> {
19365
- let params = (paramsOrCallback ||
19366
- {}) as Params$Resource$Youtube$V3$Updatecommentthreads;
19367
- let options = (optionsOrCallback || {}) as MethodOptions;
19368
-
19369
- if (typeof paramsOrCallback === 'function') {
19370
- callback = paramsOrCallback;
19371
- params = {} as Params$Resource$Youtube$V3$Updatecommentthreads;
19372
- options = {};
19373
- }
19374
-
19375
- if (typeof optionsOrCallback === 'function') {
19376
- callback = optionsOrCallback;
19377
- options = {};
19378
- }
19379
-
19380
- const rootUrl = options.rootUrl || 'https://youtube.googleapis.com/';
19381
- const parameters = {
19382
- options: Object.assign(
19383
- {
19384
- url: (rootUrl + '/youtube/v3/commentThreads').replace(
19385
- /([^:]\/)\/+/g,
19386
- '$1'
19387
- ),
19388
- method: 'PUT',
19389
- apiVersion: '',
19390
- },
19391
- options
19392
- ),
19393
- params,
19394
- requiredParams: [],
19395
- pathParams: [],
19396
- context: this.context,
19397
- };
19398
- if (callback) {
19399
- createAPIRequest<Schema$CommentThread>(
19400
- parameters,
19401
- callback as BodyResponseCallback<unknown>
19402
- );
19403
- } else {
19404
- return createAPIRequest<Schema$CommentThread>(parameters);
19405
- }
19406
- }
19407
- }
19408
-
19409
- export interface Params$Resource$Youtube$V3$Updatecommentthreads extends StandardParameters {
19410
- /**
19411
- * 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.
19412
- */
19413
- part?: string[];
19414
-
19415
- /**
19416
- * Request body metadata
19417
- */
19418
- requestBody?: Schema$CommentThread;
19419
19511
  }
19420
19512
 
19421
19513
  export class Resource$Youtube$V3$Livechat {