@googleapis/youtube 34.0.0 → 35.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/build/v3.d.ts CHANGED
@@ -124,11 +124,11 @@ export declare namespace youtube_v3 {
124
124
  exception?: string[] | null;
125
125
  }
126
126
  /**
127
- * An *activity* resource contains information about an action that a particular channel, or user, has taken on YouTube.The actions reported in activity feeds include rating a video, sharing a video, marking a video as a favorite, commenting on a video, uploading a video, and so forth. Each activity resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
127
+ * An `activity` resource contains information about an action that a particular channel, or user, has taken on YouTube. The actions reported in activity feeds include sharing a video, uploading a video, and so forth. Each `activity` resource identifies the type of action, the channel associated with the action, and the resource(s) associated with the action, such as the video that was rated or uploaded.
128
128
  */
129
129
  export interface Schema$Activity {
130
130
  /**
131
- * The contentDetails object contains information about the content associated with the activity. For example, if the snippet.type value is videoRated, then the contentDetails object's content identifies the rated video.
131
+ * The `contentDetails` object contains information about the content associated with the activity. For example, if the `snippet.type` value is `videoRated`, then the `contentDetails` object's content identifies the rated video.
132
132
  */
133
133
  contentDetails?: Schema$ActivityContentDetails;
134
134
  /**
@@ -140,11 +140,11 @@ export declare namespace youtube_v3 {
140
140
  */
141
141
  id?: string | null;
142
142
  /**
143
- * Identifies what kind of resource this is. Value: the fixed string "youtube#activity".
143
+ * Identifies what kind of resource this is. Value: The fixed string `"youtube#activity"`.
144
144
  */
145
145
  kind?: string | null;
146
146
  /**
147
- * The snippet object contains basic details about the activity, including the activity's type and group ID.
147
+ * The `snippet` object contains basic details about the activity, including the activity's type and group ID.
148
148
  */
149
149
  snippet?: Schema$ActivitySnippet;
150
150
  }
@@ -153,47 +153,47 @@ export declare namespace youtube_v3 {
153
153
  */
154
154
  export interface Schema$ActivityContentDetails {
155
155
  /**
156
- * The bulletin object contains details about a channel bulletin post. This object is only present if the snippet.type is bulletin.
156
+ * The `bulletin` object contains details about a channel bulletin post. This object is only present if the `snippet.type` is `bulletin`.
157
157
  */
158
158
  bulletin?: Schema$ActivityContentDetailsBulletin;
159
159
  /**
160
- * The channelItem object contains details about a resource which was added to a channel. This property is only present if the snippet.type is channelItem.
160
+ * The `channelItem` object contains details about a resource which was added to a channel. This property is only present if the `snippet.type` is `channelItem`.
161
161
  */
162
162
  channelItem?: Schema$ActivityContentDetailsChannelItem;
163
163
  /**
164
- * The comment object contains information about a resource that received a comment. This property is only present if the snippet.type is comment.
164
+ * The `comment` object contains information about a resource that received a comment. This property is only present if the `snippet.type` is `comment`.
165
165
  */
166
166
  comment?: Schema$ActivityContentDetailsComment;
167
167
  /**
168
- * The favorite object contains information about a video that was marked as a favorite video. This property is only present if the snippet.type is favorite.
168
+ * The `favorite` object contains information about a video that was marked as a favorite video. This property is only present if the `snippet.type` is `favorite`. Deprecated: This property is no longer returned.
169
169
  */
170
170
  favorite?: Schema$ActivityContentDetailsFavorite;
171
171
  /**
172
- * The like object contains information about a resource that received a positive (like) rating. This property is only present if the snippet.type is like.
172
+ * The `like` object contains information about a resource that received a positive (like) rating. This property is only present if the `snippet.type` is `like`. Deprecated: This property is no longer returned.
173
173
  */
174
174
  like?: Schema$ActivityContentDetailsLike;
175
175
  /**
176
- * The playlistItem object contains information about a new playlist item. This property is only present if the snippet.type is playlistItem.
176
+ * The `playlistItem` object contains information about a new playlist item. This property is only present if the `snippet.type` is `playlistItem`.
177
177
  */
178
178
  playlistItem?: Schema$ActivityContentDetailsPlaylistItem;
179
179
  /**
180
- * The promotedItem object contains details about a resource which is being promoted. This property is only present if the snippet.type is promotedItem.
180
+ * The `promotedItem` object contains details about a resource which is being promoted. This property is only present if the `snippet.type` is `promotedItem`.
181
181
  */
182
182
  promotedItem?: Schema$ActivityContentDetailsPromotedItem;
183
183
  /**
184
- * The recommendation object contains information about a recommended resource. This property is only present if the snippet.type is recommendation.
184
+ * The `recommendation` object contains information about a recommended resource. This property is only present if the `snippet.type` is `recommendation`.
185
185
  */
186
186
  recommendation?: Schema$ActivityContentDetailsRecommendation;
187
187
  /**
188
- * The social object contains details about a social network post. This property is only present if the snippet.type is social.
188
+ * The `social` object contains details about a social network post. This property is only present if the `snippet.type` is `social`.
189
189
  */
190
190
  social?: Schema$ActivityContentDetailsSocial;
191
191
  /**
192
- * The subscription object contains information about a channel that a user subscribed to. This property is only present if the snippet.type is subscription.
192
+ * The `subscription` object contains information about a channel that a user subscribed to. This property is only present if the `snippet.type` is `subscription`. Deprecated: This property is no longer returned.
193
193
  */
194
194
  subscription?: Schema$ActivityContentDetailsSubscription;
195
195
  /**
196
- * The upload object contains information about the uploaded video. This property is only present if the snippet.type is upload.
196
+ * The `upload` object contains information about the uploaded video. This property is only present if the `snippet.type` is `upload`.
197
197
  */
198
198
  upload?: Schema$ActivityContentDetailsUpload;
199
199
  }
@@ -202,7 +202,7 @@ export declare namespace youtube_v3 {
202
202
  */
203
203
  export interface Schema$ActivityContentDetailsBulletin {
204
204
  /**
205
- * The resourceId object contains information that identifies the resource associated with a bulletin post. @mutable youtube.activities.insert
205
+ * The `resourceId` object contains information that identifies the resource associated with a bulletin post. @mutable youtube.activities.insert
206
206
  */
207
207
  resourceId?: Schema$ResourceId;
208
208
  }
@@ -211,7 +211,7 @@ export declare namespace youtube_v3 {
211
211
  */
212
212
  export interface Schema$ActivityContentDetailsChannelItem {
213
213
  /**
214
- * The resourceId object contains information that identifies the resource that was added to the channel.
214
+ * The `resourceId` object contains information that identifies the resource that was added to the channel.
215
215
  */
216
216
  resourceId?: Schema$ResourceId;
217
217
  }
@@ -220,25 +220,25 @@ export declare namespace youtube_v3 {
220
220
  */
221
221
  export interface Schema$ActivityContentDetailsComment {
222
222
  /**
223
- * The resourceId object contains information that identifies the resource associated with the comment.
223
+ * The `resourceId` object contains information that identifies the resource associated with the comment.
224
224
  */
225
225
  resourceId?: Schema$ResourceId;
226
226
  }
227
227
  /**
228
- * Information about a video that was marked as a favorite video.
228
+ * Information about a video that was marked as a favorite video. Deprecated: This resource is no longer returned.
229
229
  */
230
230
  export interface Schema$ActivityContentDetailsFavorite {
231
231
  /**
232
- * The resourceId object contains information that identifies the resource that was marked as a favorite.
232
+ * The `resourceId` object contains information that identifies the resource that was marked as a favorite.
233
233
  */
234
234
  resourceId?: Schema$ResourceId;
235
235
  }
236
236
  /**
237
- * Information about a resource that received a positive (like) rating.
237
+ * Information about a resource that received a positive (like) rating. Deprecated: This resource is no longer returned.
238
238
  */
239
239
  export interface Schema$ActivityContentDetailsLike {
240
240
  /**
241
- * The resourceId object contains information that identifies the rated resource.
241
+ * The `resourceId` object contains information that identifies the rated resource.
242
242
  */
243
243
  resourceId?: Schema$ResourceId;
244
244
  }
@@ -255,7 +255,7 @@ export declare namespace youtube_v3 {
255
255
  */
256
256
  playlistItemId?: string | null;
257
257
  /**
258
- * The resourceId object contains information about the resource that was added to the playlist.
258
+ * The `resourceId` object contains information about the resource that was added to the playlist.
259
259
  */
260
260
  resourceId?: Schema$ResourceId;
261
261
  }
@@ -313,11 +313,11 @@ export declare namespace youtube_v3 {
313
313
  */
314
314
  reason?: string | null;
315
315
  /**
316
- * The resourceId object contains information that identifies the recommended resource.
316
+ * The `resourceId` object contains information that identifies the recommended resource.
317
317
  */
318
318
  resourceId?: Schema$ResourceId;
319
319
  /**
320
- * The seedResourceId object contains information about the resource that caused the recommendation.
320
+ * The `seedResourceId` object contains information about the resource that caused the recommendation.
321
321
  */
322
322
  seedResourceId?: Schema$ResourceId;
323
323
  }
@@ -338,7 +338,7 @@ export declare namespace youtube_v3 {
338
338
  */
339
339
  referenceUrl?: string | null;
340
340
  /**
341
- * The resourceId object encapsulates information that identifies the resource associated with a social network post.
341
+ * The `resourceId` object encapsulates information that identifies the resource associated with a social network post.
342
342
  */
343
343
  resourceId?: Schema$ResourceId;
344
344
  /**
@@ -347,11 +347,11 @@ export declare namespace youtube_v3 {
347
347
  type?: string | null;
348
348
  }
349
349
  /**
350
- * Information about a channel that a user subscribed to.
350
+ * Information about a channel that a user subscribed to. Deprecated: This resource is no longer returned.
351
351
  */
352
352
  export interface Schema$ActivityContentDetailsSubscription {
353
353
  /**
354
- * The resourceId object contains information that identifies the resource that the user subscribed to.
354
+ * The `resourceId` object contains information that identifies the resource that the user subscribed to.
355
355
  */
356
356
  resourceId?: Schema$ResourceId;
357
357
  }
@@ -413,7 +413,7 @@ export declare namespace youtube_v3 {
413
413
  */
414
414
  description?: string | null;
415
415
  /**
416
- * The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user rates a video and marks the same video as a favorite, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same groupId value.
416
+ * The group ID associated with the activity. A group ID identifies user events that are associated with the same user and resource. For example, if a user uploads a video and watches the same video, the entries for those events would have the same group ID in the user's activity feed. In your user interface, you can avoid repetition by grouping events with the same `groupId` value.
417
417
  */
418
418
  groupId?: string | null;
419
419
  /**
@@ -433,6 +433,54 @@ export declare namespace youtube_v3 {
433
433
  */
434
434
  type?: string | null;
435
435
  }
436
+ /**
437
+ * Common proto for Live and VOD geo-restrictions
438
+ */
439
+ export interface Schema$AvailabilityConfig {
440
+ /**
441
+ * Video is available in all regions except the ones specified in the config.
442
+ */
443
+ globalConfig?: Schema$AvailabilityConfigGlobalConfig;
444
+ /**
445
+ * Video is available in the specified regions only.
446
+ */
447
+ regionsConfig?: Schema$AvailabilityConfigRegionsConfig;
448
+ }
449
+ /**
450
+ * Video is available in all regions except the ones specified in the excluded_region_codes list.
451
+ */
452
+ export interface Schema$AvailabilityConfigGlobalConfig {
453
+ /**
454
+ * Optional. Regions where video is blocked
455
+ */
456
+ excludedRegionCodes?: string[] | null;
457
+ /**
458
+ * Default time window where video is available for all non-blocked regions Not supported for upcoming / active live broadcasts. If start time is unspecified, video is already available If end time is unspecified, video is available forever Specified start and end times cannot be more than five years in the future.
459
+ */
460
+ interval?: Schema$Interval;
461
+ }
462
+ /**
463
+ * Video is available in the specified regions only.
464
+ */
465
+ export interface Schema$AvailabilityConfigRegionsConfig {
466
+ /**
467
+ * Required. List of regions and time windows where video is available. If a region is specified multiple times, the union of all intervals is used.
468
+ */
469
+ regionIntervals?: Schema$AvailabilityConfigRegionsConfigRegionInterval[];
470
+ }
471
+ /**
472
+ * Region and time window where video is available for the region.
473
+ */
474
+ export interface Schema$AvailabilityConfigRegionsConfigRegionInterval {
475
+ /**
476
+ * Time window where video is available for the region. Not supported for upcoming / active live broadcasts. If start time is unspecified, video is already available If end time is unspecified, video is available forever Specified start and end times cannot be more than five years in the future.
477
+ */
478
+ interval?: Schema$Interval;
479
+ /**
480
+ * Required. Region where video is available
481
+ */
482
+ regionCode?: string | null;
483
+ }
436
484
  /**
437
485
  * 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.
438
486
  */
@@ -1962,6 +2010,19 @@ export declare namespace youtube_v3 {
1962
2010
  */
1963
2011
  streamName?: string | null;
1964
2012
  }
2013
+ /**
2014
+ * Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
2015
+ */
2016
+ export interface Schema$Interval {
2017
+ /**
2018
+ * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
2019
+ */
2020
+ endTime?: string | null;
2021
+ /**
2022
+ * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
2023
+ */
2024
+ startTime?: string | null;
2025
+ }
1965
2026
  /**
1966
2027
  * Describes an invideo branding.
1967
2028
  */
@@ -2067,6 +2128,10 @@ export declare namespace youtube_v3 {
2067
2128
  * Detailed settings of a broadcast.
2068
2129
  */
2069
2130
  export interface Schema$LiveBroadcastContentDetails {
2131
+ /**
2132
+ * Optional. The broadcast's availability config. Used to set specific region availability or block specific regions It is optional - if not set, it is not enforced.
2133
+ */
2134
+ availabilityConfig?: Schema$AvailabilityConfig;
2070
2135
  /**
2071
2136
  * This value uniquely identifies the live stream bound to the broadcast.
2072
2137
  */
@@ -2186,6 +2251,10 @@ export declare namespace youtube_v3 {
2186
2251
  * The date and time that the broadcast actually started. This information is only available once the broadcast's state is live.
2187
2252
  */
2188
2253
  actualStartTime?: string | null;
2254
+ /**
2255
+ * The YouTube video category associated with the video broadcast.
2256
+ */
2257
+ categoryId?: string | null;
2189
2258
  /**
2190
2259
  * The ID that YouTube uses to uniquely identify the channel that is publishing the broadcast.
2191
2260
  */
@@ -3857,6 +3926,10 @@ export declare namespace youtube_v3 {
3857
3926
  * The default image for this resource.
3858
3927
  */
3859
3928
  default?: Schema$Thumbnail;
3929
+ /**
3930
+ * The full high definition (1080p) quality image for this resource.
3931
+ */
3932
+ fhd?: Schema$Thumbnail;
3860
3933
  /**
3861
3934
  * The high quality image for this resource.
3862
3935
  */
@@ -3869,10 +3942,18 @@ export declare namespace youtube_v3 {
3869
3942
  * The medium quality image for this resource.
3870
3943
  */
3871
3944
  medium?: Schema$Thumbnail;
3945
+ /**
3946
+ * The quad high definition (1440p / 2K) quality image for this resource.
3947
+ */
3948
+ qhd?: Schema$Thumbnail;
3872
3949
  /**
3873
3950
  * The standard quality image for this resource.
3874
3951
  */
3875
3952
  standard?: Schema$Thumbnail;
3953
+ /**
3954
+ * The ultra-high resolution (4K) quality image for this resource.
3955
+ */
3956
+ uhd?: Schema$Thumbnail;
3876
3957
  }
3877
3958
  export interface Schema$ThumbnailSetResponse {
3878
3959
  /**