@google-analytics/data 5.0.0 → 5.2.0

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

@@ -270,7 +270,7 @@ export declare class AlphaAnalyticsDataClient {
      */
     queryAudienceList(request?: protos.google.analytics.data.v1alpha.IQueryAudienceListRequest, options?: CallOptions): Promise<[
         protos.google.analytics.data.v1alpha.IQueryAudienceListResponse,
-        (protos.google.analytics.data.v1alpha.IQueryAudienceListRequest | undefined),
+        protos.google.analytics.data.v1alpha.IQueryAudienceListRequest | undefined,
         {} | undefined
     ]>;
     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;
@@ -333,7 +333,7 @@ export declare class AlphaAnalyticsDataClient {
      */
     sheetExportAudienceList(request?: protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest, options?: CallOptions): Promise<[
         protos.google.analytics.data.v1alpha.ISheetExportAudienceListResponse,
-        (protos.google.analytics.data.v1alpha.ISheetExportAudienceListRequest | undefined),
+        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;
@@ -411,7 +411,7 @@ export declare class AlphaAnalyticsDataClient {
      */
     createRecurringAudienceList(request?: protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest, options?: CallOptions): Promise<[
         protos.google.analytics.data.v1alpha.IRecurringAudienceList,
-        (protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest | undefined),
+        protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest | undefined,
         {} | undefined
     ]>;
     createRecurringAudienceList(request: protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.ICreateRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
@@ -446,7 +446,7 @@ export declare class AlphaAnalyticsDataClient {
      */
     getRecurringAudienceList(request?: protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, options?: CallOptions): Promise<[
         protos.google.analytics.data.v1alpha.IRecurringAudienceList,
-        (protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | undefined),
+        protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | undefined,
         {} | undefined
     ]>;
     getRecurringAudienceList(request: protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IRecurringAudienceList, protos.google.analytics.data.v1alpha.IGetRecurringAudienceListRequest | null | undefined, {} | null | undefined>): void;
@@ -471,7 +471,7 @@ export declare class AlphaAnalyticsDataClient {
      */
     getPropertyQuotasSnapshot(request?: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, options?: CallOptions): Promise<[
         protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot,
-        (protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | undefined),
+        protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | undefined,
         {} | undefined
     ]>;
     getPropertyQuotasSnapshot(request: protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1alpha.IPropertyQuotasSnapshot, protos.google.analytics.data.v1alpha.IGetPropertyQuotasSnapshotRequest | null | undefined, {} | null | undefined>): void;
@@ -669,49 +669,49 @@ export declare class AlphaAnalyticsDataClient {
      */
     checkCreateReportTaskProgress(name: string): Promise<LROperation<protos.google.analytics.data.v1alpha.ReportTask, protos.google.analytics.data.v1alpha.ReportTaskMetadata>>;
     /**
-     * Lists all audience lists for a property. This method can be used for you to
-     * find and reuse existing audience lists rather than creating unnecessary new
-     * 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 available at beta stability at
-     * [audienceExports.list](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/list).
-     * 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/{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.
-     * @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 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     */
+    * Lists all audience lists for a property. This method can be used for you to
+    * find and reuse existing audience lists rather than creating unnecessary new
+    * 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 available at beta stability at
+    * [audienceExports.list](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/list).
+    * 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/{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.
+    * @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 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 {@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<[
         protos.google.analytics.data.v1alpha.IAudienceList[],
         protos.google.analytics.data.v1alpha.IListAudienceListsRequest | null,
@@ -783,49 +783,49 @@ export declare class AlphaAnalyticsDataClient {
      */
     listAudienceListsAsync(request?: protos.google.analytics.data.v1alpha.IListAudienceListsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.data.v1alpha.IAudienceList>;
     /**
-     * Lists all recurring audience lists for a property. This method can be used
-     * for you to find and reuse existing recurring audience lists rather than
-     * creating unnecessary new recurring audience lists. The same audience can
-     * have multiple recurring audience lists that represent different dimension
-     * combinations; for example, just the dimension `deviceId` or both the
-     * dimensions `deviceId` and `userId`.
-     *
-     * 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 recurring audience lists for this property will be listed in
-     *   the response. Format: `properties/{property}`
-     * @param {number} [request.pageSize]
-     *   Optional. The maximum number of recurring audience lists to return. The
-     *   service may return fewer than this value. If unspecified, at most 200
-     *   recurring 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
-     *   `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
-     *   page.
-     *
-     *   When paginating, all other parameters provided to
-     *   `ListRecurringAudienceLists` must match the call that provided the page
-     *   token.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-     * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is Array of {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}.
-     *   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 `listRecurringAudienceListsAsync()`
-     *   method described below for async iteration which you can stop as needed.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     */
+    * Lists all recurring audience lists for a property. This method can be used
+    * for you to find and reuse existing recurring audience lists rather than
+    * creating unnecessary new recurring audience lists. The same audience can
+    * have multiple recurring audience lists that represent different dimension
+    * combinations; for example, just the dimension `deviceId` or both the
+    * dimensions `deviceId` and `userId`.
+    *
+    * 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 recurring audience lists for this property will be listed in
+    *   the response. Format: `properties/{property}`
+    * @param {number} [request.pageSize]
+    *   Optional. The maximum number of recurring audience lists to return. The
+    *   service may return fewer than this value. If unspecified, at most 200
+    *   recurring 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
+    *   `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent
+    *   page.
+    *
+    *   When paginating, all other parameters provided to
+    *   `ListRecurringAudienceLists` must match the call that provided the page
+    *   token.
+    * @param {object} [options]
+    *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+    * @returns {Promise} - The promise which resolves to an array.
+    *   The first element of the array is Array of {@link protos.google.analytics.data.v1alpha.RecurringAudienceList|RecurringAudienceList}.
+    *   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 `listRecurringAudienceListsAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
     listRecurringAudienceLists(request?: protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, options?: CallOptions): Promise<[
         protos.google.analytics.data.v1alpha.IRecurringAudienceList[],
         protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest | null,
@@ -901,30 +901,30 @@ export declare class AlphaAnalyticsDataClient {
      */
     listRecurringAudienceListsAsync(request?: protos.google.analytics.data.v1alpha.IListRecurringAudienceListsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.data.v1alpha.IRecurringAudienceList>;
     /**
-     * Lists all report tasks for a property.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.parent
-     *   Required. All report tasks for this property will be listed in the
-     *   response. Format: `properties/{property}`
-     * @param {number} [request.pageSize]
-     *   Optional. The maximum number of report tasks to return.
-     * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListReportTasks` call.
-     *   Provide this to retrieve the subsequent page.
-     * @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 protos.google.analytics.data.v1alpha.ReportTask|ReportTask}.
-     *   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 `listReportTasksAsync()`
-     *   method described below for async iteration which you can stop as needed.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     */
+    * Lists all report tasks for a property.
+    *
+    * @param {Object} request
+    *   The request object that will be sent.
+    * @param {string} request.parent
+    *   Required. All report tasks for this property will be listed in the
+    *   response. Format: `properties/{property}`
+    * @param {number} [request.pageSize]
+    *   Optional. The maximum number of report tasks to return.
+    * @param {string} [request.pageToken]
+    *   Optional. A page token, received from a previous `ListReportTasks` call.
+    *   Provide this to retrieve the subsequent page.
+    * @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 protos.google.analytics.data.v1alpha.ReportTask|ReportTask}.
+    *   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 `listReportTasksAsync()`
+    *   method described below for async iteration which you can stop as needed.
+    *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+    *   for more details and examples.
+    */
     listReportTasks(request?: protos.google.analytics.data.v1alpha.IListReportTasksRequest, options?: CallOptions): Promise<[
         protos.google.analytics.data.v1alpha.IReportTask[],
         protos.google.analytics.data.v1alpha.IListReportTasksRequest | null,
@@ -984,35 +984,35 @@ export declare class AlphaAnalyticsDataClient {
      */
     listReportTasksAsync(request?: protos.google.analytics.data.v1alpha.IListReportTasksRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.data.v1alpha.IReportTask>;
     /**
-     * Gets the latest state of a long-running operation.  Clients can use this
-     * method to poll the operation result at intervals as recommended by the API
-     * service.
-     *
-     * @param {Object} request - The request object that will be sent.
-     * @param {string} request.name - The name of the operation resource.
-     * @param {Object=} options
-     *   Optional parameters. You can override the default settings for this call,
-     *   e.g, timeout, retries, paginations, etc. See {@link
-     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
-     *   for the details.
-     * @param {function(?Error, ?Object)=} callback
-     *   The function which will be called with the result of the API call.
-     *
-     *   The second parameter to the callback is an object representing
-     *   {@link google.longrunning.Operation | google.longrunning.Operation}.
-     * @return {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing
-     * {@link google.longrunning.Operation | google.longrunning.Operation}.
-     * The promise has a method named "cancel" which cancels the ongoing API call.
-     *
-     * @example
-     * ```
-     * const client = longrunning.operationsClient();
-     * const name = '';
-     * const [response] = await client.getOperation({name});
-     * // doThingsWith(response)
-     * ```
-     */
+       * Gets the latest state of a long-running operation.  Clients can use this
+       * method to poll the operation result at intervals as recommended by the API
+       * service.
+       *
+       * @param {Object} request - The request object that will be sent.
+       * @param {string} request.name - The name of the operation resource.
+       * @param {Object=} options
+       *   Optional parameters. You can override the default settings for this call,
+       *   e.g, timeout, retries, paginations, etc. See {@link
+       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+       *   for the details.
+       * @param {function(?Error, ?Object)=} callback
+       *   The function which will be called with the result of the API call.
+       *
+       *   The second parameter to the callback is an object representing
+       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * @return {Promise} - The promise which resolves to an array.
+       *   The first element of the array is an object representing
+       * {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * The promise has a method named "cancel" which cancels the ongoing API call.
+       *
+       * @example
+       * ```
+       * const client = longrunning.operationsClient();
+       * const name = '';
+       * const [response] = await client.getOperation({name});
+       * // doThingsWith(response)
+       * ```
+       */
     getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
     /**
      * Lists operations that match the specified filter in the request. If the
@@ -1044,7 +1044,7 @@ export declare class AlphaAnalyticsDataClient {
      * // doThingsWith(response)
      * ```
      */
-    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
+    listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
     /**
      * Starts asynchronous cancellation on a long-running operation.  The server
      * makes a best effort to cancel the operation, but success is not