@google-cloud/nodejs-common 2.1.0 → 2.2.0

package/bin/install_functions.sh

@@ -1560,6 +1560,7 @@ set_cloud_functions_default_settings() {
   default_cf_flag+=(--set-env-vars=DEBUG="${DEBUG}")
   default_cf_flag+=(--set-env-vars=IN_GCP="${IN_GCP}")
   default_cf_flag+=(--set-env-vars=DATABASE_ID="${DATABASE_ID}")
+  default_cf_flag+=(--set-env-vars=DATABASE_MODE="${DATABASE_MODE}")
 }
 
 #######################################

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",
@@ -16,24 +16,24 @@
   },
   "homepage": "https://github.com/GoogleCloudPlatform/cloud-for-marketing/blob/master/marketing-analytics/activation/common-libs/nodejs-common/README.md",
   "dependencies": {
-    "@google-cloud/aiplatform": "^3.10.0",
+    "@google-cloud/aiplatform": "^3.17.0",
     "@google-cloud/automl": "^4.0.1",
-    "@google-cloud/bigquery": "^7.3.0",
-    "@google-cloud/datastore": "^8.4.0",
-    "@google-cloud/firestore": "^7.2.0",
+    "@google-cloud/bigquery": "^7.5.2",
+    "@google-cloud/datastore": "^8.6.0",
+    "@google-cloud/firestore": "^7.5.0",
     "@google-cloud/logging-winston": "^6.0.0",
-    "@google-cloud/pubsub": "^4.1.1",
-    "@google-cloud/storage": "^7.7.0",
-    "@google-cloud/scheduler": "^4.0.1",
-    "@google-cloud/secret-manager": "^5.0.1",
-    "gaxios": "^6.1.1",
+    "@google-cloud/pubsub": "^4.3.3",
+    "@google-cloud/storage": "^7.9.0",
+    "@google-cloud/scheduler": "^4.1.0",
+    "@google-cloud/secret-manager": "^5.2.0",
+    "gaxios": "^6.3.0",
     "google-ads-nodejs-client": "16.0.0",
     "google-ads-api": "^14.1.0",
     "google-ads-node": "^12.0.2",
-    "google-auth-library": "^9.4.2",
-    "googleapis": "^131.0.0",
-    "winston": "^3.10.0",
-    "@grpc/grpc-js": "1.9.14",
+    "google-auth-library": "^9.7.0",
+    "googleapis": "^134.0.0",
+    "winston": "^3.13.0",
+    "@grpc/grpc-js": "^1.10.5",
     "lodash": "^4.17.21"
   },
   "devDependencies": {

package/src/apis/analytics.js

@@ -21,6 +21,7 @@
 
 const stream = require('stream');
 const {google} = require('googleapis');
+const { GoogleApiClient } = require('./base/google_api_client.js');
 const {Schema$Upload} = google.analytics;
 const AuthClient = require('./auth_client.js');
 const {wait, getLogger, BatchResult} = require('../components/utils.js');
@@ -55,31 +56,26 @@ let DataImportClearConfig;
 /**
  * Google Analytics API v3 stub.
  */
-class Analytics {
+class Analytics 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);
+    super(env);
+    this.googleApi = 'analytics';
     this.logger = getLogger('API.GA');
   }
 
-  /**
-   * Prepares the Google Analytics instance.
-   * @return {!google.analytics}
-   * @private
-   */
-  async getApiClient_() {
-    if (this.analytics) return this.analytics;
-    await this.authClient.prepareCredentials();
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.analytics = google.analytics({
-      version: API_VERSION,
-      auth: this.authClient.getDefaultAuth(),
-    });
-    return this.analytics;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
+  }
+
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
   /**
@@ -102,7 +98,7 @@ class Analytics {
         },
         config);
 
-    const analytics = await this.getApiClient_();
+    const analytics = await this.getApiClient();
     const response = await analytics.management.uploads.uploadData(
         uploadConfig);
     this.logger.debug('Configuration: ', config);
@@ -151,7 +147,7 @@ class Analytics {
    * @return {!Promise<!Schema$Upload>} Updated data import Job status.
    */
   async checkJobStatus(jobConfig) {
-    const analytics = await this.getApiClient_();
+    const analytics = await this.getApiClient();
     const { data: job } = await analytics.management.uploads.get(jobConfig);
     if (job.status !== 'PENDING') return job;
     this.logger.debug(
@@ -169,7 +165,7 @@ class Analytics {
    * @return {!Promise<!Array<string>>}
    */
   async listAccounts() {
-    const analytics = await this.getApiClient_();
+    const analytics = await this.getApiClient();
     const response = await analytics.management.accounts.list();
     return response.data.items.map(
         (account) => `Account id: ${account.name}[${account.id}]`
@@ -182,7 +178,7 @@ class Analytics {
    * @return {!Promise<!Array<Object>>}
    */
   async listUploads(config) {
-    const analytics = await this.getApiClient_();
+    const analytics = await this.getApiClient();
     const response = await analytics.management.uploads.list(config);
     return response.data.items;
   }
@@ -203,7 +199,7 @@ class Analytics {
     const request = Object.assign({}, config, {
       resource: {customDataImportUids},
     });
-    const analytics = await this.getApiClient_();
+    const analytics = await this.getApiClient();
     await analytics.management.uploads.deleteUploadData(request);
     this.logger.debug('Delete uploads: ', customDataImportUids);
   }

package/src/apis/base/ads_api_common.js

@@ -19,8 +19,7 @@
 
 const { Transform } = require('stream');
 const {
-  extractObject,
-  changeObjectNamingFromLowerCamelToSnake,
+  getFilterAndStringifyFn,
   getLogger,
 } = require('../../components/utils.js');
 
@@ -37,22 +36,6 @@ const START_TAG = '"results":';
 const FIELD_MASK_TAG = '"fieldMask"';
 const END_TAG = '"requestId"';
 
-/**
- * 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.
- */
-function generateProcessFn(fieldMask, snakeCase = false) {
-  const extractor = extractObject(fieldMask.split(','));
-  return (originalObject) => {
-    const extracted = extractor(originalObject);
-    const generatedObject = snakeCase
-      ? changeObjectNamingFromLowerCamelToSnake(extracted) : extracted;
-    return JSON.stringify(generatedObject);
-  };
-};
-
 /**
  * A stream.Transform that can extract properties and convert naming of the
  * reponse of Google/Search Ads report from REST interface.
@@ -85,7 +68,7 @@ class RestSearchStreamTransform extends Transform {
           .substring(maskIndex + FIELD_MASK_TAG.length, rawString.indexOf(END_TAG))
           .split('"')[1];
         this.logger.debug(`Got fieldMask: ${fieldMask}`);
-        this.processFn = generateProcessFn(fieldMask, this.snakeCase);
+        this.processFn = getFilterAndStringifyFn(fieldMask, this.snakeCase);
       }
       const resultsWithTailing = rawString.substring(startIndex, maskIndex);
       const results = resultsWithTailing.substring(

package/src/apis/base/google_api_client.js

@@ -0,0 +1,55 @@
+// Copyright 2023 Google Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/**
+ * @fileoverview A base class for Google Api client library class.
+ */
+const { google } = require('googleapis');
+const { getLogger, getObjectByPath } = require('../../components/utils.js');
+const { AuthRestfulApi } = require('./auth_restful_api.js');
+
+/**
+ * A Google Api client library class.
+ */
+class GoogleApiClient extends AuthRestfulApi {
+
+  /** @constructor */
+  constructor(env = process.env, options = {}) {
+    super(env, options);
+    this.logger = getLogger('API.default');
+  }
+
+  /**
+   * Returns the Api version of the Api in the current library.
+   * @return {string}
+   * @abstract
+   */
+  getVersion() { }
+
+  /**
+   * Returns the Api instance.
+   * @return {!Promise<object>} The Api instance.
+   */
+  async getApiClient() {
+    if (this.apiClient) return this.apiClient;
+    this.logger.info(`Initialized ${this.constructor.name} instance.`);
+    this.apiClient = google[this.googleApi]({
+      version: this.getVersion(),
+      auth: await this.getAuth(),
+    });
+    return this.apiClient;
+  }
+}
+
+module.exports = { GoogleApiClient };

package/src/apis/dfa_reporting.js

@@ -19,9 +19,8 @@
 
 'use strict';
 
-const {google} = require('googleapis');
-const {request} = require('gaxios');
-const AuthClient = require('./auth_client.js');
+const { request } = require('gaxios');
+const { GoogleApiClient } = require('./base/google_api_client.js');
 const {
   getLogger,
   getFilterFunction,
@@ -94,7 +93,7 @@ const MAX_IDENTIFIERS_PER_USER = 5;
  * Google DfaReport API v3.0 stub.
  * see https://developers.google.com/doubleclick-advertisers/service_accounts
  */
-class DfaReporting {
+class DfaReporting extends GoogleApiClient {
 
   /**
    * @constructor
@@ -102,34 +101,19 @@ class DfaReporting {
    *     variables.
    */
   constructor(env = process.env) {
-    this.authClient = new AuthClient(API_SCOPES, env);
+    super(env);
+    this.googleApi = 'dfareporting';
     this.logger = getLogger('API.CM');
   }
 
-  /**
-    * Prepares the Google DfaReport API instance.
-    * @return {!google.dfareporting}
-    * @private
-    */
-  async getApiClient_() {
-    if (this.dfareporting) return this.dfareporting;
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.dfareporting = google.dfareporting({
-      version: API_VERSION,
-      auth: await this.getAuth_(),
-    });
-    return this.dfareporting;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
   }
 
-  /**
-   * Gets the auth object.
-   * @return {!Promise<{!OAuth2Client|!JWT|!Compute}>}
-   */
-  async getAuth_() {
-    if (this.auth) return this.auth;
-    await this.authClient.prepareCredentials();
-    this.auth = this.authClient.getDefaultAuth();
-    return this.auth;
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
   /**
@@ -140,7 +124,7 @@ class DfaReporting {
    * @return {!Promise<string>}
    */
   async getProfileId(accountId) {
-    const dfareporting = await this.getApiClient_();
+    const dfareporting = await this.getApiClient();
     const { data: { items } } = await dfareporting.userProfiles.list();
     const profiles = items.filter(
         (profile) => profile.accountId === accountId
@@ -237,7 +221,7 @@ class DfaReporting {
         numberOfLines: lines.length,
       };
       try {
-        const dfareporting = await this.getApiClient_();
+        const dfareporting = await this.getApiClient();
         const response = await dfareporting.conversions[operation]({
           profileId: config.profileId,
           requestBody: requestBody,
@@ -304,7 +288,7 @@ class DfaReporting {
    * @return {!Promise<!Array<string>>}
    */
   async listUserProfiles() {
-    const dfareporting = await this.getApiClient_();
+    const dfareporting = await this.getApiClient();
     const { data: { items } } = await dfareporting.userProfiles.list();
     return items.map(({profileId, userName, accountId, accountName}) => {
       return `Profile: ${profileId}[${userName}] `
@@ -349,7 +333,7 @@ class DfaReporting {
    */
   async runReport(config) {
     const profileId = await this.getProfileForOperation_(config);
-    const dfareporting = await this.getApiClient_();
+    const dfareporting = await this.getApiClient();
     const { startDate, endDate } = config;
     if (startDate && endDate) {
       const { data: report } = await dfareporting.reports.get({
@@ -392,7 +376,7 @@ class DfaReporting {
    */
   async getReportFileUrl(config) {
     const profileId = await this.getProfileForOperation_(config);
-    const dfareporting = await this.getApiClient_();
+    const dfareporting = await this.getApiClient();
     const response = await dfareporting.reports.files.get({
       profileId,
       reportId: config.reportId,
@@ -410,7 +394,7 @@ class DfaReporting {
    * @return {!Promise<stream>}
    */
   async getReportFileStream(url) {
-    const auth = await this.getAuth_();
+    const auth = await this.getAuth();
     const headers = await auth.getRequestHeaders();
     const response = await request({
       method: 'GET',

package/src/apis/display_video.js

@@ -19,14 +19,8 @@
 
 'use strict';
 
-const { google } = require('googleapis');
-const AuthClient = require('./auth_client.js');
-const {
-  getLogger,
-  getObjectByPath,
-  SendSingleBatch,
-  BatchResult,
-} = require('../components/utils.js');
+const { GoogleApiClient } = require('./base/google_api_client.js');
+const { getLogger } = require('../components/utils.js');
 
 const API_SCOPES = Object.freeze([
   'https://www.googleapis.com/auth/display-video',
@@ -40,7 +34,7 @@ const API_VERSION = 'v3';
  * Bid Manager API.
  * @see https://developers.google.com/bid-manager/reference/rest
  */
-class DisplayVideo {
+class DisplayVideo extends GoogleApiClient {
 
   /**
    * @constructor
@@ -48,44 +42,19 @@ class DisplayVideo {
    *     variables.
    */
   constructor(env = process.env) {
-    this.authClient = new AuthClient(API_SCOPES, env);
+    super(env);
+    this.googleApi = 'displayvideo';
     this.logger = getLogger('API.DV3API');
   }
 
-  /**
-   * Prepares the Google DV3 instance.
-   * @return {!google.displayvideo}
-   * @private
-   */
-  async getApiClient_() {
-    if (this.displayvideo) return this.displayvideo;
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.displayvideo = google.displayvideo({
-      version: API_VERSION,
-      auth: await this.getAuth_(),
-    });
-    return this.displayvideo;
-  }
-
-  /**
-   * Gets the auth object.
-   * @return {!Promise<{!OAuth2Client|!JWT|!Compute}>}
-   */
-  async getAuth_() {
-    if (this.auth) return this.auth;
-    await this.authClient.prepareCredentials();
-    this.auth = this.authClient.getDefaultAuth();
-    return this.auth;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
   }
 
-  /**
-   * Gets the instance of function object based on Google API client library.
-   * @param {string|undefined} path
-   * @return {Object}
-   */
-  async getFunctionObject(path) {
-    const instance = await this.getApiClient_();
-    return getObjectByPath(instance, path);
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
 }

package/src/apis/doubleclick_bidmanager.js

@@ -19,8 +19,7 @@
 
 'use strict';
 
-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 API_SCOPES = Object.freeze([
@@ -28,25 +27,24 @@ const API_SCOPES = Object.freeze([
 ]);
 const API_VERSION = 'v2';
 
-/**
- * The returned information of get a query.
- * @typedef {{
- *   running:boolean,
- *   latestReportRunTimeMs:string,
- *   googleCloudStoragePathForLatestReport:string,
- * }}
- */
-let QueryResource;
-
 /**
  * RequestBody controls the data range of reports.
  * see:
- * https://developers.google.com/bid-manager/v1.1/queries/runquery#request-body
+ * https://developers.google.com/bid-manager/reference/rest/v2/queries/run#RunQueryRequest
  * @typedef {{
- *   dataRange: string,
- *   reportDataStartTimeMs: long,
- *   reportDataEndTimeMs: long,
- *   timezoneCode: string
+ *   dataRange: {
+ *     range: Range,
+ *     customStartDate: {
+ *       year: integer,
+ *       month: integer,
+ *       day: integer,
+ *     },
+ *     customEndDate: {
+*       year: integer,
+*       month: integer,
+*       day: integer,
+*     },
+ *   }
  * }}
  */
 let RequestBody;
@@ -56,31 +54,26 @@ let RequestBody;
  * Note: DV360 report API only support OAuth 2.0, see:
  * https://developers.google.com/bid-manager/how-tos/authorizing
  */
-class DoubleClickBidManager {
+class DoubleClickBidManager 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);
+    super(env);
+    this.googleApi = 'doubleclickbidmanager';
     this.logger = getLogger('API.DV3');
   }
 
-  /**
-   * Prepares the Google DBM instance.
-   * @return {!google.doubleclickbidmanager}
-   * @private
-   */
-  async getApiClient_() {
-    if (this.doubleclickbidmanager) return this.doubleclickbidmanager;
-    await this.authClient.prepareCredentials();
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.doubleclickbidmanager = google.doubleclickbidmanager({
-      version: API_VERSION,
-      auth: this.authClient.getDefaultAuth(),
-    });
-    return this.doubleclickbidmanager;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
+  }
+
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
   /**
@@ -91,21 +84,21 @@ class DoubleClickBidManager {
    * @return {!Promise<number>} Report Id.
    */
   async runQuery(queryId, requestBody = undefined) {
-    const doubleclickbidmanager = await this.getApiClient_();
+    const doubleclickbidmanager = await this.getApiClient();
     const response = await doubleclickbidmanager.queries.run(
         {queryId, requestBody});
     return response.data.key.reportId;
   }
 
   /**
-   * Gets a query resource.
+   * Gets a query metadata.
    * See https://developers.google.com/bid-manager/reference/rest/v2/queries/get
    * @param {number} queryId Id of the query.
-   * @return {!Promise<!QueryResource>} Query resource, see
-   *     https://developers.google.com/bid-manager/reference/rest/v2/queries#Query
+   * @return {!Promise<!QueryMetadata>} Query metadata, see
+   *     https://developers.google.com/bid-manager/reference/rest/v2/queries#QueryMetadata
    */
   async getQuery(queryId) {
-    const doubleclickbidmanager = await this.getApiClient_();
+    const doubleclickbidmanager = await this.getApiClient();
     const response = await doubleclickbidmanager.queries.get({ queryId });
     return response.data.metadata;
   }
@@ -117,14 +110,14 @@ class DoubleClickBidManager {
    * @return {!Promise<number>} Id of created query.
    */
   async createQuery(query) {
-    const doubleclickbidmanager = await this.getApiClient_();
+    const doubleclickbidmanager = await this.getApiClient();
     const response = await doubleclickbidmanager.queries.create(
         {requestBody: query});
     return response.data.queryId;
   }
 
   async getQueryReport(queryId, reportId) {
-    const doubleclickbidmanager = await this.getApiClient_();
+    const doubleclickbidmanager = await this.getApiClient();
     const response = await doubleclickbidmanager.queries.reports.get(
       { queryId, reportId });
     return response.data.metadata;
@@ -136,7 +129,7 @@ class DoubleClickBidManager {
    * @return {!Promise<boolean>} Whether the query was deleted.
    */
   async deleteQuery(queryId) {
-    const doubleclickbidmanager = await this.getApiClient_();
+    const doubleclickbidmanager = await this.getApiClient();
     try {
       const { status } = await doubleclickbidmanager.queries.delete({ queryId });
       return status === 200;
@@ -148,7 +141,6 @@ class DoubleClickBidManager {
 }
 
 module.exports = {
-  QueryResource,
   RequestBody,
   DoubleClickBidManager,
 };

package/src/apis/doubleclick_search.js

@@ -19,9 +19,8 @@
 
 'use strict';
 
-const {google} = require('googleapis');
 const {request} = require('gaxios');
-const AuthClient = require('./auth_client.js');
+const { GoogleApiClient } = require('./base/google_api_client.js');
 const {
   getLogger,
   SendSingleBatch,
@@ -118,7 +117,7 @@ let ReportRequest;
  * Quota limits, see:
  * https://support.google.com/adsihc/answer/6346075?hl=en
  */
-class DoubleClickSearch {
+class DoubleClickSearch extends GoogleApiClient {
 
   /**
    * @constructor
@@ -126,34 +125,19 @@ class DoubleClickSearch {
    *     variables.
    */
   constructor(env = process.env) {
-    this.authClient = new AuthClient(API_SCOPES, env);
+    super(env);
+    this.googleApi = 'doubleclicksearch';
     this.logger = getLogger('API.DS');
   }
 
-  /**
-   * Prepares the Google SA360 instance.
-   * @return {!google.doubleclicksearch}
-   * @private
-   */
-  async getApiClient_() {
-    if (this.doubleclicksearch) return this.doubleclicksearch;
-    this.logger.debug(`Initialized ${this.constructor.name} instance.`);
-    this.doubleclicksearch = google.doubleclicksearch({
-      version: API_VERSION,
-      auth: await this.getAuth_(),
-    });
-    return this.doubleclicksearch;
+  /** @override */
+  getScope() {
+    return API_SCOPES;
   }
 
-  /**
-   * Gets the auth object.
-   * @return {!Promise<{!OAuth2Client|!JWT|!Compute}>}
-   */
-  async getAuth_() {
-    if (this.auth) return this.auth;
-    await this.authClient.prepareCredentials();
-    this.auth = this.authClient.getDefaultAuth();
-    return this.auth;
+  /** @override */
+  getVersion() {
+    return API_VERSION;
   }
 
   /**
@@ -172,7 +156,7 @@ class DoubleClickSearch {
     });
     this.logger.debug('Sending out availabilities', availabilities);
     try {
-      const doubleclicksearch = await this.getApiClient_();
+      const doubleclicksearch = await this.getApiClient();
       const response = await doubleclicksearch.conversion.updateAvailability(
           {requestBody: {availabilities}});
       this.logger.debug('Get response: ', response);
@@ -221,7 +205,7 @@ class DoubleClickSearch {
         numberOfLines: lines.length,
       };
       try {
-        const doubleclicksearch = await this.getApiClient_();
+        const doubleclicksearch = await this.getApiClient();
         const response = await doubleclicksearch.conversion.insert(
             {requestBody: {conversion: conversions}}
         );
@@ -322,7 +306,7 @@ class DoubleClickSearch {
    * @return {!Promise<string>}
    */
   async requestReports(requestBody) {
-    const doubleclicksearch = await this.getApiClient_();
+    const doubleclicksearch = await this.getApiClient();
     const { status, data } = await doubleclicksearch.reports.request({ requestBody });
     if (status >= 200 && status < 300) {
       return data.id;
@@ -341,7 +325,7 @@ class DoubleClickSearch {
    * }>>}
    */
   async getReportUrls(reportId) {
-    const doubleclicksearch = await this.getApiClient_();
+    const doubleclicksearch = await this.getApiClient();
     const { status, data } = await doubleclicksearch.reports.get({ reportId });
     switch (status) {
       case 200:
@@ -367,11 +351,11 @@ class DoubleClickSearch {
    * @return {!Promise<string>}
    */
   async getReportFile(reportId, reportFragment) {
-    const doubleclicksearch = await this.getApiClient_();
+    const doubleclicksearch = await this.getApiClient();
     const response = await doubleclicksearch.reports.getFile(
         {reportId, reportFragment});
     if (response.status === 200) {
-      return Buffer.from(await response.data.arrayBuffer()).toString();
+      return response.data;
     }
     const errorMsg =
         `Error in get file from reports: ${reportFragment}@${reportId}`;
@@ -387,7 +371,7 @@ class DoubleClickSearch {
    * @return {!Promise<ReadableStream>}
    */
   async getReportFileStream(url) {
-    const auth = await this.getAuth_();
+    const auth = await this.getAuth();
     const headers = await auth.getRequestHeaders();
     const response = await request({
       method: 'GET',

package/src/apis/google_ads_api.js

@@ -1100,7 +1100,7 @@ class GoogleAdsApi {
    */
   buildCustomerMatchUserListMetadata_(config) {
     const { customerId, listId, customerMatchUserListMetadata } = config;
-    const resourceName = `customers/${customerId}/userLists/${listId}`;
+    const resourceName = `customers/${getCleanCid(customerId)}/userLists/${listId}`;
     return new CustomerMatchUserListMetadata(Object.assign({
       userList: resourceName,
     }, customerMatchUserListMetadata));
@@ -1521,7 +1521,7 @@ const buildConversionJsonList = (lines, config, conversionFields,
         conversion.customVariables = variables.map((variable) => {
           return new CustomVariable({
             conversionCustomVariable:
-              `customers/${customerId}/conversionCustomVariables/${customVariables[variable]}`,
+              `customers/${getCleanCid(customerId)}/conversionCustomVariables/${customVariables[variable]}`,
             value: record[variable],
           });
         });

package/src/apis/index.js

@@ -88,7 +88,6 @@ exports.searchads = require('./search_ads.js');
 /**
  * APIs integration class for DoubleClick BidManager (DV360).
  * @const {{
- *   QueryResource:!QueryResource,
  *   DoubleClickBidManager:!DoubleClickBidManager,
  * }}
  */

package/src/apis/search_ads.js

@@ -20,7 +20,7 @@
 
 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');
@@ -35,7 +35,7 @@ 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
@@ -43,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.
@@ -59,11 +70,11 @@ class SearchAds {
    * @return {!google.searchads360}
    * @private
    */
-  async getApiClient_(loginCustomerId) {
+  async getApiClient(loginCustomerId) {
     this.logger.debug(`Initialized SA reporting for ${loginCustomerId}`);
     const options = {
-      version: API_VERSION,
-      auth: await this.getAuth_(),
+      version: this.getVersion(),
+      auth: await this.getAuth(),
     };
     if (loginCustomerId) {
       options.headers = { 'login-customer-id': getCleanCid(loginCustomerId) };
@@ -71,17 +82,6 @@ class SearchAds {
     return google.searchads360(options);
   }
 
-  /**
-   * Gets the auth object.
-   * @return {!Promise<{!OAuth2Client|!JWT|!Compute}>}
-   */
-  async getAuth_() {
-    if (this.auth) return this.auth;
-    await this.authClient.prepareCredentials();
-    this.auth = this.authClient.getDefaultAuth();
-    return this.auth;
-  }
-
   /**
    * Gets a report synchronously from a given Customer account.
    * If there is a `nextPageToken` in the response, it means the report is not
@@ -96,7 +96,7 @@ class SearchAds {
    * @see https://developers.google.com/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#searchsearchads360response
    */
   async getPaginatedReport(customerId, loginCustomerId, query, options = {}) {
-    const searchads = await this.getApiClient_(loginCustomerId);
+    const searchads = await this.getApiClient(loginCustomerId);
     const requestBody = Object.assign({
       query,
       pageSize: 10000,
@@ -120,7 +120,7 @@ class SearchAds {
    * @see https://developers.google.com/search-ads/reporting/api/reference/rest/search
    */
   async restStreamReport(customerId, loginCustomerId, query) {
-    const auth = await this.getAuth_();
+    const auth = await this.getAuth();
     const headers = Object.assign(
       await auth.getRequestHeaders(), {
       'login-customer-id': getCleanCid(loginCustomerId),
@@ -166,7 +166,7 @@ class SearchAds {
    * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/searchAds360Fields#SearchAds360Field
    */
   async getReportField(fieldName) {
-    const searchads = await this.getApiClient_();
+    const searchads = await this.getApiClient();
     const resourceName = `searchAds360Fields/${fieldName}`;
     const response =
       await searchads.searchAds360Fields.get({ resourceName });
@@ -185,7 +185,7 @@ class SearchAds {
    */
   async searchReportField(adFields,
     metadata = ['name', 'data_type', 'is_repeated', 'type_url',]) {
-    const searchads = await this.getApiClient_();
+    const searchads = await this.getApiClient();
     const selectClause = metadata.join(',');
     const fields = adFields.join('","');
     const query = `SELECT ${selectClause} WHERE name IN ("${fields}")`;
@@ -203,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;
   }
@@ -219,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,7 +487,7 @@ 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 (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,
 };