@google-analytics/data 4.0.0 → 4.1.0

package/build/src/v1alpha/alpha_analytics_data_client.js

@@ -60,8 +60,7 @@ class AlphaAnalyticsDataClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -69,7 +68,7 @@ class AlphaAnalyticsDataClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new AlphaAnalyticsDataClient({fallback: 'rest'}, gax);
+     *     const client = new AlphaAnalyticsDataClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts, gaxInstance) {
@@ -126,7 +125,7 @@ class AlphaAnalyticsDataClient {
         if (!opts.fallback) {
             clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
         }
-        else if (opts.fallback === 'rest') {
+        else {
             clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
         }
         if (opts.libName && opts.libVersion) {
@@ -138,8 +137,8 @@ class AlphaAnalyticsDataClient {
         // identifiers to uniquely identify resources within the API.
         // Create useful helper objects for these.
         this.pathTemplates = {
-            audienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{propertyId}/audienceLists/{audienceListId}'),
-            propertyPathTemplate: new this._gaxModule.PathTemplate('properties/{propertyId}'),
+            audienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/audienceLists/{audience_list}'),
+            propertyPathTemplate: new this._gaxModule.PathTemplate('properties/{property}'),
         };
         // Some of the methods on this service return "paged" results,
         // (e.g. 50 results at a time, with tokens to get subsequent
@@ -155,7 +154,7 @@ class AlphaAnalyticsDataClient {
             auth: this.auth,
             grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
         };
-        if (opts.fallback === 'rest') {
+        if (opts.fallback) {
             lroOptions.protoJson = protoFilesRoot;
             lroOptions.httpRules = [];
         }
@@ -205,6 +204,7 @@ class AlphaAnalyticsDataClient {
             'runFunnelReport',
             'createAudienceList',
             'queryAudienceList',
+            'sheetExportAudienceList',
             'getAudienceList',
             'listAudienceLists',
         ];
@@ -257,6 +257,9 @@ class AlphaAnalyticsDataClient {
         return [
             'https://www.googleapis.com/auth/analytics',
             'https://www.googleapis.com/auth/analytics.readonly',
+            'https://www.googleapis.com/auth/drive',
+            'https://www.googleapis.com/auth/drive.file',
+            'https://www.googleapis.com/auth/spreadsheets',
         ];
     }
     /**
@@ -312,6 +315,27 @@ class AlphaAnalyticsDataClient {
         this.initialize();
         return this.innerApiCalls.queryAudienceList(request, options, callback);
     }
+    sheetExportAudienceList(request, optionsOrCallback, callback) {
+        var _a;
+        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({
+                name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.sheetExportAudienceList(request, options, callback);
+    }
     getAudienceList(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};
@@ -398,15 +422,15 @@ class AlphaAnalyticsDataClient {
      *   The request object that will be sent.
      * @param {string} request.parent
      *   Required. All audience lists for this property will be listed in the
-     *   response. Format: `properties/{propertyId}`
-     * @param {number} request.pageSize
-     *   The maximum number of audience lists to return. The service may return
-     *   fewer than this value. If unspecified, at most 200 audience lists will be
-     *   returned. The maximum value is 1000 (higher values will be coerced to the
-     *   maximum).
-     * @param {string} request.pageToken
-     *   A page token, received from a previous `ListAudienceLists` call. Provide
-     *   this to retrieve the subsequent page.
+     *   response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of audience lists to return. The service may
+     *   return fewer than this value. If unspecified, at most 200 audience lists
+     *   will be returned. The maximum value is 1000 (higher values will be coerced
+     *   to the maximum).
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListAudienceLists` call.
+     *   Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to `ListAudienceLists` must
      *   match the call that provided the page token.
@@ -444,15 +468,15 @@ class AlphaAnalyticsDataClient {
      *   The request object that will be sent.
      * @param {string} request.parent
      *   Required. All audience lists for this property will be listed in the
-     *   response. Format: `properties/{propertyId}`
-     * @param {number} request.pageSize
-     *   The maximum number of audience lists to return. The service may return
-     *   fewer than this value. If unspecified, at most 200 audience lists will be
-     *   returned. The maximum value is 1000 (higher values will be coerced to the
-     *   maximum).
-     * @param {string} request.pageToken
-     *   A page token, received from a previous `ListAudienceLists` call. Provide
-     *   this to retrieve the subsequent page.
+     *   response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of audience lists to return. The service may
+     *   return fewer than this value. If unspecified, at most 200 audience lists
+     *   will be returned. The maximum value is 1000 (higher values will be coerced
+     *   to the maximum).
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListAudienceLists` call.
+     *   Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to `ListAudienceLists` must
      *   match the call that provided the page token.
@@ -489,59 +513,58 @@ class AlphaAnalyticsDataClient {
     /**
      * Return a fully-qualified audienceList resource name string.
      *
-     * @param {string} propertyId
-     * @param {string} audienceListId
+     * @param {string} property
+     * @param {string} audience_list
      * @returns {string} Resource name string.
      */
-    audienceListPath(propertyId, audienceListId) {
+    audienceListPath(property, audienceList) {
         return this.pathTemplates.audienceListPathTemplate.render({
-            propertyId: propertyId,
-            audienceListId: audienceListId,
+            property: property,
+            audience_list: audienceList,
         });
     }
     /**
-     * Parse the propertyId from AudienceList resource.
+     * Parse the property from AudienceList resource.
      *
      * @param {string} audienceListName
      *   A fully-qualified path representing AudienceList resource.
-     * @returns {string} A string representing the propertyId.
+     * @returns {string} A string representing the property.
      */
-    matchPropertyIdFromAudienceListName(audienceListName) {
+    matchPropertyFromAudienceListName(audienceListName) {
         return this.pathTemplates.audienceListPathTemplate.match(audienceListName)
-            .propertyId;
+            .property;
     }
     /**
-     * Parse the audienceListId from AudienceList resource.
+     * Parse the audience_list from AudienceList resource.
      *
      * @param {string} audienceListName
      *   A fully-qualified path representing AudienceList resource.
-     * @returns {string} A string representing the audienceListId.
+     * @returns {string} A string representing the audience_list.
      */
-    matchAudienceListIdFromAudienceListName(audienceListName) {
+    matchAudienceListFromAudienceListName(audienceListName) {
         return this.pathTemplates.audienceListPathTemplate.match(audienceListName)
-            .audienceListId;
+            .audience_list;
     }
     /**
      * Return a fully-qualified property resource name string.
      *
-     * @param {string} propertyId
+     * @param {string} property
      * @returns {string} Resource name string.
      */
-    propertyPath(propertyId) {
+    propertyPath(property) {
         return this.pathTemplates.propertyPathTemplate.render({
-            propertyId: propertyId,
+            property: property,
         });
     }
     /**
-     * Parse the propertyId from Property resource.
+     * Parse the property from Property resource.
      *
      * @param {string} propertyName
      *   A fully-qualified path representing Property resource.
-     * @returns {string} A string representing the propertyId.
+     * @returns {string} A string representing the property.
      */
-    matchPropertyIdFromPropertyName(propertyName) {
-        return this.pathTemplates.propertyPathTemplate.match(propertyName)
-            .propertyId;
+    matchPropertyFromPropertyName(propertyName) {
+        return this.pathTemplates.propertyPathTemplate.match(propertyName).property;
     }
     /**
      * Terminate the gRPC channel and close the client.

package/build/src/v1alpha/alpha_analytics_data_client_config.json

@@ -47,6 +47,11 @@
                     "retry_codes_name": "unknown",
                     "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
                 },
+                "SheetExportAudienceList": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
                 "GetAudienceList": {
                     "timeout_millis": 60000,
                     "retry_codes_name": "unknown",

package/build/src/v1beta/beta_analytics_data_client.d.ts

@@ -54,8 +54,7 @@ export declare class BetaAnalyticsDataClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -63,7 +62,7 @@ export declare class BetaAnalyticsDataClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new BetaAnalyticsDataClient({fallback: 'rest'}, gax);
+     *     const client = new BetaAnalyticsDataClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

package/build/src/v1beta/beta_analytics_data_client.js

@@ -60,8 +60,7 @@ class BetaAnalyticsDataClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -69,7 +68,7 @@ class BetaAnalyticsDataClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new BetaAnalyticsDataClient({fallback: 'rest'}, gax);
+     *     const client = new BetaAnalyticsDataClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts, gaxInstance) {
@@ -126,7 +125,7 @@ class BetaAnalyticsDataClient {
         if (!opts.fallback) {
             clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
         }
-        else if (opts.fallback === 'rest') {
+        else {
             clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
         }
         if (opts.libName && opts.libVersion) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-analytics/data",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Data client for Node.js",
   "repository": {
     "type": "git",
@@ -50,18 +50,18 @@
   "devDependencies": {
     "@types/mocha": "^9.0.0",
     "@types/node": "^20.4.5",
-    "@types/sinon": "^10.0.0",
+    "@types/sinon": "^17.0.0",
     "c8": "^8.0.1",
-    "gapic-tools": "^0.1.8",
+    "gapic-tools": "^0.2.0",
     "gts": "^5.0.0",
     "jsdoc": "^4.0.0",
-    "jsdoc-fresh": "^2.0.0",
-    "jsdoc-region-tag": "^2.0.0",
+    "jsdoc-fresh": "^3.0.0",
+    "jsdoc-region-tag": "^3.0.0",
     "linkinator": "4.1.2",
     "long": "^5.2.3",
     "mocha": "^9.2.2",
-    "pack-n-play": "^1.0.0-2",
-    "sinon": "^15.0.0",
+    "pack-n-play": "^2.0.0",
+    "sinon": "^17.0.0",
     "typescript": "^5.1.6"
   },
   "engines": {