@google-cloud/nodejs-common 1.7.0 → 1.7.2-alpha

package/bin/install_functions.sh

@@ -1552,6 +1552,7 @@ set_cloud_functions_default_settings() {
   local -n default_cf_flag=$1
   default_cf_flag+=(--region="${REGION}")
   default_cf_flag+=(--no-allow-unauthenticated)
+  default_cf_flag+=(--docker-registry=artifact-registry)
   default_cf_flag+=(--timeout=540 --memory="${CF_MEMORY}" --runtime="${CF_RUNTIME}")
   default_cf_flag+=(--set-env-vars=GCP_PROJECT="${GCP_PROJECT}")
   default_cf_flag+=(--set-env-vars=PROJECT_NAMESPACE="${PROJECT_NAMESPACE}")

package/package.json

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

package/src/apis/dfa_reporting.js

@@ -75,6 +75,17 @@ const PICKED_PROPERTIES = [
   'quantity',
 ];
 
+/**
+ * Kinds of UserIdentifier.
+ * @type {Array<string>}
+ */
+const IDENTIFIERS = [
+  'hashedEmail',
+  'hashedPhoneNumber',
+  'addressInfo',
+];
+
+const MAX_IDENTIFIERS_PER_USER = 5;
 /**
  * Google DfaReport API v3.0 stub.
  * see https://developers.google.com/doubleclick-advertisers/service_accounts
@@ -175,6 +186,32 @@ class DfaReporting {
           conversion.customVariables = config.customVariables.map(
               (variable) => ({'type': variable, 'value': record[variable],}));
         }
+        // User Identifiers
+        if (record.userIdentifiers) {
+          const userIdentifiers = [];
+          IDENTIFIERS.map((id) => {
+            const idValue = record.userIdentifiers[id];
+            if (idValue) {
+              if (Array.isArray(idValue)) {
+                idValue.forEach(
+                  (user) => void userIdentifiers.push({ [id]: user }));
+              } else {
+                userIdentifiers.push({ [id]: idValue });
+              }
+            }
+          });
+          if (userIdentifiers.length > 0) {
+            if (userIdentifiers.length > MAX_IDENTIFIERS_PER_USER) {
+              this.logger.warn(
+                'There are too many user identifiers:', record.userIdentifiers);
+            }
+            conversion.userIdentifiers =
+              userIdentifiers.slice(0, MAX_IDENTIFIERS_PER_USER);
+          } else {
+            this.logger.warn(
+              'There is no valid user identifier:', record.userIdentifiers);
+          }
+        }
         return conversion;
       });
       const requestBody = {conversions};

package/src/apis/display_video.js

@@ -0,0 +1,97 @@
+// 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 DoubleClick Search Ads Conversions uploading on Google
+ * API Client Library.
+ */
+
+'use strict';
+
+const { google } = require('googleapis');
+const AuthClient = require('./auth_client.js');
+const {
+  getLogger,
+  getObjectByPath,
+  SendSingleBatch,
+  BatchResult,
+} = require('../components/utils.js');
+
+const API_SCOPES = Object.freeze([
+  'https://www.googleapis.com/auth/display-video',
+]);
+const API_VERSION = 'v2';
+
+/**
+ * Display and Video 360 API v2 stub.
+ * @see https://developers.google.com/display-video/api/reference/rest/v2
+ * This is not the same to Reports Display & Video 360 API which is from Google
+ * Bid Manager API.
+ * @see https://developers.google.com/bid-manager/reference/rest
+ */
+class DisplayVideo {
+
+  /**
+   * @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.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;
+  }
+
+  /**
+   * 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);
+  }
+
+}
+
+module.exports = {
+  DisplayVideo,
+  API_VERSION,
+  API_SCOPES,
+};

package/src/apis/index.js

@@ -30,6 +30,14 @@ exports.AuthClient = require('./auth_client.js');
  */
 exports.dfareporting = require('./dfa_reporting.js');
 
+/**
+ * APIs integration class for DV3 API.
+ * @const {{
+*   DisplayVideo:!DisplayVideo,
+* }}
+*/
+exports.displayvideo = require('./display_video.js');
+
 /**
  * APIs integration class for Google Analytics Data Import API.
  * @const {{

package/src/components/utils.js

@@ -497,6 +497,26 @@ const extractObject = (paths) => {
   };
 };
 
+/**
+ * Returns the embedded object from the given object and path.
+ * @param {Object} obj
+ * @param {string|undefined} paths
+ * @return {Object}
+ */
+const getObjectByPath = (obj, paths) => {
+  let instance = obj;
+  if (paths) {
+    paths.split('.').filter((key) => !!key).forEach((key) => {
+      instance = instance[key];
+      if (!instance) {
+        console.error('Fail to get function containter', paths);
+        return instance;
+      }
+    });
+  }
+  return instance;
+};
+
 /**
  * For more details, see:
  * https://developers.google.com/google-ads/api/docs/rest/design/json-mappings
@@ -533,6 +553,7 @@ module.exports = {
   replaceParameters,
   getFilterFunction,
   extractObject,
+  getObjectByPath,
   changeNamingFromSnakeToUpperCamel,
   changeNamingFromSnakeToLowerCamel,
 };