@google-analytics/data 4.0.0 → 4.1.0

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

@@ -57,8 +57,7 @@ export declare class AlphaAnalyticsDataClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     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
@@ -66,7 +65,7 @@ export declare class AlphaAnalyticsDataClient {
      *     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);
+     *     const client = new AlphaAnalyticsDataClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
@@ -128,66 +127,67 @@ export declare class AlphaAnalyticsDataClient {
      *
      * @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
+     * @param {string} [request.property]
+     *   Optional. 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`,
+     * @param {number[]} [request.dateRanges]
+     *   Optional. 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]
+     *   Optional. The configuration of this request's funnel. This funnel
+     *   configuration is required.
+     * @param {google.analytics.data.v1alpha.FunnelBreakdown} [request.funnelBreakdown]
+     *   Optional. 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 (for example
-     *   `session_start` & `click`) and the total.
+     * @param {google.analytics.data.v1alpha.FunnelNextAction} [request.funnelNextAction]
+     *   Optional. 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
+     *   (for example `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.
+     * @param {google.analytics.data.v1alpha.RunFunnelReportRequest.FunnelVisualizationType} [request.funnelVisualizationType]
+     *   Optional. 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]
+     *   Optional. 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 250,000 rows per request, no matter how many you
-     *   ask for. `limit` must be positive.
+     * @param {number} [request.limit]
+     *   Optional. The number of rows to return. If unspecified, 10,000 rows are
+     *   returned. The 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
      *   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
+     * @param {google.analytics.data.v1alpha.FilterExpression} [request.dimensionFilter]
+     *   Optional. 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 {boolean} [request.returnPropertyQuota]
+     *   Optional. 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.
@@ -208,19 +208,31 @@ export declare class AlphaAnalyticsDataClient {
      * Retrieves an audience list of users. After creating an audience, the users
      * are not immediately available for listing. First, a request to
      * `CreateAudienceList` is necessary to create an audience list of users, and
-     * then second, this method is used to retrieve the users in the audience.
+     * then second, this method is used to retrieve the users in the audience
+     * list.
+     *
+     * See [Creating an Audience
+     * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+     * for an introduction to Audience Lists with examples.
      *
      * Audiences in Google Analytics 4 allow you to segment your users in the ways
      * that are important to your business. To learn more, see
      * https://support.google.com/analytics/answer/9267572.
      *
+     * This method is introduced at alpha stability with the intention of
+     * gathering feedback on syntax and capabilities before entering beta. To give
+     * your feedback on this API, complete the
+     * [Google Analytics Audience Export API
+     * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+     *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.name
-     *   The name of the audience list to retrieve users from.
-     *   Format: `properties/{propertyId}/audienceLists/{audienceListId}`
-     * @param {number} request.offset
-     *   The row count of the start row. The first row is counted as row 0.
+     *   Required. The name of the audience list to retrieve users from.
+     *   Format: `properties/{property}/audienceLists/{audience_list}`
+     * @param {number} [request.offset]
+     *   Optional. 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
@@ -229,10 +241,10 @@ export declare class AlphaAnalyticsDataClient {
      *
      *   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 250,000 rows per request, no matter how many you
-     *   ask for. `limit` must be positive.
+     * @param {number} [request.limit]
+     *   Optional. The number of rows to return. If unspecified, 10,000 rows are
+     *   returned. The 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
      *   aren't as many dimension values as the `limit`.
@@ -255,15 +267,88 @@ export declare class AlphaAnalyticsDataClient {
     ]>;
     queryAudienceList(request: protos.google.analytics.data.v1alpha.IQueryAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IQueryAudienceListResponse, protos.google.analytics.data.v1alpha.IQueryAudienceListRequest | null | undefined, {} | null | undefined>): void;
     queryAudienceList(request: protos.google.analytics.data.v1alpha.IQueryAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.IQueryAudienceListResponse, protos.google.analytics.data.v1alpha.IQueryAudienceListRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Exports an audience list of users to a Google Sheet. After creating an
+     * audience, the users are not immediately available for listing. First, a
+     * request to `CreateAudienceList` is necessary to create an audience list of
+     * users, and then second, this method is used to export those users in the
+     * audience list to a Google Sheet.
+     *
+     * See [Creating an Audience
+     * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+     * for an introduction to Audience Lists with examples.
+     *
+     * Audiences in Google Analytics 4 allow you to segment your users in the ways
+     * that are important to your business. To learn more, see
+     * https://support.google.com/analytics/answer/9267572.
+     *
+     * This method is introduced at alpha stability with the intention of
+     * gathering feedback on syntax and capabilities before entering beta. To give
+     * your feedback on this API, complete the
+     * [Google Analytics Audience Export API
+     * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. The name of the audience list to retrieve users from.
+     *   Format: `properties/{property}/audienceLists/{audience_list}`
+     * @param {number} [request.offset]
+     *   Optional. 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]
+     *   Optional. The number of rows to return. If unspecified, 10,000 rows are
+     *   returned. The 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
+     *   aren't as many dimension values as the `limit`.
+     *
+     *   To learn more about this pagination parameter, see
+     *   [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
+     * @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 protos.google.analytics.data.v1alpha.SheetExportAudienceListResponse|SheetExportAudienceListResponse}.
+     *   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.sheet_export_audience_list.js</caption>
+     * region_tag:analyticsdata_v1alpha_generated_AlphaAnalyticsData_SheetExportAudienceList_async
+     */
+    sheetExportAudienceList(request?: protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest, options?: CallOptions): Promise<[
+        protos.google.analytics.data.v1alpha.ISheetExportAudienceListResponse,
+        (protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest | undefined),
+        {} | undefined
+    ]>;
+    sheetExportAudienceList(request: protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.ISheetExportAudienceListResponse, protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest | null | undefined, {} | null | undefined>): void;
+    sheetExportAudienceList(request: protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest, callback: Callback<protos.google.analytics.data.v1alpha.ISheetExportAudienceListResponse, protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Gets configuration metadata about a specific audience list. This method
      * can be used to understand an audience list after it has been created.
      *
+     * See [Creating an Audience
+     * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+     * for an introduction to Audience Lists with examples.
+     *
+     * This method is introduced at alpha stability with the intention of
+     * gathering feedback on syntax and capabilities before entering beta. To give
+     * your feedback on this API, complete the
+     * [Google Analytics Audience Export API
+     * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+     *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.name
      *   Required. The audience list resource name.
-     *   Format: `properties/{propertyId}/audienceLists/{audienceListId}`
+     *   Format: `properties/{property}/audienceLists/{audience_list}`
      * @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.
@@ -287,6 +372,10 @@ export declare class AlphaAnalyticsDataClient {
      * first create the audience list through this method and then send the
      * audience resource name to the `QueryAudienceList` method.
      *
+     * See [Creating an Audience
+     * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+     * for an introduction to Audience Lists with examples.
+     *
      * An audience list is a snapshot of the users currently in the audience at
      * the time of audience list creation. Creating audience lists for one
      * audience on different days will return different results as users enter and
@@ -297,11 +386,17 @@ export declare class AlphaAnalyticsDataClient {
      * https://support.google.com/analytics/answer/9267572. Audience lists contain
      * the users in each audience.
      *
+     * This method is introduced at alpha stability with the intention of
+     * gathering feedback on syntax and capabilities before entering beta. To give
+     * your feedback on this API, complete the
+     * [Google Analytics Audience Export API
+     * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+     *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
      *   Required. The parent resource where this audience list will be created.
-     *   Format: `properties/{propertyId}`
+     *   Format: `properties/{property}`
      * @param {google.analytics.data.v1alpha.AudienceList} request.audienceList
      *   Required. The audience list to create.
      * @param {object} [options]
@@ -340,19 +435,29 @@ export declare class AlphaAnalyticsDataClient {
      * audience lists. The same audience can have multiple audience lists that
      * represent the list of users that were in an audience on different days.
      *
+     * See [Creating an Audience
+     * List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
+     * for an introduction to Audience Lists with examples.
+     *
+     * This method is introduced at alpha stability with the intention of
+     * gathering feedback on syntax and capabilities before entering beta. To give
+     * your feedback on this API, complete the
+     * [Google Analytics Audience Export API
+     * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
+     *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
      *   Required. All audience lists for this property will be listed in the
-     *   response. Format: `properties/{propertyId}`
-     * @param {number} request.pageSize
-     *   The maximum number of audience lists to return. The service may return
-     *   fewer than this value. If unspecified, at most 200 audience lists will be
-     *   returned. The maximum value is 1000 (higher values will be coerced to the
-     *   maximum).
-     * @param {string} request.pageToken
-     *   A page token, received from a previous `ListAudienceLists` call. Provide
-     *   this to retrieve the subsequent page.
+     *   response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of audience lists to return. The service may
+     *   return fewer than this value. If unspecified, at most 200 audience lists
+     *   will be returned. The maximum value is 1000 (higher values will be coerced
+     *   to the maximum).
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListAudienceLists` call.
+     *   Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to `ListAudienceLists` must
      *   match the call that provided the page token.
@@ -381,15 +486,15 @@ export declare class AlphaAnalyticsDataClient {
      *   The request object that will be sent.
      * @param {string} request.parent
      *   Required. All audience lists for this property will be listed in the
-     *   response. Format: `properties/{propertyId}`
-     * @param {number} request.pageSize
-     *   The maximum number of audience lists to return. The service may return
-     *   fewer than this value. If unspecified, at most 200 audience lists will be
-     *   returned. The maximum value is 1000 (higher values will be coerced to the
-     *   maximum).
-     * @param {string} request.pageToken
-     *   A page token, received from a previous `ListAudienceLists` call. Provide
-     *   this to retrieve the subsequent page.
+     *   response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of audience lists to return. The service may
+     *   return fewer than this value. If unspecified, at most 200 audience lists
+     *   will be returned. The maximum value is 1000 (higher values will be coerced
+     *   to the maximum).
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListAudienceLists` call.
+     *   Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to `ListAudienceLists` must
      *   match the call that provided the page token.
@@ -413,15 +518,15 @@ export declare class AlphaAnalyticsDataClient {
      *   The request object that will be sent.
      * @param {string} request.parent
      *   Required. All audience lists for this property will be listed in the
-     *   response. Format: `properties/{propertyId}`
-     * @param {number} request.pageSize
-     *   The maximum number of audience lists to return. The service may return
-     *   fewer than this value. If unspecified, at most 200 audience lists will be
-     *   returned. The maximum value is 1000 (higher values will be coerced to the
-     *   maximum).
-     * @param {string} request.pageToken
-     *   A page token, received from a previous `ListAudienceLists` call. Provide
-     *   this to retrieve the subsequent page.
+     *   response. Format: `properties/{property}`
+     * @param {number} [request.pageSize]
+     *   Optional. The maximum number of audience lists to return. The service may
+     *   return fewer than this value. If unspecified, at most 200 audience lists
+     *   will be returned. The maximum value is 1000 (higher values will be coerced
+     *   to the maximum).
+     * @param {string} [request.pageToken]
+     *   Optional. A page token, received from a previous `ListAudienceLists` call.
+     *   Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to `ListAudienceLists` must
      *   match the call that provided the page token.
@@ -441,42 +546,42 @@ export declare class AlphaAnalyticsDataClient {
     /**
      * Return a fully-qualified audienceList resource name string.
      *
-     * @param {string} propertyId
-     * @param {string} audienceListId
+     * @param {string} property
+     * @param {string} audience_list
      * @returns {string} Resource name string.
      */
-    audienceListPath(propertyId: string, audienceListId: string): string;
+    audienceListPath(property: string, audienceList: string): string;
     /**
-     * Parse the propertyId from AudienceList resource.
+     * Parse the property from AudienceList resource.
      *
      * @param {string} audienceListName
      *   A fully-qualified path representing AudienceList resource.
-     * @returns {string} A string representing the propertyId.
+     * @returns {string} A string representing the property.
      */
-    matchPropertyIdFromAudienceListName(audienceListName: string): string | number;
+    matchPropertyFromAudienceListName(audienceListName: string): string | number;
     /**
-     * Parse the audienceListId from AudienceList resource.
+     * Parse the audience_list from AudienceList resource.
      *
      * @param {string} audienceListName
      *   A fully-qualified path representing AudienceList resource.
-     * @returns {string} A string representing the audienceListId.
+     * @returns {string} A string representing the audience_list.
      */
-    matchAudienceListIdFromAudienceListName(audienceListName: string): string | number;
+    matchAudienceListFromAudienceListName(audienceListName: string): string | number;
     /**
      * Return a fully-qualified property resource name string.
      *
-     * @param {string} propertyId
+     * @param {string} property
      * @returns {string} Resource name string.
      */
-    propertyPath(propertyId: string): string;
+    propertyPath(property: string): string;
     /**
-     * Parse the propertyId from Property resource.
+     * Parse the property from Property resource.
      *
      * @param {string} propertyName
      *   A fully-qualified path representing Property resource.
-     * @returns {string} A string representing the propertyId.
+     * @returns {string} A string representing the property.
      */
-    matchPropertyIdFromPropertyName(propertyName: string): string | number;
+    matchPropertyFromPropertyName(propertyName: string): string | number;
     /**
      * Terminate the gRPC channel and close the client.
      *