@google-analytics/data 7.0.0 → 7.2.0

package/build/src/v1alpha/alpha_analytics_data_client.d.ts

@@ -493,6 +493,50 @@ export declare class AlphaAnalyticsDataClient {
     ]>;
     getReportTask(request: protos.google.analytics.data.v1alpha.IGetReportTaskRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IReportTask, protos.google.analytics.data.v1alpha.IGetReportTaskRequest | null | undefined, {} | null | undefined>): void;
     getReportTask(request: protos.google.analytics.data.v1alpha.IGetReportTaskRequest, callback: Callback<protos.google.analytics.data.v1alpha.IReportTask, protos.google.analytics.data.v1alpha.IGetReportTaskRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Provides a chat interface for interacting with Google Analytics data
+     * through the API.
+     *
+     * This product uses AI and may display inaccurate info. Your chat activity
+     * may be used to improve the product and your use is subject to Google's
+     * [Terms](https://policies.google.com/terms),
+     * [AI Use
+     * Policy](https://policies.google.com/terms/generative-ai/use-policy), and
+     * [Privacy Policy](https://policies.google.com/privacy).
+     * [Learn more about Chat AI
+     * Privacy](https://support.google.com/helpguide/answer/14185196).
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.property
+     *   Required. The property to chat about.
+     *   Format: properties/{property}
+     * @param {string} request.userQuery
+     *   Required. The user's query.
+     * @param {string} [request.sessionId]
+     *   Optional. Provide this session ID to continue an existing conversation
+     *   and maintain context. If this field is empty or unset, a new chat
+     *   session is created. Invalid session IDs will result in an error.
+     * @param {boolean} [request.returnPropertyQuota]
+     *   Optional. If true, the response will include the current state of this
+     *   Analytics Property's quota. Quota is returned in
+     *   [PropertyChatQuota](#PropertyChatQuota).
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.ChatResponse|ChatResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.chat.js</caption>
+     * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_Chat_async
+     */
+    chat(request?: protos.google.analytics.data.v1alpha.IChatRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1alpha.IChatResponse,
+        protos.google.analytics.data.v1alpha.IChatRequest | undefined,
+        {} | undefined
+    ]>;
+    chat(request: protos.google.analytics.data.v1alpha.IChatRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IChatResponse, protos.google.analytics.data.v1alpha.IChatRequest | null | undefined, {} | null | undefined>): void;
+    chat(request: protos.google.analytics.data.v1alpha.IChatRequest, callback: Callback<protos.google.analytics.data.v1alpha.IChatResponse, protos.google.analytics.data.v1alpha.IChatRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Returns a customized report of your Google Analytics event data. Reports
      * contain statistics derived from data collected by the Google Analytics

package/build/src/v1alpha/alpha_analytics_data_client.js

@@ -253,11 +253,12 @@ class AlphaAnalyticsDataClient {
             'queryReportTask',
             'getReportTask',
             'listReportTasks',
+            'chat',
             'runReport',
             'getMetadata',
         ];
         for (const methodName of alphaAnalyticsDataStubMethods) {
-            const callPromise = this.alphaAnalyticsDataStub.then((stub) => (...args) => {
+            const callPromise = this.alphaAnalyticsDataStub.then(stub => (...args) => {
                 if (this._terminated) {
                     return Promise.reject('The client has already been closed.');
                 }
@@ -323,6 +324,7 @@ class AlphaAnalyticsDataClient {
     static get scopes() {
         return [
             'https://www.googleapis.com/auth/analytics',
+            'https://www.googleapis.com/auth/analytics.chatbot.read',
             'https://www.googleapis.com/auth/analytics.readonly',
         ];
     }
@@ -354,7 +356,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('runFunnelReport request %j', request);
@@ -397,7 +399,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('queryAudienceList request %j', request);
@@ -440,7 +442,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getAudienceList request %j', request);
@@ -483,7 +485,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('createRecurringAudienceList request %j', request);
@@ -526,7 +528,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getRecurringAudienceList request %j', request);
@@ -569,7 +571,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getPropertyQuotasSnapshot request %j', request);
@@ -612,7 +614,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('queryReportTask request %j', request);
@@ -655,7 +657,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getReportTask request %j', request);
@@ -681,6 +683,49 @@ class AlphaAnalyticsDataClient {
             throw error;
         });
     }
+    chat(request, optionsOrCallback, callback) {
+        request = request || {};
+        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({
+                property: request.property ?? '',
+            });
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('chat request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('chat response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .chat(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('chat response %j', response);
+            return [response, options, rawResponse];
+        })
+            .catch((error) => {
+            if (error &&
+                'statusDetails' in error &&
+                error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
+        });
+    }
     runReport(request, optionsOrCallback, callback) {
         request = request || {};
         let options;
@@ -698,7 +743,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('runReport request %j', request);
@@ -741,7 +786,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getMetadata request %j', request);
@@ -784,7 +829,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -836,7 +881,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -888,7 +933,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -945,7 +990,7 @@ class AlphaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listAudienceLists'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listAudienceLists stream %j', request);
@@ -994,7 +1039,7 @@ class AlphaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listAudienceLists'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listAudienceLists iterate %j', request);
@@ -1017,7 +1062,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -1076,7 +1121,7 @@ class AlphaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listRecurringAudienceLists'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listRecurringAudienceLists stream %j', request);
@@ -1127,7 +1172,7 @@ class AlphaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listRecurringAudienceLists'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listRecurringAudienceLists iterate %j', request);
@@ -1150,7 +1195,7 @@ class AlphaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -1201,7 +1246,7 @@ class AlphaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listReportTasks'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listReportTasks stream %j', request);
@@ -1244,7 +1289,7 @@ class AlphaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listReportTasks'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listReportTasks iterate %j', request);
@@ -1607,7 +1652,7 @@ class AlphaAnalyticsDataClient {
      */
     close() {
         if (this.alphaAnalyticsDataStub && !this._terminated) {
-            return this.alphaAnalyticsDataStub.then((stub) => {
+            return this.alphaAnalyticsDataStub.then(stub => {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();

package/build/src/v1alpha/alpha_analytics_data_client_config.json

@@ -97,6 +97,11 @@
                     "retry_codes_name": "unknown",
                     "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
                 },
+                "Chat": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
                 "RunReport": {
                     "timeout_millis": 60000,
                     "retry_codes_name": "unknown",

package/build/src/v1alpha/gapic_metadata.json

@@ -50,6 +50,11 @@
                                 "getReportTask"
                             ]
                         },
+                        "Chat": {
+                            "methods": [
+                                "chat"
+                            ]
+                        },
                         "RunReport": {
                             "methods": [
                                 "runReport"
@@ -136,6 +141,11 @@
                                 "getReportTask"
                             ]
                         },
+                        "Chat": {
+                            "methods": [
+                                "chat"
+                            ]
+                        },
                         "RunReport": {
                             "methods": [
                                 "runReport"

package/build/src/v1beta/beta_analytics_data_client.js

@@ -244,7 +244,7 @@ class BetaAnalyticsDataClient {
             'listAudienceExports',
         ];
         for (const methodName of betaAnalyticsDataStubMethods) {
-            const callPromise = this.betaAnalyticsDataStub.then((stub) => (...args) => {
+            const callPromise = this.betaAnalyticsDataStub.then(stub => (...args) => {
                 if (this._terminated) {
                     return Promise.reject('The client has already been closed.');
                 }
@@ -341,7 +341,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('runReport request %j', request);
@@ -384,7 +384,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('runPivotReport request %j', request);
@@ -427,7 +427,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('batchRunReports request %j', request);
@@ -470,7 +470,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('batchRunPivotReports request %j', request);
@@ -513,7 +513,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getMetadata request %j', request);
@@ -556,7 +556,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('runRealtimeReport request %j', request);
@@ -599,7 +599,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 property: request.property ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('checkCompatibility request %j', request);
@@ -642,7 +642,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('queryAudienceExport request %j', request);
@@ -685,7 +685,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 name: request.name ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('getAudienceExport request %j', request);
@@ -728,7 +728,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -780,7 +780,7 @@ class BetaAnalyticsDataClient {
             this._gaxModule.routingHeader.fromParams({
                 parent: request.parent ?? '',
             });
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         const wrappedCallback = callback
@@ -837,7 +837,7 @@ class BetaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listAudienceExports'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listAudienceExports stream %j', request);
@@ -886,7 +886,7 @@ class BetaAnalyticsDataClient {
             });
         const defaultCallSettings = this._defaults['listAudienceExports'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch((err) => {
+        this.initialize().catch(err => {
             throw err;
         });
         this._log.info('listAudienceExports iterate %j', request);
@@ -1158,7 +1158,7 @@ class BetaAnalyticsDataClient {
      */
     close() {
         if (this.betaAnalyticsDataStub && !this._terminated) {
-            return this.betaAnalyticsDataStub.then((stub) => {
+            return this.betaAnalyticsDataStub.then(stub => {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-analytics/data",
-  "version": "7.0.0",
+  "version": "7.2.0",
   "description": "Data client for Node.js",
   "repository": {
     "type": "git",