@google-cloud/nodejs-common 2.5.0 → 2.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/nodejs-common",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "A NodeJs common library for solutions based on Cloud Functions",
   "author": "Google Inc.",
   "license": "Apache-2.0",
@@ -16,25 +16,25 @@
   },
   "homepage": "https://github.com/GoogleCloudPlatform/cloud-for-marketing/blob/master/marketing-analytics/activation/common-libs/nodejs-common/README.md",
   "dependencies": {
-    "@google-cloud/aiplatform": "^4.2.0",
-    "@google-cloud/bigquery": "^8.1.0",
+    "@google-cloud/aiplatform": "^6.0.0",
+    "@google-cloud/bigquery": "^8.1.1",
     "@google-cloud/datastore": "^9.2.1",
-    "@google-cloud/firestore": "^7.11.1",
+    "@google-cloud/firestore": "^8.0.0",
     "@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.4",
-    "gaxios": "^7.0.0",
-    "google-ads-nodejs-client": "^20.0.0",
-    "google-auth-library": "^10.0.0",
-    "googleapis": "^150.0.1",
+    "@google-cloud/pubsub": "^5.2.0",
+    "@google-cloud/scheduler": "^5.3.1",
+    "@google-cloud/secret-manager": "^6.1.1",
+    "@google-cloud/storage": "^7.18.0",
+    "@grpc/grpc-js": "^1.14.3",
+    "gaxios": "^7.1.3",
+    "google-ads-nodejs-client": "22.0.0",
+    "google-auth-library": "^10.5.0",
+    "googleapis": "^168.0.0",
     "lodash": "^4.17.21",
-    "winston": "^3.17.0"
+    "winston": "^3.19.0"
   },
   "devDependencies": {
-    "jasmine": "^5.7.0"
+    "jasmine": "^5.13.0"
   },
   "scripts": {
     "test": "node node_modules/jasmine/bin/jasmine"

package/src/apis/dfa_reporting.js

@@ -33,7 +33,7 @@ const API_SCOPES = Object.freeze([
   'https://www.googleapis.com/auth/dfareporting',
   'https://www.googleapis.com/auth/dfatrafficking',
 ]);
-const API_VERSION = 'v4';
+const API_VERSION = 'v5';
 
 /**
  * Configuration for preparing conversions for Campaign Manager, includes:
@@ -41,8 +41,8 @@ const API_VERSION = 'v4';
  * 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
+ * 'insert' stands for https://developers.google.com/doubleclick-advertisers/rest/v5/conversions/batchinsert
+ * 'update' stands for https://developers.google.com/doubleclick-advertisers/rest/v5/conversions/batchupdate
  * For other properties, see
  * https://developers.google.com/doubleclick-advertisers/guides/conversions_update
  *
@@ -69,7 +69,7 @@ let ConversionsConfig;
 /**
  * List of properties that will be take from the data file as elements of a
  * conversion.
- * See https://developers.google.com/doubleclick-advertisers/rest/v4/Conversion
+ * See https://developers.google.com/doubleclick-advertisers/rest/v5/Conversion
  * @type {Array<string>}
  */
 const PICKED_PROPERTIES = [
@@ -92,7 +92,7 @@ const IDENTIFIERS = [
 
 const MAX_IDENTIFIERS_PER_USER = 5;
 /**
- * Google DfaReport API v4.0 stub.
+ * Google DfaReport API v5 stub.
  * see https://developers.google.com/doubleclick-advertisers/service_accounts
  */
 class DfaReporting extends GoogleApiClient {
@@ -164,7 +164,7 @@ class DfaReporting extends GoogleApiClient {
       const operation =
         config.operation === 'update' ? 'batchupdate' : 'batchinsert';
       // customVariables is not supported by batchupdate.
-      // https://developers.google.com/doubleclick-advertisers/rest/v4/Conversion#CustomFloodlightVariable
+      // https://developers.google.com/doubleclick-advertisers/rest/v5/Conversion#CustomFloodlightVariable
       if (operation === 'batchupdate' &&
         typeof config.customVariables !== 'undefined') {
         this.logger.warn('customVariables is not supported by batchupdate');
@@ -252,9 +252,9 @@ class DfaReporting extends GoogleApiClient {
    * ConversionStatus object. This function extras failed lines and error
    * messages based on the 'errors'.
    * For 'ConversionStatus', see:
-   *   https://developers.google.com/doubleclick-advertisers/rest/v4/ConversionStatus
+   *   https://developers.google.com/doubleclick-advertisers/rest/v5/ConversionStatus
    * For 'ConversionError', see:
-   *   https://developers.google.com/doubleclick-advertisers/rest/v4/ConversionStatus#ConversionError
+   *   https://developers.google.com/doubleclick-advertisers/rest/v5/ConversionStatus#ConversionError
    * @param {!BatchResult} batchResult
    * @param {!Array<!Schema$ConversionStatus>} statuses
    * @param {!Array<string>} lines The original input data.
@@ -324,7 +324,7 @@ class DfaReporting extends GoogleApiClient {
    * has a relative date range, e.g. YESTERDAY. To solve this, if there are
    * `startDate` and `endDate` available in the given `config`, they will be
    * used to update the report before the report is started to run.
-   * @see https://developers.google.com/doubleclick-advertisers/rest/v4/reports/run
+   * @see https://developers.google.com/doubleclick-advertisers/rest/v5/reports/run
    *
    * @param {{
    *   accountId:(string|undefined),
@@ -366,7 +366,7 @@ class DfaReporting extends GoogleApiClient {
    * Returns file url from a report. If the report status is 'REPORT_AVAILABLE',
    * then return the apiUrl from the response; if the status is 'PROCESSING' or
    * 'QUEUED', returns undefined as it is unfinished; otherwise throws an error.
-   * @see https://developers.google.com/doubleclick-advertisers/rest/v4/reports/get
+   * @see https://developers.google.com/doubleclick-advertisers/rest/v5/reports/get
    *
    * @param {{
    *   accountId:(string|undefined),

package/src/apis/display_video.js

@@ -25,11 +25,11 @@ const { getLogger } = require('../components/utils.js');
 const API_SCOPES = Object.freeze([
   'https://www.googleapis.com/auth/display-video',
 ]);
-const API_VERSION = 'v3';
+const API_VERSION = 'v4';
 
 /**
- * Display and Video 360 API v3 stub.
- * @see https://developers.google.com/display-video/api/reference/rest/v3
+ * Display and Video 360 API v4 stub.
+ * @see https://developers.google.com/display-video/api/reference/rest/v4
  * 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

package/src/apis/google_ads_api.js

@@ -238,6 +238,7 @@ const MAX_IDENTIFIERS = {
  *
  * @see https://developers.google.com/google-ads/api/reference/rpc/latest/ClickConversion
  * @typedef {{
+ *   jobId: (number|undefined),
  *   externalAttributionData: (GoogleAdsApi.ExternalAttributionData|undefined),
  *   cartData: (object|undefined),
  *   gclid: (string|undefined),
@@ -867,7 +868,7 @@ class GoogleAdsApi extends AuthRestfulApi {
    * @return {!Promise<!UploadClickConversionsResponse>}
    */
   async uploadClickConversions(lines, config) {
-    const { customerId, loginCustomerId } = config;
+    const { customerId, loginCustomerId, jobId } = config;
     this.logger.debug('Upload click conversions for:', config);
     const conversions = buildConversionJsonList(lines, config,
       CONVERSION_FIELDS.CLICK, IDENTIFIERS.CLICK_CONVERSION, MAX_IDENTIFIERS.CONVERSION);
@@ -877,6 +878,7 @@ class GoogleAdsApi extends AuthRestfulApi {
     const request = new UploadClickConversionsRequest({
       conversions: clickConversions,
       customerId,
+      jobId,
       validateOnly: this.debugMode, // when true makes no changes
       partialFailure: true, // Will still create the non-failed entities
     });

package/src/apis/search_ads.js

@@ -90,7 +90,7 @@ class SearchAds extends GoogleApiClient {
    * @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}
+   * @return {!SearchSearchAds360Response}
    * @see https://developers.google.com/search-ads/reporting/api/reference/rpc/google.ads.searchads360.v0.services#searchsearchads360response
    */
   async getPaginatedReport(customerId, loginCustomerId, query, options = {}) {

package/src/components/pubsub.js

@@ -34,7 +34,15 @@ const {
  * 1. gets or creates a topic.
  * 2. gets or creates a subscription.
  * 3. publishes a message after confirms the topic exists.
- * 4. acknowledge message(s).
+ * 4. pull message(s).
+ * 5. acknowledge message(s).
+ *
+ * The 'pull' and 'acknowledge' are built on 'v1.SubscriberClient` which is
+ * considered as 'low-level', auto-generated gRPC API class. This class offers
+ * more direct control over the request-response cycle. Tentacles' queuing
+ * mechanism is built on this kind of precise control.
+ * There is also a high-level 'Pubsub' client, which automatically handles
+ * message streaming and flow control.
  */
 class EnhancedPubSub {
   /**
@@ -127,23 +135,53 @@ class EnhancedPubSub {
     }
   };
 
+  /**
+   * Pulls and returns message(s) from a pull subscription.
+   *
+   * @param {string} subscriptionName Subscription name.
+   * @param {number=} maxMessages
+   * @return {!Array<ReceivedMessage>}
+   */
+  async pull(subscriptionName, maxMessages = 1) {
+    const subscriptionPath = await this.getSubscriptionPath_(subscriptionName);
+    const [response] = await this.subClient.pull({
+      subscription: subscriptionPath,
+      maxMessages,
+    });
+    return response.receivedMessages ? response.receivedMessages : [];
+  }
+
   /**
    * Using `SubscriberClient` to acknowledge messages.
    * 2022.11.02 The method `ack()` in Message doesn't work properly due to a
    * unknown reason. Use this function to acknowledge a message for now.
+   * 2025.08.20 This function can't properly acknowledge messages pulled through
+   * 'Pubsub' object. Use a new 'pull' method to get the message and ack.
    *
-   * @param {string} subscription Subscription name.
+   * @param {string} subscriptionName Subscription name.
    * @param {(string|!Array<string>)} ackIds Message ackIds.
    */
-  async acknowledge(subscription, ackIds) {
-    const projectId = await this.subClient.getProjectId();
+  async acknowledge(subscriptionName, ackIds) {
+    const subscriptionPath = await this.getSubscriptionPath_(subscriptionName);
     const ackRequest = {
-      subscription: this.subClient.subscriptionPath(projectId, subscription),
+      subscription: subscriptionPath,
       ackIds: Array.isArray(ackIds) ? ackIds : [ackIds],
     };
     await this.subClient.acknowledge(ackRequest);
   }
 
+  /**
+   * Returns the complete subscription path for the `SubscriberClient` object.
+   * @see https://cloud.google.com/nodejs/docs/reference/pubsub/latest/pubsub/v1.subscriberclient
+   * @param {string} subscriptionName Subscription name.
+   * @return {string}
+   * @private
+   */
+  async getSubscriptionPath_(subscriptionName) {
+    const projectId = await this.subClient.getProjectId();
+    return this.subClient.subscriptionPath(projectId, subscriptionName);
+  }
+
   /**
    * Returns a new instance of this class. Using this function to replace
    * constructor to be more friendly to unit tests.
@@ -163,7 +201,7 @@ class EnhancedPubSub {
  * @return {string} The decoded message.
  */
 const getMessage = (message) => {
-  return Buffer.from(message.data, 'base64').toString();
+  return Buffer.from(message.data || '', 'base64').toString();
 };
 
 module.exports = {