@google-analytics/data 4.12.0 → 5.0.0

package/build/src/v1beta/beta_analytics_data_client.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2024 Google LLC
+// Copyright 2025 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BetaAnalyticsDataClient = void 0;
 const jsonProtos = require("../../protos/protos.json");
+const google_gax_1 = require("google-gax");
 /**
  * Client JSON configuration object, loaded from
  * `src/v1beta/beta_analytics_data_client_config.json`.
@@ -32,6 +33,28 @@ const version = require('../../../package.json').version;
  * @memberof v1beta
  */
 class BetaAnalyticsDataClient {
+    _terminated = false;
+    _opts;
+    _providedCustomServicePath;
+    _gaxModule;
+    _gaxGrpc;
+    _protos;
+    _defaults;
+    _universeDomain;
+    _servicePath;
+    _log = google_gax_1.loggingUtils.log('data');
+    auth;
+    descriptors = {
+        page: {},
+        stream: {},
+        longrunning: {},
+        batching: {},
+    };
+    warn;
+    innerApiCalls;
+    pathTemplates;
+    operationsClient;
+    betaAnalyticsDataStub;
     /**
      * Construct an instance of BetaAnalyticsDataClient.
      *
@@ -54,7 +77,7 @@ class BetaAnalyticsDataClient {
      *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
      *     the environment variable GCLOUD_PROJECT for your project ID. If your
      *     app is running in an environment which supports
-     *     {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
      *     your project ID will be detected automatically.
      * @param {string} [options.apiEndpoint] - The domain name of the
      *     API remote host.
@@ -72,32 +95,28 @@ class BetaAnalyticsDataClient {
      *     ```
      */
     constructor(opts, gaxInstance) {
-        var _a, _b, _c, _d, _e;
-        this._terminated = false;
-        this.descriptors = {
-            page: {},
-            stream: {},
-            longrunning: {},
-            batching: {},
-        };
         // Ensure that options include all the required fields.
         const staticMembers = this.constructor;
-        if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
-            (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
-            (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
+        if (opts?.universe_domain &&
+            opts?.universeDomain &&
+            opts?.universe_domain !== opts?.universeDomain) {
             throw new Error('Please set either universe_domain or universeDomain, but not both.');
         }
         const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
             ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
             : undefined;
         this._universeDomain =
-            (_c = (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : universeDomainEnvVar) !== null && _c !== void 0 ? _c : 'googleapis.com';
+            opts?.universeDomain ??
+                opts?.universe_domain ??
+                universeDomainEnvVar ??
+                'googleapis.com';
         this._servicePath = 'analyticsdata.' + this._universeDomain;
-        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
-        this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
-        const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
-        const clientConfig = (_d = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _d !== void 0 ? _d : {};
-        const fallback = (_e = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _e !== void 0 ? _e : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
+        const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
+        this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
+        const port = opts?.port || staticMembers.port;
+        const clientConfig = opts?.clientConfig ?? {};
+        const fallback = opts?.fallback ??
+            (typeof window !== 'undefined' && typeof window?.fetch === 'function');
         opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
         // Request numeric enum values if REST transport is used.
         opts.numericEnums = true;
@@ -306,7 +325,6 @@ class BetaAnalyticsDataClient {
         return this.auth.getProjectId();
     }
     runReport(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -321,13 +339,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                property: (_a = request.property) !== null && _a !== void 0 ? _a : '',
+                property: request.property ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.runReport(request, options, callback);
+        this._log.info('runReport request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('runReport response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .runReport(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('runReport response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     runPivotReport(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -342,13 +371,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                property: (_a = request.property) !== null && _a !== void 0 ? _a : '',
+                property: request.property ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.runPivotReport(request, options, callback);
+        this._log.info('runPivotReport request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('runPivotReport response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .runPivotReport(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('runPivotReport response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     batchRunReports(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -363,13 +403,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                property: (_a = request.property) !== null && _a !== void 0 ? _a : '',
+                property: request.property ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.batchRunReports(request, options, callback);
+        this._log.info('batchRunReports request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('batchRunReports response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .batchRunReports(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('batchRunReports response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     batchRunPivotReports(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -384,13 +435,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                property: (_a = request.property) !== null && _a !== void 0 ? _a : '',
+                property: request.property ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.batchRunPivotReports(request, options, callback);
+        this._log.info('batchRunPivotReports request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('batchRunPivotReports response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .batchRunPivotReports(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('batchRunPivotReports response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     getMetadata(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -405,13 +467,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
+                name: request.name ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.getMetadata(request, options, callback);
+        this._log.info('getMetadata request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('getMetadata response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .getMetadata(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('getMetadata response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     runRealtimeReport(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -426,13 +499,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                property: (_a = request.property) !== null && _a !== void 0 ? _a : '',
+                property: request.property ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.runRealtimeReport(request, options, callback);
+        this._log.info('runRealtimeReport request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('runRealtimeReport response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .runRealtimeReport(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('runRealtimeReport response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     checkCompatibility(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -447,13 +531,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                property: (_a = request.property) !== null && _a !== void 0 ? _a : '',
+                property: request.property ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.checkCompatibility(request, options, callback);
+        this._log.info('checkCompatibility request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('checkCompatibility response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .checkCompatibility(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('checkCompatibility response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     queryAudienceExport(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -468,13 +563,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
+                name: request.name ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.queryAudienceExport(request, options, callback);
+        this._log.info('queryAudienceExport request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('queryAudienceExport response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .queryAudienceExport(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('queryAudienceExport response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     getAudienceExport(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -489,13 +595,24 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
+                name: request.name ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.getAudienceExport(request, options, callback);
+        this._log.info('getAudienceExport request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('getAudienceExport response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .getAudienceExport(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('getAudienceExport response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     createAudienceExport(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -510,10 +627,22 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+                parent: request.parent ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.createAudienceExport(request, options, callback);
+        const wrappedCallback = callback
+            ? (error, response, rawResponse, _) => {
+                this._log.info('createAudienceExport response %j', rawResponse);
+                callback(error, response, rawResponse, _); // We verified callback above.
+            }
+            : undefined;
+        this._log.info('createAudienceExport request %j', request);
+        return this.innerApiCalls
+            .createAudienceExport(request, options, wrappedCallback)
+            ?.then(([response, rawResponse, _]) => {
+            this._log.info('createAudienceExport response %j', rawResponse);
+            return [response, rawResponse, _];
+        });
     }
     /**
      * Check the status of the long running operation returned by `createAudienceExport()`.
@@ -527,13 +656,13 @@ class BetaAnalyticsDataClient {
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_CreateAudienceExport_async
      */
     async checkCreateAudienceExportProgress(name) {
+        this._log.info('createAudienceExport long-running');
         const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
         const [operation] = await this.operationsClient.getOperation(request);
         const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.createAudienceExport, this._gaxModule.createDefaultBackoffSettings());
         return decodeOperation;
     }
     listAudienceExports(request, optionsOrCallback, callback) {
-        var _a;
         request = request || {};
         let options;
         if (typeof optionsOrCallback === 'function' && callback === undefined) {
@@ -548,13 +677,25 @@ class BetaAnalyticsDataClient {
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+                parent: request.parent ?? '',
             });
         this.initialize();
-        return this.innerApiCalls.listAudienceExports(request, options, callback);
+        const wrappedCallback = callback
+            ? (error, values, nextPageRequest, rawResponse) => {
+                this._log.info('listAudienceExports values %j', values);
+                callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        this._log.info('listAudienceExports request %j', request);
+        return this.innerApiCalls
+            .listAudienceExports(request, options, wrappedCallback)
+            ?.then(([response, input, output]) => {
+            this._log.info('listAudienceExports values %j', response);
+            return [response, input, output];
+        });
     }
     /**
-     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * Equivalent to `listAudienceExports`, but returns a NodeJS Stream object.
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
@@ -583,18 +724,18 @@ class BetaAnalyticsDataClient {
      *   for more details and examples.
      */
     listAudienceExportsStream(request, options) {
-        var _a;
         request = request || {};
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+                parent: request.parent ?? '',
             });
         const defaultCallSettings = this._defaults['listAudienceExports'];
         const callSettings = defaultCallSettings.merge(options);
         this.initialize();
+        this._log.info('listAudienceExports stream %j', request);
         return this.descriptors.page.listAudienceExports.createStream(this.innerApiCalls.listAudienceExports, request, callSettings);
     }
     /**
@@ -630,18 +771,18 @@ class BetaAnalyticsDataClient {
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_ListAudienceExports_async
      */
     listAudienceExportsAsync(request, options) {
-        var _a;
         request = request || {};
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
         options.otherArgs.headers['x-goog-request-params'] =
             this._gaxModule.routingHeader.fromParams({
-                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+                parent: request.parent ?? '',
             });
         const defaultCallSettings = this._defaults['listAudienceExports'];
         const callSettings = defaultCallSettings.merge(options);
         this.initialize();
+        this._log.info('listAudienceExports iterate %j', request);
         return this.descriptors.page.listAudienceExports.asyncIterate(this.innerApiCalls['listAudienceExports'], request, callSettings);
     }
     /**
@@ -674,7 +815,22 @@ class BetaAnalyticsDataClient {
      * // doThingsWith(response)
      * ```
      */
-    getOperation(request, options, callback) {
+    getOperation(request, optionsOrCallback, callback) {
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: request.name ?? '',
+            });
         return this.operationsClient.getOperation(request, options, callback);
     }
     /**
@@ -708,6 +864,13 @@ class BetaAnalyticsDataClient {
      * ```
      */
     listOperationsAsync(request, options) {
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: request.name ?? '',
+            });
         return this.operationsClient.listOperationsAsync(request, options);
     }
     /**
@@ -741,7 +904,22 @@ class BetaAnalyticsDataClient {
      * await client.cancelOperation({name: ''});
      * ```
      */
-    cancelOperation(request, options, callback) {
+    cancelOperation(request, optionsOrCallback, callback) {
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: request.name ?? '',
+            });
         return this.operationsClient.cancelOperation(request, options, callback);
     }
     /**
@@ -769,7 +947,22 @@ class BetaAnalyticsDataClient {
      * await client.deleteOperation({name: ''});
      * ```
      */
-    deleteOperation(request, options, callback) {
+    deleteOperation(request, optionsOrCallback, callback) {
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                name: request.name ?? '',
+            });
         return this.operationsClient.deleteOperation(request, options, callback);
     }
     // --------------------
@@ -859,6 +1052,7 @@ class BetaAnalyticsDataClient {
     close() {
         if (this.betaAnalyticsDataStub && !this._terminated) {
             return this.betaAnalyticsDataStub.then(stub => {
+                this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
                 this.operationsClient.close();

package/build/src/v1beta/beta_analytics_data_proto_list.json

@@ -0,0 +1,4 @@
+[
+    "../../protos/google/analytics/data/v1beta/analytics_data_api.proto",
+    "../../protos/google/analytics/data/v1beta/data.proto"
+]