@google-cloud/nodejs-common 2.0.3-alpha → 2.0.5-alpha

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.0.3-alpha",
+  "version": "2.0.5-alpha",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",
@@ -16,23 +16,23 @@
   },
   "homepage": "https://github.com/GoogleCloudPlatform/cloud-for-marketing/blob/master/marketing-analytics/activation/common-libs/nodejs-common/README.md",
   "dependencies": {
-    "@google-cloud/aiplatform": "^3.0.0",
-    "@google-cloud/automl": "^4.0.0",
-    "@google-cloud/bigquery": "^7.2.0",
-    "@google-cloud/datastore": "^8.2.2",
-    "@google-cloud/firestore": "^6.7.0",
+    "@google-cloud/aiplatform": "^3.10.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/logging-winston": "^6.0.0",
-    "@google-cloud/pubsub": "^4.0.2",
-    "@google-cloud/storage": "^7.0.1",
-    "@google-cloud/scheduler": "^4.0.0",
-    "@google-cloud/secret-manager": "^5.0.0",
-    "gaxios": "^6.1.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-ads-api": "^14.1.0",
     "google-ads-node": "^12.0.2",
-    "google-auth-library": "^9.0.0",
-    "googleapis": "^126.0.1",
+    "google-auth-library": "^9.4.2",
+    "googleapis": "^131.0.0",
     "winston": "^3.10.0",
-    "@grpc/grpc-js": "1.9.5",
+    "@grpc/grpc-js": "1.9.14",
     "lodash": "^4.17.21"
   },
   "devDependencies": {

package/src/apis/dfa_reporting.js

@@ -41,12 +41,16 @@ const API_VERSION = 'v4';
  * profileId, idType, conversion, customVariables, encryptionInfo.
  * The 'idType' can be one of the values: 'encryptedUserId', 'gclid' or
  * 'mobileDeviceId'.
+ * The 'operation' can be 'insert' or 'update'. The default value is 'insert'.
+ * 'insert' stands for https://developers.google.com/doubleclick-advertisers/rest/v4/conversions/batchinsert
+ * 'update' stands for https://developers.google.com/doubleclick-advertisers/rest/v4/conversions/batchupdate
  * For other properties, see
  * https://developers.google.com/doubleclick-advertisers/guides/conversions_update
  *
  * @typedef {{
  *   profileId:string,
  *   idType:string,
+ *   operation:'insert'|'update'|undefined,
  *   conversion:{
  *     floodlightConfigurationId:string,
  *     floodlightActivityId:string,
@@ -60,7 +64,7 @@ const API_VERSION = 'v4';
  *   }|undefined),
  * }}
  */
-let InsertConversionsConfig;
+let ConversionsConfig;
 
 /**
  * List of properties that will be take from the data file as elements of a
@@ -155,7 +159,7 @@ class DfaReporting {
   /**
    * Returns the function to sends out a request to CM with a batch of
    * conversions.
-   * @param {!InsertConversionsConfig} config Campaign Manager configuration.
+   * @param {!ConversionsConfig} config Campaign Manager configuration.
    * @return {!SendSingleBatch} Function which can send a batch of hits to
    *     Campaign Manager.
    */
@@ -171,6 +175,15 @@ class DfaReporting {
       /** @type {function} Gets the conversion elements from the data object. */
       const filterObject = getFilterFunction(PICKED_PROPERTIES);
       const time = new Date().getTime();
+      const operation =
+        config.operation === 'update' ? 'batchupdate' : 'batchinsert';
+      // customVariables is not supported by batchupdate.
+      // https://developers.google.com/doubleclick-advertisers/rest/v4/Conversion#CustomFloodlightVariable
+      if (operation === 'batchupdate' &&
+        typeof config.customVariables !== 'undefined') {
+        this.logger.warn('customVariables is not supported by batchupdate');
+        delete config.customVariables;
+      }
       const conversions = lines.map((line) => {
         const record = JSON.parse(line);
         const conversion = Object.assign(
@@ -184,7 +197,7 @@ class DfaReporting {
         // Custom Variables
         if (typeof config.customVariables !== 'undefined') {
           conversion.customVariables = config.customVariables.map(
-              (variable) => ({'type': variable, 'value': record[variable],}));
+            (variable) => ({ 'type': variable, 'value': record[variable], }));
         }
         // User Identifiers
         if (record.userIdentifiers) {
@@ -225,7 +238,7 @@ class DfaReporting {
       };
       try {
         const dfareporting = await this.getApiClient_();
-        const response = await dfareporting.conversions.batchinsert({
+        const response = await dfareporting.conversions[operation]({
           profileId: config.profileId,
           requestBody: requestBody,
         });
@@ -411,7 +424,7 @@ class DfaReporting {
 
 module.exports = {
   DfaReporting,
-  InsertConversionsConfig,
+  ConversionsConfig,
   API_VERSION,
   API_SCOPES,
 };

package/src/apis/display_video.js

@@ -31,7 +31,7 @@ const {
 const API_SCOPES = Object.freeze([
   'https://www.googleapis.com/auth/display-video',
 ]);
-const API_VERSION = 'v2';
+const API_VERSION = 'v3';
 
 /**
  * Display and Video 360 API v2 stub.

package/src/apis/doubleclick_search.js

@@ -370,7 +370,9 @@ class DoubleClickSearch {
     const doubleclicksearch = await this.getApiClient_();
     const response = await doubleclicksearch.reports.getFile(
         {reportId, reportFragment});
-    if (response.status === 200) return response.data;
+    if (response.status === 200) {
+      return Buffer.from(await response.data.arrayBuffer()).toString();
+    }
     const errorMsg =
         `Error in get file from reports: ${reportFragment}@${reportId}`;
     this.logger.error(errorMsg, response);

package/src/apis/index.js

@@ -25,7 +25,7 @@ exports.AuthClient = require('./auth_client.js');
  * APIs integration class for DFA Reporting API.
  * @const {{
  *   DfaReporting:!DfaReporting,
- *   InsertConversionsConfig:!InsertConversionsConfig,
+ *   ConversionsConfig:!ConversionsConfig,
  * }}
  */
 exports.dfareporting = require('./dfa_reporting.js');
@@ -77,6 +77,14 @@ exports.spreadsheets = require('./spreadsheets.js');
  */
 exports.doubleclicksearch = require('./doubleclick_search.js');
 
+/**
+ * APIs integration class for Search Ads 360 Reporting.
+ * @const {{
+*   SearchAds:!SearchAds,
+* }}
+*/
+exports.searchads = require('./search_ads.js');
+
 /**
  * APIs integration class for DoubleClick BidManager (DV360).
  * @const {{

package/src/apis/search_ads.js

@@ -0,0 +1,171 @@
+// Copyright 2019 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 Google Search Ads 360 Reporting on GoogleAPI Client Library.
+ */
+
+'use strict';
+
+const { google } = require('googleapis');
+const AuthClient = require('./auth_client.js');
+const { getLogger } = require('../components/utils.js');
+
+const API_SCOPES = Object.freeze([
+  'https://www.googleapis.com/auth/doubleclicksearch',
+]);
+const API_VERSION = 'v0';
+
+/**
+ * Search Ads 360 Reporting API stub.
+ * See: https://developers.google.com/search-ads/reporting/api/reference/release-notes
+ */
+class SearchAds {
+
+  /**
+   * @constructor
+   * @param {!Object<string,string>=} env The environment object to hold env
+   *     variables.
+   */
+  constructor(env = process.env) {
+    this.authClient = new AuthClient(API_SCOPES, env);
+    this.logger = getLogger('API.SA');
+  }
+
+  /**
+   * Prepares the Search Ads 360 Reporting API instance.
+   * OAuth 2.0 application credentials is required for calling this API.
+   * For Search Ads Reporting API calls made by a manager to a client account,
+   * a HTTP header named `login-customer-id` is required in the request. This
+   * value represents the Search Ads 360 customer ID of the manager making the
+   * API call. Be sure to remove any hyphens (—), for example: 1234567890, not
+   * 123-456-7890.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/auth
+   * @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;
+  }
+
+  /**
+   * 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;
+  }
+
+  /**
+   * 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
+   * @param {string} customerId
+   * @param {string} loginCustomerId Login customer account ID (Mcc Account id).
+   * @param {string} query
+   * @return {!ReadableStream}
+   */
+  async streamReport(customerId, loginCustomerId, query) {
+    const searchads = await this.getApiClient_(loginCustomerId);
+    const response = await searchads.customers.searchAds360.search({
+      customerId,
+      requestBody: { query },
+    }, { responseType: 'stream' });
+    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
+   * @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
+   */
+  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;
+  }
+
+  /**
+   * 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
+   * @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 });
+    return response.data;
+  }
+
+  /**
+   * 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
+   * @param {string} customerId - The ID of the customer.
+   * @param {string} loginCustomerId - The ID of the manager.
+   * @return {!Array<CustomColumn>}
+   * @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 response = await searchads.customers.customColumns.list({ customerId });
+    return response.data.customColumns;
+  }
+
+  /**
+   * Returns the requested custom column in full detail.
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns/get
+   * @param {string} columnId - The ID of the customColumn.
+   * @param {string} customerId - The ID of the customer.
+   * @param {string} loginCustomerId - The ID of the manager.
+   * @return {!CustomColumn}
+   * @see https://developers.google.com/search-ads/reporting/api/reference/rest/v0/customers.customColumns#CustomColumn
+   */
+  async getCustomColumn(columnId, customerId, loginCustomerId) {
+    const resourceName = `customers/${customerId}/customColumns/${columnId}`;
+    const searchads = await this.getApiClient_(loginCustomerId);
+    const response = await searchads.customers.customColumns.get({ resourceName });
+    return response.data;
+  }
+
+}
+
+module.exports = {
+  SearchAds,
+  API_VERSION,
+  API_SCOPES,
+};

package/src/components/cloudfunctions_utils.js

@@ -229,4 +229,3 @@ module.exports = {
   getIdTokenForFunction,
   convertEnvPathToAbsolute,
 };
-

package/src/components/storage.js

@@ -179,7 +179,7 @@ class StorageFile {
         .on('finish', async () => {
           const [{ contentType }] = await this.file.getMetadata();
           const [file] = await outputFile.setMetadata({ contentType });
-          return file.name;
+          resolve(file.name);
         });
     });
   }
@@ -255,4 +255,3 @@ module.exports = {
   LINE_BREAKER,
   DEFAULT_SPLIT_SIZE,
 };
-

package/src/components/utils.js

@@ -21,6 +21,8 @@
 const winston = require('winston');
 const {inspect} = require('util');
 const { LoggingWinston } = require('@google-cloud/logging-winston');
+const { request } = require('gaxios');
+const lodash = require('lodash');
 
 /**
  * The result of a batch of data sent to target API. The batch here means the
@@ -537,6 +539,34 @@ const changeNamingFromSnakeToLowerCamel = (name) => {
       (initial) => initial.substring(1).toUpperCase());
 };
 
+/**
+ * Returns the response data for a HTTP request. It will retry the specific
+ * times if there was errors happened.
+ * @param {object} options Options for the request.
+ * @param {object=} logger Default is `console`.
+ * @param {number=} retryTimes Default value 3.
+ * @return {object}
+ */
+const requestWithRetry = async (options, logger = console, retryTimes = 3) => {
+  let processedTimes = 0;
+  do {
+    // Wait sometime (2s, 4s, 8s, ...) before each retry.
+    if (processedTimes > 0) await wait(2 ** processedTimes * 1000);
+    try {
+      const requestOption = lodash.merge({
+        responseType: 'json',
+        method: 'POST',
+      }, options);
+      const response = await request(requestOption);
+      return response.data;
+    } catch (error) {
+      processedTimes++;
+      if (processedTimes > retryTimes) throw error;
+      logger.error(`Request ${JSON.stringify(options)}`, error);
+    }
+  } while (processedTimes <= retryTimes)
+}
+
 // noinspection JSUnusedAssignment
 module.exports = {
   getLogger,
@@ -554,4 +584,5 @@ module.exports = {
   getObjectByPath,
   changeNamingFromSnakeToUpperCamel,
   changeNamingFromSnakeToLowerCamel,
+  requestWithRetry,
 };