@googleapis/youtube 39.0.1 → 40.0.1

package/build/v3.d.ts

@@ -164,14 +164,6 @@ export declare namespace youtube_v3 {
          * The `comment` object contains information about a resource that received a comment. This property is only present if the `snippet.type` is `comment`.
          */
         comment?: Schema$ActivityContentDetailsComment;
-        /**
-         * 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.
-         */
-        favorite?: Schema$ActivityContentDetailsFavorite;
-        /**
-         * 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.
-         */
-        like?: Schema$ActivityContentDetailsLike;
         /**
          * The `playlistItem` object contains information about a new playlist item. This property is only present if the `snippet.type` is `playlistItem`.
          */
@@ -189,7 +181,7 @@ export declare namespace youtube_v3 {
          */
         social?: Schema$ActivityContentDetailsSocial;
         /**
-         * 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.
+         * The `subscription` object contains information about a channel that a user subscribed to. This property is only present if the `snippet.type` is `subscription`.
          */
         subscription?: Schema$ActivityContentDetailsSubscription;
         /**
@@ -224,24 +216,6 @@ export declare namespace youtube_v3 {
          */
         resourceId?: Schema$ResourceId;
     }
-    /**
-     * Information about a video that was marked as a favorite video. Deprecated: This resource is no longer returned.
-     */
-    export interface Schema$ActivityContentDetailsFavorite {
-        /**
-         * The `resourceId` object contains information that identifies the resource that was marked as a favorite.
-         */
-        resourceId?: Schema$ResourceId;
-    }
-    /**
-     * Information about a resource that received a positive (like) rating. Deprecated: This resource is no longer returned.
-     */
-    export interface Schema$ActivityContentDetailsLike {
-        /**
-         * The `resourceId` object contains information that identifies the rated resource.
-         */
-        resourceId?: Schema$ResourceId;
-    }
     /**
      * Information about a new playlist item.
      */
@@ -347,7 +321,7 @@ export declare namespace youtube_v3 {
         type?: string | null;
     }
     /**
-     * Information about a channel that a user subscribed to. Deprecated: This resource is no longer returned.
+     * Information about a channel that a user subscribed to.
      */
     export interface Schema$ActivityContentDetailsSubscription {
         /**
@@ -1280,6 +1254,10 @@ export declare namespace youtube_v3 {
          * The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.
          */
         channelId?: string | null;
+        /**
+         * Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval.
+         */
+        imageUrl?: string | null;
         /**
          * The total number of likes this comment has received.
          */
@@ -1292,10 +1270,6 @@ export declare namespace youtube_v3 {
          * The unique id of the top-level comment, only set for replies.
          */
         parentId?: string | null;
-        /**
-         * The ID of the post the comment refers to, if any.
-         */
-        postId?: string | null;
         /**
          * The date and time when the comment was originally published.
          */
@@ -1411,10 +1385,6 @@ export declare namespace youtube_v3 {
          * Whether the thread (and therefore all its comments) is visible to all YouTube users.
          */
         isPublic?: boolean | null;
-        /**
-         * The ID of the post the comments refer to, if any.
-         */
-        postId?: string | null;
         /**
          * The top level comment of this thread.
          */
@@ -2385,7 +2355,7 @@ export declare namespace youtube_v3 {
         userComment?: string | null;
     }
     /**
-     * Details about the gift event, this is only set if the type is 'giftEvent'.
+     * Details about the gift event, this is only set if the type is `giftEvent`.
      */
     export interface Schema$LiveChatGiftDetails {
         /**
@@ -2423,7 +2393,7 @@ export declare namespace youtube_v3 {
     }
     export interface Schema$LiveChatGiftMembershipReceivedDetails {
         /**
-         * The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is 'membershipGiftingEvent'.
+         * The ID of the membership gifting message that is related to this gift membership. This ID will always refer to a message whose type is `membershipGiftingEvent`.
          */
         associatedMembershipGiftingMessageId?: string | null;
         /**
@@ -2536,7 +2506,7 @@ export declare namespace youtube_v3 {
         eventId?: string | null;
         items?: Schema$LiveChatMessage[];
         /**
-         * Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessageListResponse".
+         * Identifies what kind of resource this is. Value: the fixed string `"youtube#liveChatMessageListResponse"`.
          */
         kind?: string | null;
         nextPageToken?: string | null;
@@ -2554,7 +2524,7 @@ export declare namespace youtube_v3 {
         pollingIntervalMillis?: number | null;
         tokenPagination?: Schema$TokenPagination;
         /**
-         * The visitorId identifies the visitor.
+         * Identifies the visitor.
          */
         visitorId?: string | null;
     }
@@ -2574,15 +2544,15 @@ export declare namespace youtube_v3 {
          */
         displayMessage?: string | null;
         /**
-         * Details about the funding event, this is only set if the type is 'fanFundingEvent'.
+         * Details about the funding event, this is only set if the type is `fanFundingEvent`.
          */
         fanFundingEventDetails?: Schema$LiveChatFanFundingEventDetails;
         /**
-         * Details about the gift event, this is only set if the type is 'giftEvent'.
+         * Details about the gift event, this is only set if the type is `giftEvent`.
          */
         giftDetails?: Schema$LiveChatGiftDetails;
         /**
-         * Details about the Gift Membership Received event, this is only set if the type is 'giftMembershipReceivedEvent'.
+         * Details about the Gift Membership Received event, this is only set if the type is `giftMembershipReceivedEvent`.
          */
         giftMembershipReceivedDetails?: Schema$LiveChatGiftMembershipReceivedDetails;
         /**
@@ -2591,21 +2561,21 @@ export declare namespace youtube_v3 {
         hasDisplayContent?: boolean | null;
         liveChatId?: string | null;
         /**
-         * Details about the Member Milestone Chat event, this is only set if the type is 'memberMilestoneChatEvent'.
+         * Details about the Member Milestone Chat event, this is only set if the type is `memberMilestoneChatEvent`.
          */
         memberMilestoneChatDetails?: Schema$LiveChatMemberMilestoneChatDetails;
         /**
-         * Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'.
+         * Details about the Membership Gifting event, this is only set if the type is `membershipGiftingEvent`.
          */
         membershipGiftingDetails?: Schema$LiveChatMembershipGiftingDetails;
         messageDeletedDetails?: Schema$LiveChatMessageDeletedDetails;
         messageRetractedDetails?: Schema$LiveChatMessageRetractedDetails;
         /**
-         * Details about the New Member Announcement event, this is only set if the type is 'newSponsorEvent'. Please note that "member" is the new term for "sponsor".
+         * Details about the New Member Announcement event, this is only set if the type is `newSponsorEvent`. The term "member" replaces "sponsor".
          */
         newSponsorDetails?: Schema$LiveChatNewSponsorDetails;
         /**
-         * Details about the poll event, this is only set if the type is 'pollEvent'.
+         * Details about the poll event, this is only set if the type is `pollEvent`.
          */
         pollDetails?: Schema$LiveChatPollDetails;
         /**
@@ -2613,15 +2583,15 @@ export declare namespace youtube_v3 {
          */
         publishedAt?: string | null;
         /**
-         * Details about the Super Chat event, this is only set if the type is 'superChatEvent'.
+         * Details about the Super Chat event, this is only set if the type is `superChatEvent`.
          */
         superChatDetails?: Schema$LiveChatSuperChatDetails;
         /**
-         * Details about the Super Sticker event, this is only set if the type is 'superStickerEvent'.
+         * Details about the Super Sticker event, this is only set if the type is `superStickerEvent`.
          */
         superStickerDetails?: Schema$LiveChatSuperStickerDetails;
         /**
-         * Details about the text message, this is only set if the type is 'textMessageEvent'.
+         * Details about the text message, this is only set if the type is `textMessageEvent`.
          */
         textMessageDetails?: Schema$LiveChatTextMessageDetails;
         /**
@@ -2735,7 +2705,7 @@ export declare namespace youtube_v3 {
          */
         currency?: string | null;
         /**
-         * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+         * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is `1`.
          */
         tier?: number | null;
         /**
@@ -2761,7 +2731,7 @@ export declare namespace youtube_v3 {
          */
         superStickerMetadata?: Schema$SuperStickerMetadata;
         /**
-         * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1.
+         * The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is `1`.
          */
         tier?: number | null;
     }
@@ -2773,7 +2743,7 @@ export declare namespace youtube_v3 {
     }
     export interface Schema$LiveChatUserBannedMessageDetails {
         /**
-         * The duration of the ban. This property is only present if the banType is temporary.
+         * The duration of the ban. This property is only present if the `banType` is `temporary`.
          */
         banDurationSeconds?: string | null;
         /**
@@ -4752,7 +4722,7 @@ export declare namespace youtube_v3 {
         viewCount?: string | null;
     }
     /**
-     * Basic details about a video category, such as its localized title. Next Id: 19
+     * Basic details about a video category, such as its localized title. Next Id: 20
      */
     export interface Schema$VideoStatus {
         /**
@@ -4764,7 +4734,7 @@ export declare namespace youtube_v3 {
          */
         embeddable?: boolean | null;
         /**
-         * This value explains why a video failed to upload. This property is only present if the uploadStatus property indicates that the upload failed.
+         * This value explains why a video failed to upload. This property is only present if the `uploadStatus` property indicates that the upload failed.
          */
         failureReason?: string | null;
         /**
@@ -4773,7 +4743,7 @@ export declare namespace youtube_v3 {
         license?: string | null;
         madeForKids?: boolean | null;
         /**
-         * The video's privacy status.
+         * The video's privacy status. In a `videos.insert` request, if you don't specify a value for this property, the uploaded video's privacy status defaults to `public`. Certain uploads might default to `private` based on creator account settings, as explained in the [YouTube Help Center](https://support.google.com/youtube/answer/157177). Videos uploaded from unverified API projects are not restricted to private viewing mode.
          */
         privacyStatus?: string | null;
         /**
@@ -4785,7 +4755,7 @@ export declare namespace youtube_v3 {
          */
         publishAt?: string | null;
         /**
-         * This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected.
+         * This value explains why YouTube rejected an uploaded video. This property is only present if the `uploadStatus` property indicates that the upload was rejected.
          */
         rejectionReason?: string | null;
         selfDeclaredMadeForKids?: boolean | null;
@@ -5868,7 +5838,7 @@ export declare namespace youtube_v3 {
          *
          *   // Do the magic
          *   const res = await youtube.channels.update({
-         *     // The *onBehalfOfContentOwner* parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
+         *     // The *onBehalfOfContentOwner* parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. This parameter must be provided if the request is authenticated with credentials for a CMS content owner user acting on a managed channel. If omitted, the request executes under the authenticated user's direct context and returns an HTTP 403 Forbidden error.
          *     onBehalfOfContentOwner: 'placeholder-value',
          *     // The *part* parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The API currently only allows the parameter value to be set to either brandingSettings or invideoPromotion. (You cannot update both of those parts with a single request.) Note that this method overrides the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies.
          *     part: 'placeholder-value',
@@ -5984,7 +5954,7 @@ export declare namespace youtube_v3 {
     }
     export interface Params$Resource$Channels$Update extends StandardParameters {
         /**
-         * The *onBehalfOfContentOwner* parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner.
+         * The *onBehalfOfContentOwner* parameter indicates that the authenticated user is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with needs to be linked to the specified YouTube content owner. This parameter must be provided if the request is authenticated with credentials for a CMS content owner user acting on a managed channel. If omitted, the request executes under the authenticated user's direct context and returns an HTTP 403 Forbidden error.
          */
         onBehalfOfContentOwner?: string;
         /**
@@ -6976,8 +6946,6 @@ export declare namespace youtube_v3 {
          *     pageToken: 'placeholder-value',
          *     // The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.
          *     part: 'placeholder-value',
-         *     // Returns the comment threads of the specified post.
-         *     postId: 'placeholder-value',
          *     // Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.
          *     searchTerms: 'placeholder-value',
          *     // The requested text format for the returned comments.
@@ -7062,10 +7030,6 @@ export declare namespace youtube_v3 {
          * The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include.
          */
         part?: string[];
-        /**
-         * Returns the comment threads of the specified post.
-         */
-        postId?: string;
         /**
          * Limits the returned comment threads to those matching the specified key words. Not compatible with the 'id' filter.
          */
@@ -8135,7 +8099,7 @@ export declare namespace youtube_v3 {
         context: APIRequestContext;
         constructor(context: APIRequestContext);
         /**
-         * Deletes a chat message.
+         * Deletes a chat message. A call to this method has a quota cost of 20 units.
          * @example
          * ```js
          * // Before running the sample:
@@ -8192,7 +8156,7 @@ export declare namespace youtube_v3 {
         delete(params: Params$Resource$Livechatmessages$Delete, callback: BodyResponseCallback<void>): void;
         delete(callback: BodyResponseCallback<void>): void;
         /**
-         * Inserts a new resource into this collection.
+         * Inserts a new resource into this collection. A call to this method has a quota cost of 20 units.
          * @example
          * ```js
          * // Before running the sample:
@@ -8225,7 +8189,7 @@ export declare namespace youtube_v3 {
          *
          *   // Do the magic
          *   const res = await youtube.liveChatMessages.insert({
-         *     // 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.
+         *     // The `part` parameter serves two purposes. It identifies the properties that the write operation sets as well as the properties that the API response includes. Set the parameter value to `snippet`.
          *     part: 'placeholder-value',
          *
          *     // Request body metadata
@@ -8271,7 +8235,7 @@ export declare namespace youtube_v3 {
         insert(params: Params$Resource$Livechatmessages$Insert, callback: BodyResponseCallback<Schema$LiveChatMessage>): void;
         insert(callback: BodyResponseCallback<Schema$LiveChatMessage>): void;
         /**
-         * Retrieves a list of resources, possibly filtered.
+         * Retrieves a list of resources, possibly filtered. A call to this method has a quota cost of 5 units.
          * @example
          * ```js
          * // Before running the sample:
@@ -8307,13 +8271,13 @@ export declare namespace youtube_v3 {
          *   const res = await youtube.liveChatMessages.list({
          *     // Specifies the localization language in which the system messages should be returned.
          *     hl: 'placeholder-value',
-         *     // The id of the live chat for which comments should be returned.
+         *     // The ID of the live chat for which messages should be returned.
          *     liveChatId: 'placeholder-value',
-         *     // The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
+         *     // The `maxResults` parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
          *     maxResults: 'placeholder-value',
-         *     // The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
+         *     // The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies other pages that could be retrieved.
          *     pageToken: 'placeholder-value',
-         *     // The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.
+         *     // The `part` parameter specifies the `liveChatMessage` resource parts that the API response includes. Supported values are `id`, `snippet`, and `authorDetails`.
          *     part: 'placeholder-value',
          *     // Specifies the size of the profile image that should be returned for each user.
          *     profileImageSize: 'placeholder-value',
@@ -8355,7 +8319,7 @@ export declare namespace youtube_v3 {
         list(params: Params$Resource$Livechatmessages$List, callback: BodyResponseCallback<Schema$LiveChatMessageListResponse>): void;
         list(callback: BodyResponseCallback<Schema$LiveChatMessageListResponse>): void;
         /**
-         * Transition a durable chat event.
+         * Transitions a durable chat event. A call to this method has a quota cost of 20 units.
          * @example
          * ```js
          * // Before running the sample:
@@ -8388,7 +8352,7 @@ export declare namespace youtube_v3 {
          *
          *   // Do the magic
          *   const res = await youtube.liveChatMessages.transition({
-         *     // The ID that uniquely identify the chat message event to transition.
+         *     // The ID that uniquely identifies the chat message event to transition.
          *     id: 'placeholder-value',
          *     // The status to which the chat event is going to transition.
          *     status: 'placeholder-value',
@@ -8432,7 +8396,7 @@ export declare namespace youtube_v3 {
     }
     export interface Params$Resource$Livechatmessages$Insert extends StandardParameters {
         /**
-         * 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.
+         * The `part` parameter serves two purposes. It identifies the properties that the write operation sets as well as the properties that the API response includes. Set the parameter value to `snippet`.
          */
         part?: string[];
         /**
@@ -8446,19 +8410,19 @@ export declare namespace youtube_v3 {
          */
         hl?: string;
         /**
-         * The id of the live chat for which comments should be returned.
+         * The ID of the live chat for which messages should be returned.
          */
         liveChatId?: string;
         /**
-         * The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
+         * The `maxResults` parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
          */
         maxResults?: number;
         /**
-         * The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
+         * The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies other pages that could be retrieved.
          */
         pageToken?: string;
         /**
-         * The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.
+         * The `part` parameter specifies the `liveChatMessage` resource parts that the API response includes. Supported values are `id`, `snippet`, and `authorDetails`.
          */
         part?: string[];
         /**
@@ -8468,7 +8432,7 @@ export declare namespace youtube_v3 {
     }
     export interface Params$Resource$Livechatmessages$Transition extends StandardParameters {
         /**
-         * The ID that uniquely identify the chat message event to transition.
+         * The ID that uniquely identifies the chat message event to transition.
          */
         id?: string;
         /**
@@ -13038,7 +13002,7 @@ export declare namespace youtube_v3 {
         context: APIRequestContext;
         constructor(context: APIRequestContext);
         /**
-         * Allows a user to load live chat through a server-streamed RPC.
+         * Allows a user to load live chat through a server-streamed RPC. A call to this method has a quota cost of 5 units.
          * @example
          * ```js
          * // Before running the sample:
@@ -13074,13 +13038,13 @@ export declare namespace youtube_v3 {
          *   const res = await youtube.youtube.v3.liveChat.messages.stream({
          *     // Specifies the localization language in which the system messages should be returned.
          *     hl: 'placeholder-value',
-         *     // The id of the live chat for which comments should be returned.
+         *     // The ID of the live chat for which messages should be returned.
          *     liveChatId: 'placeholder-value',
-         *     // The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
+         *     // The `maxResults` parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
          *     maxResults: 'placeholder-value',
-         *     // The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
+         *     // The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies other pages that could be retrieved.
          *     pageToken: 'placeholder-value',
-         *     // The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.
+         *     // The `part` parameter specifies the `liveChatMessage` resource parts that the API response includes. Supported values are `id`, `snippet`, and `authorDetails`.
          *     part: 'placeholder-value',
          *     // Specifies the size of the profile image that should be returned for each user.
          *     profileImageSize: 'placeholder-value',
@@ -13128,19 +13092,19 @@ export declare namespace youtube_v3 {
          */
         hl?: string;
         /**
-         * The id of the live chat for which comments should be returned.
+         * The ID of the live chat for which messages should be returned.
          */
         liveChatId?: string;
         /**
-         * The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
+         * The `maxResults` parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.
          */
         maxResults?: number;
         /**
-         * The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.
+         * The `pageToken` parameter identifies a specific page in the result set that should be returned. In an API response, the `nextPageToken` property identifies other pages that could be retrieved.
          */
         pageToken?: string;
         /**
-         * The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.
+         * The `part` parameter specifies the `liveChatMessage` resource parts that the API response includes. Supported values are `id`, `snippet`, and `authorDetails`.
          */
         part?: string[];
         /**