@google-analytics/data 3.3.0 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [4.0.0](https://github.com/googleapis/google-cloud-node/compare/data-v3.3.0...data-v4.0.0) (2023-08-06)
+
+
+### ⚠ BREAKING CHANGES
+
+* migrate to Node 14 ([#4443](https://github.com/googleapis/google-cloud-node/issues/4443))
+
+### Bug Fixes
+
+* [Many APIs] fix typings for IAM methods ([#4459](https://github.com/googleapis/google-cloud-node/issues/4459)) ([1d510be](https://github.com/googleapis/google-cloud-node/commit/1d510bef5bd7b0ac3552b4729ef3d9ebe1ac3dc4))
+
+
+### Miscellaneous Chores
+
+* Migrate to Node 14 ([#4443](https://github.com/googleapis/google-cloud-node/issues/4443)) ([2260f12](https://github.com/googleapis/google-cloud-node/commit/2260f12543d171bda95345e53475f5f0fdc45770))
+
 ## [3.3.0](https://github.com/googleapis/google-cloud-node/compare/data-v3.2.2...data-v3.3.0) (2023-07-11)
 
 

package/README.md

@@ -130,7 +130,7 @@ also contains samples.
 
 ## Supported Node.js Versions
 
-Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
+Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
 Libraries are compatible with all current _active_ and _maintenance_ versions of
 Node.js.
 If you are using an end-of-life version of Node.js, we recommend that you update

package/build/protos/google/analytics/data/v1beta/analytics_data_api.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -66,7 +66,8 @@ service BetaAnalyticsData {
 
   // Returns multiple reports in a batch. All reports must be for the same
   // GA4 Property.
-  rpc BatchRunReports(BatchRunReportsRequest) returns (BatchRunReportsResponse) {
+  rpc BatchRunReports(BatchRunReportsRequest)
+      returns (BatchRunReportsResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:batchRunReports"
       body: "*"
@@ -75,7 +76,8 @@ service BetaAnalyticsData {
 
   // Returns multiple pivot reports in a batch. All reports must be for the same
   // GA4 Property.
-  rpc BatchRunPivotReports(BatchRunPivotReportsRequest) returns (BatchRunPivotReportsResponse) {
+  rpc BatchRunPivotReports(BatchRunPivotReportsRequest)
+      returns (BatchRunPivotReportsResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:batchRunPivotReports"
       body: "*"
@@ -108,7 +110,8 @@ service BetaAnalyticsData {
   // For a guide to constructing realtime requests & understanding responses,
   // see [Creating a Realtime
   // Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics).
-  rpc RunRealtimeReport(RunRealtimeReportRequest) returns (RunRealtimeReportResponse) {
+  rpc RunRealtimeReport(RunRealtimeReportRequest)
+      returns (RunRealtimeReportResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:runRealtimeReport"
       body: "*"
@@ -125,7 +128,8 @@ service BetaAnalyticsData {
   //
   // The Realtime and Core reports have different compatibility rules. This
   // method checks compatibility for Core reports.
-  rpc CheckCompatibility(CheckCompatibilityRequest) returns (CheckCompatibilityResponse) {
+  rpc CheckCompatibility(CheckCompatibilityRequest)
+      returns (CheckCompatibilityResponse) {
     option (google.api.http) = {
       post: "/v1beta/{property=properties/*}:checkCompatibility"
       body: "*"
@@ -144,10 +148,6 @@ message CheckCompatibilityRequest {
   // `property` should be the same value as in your `runReport` request.
   //
   // Example: properties/1234
-  //
-  // Set the Property ID to 0 for compatibility checking on dimensions and
-  // metrics common to all properties. In this special mode, this method will
-  // not return custom dimensions and metrics.
   string property = 1;
 
   // The dimensions in this report. `dimensions` should be the same value as in
@@ -223,7 +223,7 @@ message RunReportRequest {
   // must be unspecified.
   repeated DateRange date_ranges = 4;
 
-  // Dimension filters allow you to ask for only specific dimension values in
+  // Dimension filters let you ask for only specific dimension values in
   // the report. To learn more, see [Fundamentals of Dimension
   // Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
   // for examples. Metrics cannot be used in this filter.
@@ -245,7 +245,7 @@ message RunReportRequest {
   int64 offset = 7;
 
   // The number of rows to return. If unspecified, 10,000 rows are returned. The
-  // API returns a maximum of 100,000 rows per request, no matter how many you
+  // API returns a maximum of 250,000 rows per request, no matter how many you
   // ask for. `limit` must be positive.
   //
   // The API can also return fewer rows than the requested `limit`, if there
@@ -276,6 +276,13 @@ message RunReportRequest {
   // If false or unspecified, each row with all metrics equal to 0 will not be
   // returned. If true, these rows will be returned if they are not separately
   // removed by a filter.
+  //
+  // Regardless of this `keep_empty_rows` setting, only data recorded by the
+  // Google Analytics (GA4) property can be displayed in a report.
+  //
+  // For example if a property never logs a `purchase` event, then a query for
+  // the `eventName` dimension and  `eventCount` metric will not have a row
+  // eventName: "purchase" and eventCount: 0.
   bool keep_empty_rows = 13;
 
   // Toggles whether to return the current state of this Analytics Property's
@@ -381,6 +388,13 @@ message RunPivotReportRequest {
   // If false or unspecified, each row with all metrics equal to 0 will not be
   // returned. If true, these rows will be returned if they are not separately
   // removed by a filter.
+  //
+  // Regardless of this `keep_empty_rows` setting, only data recorded by the
+  // Google Analytics (GA4) property can be displayed in a report.
+  //
+  // For example if a property never logs a `purchase` event, then a query for
+  // the `eventName` dimension and  `eventCount` metric will not have a row
+  // eventName: "purchase" and eventCount: 0.
   bool keep_empty_rows = 10;
 
   // Toggles whether to return the current state of this Analytics Property's
@@ -560,7 +574,7 @@ message RunRealtimeReportRequest {
   FilterExpression metric_filter = 5;
 
   // The number of rows to return. If unspecified, 10,000 rows are returned. The
-  // API returns a maximum of 100,000 rows per request, no matter how many you
+  // API returns a maximum of 250,000 rows per request, no matter how many you
   // ask for. `limit` must be positive.
   //
   // The API can also return fewer rows than the requested `limit`, if there

package/build/protos/google/analytics/data/v1beta/data.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -21,8 +21,8 @@ option java_multiple_files = true;
 option java_outer_classname = "ReportingApiProto";
 option java_package = "com.google.analytics.data.v1beta";
 
-// A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
-// are allowed up to 4 date ranges.
+// A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
+// Requests are allowed up to 4 date ranges.
 message DateRange {
   // The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
   // be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
@@ -43,8 +43,8 @@ message DateRange {
   string name = 3;
 }
 
-// A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
-// endMinutesAgo. Requests are allowed up to 2 minute ranges.
+// A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ...,
+// `endMinutesAgo`. Requests are allowed up to 2 minute ranges.
 message MinuteRange {
   // The inclusive start minute for the query as a number of minutes before now.
   // For example, `"startMinutesAgo": 29` specifies the report should include
@@ -420,7 +420,7 @@ message Pivot {
   // single pivot requests.
   //
   // The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
-  // must not exceed 100,000. For example, a two pivot request with `limit:
+  // must not exceed 250,000. For example, a two pivot request with `limit:
   // 1000` in each pivot will fail because the product is `1,000,000`.
   int64 limit = 4;
 
@@ -581,6 +581,18 @@ message ResponseMetaData {
 
   // If true, indicates some buckets of dimension combinations are rolled into
   // "(other)" row. This can happen for high cardinality reports.
+  //
+  // The metadata parameter dataLossFromOtherRow is populated based on the
+  // aggregated data table used in the report. The parameter will be accurately
+  // populated regardless of the filters and limits in the report.
+  //
+  // For example, the (other) row could be dropped from the report because the
+  // request contains a filter on sessionSource = google. This parameter will
+  // still be populated if data loss from other row was present in the input
+  // aggregate data used to generate this report.
+  //
+  // To learn more, see [About the (other) row and data
+  // sampling](https://support.google.com/analytics/answer/13208658#reports).
   bool data_loss_from_other_row = 3;
 
   // Describes the schema restrictions actively enforced in creating this
@@ -739,13 +751,13 @@ message NumericValue {
 // property is exhausted, all requests to that property will return Resource
 // Exhausted errors.
 message PropertyQuota {
-  // Standard Analytics Properties can use up to 25,000 tokens per day;
-  // Analytics 360 Properties can use 250,000 tokens per day. Most requests
+  // Standard Analytics Properties can use up to 200,000 tokens per day;
+  // Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
   // consume fewer than 10 tokens.
   QuotaStatus tokens_per_day = 1;
 
-  // Standard Analytics Properties can use up to 5,000 tokens per hour;
-  // Analytics 360 Properties can use 50,000 tokens per hour. An API request
+  // Standard Analytics Properties can use up to 40,000 tokens per hour;
+  // Analytics 360 Properties can use 400,000 tokens per hour. An API request
   // consumes a single number of tokens, and that number is deducted from all of
   // the hourly, daily, and per project hourly quotas.
   QuotaStatus tokens_per_hour = 2;
@@ -765,9 +777,9 @@ message PropertyQuota {
   // thresholded dimensions.
   QuotaStatus potentially_thresholded_requests_per_hour = 5;
 
-  // Analytics Properties can use up to 25% of their tokens per project per
-  // hour. This amounts to standard Analytics Properties can use up to 1,250
-  // tokens per project per hour, and Analytics 360 Properties can use 12,500
+  // Analytics Properties can use up to 35% of their tokens per project per
+  // hour. This amounts to standard Analytics Properties can use up to 14,000
+  // tokens per project per hour, and Analytics 360 Properties can use 140,000
   // tokens per project per hour. An API request consumes a single number of
   // tokens, and that number is deducted from all of the hourly, daily, and per
   // project hourly quotas.

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

@@ -191,9 +191,8 @@ export declare class AlphaAnalyticsDataClient {
      * @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 google.analytics.data.v1alpha.RunFunnelReportResponse | RunFunnelReportResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.RunFunnelReportResponse|RunFunnelReportResponse}.
+     *   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.run_funnel_report.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_RunFunnelReport_async
@@ -243,9 +242,8 @@ export declare class AlphaAnalyticsDataClient {
      * @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 google.analytics.data.v1alpha.QueryAudienceListResponse | QueryAudienceListResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.QueryAudienceListResponse|QueryAudienceListResponse}.
+     *   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.query_audience_list.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_QueryAudienceList_async
@@ -269,9 +267,8 @@ export declare class AlphaAnalyticsDataClient {
      * @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 google.analytics.data.v1alpha.AudienceList | AudienceList}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList}.
+     *   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.get_audience_list.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_GetAudienceList_async
@@ -313,8 +310,7 @@ export declare class AlphaAnalyticsDataClient {
      *   The first element of the array is an object representing
      *   a long running operation. Its `promise()` method returns a promise
      *   you can `await` for.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1alpha/alpha_analytics_data.create_audience_list.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_CreateAudienceList_async
@@ -332,8 +328,7 @@ export declare class AlphaAnalyticsDataClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1alpha/alpha_analytics_data.create_audience_list.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_CreateAudienceList_async
@@ -364,14 +359,13 @@ export declare class AlphaAnalyticsDataClient {
      * @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 Array of {@link google.analytics.data.v1alpha.AudienceList | AudienceList}.
+     *   The first element of the array is Array of {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList}.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed and will merge results from all the pages into this array.
      *   Note that it can affect your quota.
      *   We recommend using `listAudienceListsAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listAudienceLists(request?: protos.google.analytics.data.v1alpha.IListAudienceListsRequest, options?: CallOptions): Promise<[
@@ -402,13 +396,12 @@ export declare class AlphaAnalyticsDataClient {
      * @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 google.analytics.data.v1alpha.AudienceList | AudienceList} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList} 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 `listAudienceListsAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listAudienceListsStream(request?: protos.google.analytics.data.v1alpha.IListAudienceListsRequest, options?: CallOptions): Transform;
@@ -435,12 +428,11 @@ export declare class AlphaAnalyticsDataClient {
      * @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 [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   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 google.analytics.data.v1alpha.AudienceList | AudienceList}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList}. 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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   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_audience_lists.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListAudienceLists_async

package/build/src/v1alpha/alpha_analytics_data_client.js

@@ -360,8 +360,7 @@ class AlphaAnalyticsDataClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1alpha/alpha_analytics_data.create_audience_list.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_CreateAudienceList_async
@@ -414,13 +413,12 @@ class AlphaAnalyticsDataClient {
      * @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 google.analytics.data.v1alpha.AudienceList | AudienceList} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList} 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 `listAudienceListsAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listAudienceListsStream(request, options) {
@@ -461,12 +459,11 @@ class AlphaAnalyticsDataClient {
      * @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 [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   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 google.analytics.data.v1alpha.AudienceList | AudienceList}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.analytics.data.v1alpha.AudienceList|AudienceList}. 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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   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_audience_lists.js</caption>
      * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_ListAudienceLists_async

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

@@ -140,7 +140,7 @@ export declare class BetaAnalyticsDataClient {
      *   response rows for both date ranges. In a cohort request, this `dateRanges`
      *   must be unspecified.
      * @param {google.analytics.data.v1beta.FilterExpression} request.dimensionFilter
-     *   Dimension filters allow you to ask for only specific dimension values in
+     *   Dimension filters let you ask for only specific dimension values in
      *   the report. To learn more, see [Fundamentals of Dimension
      *   Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
      *   for examples. Metrics cannot be used in this filter.
@@ -159,7 +159,7 @@ export declare class BetaAnalyticsDataClient {
      *   [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
      * @param {number} request.limit
      *   The number of rows to return. If unspecified, 10,000 rows are returned. The
-     *   API returns a maximum of 100,000 rows per request, no matter how many you
+     *   API returns a maximum of 250,000 rows per request, no matter how many you
      *   ask for. `limit` must be positive.
      *
      *   The API can also return fewer rows than the requested `limit`, if there
@@ -185,15 +185,21 @@ export declare class BetaAnalyticsDataClient {
      *   If false or unspecified, each row with all metrics equal to 0 will not be
      *   returned. If true, these rows will be returned if they are not separately
      *   removed by a filter.
+     *
+     *   Regardless of this `keep_empty_rows` setting, only data recorded by the
+     *   Google Analytics (GA4) property can be displayed in a report.
+     *
+     *   For example if a property never logs a `purchase` event, then a query for
+     *   the `eventName` dimension and  `eventCount` metric will not have a row
+     *   eventName: "purchase" and eventCount: 0.
      * @param {boolean} request.returnPropertyQuota
      *   Toggles whether to return the current state of this Analytics Property's
      *   quota. Quota is returned in [PropertyQuota](#PropertyQuota).
      * @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 google.analytics.data.v1beta.RunReportResponse | RunReportResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.RunReportResponse|RunReportResponse}.
+     *   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/v1beta/beta_analytics_data.run_report.js</caption>
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_RunReport_async
@@ -258,15 +264,21 @@ export declare class BetaAnalyticsDataClient {
      *   If false or unspecified, each row with all metrics equal to 0 will not be
      *   returned. If true, these rows will be returned if they are not separately
      *   removed by a filter.
+     *
+     *   Regardless of this `keep_empty_rows` setting, only data recorded by the
+     *   Google Analytics (GA4) property can be displayed in a report.
+     *
+     *   For example if a property never logs a `purchase` event, then a query for
+     *   the `eventName` dimension and  `eventCount` metric will not have a row
+     *   eventName: "purchase" and eventCount: 0.
      * @param {boolean} request.returnPropertyQuota
      *   Toggles whether to return the current state of this Analytics Property's
      *   quota. Quota is returned in [PropertyQuota](#PropertyQuota).
      * @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 google.analytics.data.v1beta.RunPivotReportResponse | RunPivotReportResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.RunPivotReportResponse|RunPivotReportResponse}.
+     *   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/v1beta/beta_analytics_data.run_pivot_report.js</caption>
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_RunPivotReport_async
@@ -300,9 +312,8 @@ export declare class BetaAnalyticsDataClient {
      * @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 google.analytics.data.v1beta.BatchRunReportsResponse | BatchRunReportsResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.BatchRunReportsResponse|BatchRunReportsResponse}.
+     *   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/v1beta/beta_analytics_data.batch_run_reports.js</caption>
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_BatchRunReports_async
@@ -336,9 +347,8 @@ export declare class BetaAnalyticsDataClient {
      * @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 google.analytics.data.v1beta.BatchRunPivotReportsResponse | BatchRunPivotReportsResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.BatchRunPivotReportsResponse|BatchRunPivotReportsResponse}.
+     *   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/v1beta/beta_analytics_data.batch_run_pivot_reports.js</caption>
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_BatchRunPivotReports_async
@@ -379,9 +389,8 @@ export declare class BetaAnalyticsDataClient {
      * @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 google.analytics.data.v1beta.Metadata | Metadata}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.Metadata|Metadata}.
+     *   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/v1beta/beta_analytics_data.get_metadata.js</caption>
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_GetMetadata_async
@@ -424,7 +433,7 @@ export declare class BetaAnalyticsDataClient {
      *   SQL having-clause. Dimensions cannot be used in this filter.
      * @param {number} request.limit
      *   The number of rows to return. If unspecified, 10,000 rows are returned. The
-     *   API returns a maximum of 100,000 rows per request, no matter how many you
+     *   API returns a maximum of 250,000 rows per request, no matter how many you
      *   ask for. `limit` must be positive.
      *
      *   The API can also return fewer rows than the requested `limit`, if there
@@ -449,9 +458,8 @@ export declare class BetaAnalyticsDataClient {
      * @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 google.analytics.data.v1beta.RunRealtimeReportResponse | RunRealtimeReportResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.RunRealtimeReportResponse|RunRealtimeReportResponse}.
+     *   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/v1beta/beta_analytics_data.run_realtime_report.js</caption>
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_RunRealtimeReport_async
@@ -484,10 +492,6 @@ export declare class BetaAnalyticsDataClient {
      *   `property` should be the same value as in your `runReport` request.
      *
      *   Example: properties/1234
-     *
-     *   Set the Property ID to 0 for compatibility checking on dimensions and
-     *   metrics common to all properties. In this special mode, this method will
-     *   not return custom dimensions and metrics.
      * @param {number[]} request.dimensions
      *   The dimensions in this report. `dimensions` should be the same value as in
      *   your `runReport` request.
@@ -507,9 +511,8 @@ export declare class BetaAnalyticsDataClient {
      * @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 google.analytics.data.v1beta.CheckCompatibilityResponse | CheckCompatibilityResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.CheckCompatibilityResponse|CheckCompatibilityResponse}.
+     *   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/v1beta/beta_analytics_data.check_compatibility.js</caption>
      * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_CheckCompatibility_async

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-analytics/data",
-  "version": "3.3.0",
+  "version": "4.0.0",
   "description": "Data client for Node.js",
   "repository": {
     "type": "git",
@@ -45,30 +45,27 @@
     "test": "c8 mocha build/test"
   },
   "dependencies": {
-    "google-gax": "^3.5.8"
+    "google-gax": "^4.0.3"
   },
   "devDependencies": {
     "@types/mocha": "^9.0.0",
-    "@types/node": "^18.0.0",
+    "@types/node": "^20.4.5",
     "@types/sinon": "^10.0.0",
-    "c8": "^7.2.0",
-    "gts": "^3.1.0",
+    "c8": "^8.0.1",
+    "gapic-tools": "^0.1.8",
+    "gts": "^5.0.0",
     "jsdoc": "^4.0.0",
     "jsdoc-fresh": "^2.0.0",
     "jsdoc-region-tag": "^2.0.0",
     "linkinator": "4.1.2",
     "long": "^5.2.3",
     "mocha": "^9.2.2",
-    "null-loader": "^4.0.0",
     "pack-n-play": "^1.0.0-2",
     "sinon": "^15.0.0",
-    "ts-loader": "^9.0.0",
-    "typescript": "^4.6.4",
-    "webpack": "^5.0.0",
-    "webpack-cli": "^5.0.0"
+    "typescript": "^5.1.6"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-analytics-data"
 }