@google-cloud/nodejs-common 2.0.16-beta → 2.1.1

package/src/apis/search_ads.js

@@ -18,20 +18,24 @@
 
 'use strict';
 
+const { request: gaxiosRequest } = require('gaxios');
 const { google } = require('googleapis');
-const AuthClient = require('./auth_client.js');
+const { GoogleApiClient } = require('./base/google_api_client.js');
 const { getLogger } = require('../components/utils.js');
+const { getCleanCid, RestSearchStreamTransform }
+  = require('./base/ads_api_common.js');
 
 const API_SCOPES = Object.freeze([
   'https://www.googleapis.com/auth/doubleclicksearch',
 ]);
+const API_ENDPOINT = 'https://searchads360.googleapis.com';
 const API_VERSION = 'v0';
 
 /**
  * Search Ads 360 Reporting API stub.
  * See: https://developers.google.com/search-ads/reporting/api/reference/release-notes
  */
-class SearchAds {
+class SearchAds extends GoogleApiClient {
 
   /**
    * @constructor
@@ -39,10 +43,21 @@ class SearchAds {
    *     variables.
    */
   constructor(env = process.env) {
-    this.authClient = new AuthClient(API_SCOPES, env);
+    super(env);
+    this.googleApi = 'searchads360';
     this.logger = getLogger('API.SA');
   }
 
+  /** @override */
+  getScope() {
+    return API_SCOPES;
+  }
+
+  /** @override */
+  getVersion() {
+    return API_VERSION;
+  }
+
   /**
    * Prepares the Search Ads 360 Reporting API instance.
    * OAuth 2.0 application credentials is required for calling this API.
@@ -55,83 +70,130 @@ class SearchAds {
    * @return {!google.searchads360}
    * @private
    */
-  async getApiClient_(loginCustomerId) {
-    this.logger.debug(`Initialized Search Ads reporting instance for ${loginCustomerId}`);
-    this.searchads360 = google.searchads360({
-      version: API_VERSION,
-      auth: await this.getAuth_(),
-      headers: { 'login-customer-id': loginCustomerId },
-    });
-    return this.searchads360;
+  async getApiClient(loginCustomerId) {
+    this.logger.debug(`Initialized SA reporting for ${loginCustomerId}`);
+    const options = {
+      version: this.getVersion(),
+      auth: await this.getAuth(),
+    };
+    if (loginCustomerId) {
+      options.headers = { 'login-customer-id': getCleanCid(loginCustomerId) };
+    }
+    return google.searchads360(options);
   }
 
   /**
-   * Gets the auth object.
-   * @return {!Promise<{!OAuth2Client|!JWT|!Compute}>}
+   * Gets a report synchronously from a given Customer account.
+   * If there is a `nextPageToken` in the response, it means the report is not
+   * finished and there are more pages.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#searchads360service
+   * @param {string} customerId
+   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
+   * @param {string} query
+   * @param {object=} options Options for `SearchSearchAds360Request`.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#searchsearchads360request
+   * @return {!SearchAds360Field}
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#searchsearchads360response
    */
-  async getAuth_() {
-    if (this.auth) return this.auth;
-    await this.authClient.prepareCredentials();
-    this.auth = this.authClient.getDefaultAuth();
-    return this.auth;
+  async getPaginatedReport(customerId, loginCustomerId, query, options = {}) {
+    const searchads = await this.getApiClient(loginCustomerId);
+    const requestBody = Object.assign({
+      query,
+      pageSize: 10000,
+    }, options);
+    const response = await searchads.customers.searchAds360.search({
+      customerId: getCleanCid(customerId),
+      requestBody,
+    });
+    return response.data;
   }
 
   /**
-   * Returns all rows that match the search stream query.
-   * The streamed content is not NDJSON format, but one JSON object with the
-   * property `results`. The whole JSON string can be parsed to an object and
-   * the `results` be extracted and converted to NDJSON lines. If the report
-   * is too large to be handled in this way, a possible solution is to parse
-   * the string directly to get the content of `results`.
-   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.searchAds360/searchStream
+   * Gets a report stream from a Search Ads 360 reporting API.
+   * The streamed content is not NDJSON format, but an array of JSON objects
+   * with each element has a property `results`.
+   * `data` support `batchSize` to set how many rows in one result element.
    * @param {string} customerId
    * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
    * @param {string} query
-   * @return {!ReadableStream}
+   * @return {!Promise<stream>}
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/search
    */
-  async streamReport(customerId, loginCustomerId, query) {
-    const searchads = await this.getApiClient_(loginCustomerId);
-    const response = await searchads.customers.searchAds360.search({
-      customerId,
-      requestBody: { query },
-    }, { responseType: 'stream' });
+  async restStreamReport(customerId, loginCustomerId, query) {
+    const auth = await this.getAuth();
+    const headers = Object.assign(
+      await auth.getRequestHeaders(), {
+      'login-customer-id': getCleanCid(loginCustomerId),
+    });
+    const options = {
+      baseURL: `${API_ENDPOINT}/${API_VERSION}/`,
+      url: `customers/${getCleanCid(customerId)}/searchAds360:searchStream`,
+      headers,
+      data: { query },
+      method: 'POST',
+      responseType: 'stream',
+    };
+    const response = await gaxiosRequest(options);
     return response.data;
   }
 
   /**
-   * Gets a report synchronously from a given Customer account.
-   * This is for test as it does not handle page token. For product env, use
-   * function `streamReport`.
-   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.searchAds360/search#request-body
+   * Gets the report stream through REST interface.
+   * Based on the `fieldMask` in the response to filter out
+   * selected fields of the report and returns an array of JSON format strings
+   * with the delimit of a line breaker.
    * @param {string} customerId
    * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
-   * @param {string} query
-   * @return {!SearchAds360Field}
-   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields#SearchAds360Field
+   * @param {string} query A Google Ads Query string.
+   * @param {boolean=} snakeCase Output JSON objects in snake_case.
+   * @return {!Promise<stream>}
    */
-  async getReport(customerId, loginCustomerId, query) {
-    const searchads = await this.getApiClient_(loginCustomerId);
-    const response = await searchads.customers.searchAds360.search({
-      customerId,
-      requestBody: { query },
-    });
-    return response.data.results;
+  async cleanedRestStreamReport(customerId, loginCustomerId, query,
+    snakeCase = false) {
+    const transform = new RestSearchStreamTransform(snakeCase);
+    const stream =
+      await this.restStreamReport(customerId, loginCustomerId, query);
+    return stream.on('error', (error) => transform.emit('error', error))
+      .pipe(transform);
   }
 
   /**
    * Returns the requested field or resource (artifact) used by SearchAds360Service.
    * This service doesn't require `login-customer-id` HTTP header.
    * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields/get
-   * @param {string} resourceName
+   * @param {string} fieldName
    * @return {!SearchAds360Field}
    * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields#SearchAds360Field
    */
-  async getReportField(resourceName) {
-    const searchads = await this.getApiClient_();
-    const response = await searchads.searchAds360Fields.get({ resourceName });
+  async getReportField(fieldName) {
+    const searchads = await this.getApiClient();
+    const resourceName = `searchAds360Fields/${fieldName}`;
+    const response =
+      await searchads.searchAds360Fields.get({ resourceName });
     return response.data;
   }
 
+  /**
+   * Returns resources information from Search Ads API.
+   * @see: https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields
+   * Note, it looks like this function doesn't check the CID, just using OAuth.
+   * @param {Array<string>} adFields Array of Ad fields.
+   * @param {Array<string>} metadata Select fields, default values are:
+   *     name, data_type, is_repeated, type_url.
+   * @return {!Promise<!Array<GoogleAdsField>>}
+   * @see GoogleAdsApi.searchReportField
+   */
+  async searchReportField(adFields,
+    metadata = ['name', 'data_type', 'is_repeated', 'type_url',]) {
+    const searchads = await this.getApiClient();
+    const selectClause = metadata.join(',');
+    const fields = adFields.join('","');
+    const query = `SELECT ${selectClause} WHERE name IN ("${fields}")`;
+    const response =
+      await searchads.searchAds360Fields.search({ query, pageSize: 10000 });
+    return response.data.results;
+  }
+
   /**
    * Returns all the custom columns associated with the customer in full detail.
    * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns/list
@@ -141,7 +203,7 @@ class SearchAds {
    * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumn
    */
   async listCustomColumns(customerId, loginCustomerId) {
-    const searchads = await this.getApiClient_(loginCustomerId);
+    const searchads = await this.getApiClient(loginCustomerId);
     const response = await searchads.customers.customColumns.list({ customerId });
     return response.data.customColumns;
   }
@@ -157,7 +219,7 @@ class SearchAds {
    */
   async getCustomColumn(columnId, customerId, loginCustomerId) {
     const resourceName = `customers/${customerId}/customColumns/${columnId}`;
-    const searchads = await this.getApiClient_(loginCustomerId);
+    const searchads = await this.getApiClient(loginCustomerId);
     const response = await searchads.customers.customColumns.get({ resourceName });
     return response.data;
   }

package/src/apis/spreadsheets.js

@@ -19,6 +19,7 @@
 'use strict';
 
 const {google} = require('googleapis');
+const { GoogleApiClient } = require('./base/google_api_client.js');
 const {Params$Resource$Spreadsheets$Get} = google.sheets;
 const AuthClient = require('./auth_client.js');
 const {getLogger, BatchResult} = require('../components/utils.js');
@@ -63,7 +64,7 @@ let DimensionRange;
 /**
  * Google Spreadsheets API v4 stub.
  */
-class Spreadsheets {
+class Spreadsheets extends GoogleApiClient {
   /**
    * Init Spreadsheets API client.
    * @param {string} spreadsheetId
@@ -71,29 +72,21 @@ class Spreadsheets {
    *     variables.
    */
   constructor(spreadsheetId, env = process.env) {
+    super(env);
+    this.googleApi = 'sheets';
     /** @const {string} */
     this.spreadsheetId = spreadsheetId;
-    this.authClient = new AuthClient(API_SCOPES, env);
-    /**
-     * Logger object from 'log4js' package where this type is not exported.
-     */
     this.logger = getLogger('API.GS');
   }
 
-  /**
-   * Prepares the Google Sheets instance.
-   * @return {!google.sheets}
-   * @private
-   */
-  async getApiClient_() {
-    if (this.sheets) return this.sheets;
-    await this.authClient.prepareCredentials();
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.sheets = google.sheets({
-      version: API_VERSION,
-      auth: this.authClient.getDefaultAuth(),
-    });
-    return this.sheets;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
+  }
+
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
   /**
@@ -108,7 +101,7 @@ class Spreadsheets {
       spreadsheetId: this.spreadsheetId,
       ranges: sheetName,
     };
-    const sheets = await this.getApiClient_();
+    const sheets = await this.getApiClient();
     const response = await sheets.spreadsheets.get(request);
     const sheet = response.data.sheets[0];
     this.logger.debug(`Get sheet[${sheetName}]: `, sheet);
@@ -127,7 +120,7 @@ class Spreadsheets {
       range: sheetName,
     };
     try {
-      const sheets = await this.getApiClient_();
+      const sheets = await this.getApiClient();
       const response = await sheets.spreadsheets.values.clear(request);
       const data = response.data;
       this.logger.debug(`Clear sheet[${sheetName}}]: `, data);
@@ -180,7 +173,7 @@ class Spreadsheets {
       ranges: sheetName,
     };
     try {
-      const sheets = await this.getApiClient_();
+      const sheets = await this.getApiClient();
       const response = await sheets.spreadsheets.get(request);
       const sheet = response.data.sheets[0];
       const sheetId = sheet.properties.sheetId;
@@ -232,7 +225,7 @@ class Spreadsheets {
       numberOfLines: data.trim().split('\n').length,
     };
     try {
-      const sheets = await this.getApiClient_();
+      const sheets = await this.getApiClient();
       const response = await sheets.spreadsheets.batchUpdate(request);
       const data = response.data;
       this.logger.debug(`Batch[${batchId}] uploaded: `, data);

package/src/apis/youtube.js

@@ -19,6 +19,7 @@
 'use strict';
 
 const {google} = require('googleapis');
+const { GoogleApiClient } = require('./base/google_api_client.js');
 const {
   Schema$Channel,
   Schema$Video,
@@ -26,8 +27,7 @@ const {
   Schema$Playlist,
   Schema$Search,
 } = google.youtube;
-const AuthClient = require('./auth_client.js');
-const {getLogger} = require('../components/utils.js');
+const { getLogger } = require('../components/utils.js');
 
 const API_SCOPES = Object.freeze([
   'https://www.googleapis.com/auth/youtube.force-ssl'
@@ -159,34 +159,26 @@ let ListSearchConfig;
  * Search list type definition, see:
  * https://developers.google.com/youtube/v3/docs/search/list
  */
-class YouTube {
+class YouTube extends GoogleApiClient {
   /**
    * @constructor
    * @param {!Object<string,string>=} env The environment object to hold env
    *     variables.
    */
   constructor(env = process.env) {
-    this.authClient = new AuthClient(API_SCOPES, env);
-    /**
-     * Logger object from 'log4js' package where this type is not exported.
-     */
+    super(env);
+    this.googleApi = 'youtube';
     this.logger = getLogger('API.YT');
   }
 
-  /**
-     * Prepares the Google YouTube instance.
-     * @return {!google.youtube}
-     * @private
-     */
-  async getApiClient_() {
-    if (this.youtube) return this.youtube;
-    await this.authClient.prepareCredentials();
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.youtube = google.youtube({
-      version: API_VERSION,
-      auth: this.authClient.getDefaultAuth(),
-    });
-    return this.youtube;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
+  }
+
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
   /**
@@ -200,7 +192,7 @@ class YouTube {
     const channelListRequest = Object.assign({}, config);
     channelListRequest.part = channelListRequest.part.join(',')
     try {
-      const youtube = await this.getApiClient_();
+      const youtube = await this.getApiClient();
       const response = await youtube.channels.list(channelListRequest);
       this.logger.debug('Response: ', response);
       return response.data.items;
@@ -223,7 +215,7 @@ class YouTube {
     const videoListRequest = Object.assign({}, config);
     videoListRequest.part = videoListRequest.part.join(',')
     try {
-      const youtube = await this.getApiClient_();
+      const youtube = await this.getApiClient();
       const response = await youtube.videos.list(videoListRequest);
       this.logger.debug('Response: ', response);
       return response.data.items;
@@ -247,7 +239,7 @@ class YouTube {
     const commentThreadsRequest = Object.assign({}, config);
     commentThreadsRequest.part = commentThreadsRequest.part.join(',')
     try {
-      const youtube = await this.getApiClient_();
+      const youtube = await this.getApiClient();
       const response = await youtube.commentThreads.list(commentThreadsRequest);
       this.logger.debug('Response: ', response.data);
       return response.data.items;
@@ -282,7 +274,7 @@ class YouTube {
     }
 
     try {
-      const youtube = await this.getApiClient_();
+      const youtube = await this.getApiClient();
       const response = await youtube.playlists.list(playlistsRequest);
       this.logger.debug('Response: ', response.data);
       if (response.data.nextPageToken) {
@@ -324,7 +316,7 @@ class YouTube {
     }
 
     try {
-      const youtube = await this.getApiClient_();
+      const youtube = await this.getApiClient();
       const response = await youtube.search.list(searchRequest);
       this.logger.debug('Response: ', response.data);
       if (response.data.nextPageToken) {

package/src/components/firestore/datastore_mode_access.js

@@ -75,7 +75,7 @@ class DatastoreModeAccess {
    */
   getKey(id) {
     const keyPath = [this.kind];
-    if (id) keyPath.push(isNaN(id) ? id : parseInt(id));
+    if (id) keyPath.push(isNaN(id) ? id : this.datastore.int(id));
     return this.datastore.key({
       namespace: this.namespace,
       path: keyPath,
@@ -116,10 +116,11 @@ class DatastoreModeAccess {
     const key = this.getKey(id);
     const apiResponse =
       await this.datastore.save({ key, data, excludeLargeProperties: true });
-    // Default key in Datastore is a number in response like following.
+    // Default key in Datastore is an int as string in response. It could be
+    // larger than JavaScript max safe integer, so keep it as string here.
     // With a given id, the key in response is null.
     const updatedId = id !== undefined ? id
-      : +apiResponse[0].mutationResults[0].key.path[0].id;
+      : apiResponse[0].mutationResults[0].key.path[0].id;
     this.logger.debug(`Result of saving ${updatedId}@${this.kind}: `,
       JSON.stringify(apiResponse));
     // Datastore has a delay to write entity. This method only returns id

package/src/components/utils.js

@@ -487,9 +487,9 @@ const extractObject = (paths) => {
   return (sourceObject) => {
     const output = {};
     paths.forEach((path) => {
-      const [value, owner, property] = path.split('.')
+      const [value, owner, property] = path.trim().split('.')
           .reduce(transcribe, [sourceObject, output, undefined]);
-      if (value) {
+      if (typeof value !== 'undefined') {
         owner[property] = value;
       }
     });
@@ -509,7 +509,7 @@ const getObjectByPath = (obj, paths) => {
     paths.split('.').filter((key) => !!key).forEach((key) => {
       instance = instance[key];
       if (!instance) {
-        console.error('Fail to get function containter', paths);
+        console.error('Fail to get element from path:', paths);
         return instance;
       }
     });
@@ -591,7 +591,24 @@ const changeObjectNamingFromLowerCamelToSnake = (obj) => {
   } else {
     return obj;
   }
-}
+};
+
+/**
+ * Generates a function that can convert a given JSON object to a JSON string
+ * with only specified fields(fieldMask), in specified naming convention.
+ * @param {string} fieldMask The 'fieldMask' string from response.
+ * @param {boolean=} snakeCase Whether or not output JSON in snake naming.
+ */
+const getFilterAndStringifyFn = (fieldMask, snakeCase = false) => {
+  const extractor = extractObject(
+    Array.isArray(fieldMask) ? fieldMask : fieldMask.split(','));
+  return (originalObject) => {
+    const extracted = extractor(originalObject);
+    const generatedObject = snakeCase
+      ? changeObjectNamingFromLowerCamelToSnake(extracted) : extracted;
+    return JSON.stringify(generatedObject);
+  };
+};
 
 /**
  * Returns the response data for a HTTP request. It will retry the specific
@@ -619,7 +636,7 @@ const requestWithRetry = async (options, logger = console, retryTimes = 3) => {
       logger.error(`Request ${JSON.stringify(options)}`, error);
     }
   } while (processedTimes <= retryTimes)
-}
+};
 
 // noinspection JSUnusedAssignment
 module.exports = {
@@ -641,5 +658,6 @@ module.exports = {
   changeNamingFromLowerCamelToSnake,
   changeObjectNamingFromSnakeToLowerCamel,
   changeObjectNamingFromLowerCamelToSnake,
+  getFilterAndStringifyFn,
   requestWithRetry,
 };