@google-analytics/data 2.7.0 → 3.0.2

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

@@ -1,5 +1,5 @@
-import * as gax from 'google-gax';
-import { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
+import type * as gax from 'google-gax';
+import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
 import * as protos from '../../protos/protos';
 /**
  *  Google Analytics reporting data service.
@@ -31,7 +31,7 @@ export declare class BetaAnalyticsDataClient {
      *
      * @param {object} [options] - The configuration object.
      * The options accepted by the constructor are described in detail
-     * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
+     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
      * The common options are:
      * @param {object} [options.credentials] - Credentials object.
      * @param {string} [options.credentials.client_email]
@@ -54,13 +54,19 @@ export declare class BetaAnalyticsDataClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean} [options.fallback] - Use HTTP fallback mode.
-     *     In fallback mode, a special browser-compatible transport implementation is used
-     *     instead of gRPC transport. In browser context (if the `window` object is defined)
-     *     the fallback mode is enabled automatically; set `options.fallback` to `false`
-     *     if you need to override this behavior.
+     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
+     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     *     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
+     *     need to avoid loading the default gRPC version and want to use the fallback
+     *     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);
+     *     ```
      */
-    constructor(opts?: ClientOptions);
+    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
     /**
      * Initialize the client.
      * Performs asynchronous operations (such as authentication) and prepares the client.
@@ -99,25 +105,412 @@ export declare class BetaAnalyticsDataClient {
     static get scopes(): string[];
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
-    runReport(request?: protos.google.analytics.data.v1beta.IRunReportRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1beta.IRunReportResponse, protos.google.analytics.data.v1beta.IRunReportRequest | undefined, {} | undefined]>;
+    /**
+     * Returns a customized report of your Google Analytics event data. Reports
+     * contain statistics derived from data collected by the Google Analytics
+     * tracking code. The data returned from the API is as a table with columns
+     * for the requested dimensions and metrics. Metrics are individual
+     * measurements of user activity on your property, such as active users or
+     * event count. Dimensions break down metrics across some common criteria,
+     * such as country or event name.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.property
+     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   Specified in the URL path and not the body. To learn more, see [where to
+     *   find your Property
+     *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+     *   Within a batch request, this property should either be unspecified or
+     *   consistent with the batch-level property.
+     *
+     *   Example: properties/1234
+     * @param {number[]} request.dimensions
+     *   The dimensions requested and displayed.
+     * @param {number[]} request.metrics
+     *   The metrics requested and displayed.
+     * @param {number[]} request.dateRanges
+     *   Date ranges of data to read. If multiple date ranges are requested, each
+     *   response row will contain a zero based date range index. If two date
+     *   ranges overlap, the event data for the overlapping days is included in the
+     *   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
+     *   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.
+     * @param {google.analytics.data.v1beta.FilterExpression} request.metricFilter
+     *   The filter clause of metrics. Applied at post aggregation phase, similar to
+     *   SQL having-clause. Dimensions cannot be used in this filter.
+     * @param {number} request.offset
+     *   The row count of the start row. The first row is counted as row 0.
+     *
+     *   When paging, the first request does not specify offset; or equivalently,
+     *   sets offset to 0; the first request returns the first `limit` of rows. The
+     *   second request sets offset to the `limit` of the first request; the second
+     *   request returns the second `limit` of rows.
+     *
+     *   To learn more about this pagination parameter, see
+     *   [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
+     *   ask for. `limit` must be positive.
+     *
+     *   The API can also return fewer rows than the requested `limit`, if there
+     *   aren't as many dimension values as the `limit`. For instance, there are
+     *   fewer than 300 possible values for the dimension `country`, so when
+     *   reporting on only `country`, you can't get more than 300 rows, even if you
+     *   set `limit` to a higher value.
+     *
+     *   To learn more about this pagination parameter, see
+     *   [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+     * @param {number[]} request.metricAggregations
+     *   Aggregation of metrics. Aggregated metric values will be shown in rows
+     *   where the dimension_values are set to "RESERVED_(MetricAggregation)".
+     * @param {number[]} request.orderBys
+     *   Specifies how rows are ordered in the response.
+     * @param {string} request.currencyCode
+     *   A currency code in ISO4217 format, such as "AED", "USD", "JPY".
+     *   If the field is empty, the report uses the property's default currency.
+     * @param {google.analytics.data.v1beta.CohortSpec} request.cohortSpec
+     *   Cohort group associated with this request. If there is a cohort group
+     *   in the request the 'cohort' dimension must be present.
+     * @param {boolean} request.keepEmptyRows
+     *   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.
+     * @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 [RunReportResponse]{@link google.analytics.data.v1beta.RunReportResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   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
+     */
+    runReport(request?: protos.google.analytics.data.v1beta.IRunReportRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1beta.IRunReportResponse,
+        protos.google.analytics.data.v1beta.IRunReportRequest | undefined,
+        {} | undefined
+    ]>;
     runReport(request: protos.google.analytics.data.v1beta.IRunReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IRunReportResponse, protos.google.analytics.data.v1beta.IRunReportRequest | null | undefined, {} | null | undefined>): void;
     runReport(request: protos.google.analytics.data.v1beta.IRunReportRequest, callback: Callback<protos.google.analytics.data.v1beta.IRunReportResponse, protos.google.analytics.data.v1beta.IRunReportRequest | null | undefined, {} | null | undefined>): void;
-    runPivotReport(request?: protos.google.analytics.data.v1beta.IRunPivotReportRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1beta.IRunPivotReportResponse, protos.google.analytics.data.v1beta.IRunPivotReportRequest | undefined, {} | undefined]>;
+    /**
+     * Returns a customized pivot report of your Google Analytics event data.
+     * Pivot reports are more advanced and expressive formats than regular
+     * reports. In a pivot report, dimensions are only visible if they are
+     * included in a pivot. Multiple pivots can be specified to further dissect
+     * your data.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.property
+     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   Specified in the URL path and not the body. To learn more, see [where to
+     *   find your Property
+     *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+     *   Within a batch request, this property should either be unspecified or
+     *   consistent with the batch-level property.
+     *
+     *   Example: properties/1234
+     * @param {number[]} request.dimensions
+     *   The dimensions requested. All defined dimensions must be used by one of the
+     *   following: dimension_expression, dimension_filter, pivots, order_bys.
+     * @param {number[]} request.metrics
+     *   The metrics requested, at least one metric needs to be specified. All
+     *   defined metrics must be used by one of the following: metric_expression,
+     *   metric_filter, order_bys.
+     * @param {number[]} request.dateRanges
+     *   The date range to retrieve event data for the report. If multiple date
+     *   ranges are specified, event data from each date range is used in the
+     *   report. A special dimension with field name "dateRange" can be included in
+     *   a Pivot's field names; if included, the report compares between date
+     *   ranges. In a cohort request, this `dateRanges` must be unspecified.
+     * @param {number[]} request.pivots
+     *   Describes the visual format of the report's dimensions in columns or rows.
+     *   The union of the fieldNames (dimension names) in all pivots must be a
+     *   subset of dimension names defined in Dimensions. No two pivots can share a
+     *   dimension. A dimension is only visible if it appears in a pivot.
+     * @param {google.analytics.data.v1beta.FilterExpression} request.dimensionFilter
+     *   The filter clause of dimensions. Dimensions must be requested to be used in
+     *   this filter. Metrics cannot be used in this filter.
+     * @param {google.analytics.data.v1beta.FilterExpression} request.metricFilter
+     *   The filter clause of metrics. Applied at post aggregation phase, similar to
+     *   SQL having-clause. Metrics must be requested to be used in this filter.
+     *   Dimensions cannot be used in this filter.
+     * @param {string} request.currencyCode
+     *   A currency code in ISO4217 format, such as "AED", "USD", "JPY".
+     *   If the field is empty, the report uses the property's default currency.
+     * @param {google.analytics.data.v1beta.CohortSpec} request.cohortSpec
+     *   Cohort group associated with this request. If there is a cohort group
+     *   in the request the 'cohort' dimension must be present.
+     * @param {boolean} request.keepEmptyRows
+     *   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.
+     * @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 [RunPivotReportResponse]{@link google.analytics.data.v1beta.RunPivotReportResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   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
+     */
+    runPivotReport(request?: protos.google.analytics.data.v1beta.IRunPivotReportRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1beta.IRunPivotReportResponse,
+        protos.google.analytics.data.v1beta.IRunPivotReportRequest | undefined,
+        {} | undefined
+    ]>;
     runPivotReport(request: protos.google.analytics.data.v1beta.IRunPivotReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IRunPivotReportResponse, protos.google.analytics.data.v1beta.IRunPivotReportRequest | null | undefined, {} | null | undefined>): void;
     runPivotReport(request: protos.google.analytics.data.v1beta.IRunPivotReportRequest, callback: Callback<protos.google.analytics.data.v1beta.IRunPivotReportResponse, protos.google.analytics.data.v1beta.IRunPivotReportRequest | null | undefined, {} | null | undefined>): void;
-    batchRunReports(request?: protos.google.analytics.data.v1beta.IBatchRunReportsRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1beta.IBatchRunReportsResponse, protos.google.analytics.data.v1beta.IBatchRunReportsRequest | undefined, {} | undefined]>;
+    /**
+     * Returns multiple reports in a batch. All reports must be for the same
+     * GA4 Property.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.property
+     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   Specified in the URL path and not the body. To learn more, see [where to
+     *   find your Property
+     *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+     *   This property must be specified for the batch. The property within
+     *   RunReportRequest may either be unspecified or consistent with this
+     *   property.
+     *
+     *   Example: properties/1234
+     * @param {number[]} request.requests
+     *   Individual requests. Each request has a separate report response. Each
+     *   batch request is allowed up to 5 requests.
+     * @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 [BatchRunReportsResponse]{@link google.analytics.data.v1beta.BatchRunReportsResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   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
+     */
+    batchRunReports(request?: protos.google.analytics.data.v1beta.IBatchRunReportsRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1beta.IBatchRunReportsResponse,
+        protos.google.analytics.data.v1beta.IBatchRunReportsRequest | undefined,
+        {} | undefined
+    ]>;
     batchRunReports(request: protos.google.analytics.data.v1beta.IBatchRunReportsRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IBatchRunReportsResponse, protos.google.analytics.data.v1beta.IBatchRunReportsRequest | null | undefined, {} | null | undefined>): void;
     batchRunReports(request: protos.google.analytics.data.v1beta.IBatchRunReportsRequest, callback: Callback<protos.google.analytics.data.v1beta.IBatchRunReportsResponse, protos.google.analytics.data.v1beta.IBatchRunReportsRequest | null | undefined, {} | null | undefined>): void;
-    batchRunPivotReports(request?: protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1beta.IBatchRunPivotReportsResponse, (protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest | undefined), {} | undefined]>;
+    /**
+     * Returns multiple pivot reports in a batch. All reports must be for the same
+     * GA4 Property.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.property
+     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   Specified in the URL path and not the body. To learn more, see [where to
+     *   find your Property
+     *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+     *   This property must be specified for the batch. The property within
+     *   RunPivotReportRequest may either be unspecified or consistent with this
+     *   property.
+     *
+     *   Example: properties/1234
+     * @param {number[]} request.requests
+     *   Individual requests. Each request has a separate pivot report response.
+     *   Each batch request is allowed up to 5 requests.
+     * @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 [BatchRunPivotReportsResponse]{@link google.analytics.data.v1beta.BatchRunPivotReportsResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   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
+     */
+    batchRunPivotReports(request?: protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1beta.IBatchRunPivotReportsResponse,
+        (protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest | undefined),
+        {} | undefined
+    ]>;
     batchRunPivotReports(request: protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IBatchRunPivotReportsResponse, protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest | null | undefined, {} | null | undefined>): void;
     batchRunPivotReports(request: protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest, callback: Callback<protos.google.analytics.data.v1beta.IBatchRunPivotReportsResponse, protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest | null | undefined, {} | null | undefined>): void;
-    getMetadata(request?: protos.google.analytics.data.v1beta.IGetMetadataRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1beta.IMetadata, protos.google.analytics.data.v1beta.IGetMetadataRequest | undefined, {} | undefined]>;
+    /**
+     * Returns metadata for dimensions and metrics available in reporting methods.
+     * Used to explore the dimensions and metrics. In this method, a Google
+     * Analytics GA4 Property Identifier is specified in the request, and
+     * the metadata response includes Custom dimensions and metrics as well as
+     * Universal metadata.
+     *
+     * For example if a custom metric with parameter name `levels_unlocked` is
+     * registered to a property, the Metadata response will contain
+     * `customEvent:levels_unlocked`. Universal metadata are dimensions and
+     * metrics applicable to any property such as `country` and `totalUsers`.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The resource name of the metadata to retrieve. This name field is
+     *   specified in the URL path and not URL parameters. Property is a numeric
+     *   Google Analytics GA4 Property identifier. To learn more, see [where to find
+     *   your Property
+     *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+     *
+     *   Example: properties/1234/metadata
+     *
+     *   Set the Property ID to 0 for dimensions and metrics common to all
+     *   properties. In this special mode, this method will not return custom
+     *   dimensions and metrics.
+     * @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 [Metadata]{@link google.analytics.data.v1beta.Metadata}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   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
+     */
+    getMetadata(request?: protos.google.analytics.data.v1beta.IGetMetadataRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1beta.IMetadata,
+        protos.google.analytics.data.v1beta.IGetMetadataRequest | undefined,
+        {} | undefined
+    ]>;
     getMetadata(request: protos.google.analytics.data.v1beta.IGetMetadataRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IMetadata, protos.google.analytics.data.v1beta.IGetMetadataRequest | null | undefined, {} | null | undefined>): void;
     getMetadata(request: protos.google.analytics.data.v1beta.IGetMetadataRequest, callback: Callback<protos.google.analytics.data.v1beta.IMetadata, protos.google.analytics.data.v1beta.IGetMetadataRequest | null | undefined, {} | null | undefined>): void;
-    runRealtimeReport(request?: protos.google.analytics.data.v1beta.IRunRealtimeReportRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1beta.IRunRealtimeReportResponse, protos.google.analytics.data.v1beta.IRunRealtimeReportRequest | undefined, {} | undefined]>;
+    /**
+     * The Google Analytics Realtime API returns a customized report of realtime
+     * event data for your property. These reports show events and usage from the
+     * last 30 minutes.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.property
+     *   A Google Analytics GA4 property identifier whose events are tracked.
+     *   Specified in the URL path and not the body. To learn more, see [where to
+     *   find your Property
+     *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+     *
+     *   Example: properties/1234
+     * @param {number[]} request.dimensions
+     *   The dimensions requested and displayed.
+     * @param {number[]} request.metrics
+     *   The metrics requested and displayed.
+     * @param {google.analytics.data.v1beta.FilterExpression} request.dimensionFilter
+     *   The filter clause of dimensions. Dimensions must be requested to be used in
+     *   this filter. Metrics cannot be used in this filter.
+     * @param {google.analytics.data.v1beta.FilterExpression} request.metricFilter
+     *   The filter clause of metrics. Applied at post aggregation phase, similar to
+     *   SQL having-clause. Metrics must be requested to be used in this filter.
+     *   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
+     *   ask for. `limit` must be positive.
+     *
+     *   The API can also return fewer rows than the requested `limit`, if there
+     *   aren't as many dimension values as the `limit`. For instance, there are
+     *   fewer than 300 possible values for the dimension `country`, so when
+     *   reporting on only `country`, you can't get more than 300 rows, even if you
+     *   set `limit` to a higher value.
+     * @param {number[]} request.metricAggregations
+     *   Aggregation of metrics. Aggregated metric values will be shown in rows
+     *   where the dimension_values are set to "RESERVED_(MetricAggregation)".
+     * @param {number[]} request.orderBys
+     *   Specifies how rows are ordered in the response.
+     * @param {boolean} request.returnPropertyQuota
+     *   Toggles whether to return the current state of this Analytics Property's
+     *   Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
+     * @param {number[]} request.minuteRanges
+     *   The minute ranges of event data to read. If unspecified, one minute range
+     *   for the last 30 minutes will be used. If multiple minute ranges are
+     *   requested, each response row will contain a zero based minute range index.
+     *   If two minute ranges overlap, the event data for the overlapping minutes is
+     *   included in the response rows for both minute ranges.
+     * @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 [RunRealtimeReportResponse]{@link google.analytics.data.v1beta.RunRealtimeReportResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   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
+     */
+    runRealtimeReport(request?: protos.google.analytics.data.v1beta.IRunRealtimeReportRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1beta.IRunRealtimeReportResponse,
+        protos.google.analytics.data.v1beta.IRunRealtimeReportRequest | undefined,
+        {} | undefined
+    ]>;
     runRealtimeReport(request: protos.google.analytics.data.v1beta.IRunRealtimeReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IRunRealtimeReportResponse, protos.google.analytics.data.v1beta.IRunRealtimeReportRequest | null | undefined, {} | null | undefined>): void;
     runRealtimeReport(request: protos.google.analytics.data.v1beta.IRunRealtimeReportRequest, callback: Callback<protos.google.analytics.data.v1beta.IRunRealtimeReportResponse, protos.google.analytics.data.v1beta.IRunRealtimeReportRequest | null | undefined, {} | null | undefined>): void;
-    checkCompatibility(request?: protos.google.analytics.data.v1beta.ICheckCompatibilityRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1beta.ICheckCompatibilityResponse, (protos.google.analytics.data.v1beta.ICheckCompatibilityRequest | undefined), {} | undefined]>;
+    /**
+     * This compatibility method lists dimensions and metrics that can be added to
+     * a report request and maintain compatibility. This method fails if the
+     * request's dimensions and metrics are incompatible.
+     *
+     * In Google Analytics, reports fail if they request incompatible dimensions
+     * and/or metrics; in that case, you will need to remove dimensions and/or
+     * metrics from the incompatible report until the report is compatible.
+     *
+     * The Realtime and Core reports have different compatibility rules. This
+     * method checks compatibility for Core reports.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.property
+     *   A Google Analytics GA4 property identifier whose events are tracked. To
+     *   learn more, see [where to find your Property
+     *   ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
+     *   `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.
+     * @param {number[]} request.metrics
+     *   The metrics in this report. `metrics` should be the same value as in your
+     *   `runReport` request.
+     * @param {google.analytics.data.v1beta.FilterExpression} request.dimensionFilter
+     *   The filter clause of dimensions. `dimensionFilter` should be the same value
+     *   as in your `runReport` request.
+     * @param {google.analytics.data.v1beta.FilterExpression} request.metricFilter
+     *   The filter clause of metrics. `metricFilter` should be the same value as in
+     *   your `runReport` request
+     * @param {google.analytics.data.v1beta.Compatibility} request.compatibilityFilter
+     *   Filters the dimensions and metrics in the response to just this
+     *   compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”`
+     *   to only return compatible dimensions & metrics.
+     * @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 [CheckCompatibilityResponse]{@link google.analytics.data.v1beta.CheckCompatibilityResponse}.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   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
+     */
+    checkCompatibility(request?: protos.google.analytics.data.v1beta.ICheckCompatibilityRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1beta.ICheckCompatibilityResponse,
+        (protos.google.analytics.data.v1beta.ICheckCompatibilityRequest | undefined),
+        {} | undefined
+    ]>;
     checkCompatibility(request: protos.google.analytics.data.v1beta.ICheckCompatibilityRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.ICheckCompatibilityResponse, protos.google.analytics.data.v1beta.ICheckCompatibilityRequest | null | undefined, {} | null | undefined>): void;
     checkCompatibility(request: protos.google.analytics.data.v1beta.ICheckCompatibilityRequest, callback: Callback<protos.google.analytics.data.v1beta.ICheckCompatibilityResponse, protos.google.analytics.data.v1beta.ICheckCompatibilityRequest | null | undefined, {} | null | undefined>): void;
     /**