@google-cloud/nodejs-common 0.9.5-beta → 0.9.5-beta2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "0.9.5-beta",
+  "version": "0.9.5-beta2",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",

package/src/apis/youtube.js

@@ -24,6 +24,7 @@ const {
   Schema$Video,
   Schema$CommentThread,
   Schema$Playlist,
+  Schema$Search,
 } = google.youtube;
 const AuthClient = require('./auth_client.js');
 const {getLogger} = require('../components/utils.js');
@@ -105,6 +106,45 @@ let ListCommentThreadsConfig;
  */
 let ListPlaylistConfig;
 
+/**
+ * Configuration for listing youtube search results.
+ * @see https://developers.google.com/youtube/v3/docs/search/list
+ * @typedef {{
+ *   part: Array<string>,
+ *   forContentOwner:	(boolean|undefined),
+ *   forDeveloper:	(boolean|undefined),
+ *   forMine:	(boolean|undefined),
+ *   relatedToVideoId:	(string|undefined),
+ *   channelId:	(string|undefined),
+ *   channelType:	(string|undefined),
+ *   eventType:	(string|undefined),
+ *   location:	(string|undefined),
+ *   locationRadius:	(string|undefined),
+ *   maxResults: (unsigned integer|undefined),
+ *   onBehalfOfContentOwner:	(string|undefined),
+ *   order:	(string|undefined),
+ *   pageToken:	(string|undefined),
+ *   publishedAfter: (datetime|undefined),
+ *   publishedBefore: (datetime|undefined),
+ *   q:	(string|undefined),
+ *   regionCode:	(string|undefined),
+ *   relevanceLanguage:	(string|undefined),
+ *   safeSearch:	(string|undefined),
+ *   topicId:	(string|undefined),
+ *   type:	(string|undefined),
+ *   videoCaption:	(string|undefined),
+ *   videoCategoryId:	(string|undefined),
+ *   videoDefinition:	(string|undefined),
+ *   videoDimension:	(string|undefined),
+ *   videoDuration:	(string|undefined),
+ *   videoEmbeddable:	(string|undefined),
+ *   videoLicense:	(string|undefined),
+ *   videoSyndicated:	(string|undefined),
+ *   videoType:	(string|undefined)
+ * }}
+ */
+let ListSearchConfig;
+
 /**
  * Youtube API v3 stub.
  * See: https://developers.google.com/youtube/v3/docs
@@ -116,6 +156,8 @@ let ListPlaylistConfig;
  * https://developers.google.com/youtube/v3/docs/commentThreads/list
  * Playlist list type definition, see:
  * https://developers.google.com/youtube/v3/docs/playlists/list
+ * Search list type definition, see:
+ * https://developers.google.com/youtube/v3/docs/search/list
  */
 class YouTube {
   /**
@@ -220,7 +262,7 @@ class YouTube {
    * @return {!Promise<Array<Schema$Playlist>>}
    */
   async listPlaylists(config, resultLimit = 1000, pageToken = null) {
-    if (resultLimit <= 0) { return []; }
+    if (resultLimit <= 0) return [];
 
     const playlistsRequest = Object.assign({
         auth: this.auth,
@@ -255,6 +297,51 @@ class YouTube {
       throw new Error(errorMsg);
     }
   }
+
+  /**
+   * Returns a collection of search results that match the query parameters
+   * specified in the API request.
+   * @see https://developers.google.com/youtube/v3/docs/search/list
+   * @param {!ListSearchConfig} config List search result configuration.
+   * @param {number} resultLimit The limit of the number of results.
+   * @param {string} pageToken Token to identify a specific page in the result.
+   * @return {!Promise<Array<Schema$Search>>}
+   */
+  async listSearchResults(config, resultLimit = 1000, pageToken = null) {
+    if (resultLimit <= 0) return [];
+
+    const searchRequest = Object.assign({
+        auth: this.auth,
+    }, config, {
+        pageToken
+    });
+
+    if (Array.isArray(searchRequest.part)) {
+      searchRequest.part = searchRequest.part.join(',');
+    }
+
+    try {
+      const response = await this.instance.search.list(searchRequest);
+      this.logger.debug('Response: ', response.data);
+      if (response.data.nextPageToken) {
+        this.logger.debug(
+          'Call youtube search:list API agian with Token: ',
+          response.data.nextPageToken);
+        const nextResponse = await this.listSearchResults(
+          config,
+          resultLimit - response.data.items.length,
+          response.data.nextPageToken);
+        return response.data.items.concat(nextResponse);
+      }
+      return response.data.items;
+    } catch (error) {
+      const errorMsg =
+        `Fail to list search results: ${JSON.stringify(searchRequest)}`;
+      this.logger.error('YouTube list search results failed.', error.message);
+      this.logger.debug('Errors in response:', error);
+      throw new Error(errorMsg);
+    }
+  }
 }
 
 module.exports = {
@@ -263,6 +350,7 @@ module.exports = {
   ListVideosConfig,
   ListCommentThreadsConfig,
   ListPlaylistConfig,
+  ListSearchConfig,
   API_VERSION,
   API_SCOPES,
 };