@google-analytics/data 2.7.0 → 3.0.2

package/build/src/v1alpha/alpha_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.
@@ -20,9 +20,6 @@ export declare class AlphaAnalyticsDataClient {
     innerApiCalls: {
         [name: string]: Function;
     };
-    pathTemplates: {
-        [name: string]: gax.PathTemplate;
-    };
     alphaAnalyticsDataStub?: Promise<{
         [name: string]: Function;
     }>;
@@ -31,7 +28,7 @@ export declare class AlphaAnalyticsDataClient {
      *
      * @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 +51,19 @@ export declare class AlphaAnalyticsDataClient {
      *     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 AlphaAnalyticsDataClient({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,39 +102,97 @@ export declare class AlphaAnalyticsDataClient {
     static get scopes(): string[];
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
-    runReport(request?: protos.google.analytics.data.v1alpha.IRunReportRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1alpha.IRunReportResponse, protos.google.analytics.data.v1alpha.IRunReportRequest | undefined, {} | undefined]>;
-    runReport(request: protos.google.analytics.data.v1alpha.IRunReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRunReportResponse, protos.google.analytics.data.v1alpha.IRunReportRequest | null | undefined, {} | null | undefined>): void;
-    runReport(request: protos.google.analytics.data.v1alpha.IRunReportRequest, callback: Callback<protos.google.analytics.data.v1alpha.IRunReportResponse, protos.google.analytics.data.v1alpha.IRunReportRequest | null | undefined, {} | null | undefined>): void;
-    runPivotReport(request?: protos.google.analytics.data.v1alpha.IRunPivotReportRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1alpha.IRunPivotReportResponse, protos.google.analytics.data.v1alpha.IRunPivotReportRequest | undefined, {} | undefined]>;
-    runPivotReport(request: protos.google.analytics.data.v1alpha.IRunPivotReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRunPivotReportResponse, protos.google.analytics.data.v1alpha.IRunPivotReportRequest | null | undefined, {} | null | undefined>): void;
-    runPivotReport(request: protos.google.analytics.data.v1alpha.IRunPivotReportRequest, callback: Callback<protos.google.analytics.data.v1alpha.IRunPivotReportResponse, protos.google.analytics.data.v1alpha.IRunPivotReportRequest | null | undefined, {} | null | undefined>): void;
-    batchRunReports(request?: protos.google.analytics.data.v1alpha.IBatchRunReportsRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1alpha.IBatchRunReportsResponse, protos.google.analytics.data.v1alpha.IBatchRunReportsRequest | undefined, {} | undefined]>;
-    batchRunReports(request: protos.google.analytics.data.v1alpha.IBatchRunReportsRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IBatchRunReportsResponse, protos.google.analytics.data.v1alpha.IBatchRunReportsRequest | null | undefined, {} | null | undefined>): void;
-    batchRunReports(request: protos.google.analytics.data.v1alpha.IBatchRunReportsRequest, callback: Callback<protos.google.analytics.data.v1alpha.IBatchRunReportsResponse, protos.google.analytics.data.v1alpha.IBatchRunReportsRequest | null | undefined, {} | null | undefined>): void;
-    batchRunPivotReports(request?: protos.google.analytics.data.v1alpha.IBatchRunPivotReportsRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1alpha.IBatchRunPivotReportsResponse, (protos.google.analytics.data.v1alpha.IBatchRunPivotReportsRequest | undefined), {} | undefined]>;
-    batchRunPivotReports(request: protos.google.analytics.data.v1alpha.IBatchRunPivotReportsRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IBatchRunPivotReportsResponse, protos.google.analytics.data.v1alpha.IBatchRunPivotReportsRequest | null | undefined, {} | null | undefined>): void;
-    batchRunPivotReports(request: protos.google.analytics.data.v1alpha.IBatchRunPivotReportsRequest, callback: Callback<protos.google.analytics.data.v1alpha.IBatchRunPivotReportsResponse, protos.google.analytics.data.v1alpha.IBatchRunPivotReportsRequest | null | undefined, {} | null | undefined>): void;
-    getMetadata(request?: protos.google.analytics.data.v1alpha.IGetMetadataRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1alpha.IMetadata, protos.google.analytics.data.v1alpha.IGetMetadataRequest | undefined, {} | undefined]>;
-    getMetadata(request: protos.google.analytics.data.v1alpha.IGetMetadataRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IMetadata, protos.google.analytics.data.v1alpha.IGetMetadataRequest | null | undefined, {} | null | undefined>): void;
-    getMetadata(request: protos.google.analytics.data.v1alpha.IGetMetadataRequest, callback: Callback<protos.google.analytics.data.v1alpha.IMetadata, protos.google.analytics.data.v1alpha.IGetMetadataRequest | null | undefined, {} | null | undefined>): void;
-    runRealtimeReport(request?: protos.google.analytics.data.v1alpha.IRunRealtimeReportRequest, options?: CallOptions): Promise<[protos.google.analytics.data.v1alpha.IRunRealtimeReportResponse, (protos.google.analytics.data.v1alpha.IRunRealtimeReportRequest | undefined), {} | undefined]>;
-    runRealtimeReport(request: protos.google.analytics.data.v1alpha.IRunRealtimeReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRunRealtimeReportResponse, protos.google.analytics.data.v1alpha.IRunRealtimeReportRequest | null | undefined, {} | null | undefined>): void;
-    runRealtimeReport(request: protos.google.analytics.data.v1alpha.IRunRealtimeReportRequest, callback: Callback<protos.google.analytics.data.v1alpha.IRunRealtimeReportResponse, protos.google.analytics.data.v1alpha.IRunRealtimeReportRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * Return a fully-qualified metadata resource name string.
+     * Returns a customized funnel report of your Google Analytics event data. The
+     * data returned from the API is as a table with columns for the requested
+     * dimensions and metrics.
      *
-     * @param {string} property
-     * @returns {string} Resource name string.
-     */
-    metadataPath(property: string): string;
-    /**
-     * Parse the property from Metadata resource.
+     * Funnel exploration lets you visualize the steps your users take to complete
+     * a task and quickly see how well they are succeeding or failing at each
+     * step. For example, how do prospects become shoppers and then become buyers?
+     * How do one time buyers become repeat buyers? With this information, you can
+     * improve inefficient or abandoned customer journeys. To learn more, see [GA4
+     * Funnel Explorations](https://support.google.com/analytics/answer/9327974).
+     *
+     * @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.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.
+     * @param {google.analytics.data.v1alpha.Funnel} request.funnel
+     *   The configuration of this request's funnel. This funnel configuration is
+     *   required.
+     * @param {google.analytics.data.v1alpha.FunnelBreakdown} request.funnelBreakdown
+     *   If specified, this breakdown adds a dimension to the funnel table sub
+     *   report response. This breakdown dimension expands each funnel step to the
+     *   unique values of the breakdown dimension. For example, a breakdown by the
+     *   `deviceCategory` dimension will create rows for `mobile`, `tablet`,
+     *   `desktop`, and the total.
+     * @param {google.analytics.data.v1alpha.FunnelNextAction} request.funnelNextAction
+     *   If specified, next action adds a dimension to the funnel visualization sub
+     *   report response. This next action dimension expands each funnel step to the
+     *   unique values of the next action. For example a next action of the
+     *   `eventName` dimension will create rows for several events (i.e.
+     *   `session_start` & `click`) and the total.
+     *
+     *   Next action only supports `eventName` and most Page / Screen dimensions
+     *   like `pageTitle` and `pagePath`.
+     * @param {google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType} request.funnelVisualizationType
+     *   The funnel visualization type controls the dimensions present in the funnel
+     *   visualization sub report response. If not specified, `STANDARD_FUNNEL` is
+     *   used.
+     * @param {number[]} request.segments
+     *   The configurations of segments. Segments are subsets of a property's data.
+     *   In a funnel report with segments, the funnel is evaluated in each segment.
+     *
+     *   Each segment specified in this request
+     *   produces a separate row in the response; in the response, each segment
+     *   identified by its name.
+     *
+     *   The segments parameter is optional. Requests are limited to 4 segments.
+     * @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.
      *
-     * @param {string} metadataName
-     *   A fully-qualified path representing Metadata resource.
-     * @returns {string} A string representing the property.
+     *   The API can also return fewer rows than the requested `limit`, if there
+     *   aren't as many dimension values as the `limit`.
+     * @param {google.analytics.data.v1alpha.FilterExpression} request.dimensionFilter
+     *   Dimension filters allow you to ask for only specific dimension values in
+     *   the report. To learn more, see [Creating a Report: Dimension
+     *   Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
+     *   for examples. Metrics cannot be used in this 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 [RunFunnelReportResponse]{@link google.analytics.data.v1alpha.RunFunnelReportResponse}.
+     *   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/v1alpha/alpha_analytics_data.run_funnel_report.js</caption>
+     * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_RunFunnelReport_async
      */
-    matchPropertyFromMetadataName(metadataName: string): string | number;
+    runFunnelReport(request?: protos.google.analytics.data.v1alpha.IRunFunnelReportRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1alpha.IRunFunnelReportResponse,
+        protos.google.analytics.data.v1alpha.IRunFunnelReportRequest | undefined,
+        {} | undefined
+    ]>;
+    runFunnelReport(request: protos.google.analytics.data.v1alpha.IRunFunnelReportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRunFunnelReportResponse, protos.google.analytics.data.v1alpha.IRunFunnelReportRequest | null | undefined, {} | null | undefined>): void;
+    runFunnelReport(request: protos.google.analytics.data.v1alpha.IRunFunnelReportRequest, callback: Callback<protos.google.analytics.data.v1alpha.IRunFunnelReportResponse, protos.google.analytics.data.v1alpha.IRunFunnelReportRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Terminate the gRPC channel and close the client.
      *