@google-analytics/data 4.0.1 → 4.2.0

package/build/src/v1alpha/alpha_analytics_data_client.js

@@ -137,14 +137,16 @@ 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}'),
+            recurringAudienceListPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/recurringAudienceLists/{recurring_audience_list}'),
         };
         // Some of the methods on this service return "paged" results,
         // (e.g. 50 results at a time, with tokens to get subsequent
         // pages). Denote the keys used for pagination and results.
         this.descriptors.page = {
             listAudienceLists: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'audienceLists'),
+            listRecurringAudienceLists: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'recurringAudienceLists'),
         };
         const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
         // This API contains "long-running operations", which return a
@@ -204,8 +206,12 @@ class AlphaAnalyticsDataClient {
             'runFunnelReport',
             'createAudienceList',
             'queryAudienceList',
+            'sheetExportAudienceList',
             'getAudienceList',
             'listAudienceLists',
+            'createRecurringAudienceList',
+            'getRecurringAudienceList',
+            'listRecurringAudienceLists',
         ];
         for (const methodName of alphaAnalyticsDataStubMethods) {
             const callPromise = this.alphaAnalyticsDataStub.then(stub => (...args) => {
@@ -256,6 +262,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',
         ];
     }
     /**
@@ -311,6 +320,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 || {};
@@ -332,6 +362,48 @@ class AlphaAnalyticsDataClient {
         this.initialize();
         return this.innerApiCalls.getAudienceList(request, options, callback);
     }
+    createRecurringAudienceList(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({
+                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.createRecurringAudienceList(request, options, callback);
+    }
+    getRecurringAudienceList(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.getRecurringAudienceList(request, options, callback);
+    }
     createAudienceList(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};
@@ -397,15 +469,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.
@@ -443,15 +515,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.
@@ -482,65 +554,213 @@ class AlphaAnalyticsDataClient {
         this.initialize();
         return this.descriptors.page.listAudienceLists.asyncIterate(this.innerApiCalls['listAudienceLists'], request, callSettings);
     }
+    listRecurringAudienceLists(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({
+                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.listRecurringAudienceLists(request, options, callback);
+    }
+    /**
+     * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. All recurring audience lists for this property will be listed in
+     *   the response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of recurring audience lists to return. The
+     *   service may return fewer than this value. If unspecified, at most 200
+     *   recurring 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
+     *   `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
+     *   page.
+     *
+     *   When paginating, all other parameters provided to
+     *   `ListRecurringAudienceLists` must match the call that provided the page
+     *   token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Stream}
+     *   An object stream which emits an object representing {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList} on 'data' event.
+     *   The client library will perform auto-pagination by default: it will call the API as many
+     *   times as needed. Note that it can affect your quota.
+     *   We recommend using `listRecurringAudienceListsAsync()`
+     *   method described below for async iteration which you can stop as needed.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     */
+    listRecurringAudienceListsStream(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 : '',
+            });
+        const defaultCallSettings = this._defaults['listRecurringAudienceLists'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listRecurringAudienceLists.createStream(this.innerApiCalls.listRecurringAudienceLists, request, callSettings);
+    }
+    /**
+     * Equivalent to `listRecurringAudienceLists`, but returns an iterable object.
+     *
+     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. All recurring audience lists for this property will be listed in
+     *   the response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of recurring audience lists to return. The
+     *   service may return fewer than this value. If unspecified, at most 200
+     *   recurring 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
+     *   `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
+     *   page.
+     *
+     *   When paginating, all other parameters provided to
+     *   `ListRecurringAudienceLists` must match the call that provided the page
+     *   token.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Object}
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+     *   When you iterate the returned iterable, each element will be an object representing
+     *   {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}. The API will be called under the hood as needed, once per the page,
+     *   so you can stop the iteration when you don't need more results.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/alpha_analytics_data.list_recurring_audience_lists.js</caption>
+     * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListRecurringAudienceLists_async
+     */
+    listRecurringAudienceListsAsync(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 : '',
+            });
+        const defaultCallSettings = this._defaults['listRecurringAudienceLists'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listRecurringAudienceLists.asyncIterate(this.innerApiCalls['listRecurringAudienceLists'], request, callSettings);
+    }
     // --------------------
     // -- Path templates --
     // --------------------
     /**
      * 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.
+     */
+    matchPropertyFromPropertyName(propertyName) {
+        return this.pathTemplates.propertyPathTemplate.match(propertyName).property;
+    }
+    /**
+     * Return a fully-qualified recurringAudienceList resource name string.
+     *
+     * @param {string} property
+     * @param {string} recurring_audience_list
+     * @returns {string} Resource name string.
+     */
+    recurringAudienceListPath(property, recurringAudienceList) {
+        return this.pathTemplates.recurringAudienceListPathTemplate.render({
+            property: property,
+            recurring_audience_list: recurringAudienceList,
+        });
+    }
+    /**
+     * Parse the property from RecurringAudienceList resource.
+     *
+     * @param {string} recurringAudienceListName
+     *   A fully-qualified path representing RecurringAudienceList resource.
+     * @returns {string} A string representing the property.
+     */
+    matchPropertyFromRecurringAudienceListName(recurringAudienceListName) {
+        return this.pathTemplates.recurringAudienceListPathTemplate.match(recurringAudienceListName).property;
+    }
+    /**
+     * Parse the recurring_audience_list from RecurringAudienceList resource.
+     *
+     * @param {string} recurringAudienceListName
+     *   A fully-qualified path representing RecurringAudienceList resource.
+     * @returns {string} A string representing the recurring_audience_list.
      */
-    matchPropertyIdFromPropertyName(propertyName) {
-        return this.pathTemplates.propertyPathTemplate.match(propertyName)
-            .propertyId;
+    matchRecurringAudienceListFromRecurringAudienceListName(recurringAudienceListName) {
+        return this.pathTemplates.recurringAudienceListPathTemplate.match(recurringAudienceListName).recurring_audience_list;
     }
     /**
      * 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",
@@ -56,6 +61,21 @@
                     "timeout_millis": 60000,
                     "retry_codes_name": "unknown",
                     "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
+                "CreateRecurringAudienceList": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
+                "GetRecurringAudienceList": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
+                "ListRecurringAudienceLists": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-analytics/data",
-  "version": "4.0.1",
+  "version": "4.2.0",
   "description": "Data client for Node.js",
   "repository": {
     "type": "git",
@@ -37,7 +37,7 @@
     "docs-test": "linkinator docs",
     "fix": "gts fix",
     "lint": "gts check",
-    "prepare": "npm run compile-protos && npm run compile",
+    "prepare": "npm run compile",
     "prelint": "cd samples; npm link ../; npm i",
     "postpack": "minifyProtoJson",
     "samples-test": "cd samples/ && npm link ../ && npm i && npm test",
@@ -50,9 +50,9 @@
   "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": "^3.0.0",
@@ -60,8 +60,8 @@
     "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": {