@googleapis/youtube 32.0.0 → 34.0.0

package/build/v3.d.ts

@@ -433,6 +433,36 @@ export declare namespace youtube_v3 {
          */
         type?: string | null;
     }
+    /**
+     * 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.
+     */
+    export interface Schema$BatchGetStatsResponse {
+        /**
+         * Etag of this resource.
+         */
+        etag?: string | null;
+        /**
+         * The videos' stats information.
+         */
+        items?: Schema$VideoStat[];
+        /**
+         * Identifies what kind of resource this is. Value: the fixed string "youtube#batchGetStatsResponse".
+         */
+        kind?: string | null;
+    }
+    /**
+     * Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6
+     */
+    export interface Schema$BrandPartner {
+        /**
+         * Required. Channel handle, must begin with "@"
+         */
+        channelHandle?: string | null;
+        /**
+         * Required. External Channel ID, must begin with "UC"
+         */
+        channelId?: string | null;
+    }
     /**
      * A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.
      */
@@ -1048,6 +1078,27 @@ export declare namespace youtube_v3 {
         privacyStatus?: string | null;
         selfDeclaredMadeForKids?: boolean | null;
     }
+    /**
+     * Information specific to a creator in an affiliate program linked to a YouTube channel.
+     */
+    export interface Schema$ChannelToAffiliateProgramLinkDetails {
+        /**
+         * Required. Google Merchant Center ID of the partner.
+         */
+        merchantId?: string | null;
+        /**
+         * Required. Affiliate program status.
+         */
+        programStatus?: string | null;
+        /**
+         * Optional. Reason for the last update of the affiliate program status.
+         */
+        statusUpdateReason?: string | null;
+        /**
+         * Optional. Timestamp when the affiliate program status was last updated.
+         */
+        statusUpdateTime?: string | null;
+    }
     /**
      * Freebase topic information related to the channel.
      */
@@ -2446,7 +2497,7 @@ export declare namespace youtube_v3 {
      */
     export interface Schema$LiveChatMessageSnippet {
         /**
-         * 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
+         * 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
          */
         authorChannelId?: string | null;
         /**
@@ -3419,7 +3470,7 @@ export declare namespace youtube_v3 {
         regionCode?: string | null;
         tokenPagination?: Schema$TokenPagination;
         /**
-         * The visitorId identifies the visitor.
+         * The visitor ID identifies the visitor.
          */
         visitorId?: string | null;
     }
@@ -3762,6 +3813,10 @@ export declare namespace youtube_v3 {
      * Basic information about a third party account link, including its type and type-specific information.
      */
     export interface Schema$ThirdPartyLinkSnippet {
+        /**
+         * Information specific to a link between a channel and an affiliate program of a partner.
+         */
+        channelToAffiliateProgramLink?: Schema$ChannelToAffiliateProgramLinkDetails;
         /**
          * Information specific to a link between a channel and a store on a merchandising platform.
          */
@@ -3854,6 +3909,7 @@ export declare namespace youtube_v3 {
          * Age restriction details related to a video. This data can only be retrieved by the video owner.
          */
         ageGating?: Schema$VideoAgeGating;
+        brandPartner?: Schema$BrandPartner;
         /**
          * The contentDetails object contains information about the video content, including the length of the video and its aspect ratio.
          */
@@ -4525,6 +4581,35 @@ export declare namespace youtube_v3 {
          */
         title?: string | null;
     }
+    /**
+     * A *VideoStat* resource represents a YouTube video's stats.
+     */
+    export interface Schema$VideoStat {
+        /**
+         * Output only. The VideoStatsContentDetails object contains information about the video content, including the length of the video.
+         */
+        contentDetails?: Schema$VideoStatsContentDetails;
+        /**
+         * Output only. Etag of this resource.
+         */
+        etag?: string | null;
+        /**
+         * Output only. The ID that YouTube uses to uniquely identify the video.
+         */
+        id?: string | null;
+        /**
+         * Output only. Identifies what kind of resource this is. Value: the fixed string "youtube#videoStats".
+         */
+        kind?: string | null;
+        /**
+         * Output only. The VideoStatsSnippet object contains basic details about the video, such publish time.
+         */
+        snippet?: Schema$VideoStatsSnippet;
+        /**
+         * Output only. The VideoStatsStatistics object contains statistics about the video.
+         */
+        statistics?: Schema$VideoStatsStatistics;
+    }
     /**
      * Statistics about the video, such as the number of times the video was viewed or liked.
      */
@@ -4550,6 +4635,41 @@ export declare namespace youtube_v3 {
          */
         viewCount?: string | null;
     }
+    /**
+     * Details about the content of a YouTube Video. This is a subset of the information in VideoContentDetails specifically for the Videos.stats API.
+     */
+    export interface Schema$VideoStatsContentDetails {
+        /**
+         * 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.
+         */
+        duration?: string | null;
+    }
+    /**
+     * Basic details about a video. This is a subset of the information in VideoSnippet specifically for the Videos.stats API.
+     */
+    export interface Schema$VideoStatsSnippet {
+        /**
+         * 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.
+         */
+        publishTime?: string | null;
+    }
+    /**
+     * Statistics about the video, such as the number of times the video was viewed or liked.
+     */
+    export interface Schema$VideoStatsStatistics {
+        /**
+         * Output only. The number of comments for the video.
+         */
+        commentCount?: string | null;
+        /**
+         * Output only. The number of users who have indicated that they liked the video by giving it a positive rating.
+         */
+        likeCount?: string | null;
+        /**
+         * Output only. The number of times the video has been viewed.
+         */
+        viewCount?: string | null;
+    }
     /**
      * Basic details about a video category, such as its localized title. Next Id: 19
      */
@@ -10351,7 +10471,7 @@ export declare namespace youtube_v3 {
          *
          *   // Do the magic
          *   const res = await youtube.search.list({
-         *     // Filter on resources belonging to this channelId.
+         *     // Filter on resources belonging to this channelId. (Force TAP rebuild)
          *     channelId: 'placeholder-value',
          *     // Add a filter on the channel search.
          *     channelType: 'placeholder-value',
@@ -10452,7 +10572,7 @@ export declare namespace youtube_v3 {
     }
     export interface Params$Resource$Search$List extends StandardParameters {
         /**
-         * Filter on resources belonging to this channelId.
+         * Filter on resources belonging to this channelId. (Force TAP rebuild)
          */
         channelId?: string;
         /**
@@ -11730,6 +11850,77 @@ export declare namespace youtube_v3 {
     export class Resource$Videos {
         context: APIRequestContext;
         constructor(context: APIRequestContext);
+        /**
+         * Retrieves a batch of VideoStat resources, possibly filtered. BatchGetStats is intentionally not atomic to provide a better user experience.
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/youtube.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
+         *
+         * const {google} = require('googleapis');
+         * const youtube = google.youtube('v3');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [
+         *       'https://www.googleapis.com/auth/youtube',
+         *       'https://www.googleapis.com/auth/youtube.force-ssl',
+         *       'https://www.googleapis.com/auth/youtube.readonly',
+         *       'https://www.googleapis.com/auth/youtubepartner',
+         *     ],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res = await youtube.videos.batchGetStats({
+         *     // Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.
+         *     id: 'placeholder-value',
+         *     // 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.
+         *     onBehalfOfContentOwner: 'placeholder-value',
+         *     // 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.
+         *     part: 'placeholder-value',
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "etag": "my_etag",
+         *   //   "items": [],
+         *   //   "kind": "my_kind"
+         *   // }
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        batchGetStats(params: Params$Resource$Videos$Batchgetstats, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        batchGetStats(params?: Params$Resource$Videos$Batchgetstats, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$BatchGetStatsResponse>>;
+        batchGetStats(params: Params$Resource$Videos$Batchgetstats, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        batchGetStats(params: Params$Resource$Videos$Batchgetstats, options: MethodOptions | BodyResponseCallback<Schema$BatchGetStatsResponse>, callback: BodyResponseCallback<Schema$BatchGetStatsResponse>): void;
+        batchGetStats(params: Params$Resource$Videos$Batchgetstats, callback: BodyResponseCallback<Schema$BatchGetStatsResponse>): void;
+        batchGetStats(callback: BodyResponseCallback<Schema$BatchGetStatsResponse>): void;
         /**
          * Deletes a resource.
          * @example
@@ -11913,6 +12104,7 @@ export declare namespace youtube_v3 {
          *       // request body parameters
          *       // {
          *       //   "ageGating": {},
+         *       //   "brandPartner": {},
          *       //   "contentDetails": {},
          *       //   "etag": "my_etag",
          *       //   "fileDetails": {},
@@ -11943,6 +12135,7 @@ export declare namespace youtube_v3 {
          *   // Example response
          *   // {
          *   //   "ageGating": {},
+         *   //   "brandPartner": {},
          *   //   "contentDetails": {},
          *   //   "etag": "my_etag",
          *   //   "fileDetails": {},
@@ -12255,6 +12448,7 @@ export declare namespace youtube_v3 {
          *       // request body parameters
          *       // {
          *       //   "ageGating": {},
+         *       //   "brandPartner": {},
          *       //   "contentDetails": {},
          *       //   "etag": "my_etag",
          *       //   "fileDetails": {},
@@ -12281,6 +12475,7 @@ export declare namespace youtube_v3 {
          *   // Example response
          *   // {
          *   //   "ageGating": {},
+         *   //   "brandPartner": {},
          *   //   "contentDetails": {},
          *   //   "etag": "my_etag",
          *   //   "fileDetails": {},
@@ -12321,6 +12516,20 @@ export declare namespace youtube_v3 {
         update(params: Params$Resource$Videos$Update, callback: BodyResponseCallback<Schema$Video>): void;
         update(callback: BodyResponseCallback<Schema$Video>): void;
     }
+    export interface Params$Resource$Videos$Batchgetstats extends StandardParameters {
+        /**
+         * Required. Return videos with the given ids. The number of IDs specified cannot exceed 50.
+         */
+        id?: string[];
+        /**
+         * 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.
+         */
+        onBehalfOfContentOwner?: string;
+        /**
+         * 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.
+         */
+        part?: string[];
+    }
     export interface Params$Resource$Videos$Delete extends StandardParameters {
         /**
          *
@@ -12737,92 +12946,6 @@ export declare namespace youtube_v3 {
         context: APIRequestContext;
         liveChat: Resource$Youtube$V3$Livechat;
         constructor(context: APIRequestContext);
-        /**
-         * Updates an existing resource.
-         * @example
-         * ```js
-         * // Before running the sample:
-         * // - Enable the API at:
-         * //   https://console.developers.google.com/apis/api/youtube.googleapis.com
-         * // - Login into gcloud by running:
-         * //   ```sh
-         * //   $ gcloud auth application-default login
-         * //   ```
-         * // - Install the npm module by running:
-         * //   ```sh
-         * //   $ npm install googleapis
-         * //   ```
-         *
-         * const {google} = require('googleapis');
-         * const youtube = google.youtube('v3');
-         *
-         * async function main() {
-         *   const auth = new google.auth.GoogleAuth({
-         *     // Scopes can be specified either as an array or as a single, space-delimited string.
-         *     scopes: [],
-         *   });
-         *
-         *   // Acquire an auth client, and bind it to all future calls
-         *   const authClient = await auth.getClient();
-         *   google.options({auth: authClient});
-         *
-         *   // Do the magic
-         *   const res = await youtube.youtube.v3.updateCommentThreads({
-         *     // 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.
-         *     part: 'placeholder-value',
-         *
-         *     // Request body metadata
-         *     requestBody: {
-         *       // request body parameters
-         *       // {
-         *       //   "etag": "my_etag",
-         *       //   "id": "my_id",
-         *       //   "kind": "my_kind",
-         *       //   "replies": {},
-         *       //   "snippet": {}
-         *       // }
-         *     },
-         *   });
-         *   console.log(res.data);
-         *
-         *   // Example response
-         *   // {
-         *   //   "etag": "my_etag",
-         *   //   "id": "my_id",
-         *   //   "kind": "my_kind",
-         *   //   "replies": {},
-         *   //   "snippet": {}
-         *   // }
-         * }
-         *
-         * main().catch(e => {
-         *   console.error(e);
-         *   throw e;
-         * });
-         *
-         * ```
-         *
-         * @param params - Parameters for request
-         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
-         * @param callback - Optional callback that handles the response.
-         * @returns A promise if used with async/await, or void if used with a callback.
-         */
-        updateCommentThreads(params: Params$Resource$Youtube$V3$Updatecommentthreads, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
-        updateCommentThreads(params?: Params$Resource$Youtube$V3$Updatecommentthreads, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$CommentThread>>;
-        updateCommentThreads(params: Params$Resource$Youtube$V3$Updatecommentthreads, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
-        updateCommentThreads(params: Params$Resource$Youtube$V3$Updatecommentthreads, options: MethodOptions | BodyResponseCallback<Schema$CommentThread>, callback: BodyResponseCallback<Schema$CommentThread>): void;
-        updateCommentThreads(params: Params$Resource$Youtube$V3$Updatecommentthreads, callback: BodyResponseCallback<Schema$CommentThread>): void;
-        updateCommentThreads(callback: BodyResponseCallback<Schema$CommentThread>): void;
-    }
-    export interface Params$Resource$Youtube$V3$Updatecommentthreads extends StandardParameters {
-        /**
-         * 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.
-         */
-        part?: string[];
-        /**
-         * Request body metadata
-         */
-        requestBody?: Schema$CommentThread;
     }
     export class Resource$Youtube$V3$Livechat {
         context: APIRequestContext;

package/build/v3.js

@@ -2564,6 +2564,38 @@ var youtube_v3;
         constructor(context) {
             this.context = context;
         }
+        batchGetStats(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params = {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://youtube.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/youtube/v3/videos:batchGetStats').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'GET',
+                    apiVersion: '',
+                }, options),
+                params,
+                requiredParams: [],
+                pathParams: [],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
         delete(paramsOrCallback, optionsOrCallback, callback) {
             let params = (paramsOrCallback || {});
             let options = (optionsOrCallback || {});
@@ -2910,38 +2942,6 @@ var youtube_v3;
             this.context = context;
             this.liveChat = new Resource$Youtube$V3$Livechat(this.context);
         }
-        updateCommentThreads(paramsOrCallback, optionsOrCallback, callback) {
-            let params = (paramsOrCallback ||
-                {});
-            let options = (optionsOrCallback || {});
-            if (typeof paramsOrCallback === 'function') {
-                callback = paramsOrCallback;
-                params = {};
-                options = {};
-            }
-            if (typeof optionsOrCallback === 'function') {
-                callback = optionsOrCallback;
-                options = {};
-            }
-            const rootUrl = options.rootUrl || 'https://youtube.googleapis.com/';
-            const parameters = {
-                options: Object.assign({
-                    url: (rootUrl + '/youtube/v3/commentThreads').replace(/([^:]\/)\/+/g, '$1'),
-                    method: 'PUT',
-                    apiVersion: '',
-                }, options),
-                params,
-                requiredParams: [],
-                pathParams: [],
-                context: this.context,
-            };
-            if (callback) {
-                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
-            }
-            else {
-                return (0, googleapis_common_1.createAPIRequest)(parameters);
-            }
-        }
     }
     youtube_v3.Resource$Youtube$V3 = Resource$Youtube$V3;
     class Resource$Youtube$V3$Livechat {