@google-cloud/nodejs-common 2.4.4 → 2.5.0

package/README.md

@@ -40,9 +40,11 @@ and [Data Tasks Coordinator]. This library includes:
      interface to operate data objects within or not a transaction on either
      Firestore Native mode or Firestore Datastore mode.
 
-   - **AutoMl Tables API**: Offers a unified entry to use this API based on
+   - ~~**AutoMl Tables API**: Offers a unified entry to use this API based on
      Google Cloud client library combined with REST requests to service
-     directly due to some functionalities missed in the client library.
+     directly due to some functionalities missed in the client library.~~(Google
+    Cloud AutoML Tables was retired on April 30, 2024. Please migrate to Vertex
+    AI instead.)
 
    - **Vertex AI API**: Offers a unified entry to use this API based on Google
      Cloud client library.

package/bin/install_functions.sh

@@ -1553,7 +1553,6 @@ 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/index.js

@@ -20,7 +20,6 @@
 
 exports.api = require('./src/apis/index.js');
 exports.cloudfunctions = require('./src/components/cloudfunctions_utils.js');
-exports.automl = require('./src/components/automl.js');
 exports.firestore = require('./src/components/firestore/index.js');
 exports.pubsub = require('./src/components/pubsub.js');
 exports.scheduler = require('./src/components/scheduler.js');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.4.4",
+  "version": "2.5.0",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",
@@ -16,20 +16,20 @@
   },
   "homepage": "https://github.com/GoogleCloudPlatform/cloud-for-marketing/blob/master/marketing-analytics/activation/common-libs/nodejs-common/README.md",
   "dependencies": {
-    "@google-cloud/aiplatform": "3.35.0",
-    "@google-cloud/automl": "4.0.1",
-    "@google-cloud/bigquery": "^7.9.4",
+    "@google-cloud/aiplatform": "^4.2.0",
+    "@google-cloud/bigquery": "^8.1.0",
     "@google-cloud/datastore": "^9.2.1",
-    "@google-cloud/firestore": "^7.11.0",
-    "@google-cloud/logging-winston": "^6.0.0",
-    "@google-cloud/pubsub": "4.11.0",
-    "@google-cloud/secret-manager": "5.6.0",
-    "@google-cloud/scheduler": "4.3.0",
+    "@google-cloud/firestore": "^7.11.1",
+    "@google-cloud/logging-winston": "^6.0.1",
+    "@google-cloud/pubsub": "^5.1.0",
+    "@google-cloud/scheduler": "^5.2.0",
+    "@google-cloud/secret-manager": "^6.0.1",
     "@google-cloud/storage": "^7.16.0",
-    "@grpc/grpc-js": "^1.13.3",
-    "gaxios": "^6.7.1",
-    "google-ads-nodejs-client": "18.0.1",
-    "googleapis": "^148.0.0",
+    "@grpc/grpc-js": "^1.13.4",
+    "gaxios": "^7.0.0",
+    "google-ads-nodejs-client": "^20.0.0",
+    "google-auth-library": "^10.0.0",
+    "googleapis": "^150.0.1",
     "lodash": "^4.17.21",
     "winston": "^3.17.0"
   },

package/src/apis/base/auth_restful_api.js

@@ -62,8 +62,10 @@ class AuthRestfulApi extends RestfulApiBase {
    */
   async getDefaultHeaders() {
     const auth = await this.getAuth();
-    const headers = await auth.getRequestHeaders();
-    return Object.assign({}, super.getDefaultHeaders(), headers);
+    const authHeaders = await auth.getRequestHeaders();
+    const mergedHeaders = new Headers(await super.getDefaultHeaders());
+    authHeaders.forEach((value, key) => void mergedHeaders.set(key, value));
+    return mergedHeaders;
   }
 
 }

package/src/apis/base/restful_api_base.js

@@ -53,10 +53,10 @@ class RestfulApiBase {
 
   /**
    * Returns default HTTP headers.
-   * @return {object} HTTP headers.
+   * @return {!Headers} HTTP headers.
    */
   async getDefaultHeaders() {
-    return {};
+    return new Headers();
   }
 
   /**

package/src/apis/google_ads_api.js

@@ -33,6 +33,7 @@ const {
   UserListServiceClient,
   protos: { google: { ads: { googleads } } },
 } = require('google-ads-nodejs-client');
+const { AuthRestfulApi } = require('./base/auth_restful_api.js');
 
 const API_VERSION = Object.keys(googleads)[0];
 const {
@@ -143,6 +144,9 @@ CONVERSION_FIELDS.CLICK = [
   'conversionValue',
   'currencyCode',
   'orderId',
+  'userIpAddress',
+  'sessionAttributesEncoded',
+  'sessionAttributesKeyValuePairs',
 ];
 /**
  * @see ConversionAdjustment
@@ -335,24 +339,30 @@ let CustomerMatchRecord;
 /**
  * Google Ads API class based on Google Ads API library.
  */
-class GoogleAdsApi {
+class GoogleAdsApi extends AuthRestfulApi {
   /**
    * Note: Rate limits is set by the access level of Developer token.
-   * @param {string} developerToken Developer token to access the API.
-   * @param {boolean=} debugMode This is used to set ONLY validate conversions
-   *     but not real uploading.
    * @param {!Object<string,string>=} env The environment object to hold env
    *     variables.
+   * @param {object} options
+   * @param {string} options.developerToken Developer token to access the API.
+   * @param {boolean} options.debugMode This is used to set ONLY validate
+   *     conversions but not real uploading.
    */
-  constructor(developerToken, debugMode = false, env = process.env) {
-    this.developerToken = developerToken;
-    this.debugMode = debugMode;
-    this.authClient = new AuthClient(API_SCOPES, env);
+  constructor(env = process.env, options = {}) {
+    super(env, options);
+    this.developerToken = options.developerToken;
+    this.debugMode = options.debugMode || false;
     this.logger = getLogger('API.ADS.N');
     this.logger.info(
       `Init ${this.constructor.name} with Debug Mode?`, this.debugMode);
   }
 
+  /** @override */
+  getScope() {
+    return API_SCOPES;
+  }
+
   /**
    * Gets a Google Ads report based on a Google Ads Query Language(GAQL) query
    * with pagination automatically handled. It returns an array of
@@ -486,11 +496,9 @@ class GoogleAdsApi {
    * @return {!Promise<stream>}
    */
   async restStreamReport(customerId, loginCustomerId, query) {
-    await this.authClient.prepareCredentials();
-    const headers = Object.assign(
-      await this.authClient.getDefaultAuth().getRequestHeaders(),
-      this.getGoogleAdsHeaders_(loginCustomerId)
-    );
+    const headers = await this.getDefaultHeaders();
+    const extra = new Headers(this.getGoogleAdsHeaders_(loginCustomerId));
+    extra.forEach((value, key) => void headers.set(key, value));
     const options = {
       baseURL: `${API_ENDPOINT}/${API_VERSION}/`,
       url: `customers/${getCleanCid(customerId)}/googleAds:searchStream`,
@@ -1332,12 +1340,17 @@ class GoogleAdsApi {
   /**
    * Returns a HTTP header object contains the authentication information for
    * Google Ads API, include: `developer-token` and `login-customer-id`.
+   * `grpc` only takes plain objects as valid values of the object `otherArgs`,
+   * so here can not use 'Headers' type yet.
    * @param {string} loginCustomerId
    * @return {object} The HTTP header object.
    * @private
    */
   getGoogleAdsHeaders_(loginCustomerId) {
-    const headers = { 'developer-token': this.developerToken };
+    const headers = {};
+    if (this.developerToken) {
+      headers['developer-token'] = this.developerToken;
+    }
     if (loginCustomerId) {
       headers['login-customer-id'] = getCleanCid(loginCustomerId);
     }
@@ -1366,9 +1379,8 @@ class GoogleAdsApi {
    */
   async getGoogleAdsServiceClient_() {
     if (this.googleAdsClient) return this.googleAdsClient;
-    await this.authClient.prepareCredentials();
     this.googleAdsClient = new GoogleAdsServiceClient({
-      authClient: this.authClient.getDefaultAuth(),
+      authClient: await this.getAuth(),
     });
     return this.googleAdsClient;
   }
@@ -1379,9 +1391,8 @@ class GoogleAdsApi {
    * @private
    */
   async getGoogleAdsFieldServiceClient_() {
-    await this.authClient.prepareCredentials();
     return new GoogleAdsFieldServiceClient({
-      authClient: this.authClient.getDefaultAuth(),
+      authClient: await this.getAuth(),
     });
   }
 
@@ -1391,9 +1402,8 @@ class GoogleAdsApi {
    * @private
    */
   async getConversionUploadServiceClient_() {
-    await this.authClient.prepareCredentials();
     return new ConversionUploadServiceClient({
-      authClient: this.authClient.getDefaultAuth(),
+      authClient: await this.getAuth(),
     });
   }
 
@@ -1403,9 +1413,8 @@ class GoogleAdsApi {
    * @private
    */
   async getConversionAdjustmentUploadServiceClient_() {
-    await this.authClient.prepareCredentials();
     return new ConversionAdjustmentUploadServiceClient({
-      authClient: this.authClient.getDefaultAuth(),
+      authClient: await this.getAuth(),
     });
   }
 
@@ -1415,9 +1424,8 @@ class GoogleAdsApi {
    * @private
    */
   async getUserListServiceClient_() {
-    await this.authClient.prepareCredentials();
     return new UserListServiceClient({
-      authClient: this.authClient.getDefaultAuth(),
+      authClient: await this.getAuth(),
     });
   }
 
@@ -1427,9 +1435,8 @@ class GoogleAdsApi {
    * @private
    */
   async getUserDataServiceClient_() {
-    await this.authClient.prepareCredentials();
     return new UserDataServiceClient({
-      authClient: this.authClient.getDefaultAuth(),
+      authClient: await this.getAuth(),
     });
   }
 
@@ -1439,9 +1446,8 @@ class GoogleAdsApi {
    * @private
    */
   async getOfflineUserDataJobServiceClient_() {
-    await this.authClient.prepareCredentials();
     return new OfflineUserDataJobServiceClient({
-      authClient: this.authClient.getDefaultAuth(),
+      authClient: await this.getAuth(),
     });
   }
 }

package/src/apis/search_ads.js

@@ -19,7 +19,6 @@
 'use strict';
 
 const { request: gaxiosRequest } = require('gaxios');
-const { google } = require('googleapis');
 const { GoogleApiClient } = require('./base/google_api_client.js');
 const { changeStringToBigQuerySafe, getLogger }
   = require('../components/utils.js');
@@ -119,11 +118,8 @@ class SearchAds extends GoogleApiClient {
    * @see https://developers.google.com/search-ads/reporting/api/reference/rest/search
    */
   async restStreamReport(customerId, loginCustomerId, query) {
-    const auth = await this.getAuth();
-    const headers = Object.assign(
-      await auth.getRequestHeaders(), {
-      'login-customer-id': getCleanCid(loginCustomerId),
-    });
+    const headers = await this.getDefaultHeaders();
+    headers.set('login-customer-id', getCleanCid(loginCustomerId));
     const options = {
       baseURL: `${API_ENDPOINT}/${API_VERSION}/`,
       url: `customers/${getCleanCid(customerId)}/searchAds360:searchStream`,

package/src/apis/sendgrid.js

@@ -64,11 +64,18 @@ class SendGrid extends RestfulApiBase {
 
   /** @override */
   async getDefaultHeaders() {
-    return Object.assign({}, super.getDefaultHeaders(), {
-      Authorization: `Bearer ${this.apiKey}`,
-    });
+    const headers = await super.getDefaultHeaders();
+    headers.set('Authorization', `Bearer ${this.apiKey}`);
+    return headers;
   }
 
+  /**
+   * No responseType is required for empty body response.
+   * @override
+   */
+  getRequesterOptions() {
+    return {};
+  }
   /**
    * Generates an email object for Sendgrid.
    * @param {!EmailOptions} options

package/src/components/automl.js

@@ -1,103 +0,0 @@
-// 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 Cloud AutoML helper.
- */
-
-'use strict';
-const { ClientOptions } = require('google-gax');
-const automl = require('@google-cloud/automl');
-const google = automl.protos.google;
-
-/**
- * For version `v1beta1`, BigQuery can be the source and destination.
- * https://googleapis.dev/nodejs/automl/latest/google.cloud.automl.v1beta1.IBatchPredictInputConfig.html
- * https://googleapis.dev/nodejs/automl/latest/google.cloud.automl.v1beta1.IBatchPredictOutputConfig.html
- *
- * For version `v1`, currently only Cloud Storage are allowed.
- * https://googleapis.dev/nodejs/automl/latest/google.cloud.automl.v1.IBatchPredictInputConfig.html
- * https://googleapis.dev/nodejs/automl/latest/google.cloud.automl.v1.IBatchPredictOutputConfig.html
- *
- * NOTE: currently use `v1beta1`
- * @type {string}
- */
-const API_VERSION = 'v1beta1';
-const { PredictionServiceClient } = automl[API_VERSION];
-
-/**
- * AutoML Tables API class for:
- * 1. start a batch predict job:
- * @see https://cloud.google.com/nodejs/docs/reference/automl/latest/automl/v1beta1.predictionserviceclient#_google_cloud_automl_v1beta1_PredictionServiceClient_batchPredict_member_3_
- * 2. get the status of an operation:
- * @see https://cloud.google.com/nodejs/docs/reference/automl/latest/automl/v1beta1.predictionserviceclient#_google_cloud_automl_v1beta1_PredictionServiceClient_checkBatchPredictProgress_member_1_
- */
-class AutoMl {
-  /**
-   * Initialize an instance.
-   * @param {ClientOptions=} options
-   */
-  constructor(options = {}) {
-    this.client = new PredictionServiceClient(options);
-  }
-
-  /**
-   * Batch predicts based on Google Cloud Client Library.
-   * @param {string} projectId
-   * @param {string} computeRegion
-   * @param {string} modelId
-   * @param {google.cloud.automl.v1beta1.IBatchPredictInputConfig} inputConfig
-   * @param {google.cloud.automl.v1beta1.IBatchPredictOutputConfig} outputConfig
-   * @return {Promise<string>} Predict operation name.
-   */
-  async batchPredict(
-    projectId,
-    computeRegion,
-    modelId,
-    inputConfig,
-    outputConfig
-  ) {
-    const modelFullId = this.client.modelPath(
-      projectId,
-      computeRegion,
-      modelId
-    );
-    const responses = await this.client.batchPredict({
-      name: modelFullId,
-      inputConfig,
-      outputConfig,
-    });
-    const operation = responses[1];
-    console.log(`Operation name: ${operation.name}`);
-    return operation.name;
-  }
-
-  /**
-   * Gets status of an operation.
-   * @param {string} operationName
-   * @return {Promise<{{
-   *   done: boolean,
-   *   error: Error|undefined,
-   *   metadata: OperationMetadata,
-   *   name: string,
-   * }}>}
-   */
-  async getOperation(operationName) {
-    const response = await this.client.checkBatchPredictProgress(operationName);
-    const { done, error, metadata, name } = response;
-    return { done, error, metadata, name };
-  }
-}
-
-exports.AutoMl = AutoMl;