@google-analytics/data 4.1.0 → 4.3.0

package/build/src/v1beta/beta_analytics_data_client.js

@@ -137,7 +137,35 @@ class BetaAnalyticsDataClient {
         // identifiers to uniquely identify resources within the API.
         // Create useful helper objects for these.
         this.pathTemplates = {
+            audienceExportPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/audienceExports/{audience_export}'),
             metadataPathTemplate: new this._gaxModule.PathTemplate('properties/{property}/metadata'),
+            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
+        // pages). Denote the keys used for pagination and results.
+        this.descriptors.page = {
+            listAudienceExports: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'audienceExports'),
+        };
+        const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+        // This API contains "long-running operations", which return a
+        // an Operation object that allows for tracking of the operation,
+        // rather than holding a request open.
+        const lroOptions = {
+            auth: this.auth,
+            grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
+        };
+        if (opts.fallback) {
+            lroOptions.protoJson = protoFilesRoot;
+            lroOptions.httpRules = [];
+        }
+        this.operationsClient = this._gaxModule
+            .lro(lroOptions)
+            .operationsClient(opts);
+        const createAudienceExportResponse = protoFilesRoot.lookup('.google.analytics.data.v1beta.AudienceExport');
+        const createAudienceExportMetadata = protoFilesRoot.lookup('.google.analytics.data.v1beta.AudienceExportMetadata');
+        this.descriptors.longrunning = {
+            createAudienceExport: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createAudienceExportResponse.decode.bind(createAudienceExportResponse), createAudienceExportMetadata.decode.bind(createAudienceExportMetadata)),
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.analytics.data.v1beta.BetaAnalyticsData', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -180,6 +208,10 @@ class BetaAnalyticsDataClient {
             'getMetadata',
             'runRealtimeReport',
             'checkCompatibility',
+            'createAudienceExport',
+            'queryAudienceExport',
+            'getAudienceExport',
+            'listAudienceExports',
         ];
         for (const methodName of betaAnalyticsDataStubMethods) {
             const callPromise = this.betaAnalyticsDataStub.then(stub => (...args) => {
@@ -191,7 +223,9 @@ class BetaAnalyticsDataClient {
             }, (err) => () => {
                 throw err;
             });
-            const descriptor = undefined;
+            const descriptor = this.descriptors.page[methodName] ||
+                this.descriptors.longrunning[methodName] ||
+                undefined;
             const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
             this.innerApiCalls[methodName] = apiCall;
         }
@@ -388,9 +422,362 @@ class BetaAnalyticsDataClient {
         this.initialize();
         return this.innerApiCalls.checkCompatibility(request, options, callback);
     }
+    queryAudienceExport(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.queryAudienceExport(request, options, callback);
+    }
+    getAudienceExport(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.getAudienceExport(request, options, callback);
+    }
+    createAudienceExport(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.createAudienceExport(request, options, callback);
+    }
+    /**
+     * Check the status of the long running operation returned by `createAudienceExport()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/beta_analytics_data.create_audience_export.js</caption>
+     * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_CreateAudienceExport_async
+     */
+    async checkCreateAudienceExportProgress(name) {
+        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) {
+            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.listAudienceExports(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 audience exports for this property will be listed in the
+     *   response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of audience exports to return. The service may
+     *   return fewer than this value. If unspecified, at most 200 audience exports
+     *   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 `ListAudienceExports`
+     *   call. Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to `ListAudienceExports`
+     *   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.v1beta.AudienceExport|AudienceExport} 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 `listAudienceExportsAsync()`
+     *   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.
+     */
+    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 : '',
+            });
+        const defaultCallSettings = this._defaults['listAudienceExports'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listAudienceExports.createStream(this.innerApiCalls.listAudienceExports, request, callSettings);
+    }
+    /**
+     * Equivalent to `listAudienceExports`, 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 audience exports for this property will be listed in the
+     *   response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of audience exports to return. The service may
+     *   return fewer than this value. If unspecified, at most 200 audience exports
+     *   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 `ListAudienceExports`
+     *   call. Provide this to retrieve the subsequent page.
+     *
+     *   When paginating, all other parameters provided to `ListAudienceExports`
+     *   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.v1beta.AudienceExport|AudienceExport}. 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/v1beta/beta_analytics_data.list_audience_exports.js</caption>
+     * 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 : '',
+            });
+        const defaultCallSettings = this._defaults['listAudienceExports'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize();
+        return this.descriptors.page.listAudienceExports.asyncIterate(this.innerApiCalls['listAudienceExports'], request, callSettings);
+    }
+    /**
+     * Gets the latest state of a long-running operation.  Clients can use this
+     * method to poll the operation result at intervals as recommended by the API
+     * service.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     *   e.g, timeout, retries, paginations, etc. See {@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+     *   for the details.
+     * @param {function(?Error, ?Object)=} callback
+     *   The function which will be called with the result of the API call.
+     *
+     *   The second parameter to the callback is an object representing
+     *   {@link google.longrunning.Operation | google.longrunning.Operation}.
+     * @return {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     * {@link google.longrunning.Operation | google.longrunning.Operation}.
+     * The promise has a method named "cancel" which cancels the ongoing API call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * const name = '';
+     * const [response] = await client.getOperation({name});
+     * // doThingsWith(response)
+     * ```
+     */
+    getOperation(request, options, callback) {
+        return this.operationsClient.getOperation(request, options, callback);
+    }
+    /**
+     * Lists operations that match the specified filter in the request. If the
+     * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
+     *
+     * For-await-of syntax is used with the iterable to recursively get response element on-demand.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation collection.
+     * @param {string} request.filter - The standard list filter.
+     * @param {number=} request.pageSize -
+     *   The maximum number of resources contained in the underlying API
+     *   response. If page streaming is performed per-resource, this
+     *   parameter does not affect the return value. If page streaming is
+     *   performed per-page, this determines the maximum number of
+     *   resources in a page.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     *   e.g, timeout, retries, paginations, etc. See {@link
+     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
+     *   details.
+     * @returns {Object}
+     *   An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * for await (const response of client.listOperationsAsync(request));
+     * // doThingsWith(response)
+     * ```
+     */
+    listOperationsAsync(request, options) {
+        return this.operationsClient.listOperationsAsync(request, options);
+    }
+    /**
+     * Starts asynchronous cancellation on a long-running operation.  The server
+     * makes a best effort to cancel the operation, but success is not
+     * guaranteed.  If the server doesn't support this method, it returns
+     * `google.rpc.Code.UNIMPLEMENTED`.  Clients can use
+     * {@link Operations.GetOperation} or
+     * other methods to check whether the cancellation succeeded or whether the
+     * operation completed despite cancellation. On successful cancellation,
+     * the operation is not deleted; instead, it becomes an operation with
+     * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
+     * 1, corresponding to `Code.CANCELLED`.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource to be cancelled.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     * e.g, timeout, retries, paginations, etc. See {@link
+     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
+     * details.
+     * @param {function(?Error)=} callback
+     *   The function which will be called with the result of the API call.
+     * @return {Promise} - The promise which resolves when API call finishes.
+     *   The promise has a method named "cancel" which cancels the ongoing API
+     * call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * await client.cancelOperation({name: ''});
+     * ```
+     */
+    cancelOperation(request, options, callback) {
+        return this.operationsClient.cancelOperation(request, options, callback);
+    }
+    /**
+     * Deletes a long-running operation. This method indicates that the client is
+     * no longer interested in the operation result. It does not cancel the
+     * operation. If the server doesn't support this method, it returns
+     * `google.rpc.Code.UNIMPLEMENTED`.
+     *
+     * @param {Object} request - The request object that will be sent.
+     * @param {string} request.name - The name of the operation resource to be deleted.
+     * @param {Object=} options
+     *   Optional parameters. You can override the default settings for this call,
+     * e.g, timeout, retries, paginations, etc. See {@link
+     * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+     * for the details.
+     * @param {function(?Error)=} callback
+     *   The function which will be called with the result of the API call.
+     * @return {Promise} - The promise which resolves when API call finishes.
+     *   The promise has a method named "cancel" which cancels the ongoing API
+     * call.
+     *
+     * @example
+     * ```
+     * const client = longrunning.operationsClient();
+     * await client.deleteOperation({name: ''});
+     * ```
+     */
+    deleteOperation(request, options, callback) {
+        return this.operationsClient.deleteOperation(request, options, callback);
+    }
     // --------------------
     // -- Path templates --
     // --------------------
+    /**
+     * Return a fully-qualified audienceExport resource name string.
+     *
+     * @param {string} property
+     * @param {string} audience_export
+     * @returns {string} Resource name string.
+     */
+    audienceExportPath(property, audienceExport) {
+        return this.pathTemplates.audienceExportPathTemplate.render({
+            property: property,
+            audience_export: audienceExport,
+        });
+    }
+    /**
+     * Parse the property from AudienceExport resource.
+     *
+     * @param {string} audienceExportName
+     *   A fully-qualified path representing AudienceExport resource.
+     * @returns {string} A string representing the property.
+     */
+    matchPropertyFromAudienceExportName(audienceExportName) {
+        return this.pathTemplates.audienceExportPathTemplate.match(audienceExportName).property;
+    }
+    /**
+     * Parse the audience_export from AudienceExport resource.
+     *
+     * @param {string} audienceExportName
+     *   A fully-qualified path representing AudienceExport resource.
+     * @returns {string} A string representing the audience_export.
+     */
+    matchAudienceExportFromAudienceExportName(audienceExportName) {
+        return this.pathTemplates.audienceExportPathTemplate.match(audienceExportName).audience_export;
+    }
     /**
      * Return a fully-qualified metadata resource name string.
      *
@@ -412,6 +799,27 @@ class BetaAnalyticsDataClient {
     matchPropertyFromMetadataName(metadataName) {
         return this.pathTemplates.metadataPathTemplate.match(metadataName).property;
     }
+    /**
+     * Return a fully-qualified property resource name string.
+     *
+     * @param {string} property
+     * @returns {string} Resource name string.
+     */
+    propertyPath(property) {
+        return this.pathTemplates.propertyPathTemplate.render({
+            property: property,
+        });
+    }
+    /**
+     * Parse the property from Property resource.
+     *
+     * @param {string} propertyName
+     *   A fully-qualified path representing Property resource.
+     * @returns {string} A string representing the property.
+     */
+    matchPropertyFromPropertyName(propertyName) {
+        return this.pathTemplates.propertyPathTemplate.match(propertyName).property;
+    }
     /**
      * Terminate the gRPC channel and close the client.
      *
@@ -423,6 +831,7 @@ class BetaAnalyticsDataClient {
             return this.betaAnalyticsDataStub.then(stub => {
                 this._terminated = true;
                 stub.close();
+                this.operationsClient.close();
             });
         }
         return Promise.resolve();

package/build/src/v1beta/beta_analytics_data_client_config.json

@@ -6,6 +6,9 @@
                 "idempotent": [
                     "DEADLINE_EXCEEDED",
                     "UNAVAILABLE"
+                ],
+                "unknown": [
+                    "UNKNOWN"
                 ]
             },
             "retry_params": {
@@ -17,6 +20,15 @@
                     "rpc_timeout_multiplier": 1,
                     "max_rpc_timeout_millis": 60000,
                     "total_timeout_millis": 600000
+                },
+                "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c": {
+                    "initial_retry_delay_millis": 1000,
+                    "retry_delay_multiplier": 1.3,
+                    "max_retry_delay_millis": 60000,
+                    "initial_rpc_timeout_millis": 60000,
+                    "rpc_timeout_multiplier": 1,
+                    "max_rpc_timeout_millis": 60000,
+                    "total_timeout_millis": 600000
                 }
             },
             "methods": {
@@ -54,6 +66,26 @@
                     "timeout_millis": 60000,
                     "retry_codes_name": "non_idempotent",
                     "retry_params_name": "default"
+                },
+                "CreateAudienceExport": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
+                "QueryAudienceExport": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
+                "GetAudienceExport": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
+                },
+                "ListAudienceExports": {
+                    "timeout_millis": 60000,
+                    "retry_codes_name": "unknown",
+                    "retry_params_name": "01d6d956b4dadd7e38ee9dec12ed8720e6e6f90c"
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-analytics/data",
-  "version": "4.1.0",
+  "version": "4.3.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",