@google-analytics/data 4.2.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,7 @@
1
+ /// <reference types="node" />
1
2
  import type * as gax from 'google-gax';
2
- import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
3
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
4
+ import { Transform } from 'stream';
3
5
  import * as protos from '../../protos/protos';
4
6
  /**
5
7
  * Google Analytics reporting data service.
@@ -14,6 +16,8 @@ export declare class BetaAnalyticsDataClient {
14
16
  private _gaxGrpc;
15
17
  private _protos;
16
18
  private _defaults;
19
+ private _universeDomain;
20
+ private _servicePath;
17
21
  auth: gax.GoogleAuth;
18
22
  descriptors: Descriptors;
19
23
  warn: (code: string, message: string, warnType?: string) => void;
@@ -23,6 +27,7 @@ export declare class BetaAnalyticsDataClient {
23
27
  pathTemplates: {
24
28
  [name: string]: gax.PathTemplate;
25
29
  };
30
+ operationsClient: gax.OperationsClient;
26
31
  betaAnalyticsDataStub?: Promise<{
27
32
  [name: string]: Function;
28
33
  }>;
@@ -82,15 +87,22 @@ export declare class BetaAnalyticsDataClient {
82
87
  }>;
83
88
  /**
84
89
  * The DNS address for this API service.
90
+ * @deprecated Use the apiEndpoint method of the client instance.
85
91
  * @returns {string} The DNS address for this service.
86
92
  */
87
93
  static get servicePath(): string;
88
94
  /**
89
- * The DNS address for this API service - same as servicePath(),
90
- * exists for compatibility reasons.
95
+ * The DNS address for this API service - same as servicePath.
96
+ * @deprecated Use the apiEndpoint method of the client instance.
91
97
  * @returns {string} The DNS address for this service.
92
98
  */
93
99
  static get apiEndpoint(): string;
100
+ /**
101
+ * The DNS address for this API service.
102
+ * @returns {string} The DNS address for this service.
103
+ */
104
+ get apiEndpoint(): string;
105
+ get universeDomain(): string;
94
106
  /**
95
107
  * The port for this API service.
96
108
  * @returns {number} The default port for this service.
@@ -523,6 +535,427 @@ export declare class BetaAnalyticsDataClient {
523
535
  ]>;
524
536
  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;
525
537
  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;
538
+ /**
539
+ * Retrieves an audience export of users. After creating an audience, the
540
+ * users are not immediately available for exporting. First, a request to
541
+ * `CreateAudienceExport` is necessary to create an audience export of users,
542
+ * and then second, this method is used to retrieve the users in the audience
543
+ * export.
544
+ *
545
+ * See [Creating an Audience
546
+ * Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
547
+ * for an introduction to Audience Exports with examples.
548
+ *
549
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways
550
+ * that are important to your business. To learn more, see
551
+ * https://support.google.com/analytics/answer/9267572.
552
+ *
553
+ * Audience Export APIs have some methods at alpha and other methods at beta
554
+ * stability. The intention is to advance methods to beta stability after some
555
+ * feedback and adoption. To give your feedback on this API, complete the
556
+ * [Google Analytics Audience Export API
557
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
558
+ *
559
+ * @param {Object} request
560
+ * The request object that will be sent.
561
+ * @param {string} request.name
562
+ * Required. The name of the audience export to retrieve users from.
563
+ * Format: `properties/{property}/audienceExports/{audience_export}`
564
+ * @param {number} [request.offset]
565
+ * Optional. The row count of the start row. The first row is counted as row
566
+ * 0.
567
+ *
568
+ * When paging, the first request does not specify offset; or equivalently,
569
+ * sets offset to 0; the first request returns the first `limit` of rows. The
570
+ * second request sets offset to the `limit` of the first request; the second
571
+ * request returns the second `limit` of rows.
572
+ *
573
+ * To learn more about this pagination parameter, see
574
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
575
+ * @param {number} [request.limit]
576
+ * Optional. The number of rows to return. If unspecified, 10,000 rows are
577
+ * returned. The API returns a maximum of 250,000 rows per request, no matter
578
+ * how many you ask for. `limit` must be positive.
579
+ *
580
+ * The API can also return fewer rows than the requested `limit`, if there
581
+ * aren't as many dimension values as the `limit`.
582
+ *
583
+ * To learn more about this pagination parameter, see
584
+ * [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
585
+ * @param {object} [options]
586
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
587
+ * @returns {Promise} - The promise which resolves to an array.
588
+ * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.QueryAudienceExportResponse|QueryAudienceExportResponse}.
589
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
590
+ * for more details and examples.
591
+ * @example <caption>include:samples/generated/v1beta/beta_analytics_data.query_audience_export.js</caption>
592
+ * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_QueryAudienceExport_async
593
+ */
594
+ queryAudienceExport(request?: protos.google.analytics.data.v1beta.IQueryAudienceExportRequest, options?: CallOptions): Promise<[
595
+ protos.google.analytics.data.v1beta.IQueryAudienceExportResponse,
596
+ (protos.google.analytics.data.v1beta.IQueryAudienceExportRequest | undefined),
597
+ {} | undefined
598
+ ]>;
599
+ queryAudienceExport(request: protos.google.analytics.data.v1beta.IQueryAudienceExportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IQueryAudienceExportResponse, protos.google.analytics.data.v1beta.IQueryAudienceExportRequest | null | undefined, {} | null | undefined>): void;
600
+ queryAudienceExport(request: protos.google.analytics.data.v1beta.IQueryAudienceExportRequest, callback: Callback<protos.google.analytics.data.v1beta.IQueryAudienceExportResponse, protos.google.analytics.data.v1beta.IQueryAudienceExportRequest | null | undefined, {} | null | undefined>): void;
601
+ /**
602
+ * Gets configuration metadata about a specific audience export. This method
603
+ * can be used to understand an audience export after it has been created.
604
+ *
605
+ * See [Creating an Audience
606
+ * Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
607
+ * for an introduction to Audience Exports with examples.
608
+ *
609
+ * Audience Export APIs have some methods at alpha and other methods at beta
610
+ * stability. The intention is to advance methods to beta stability after some
611
+ * feedback and adoption. To give your feedback on this API, complete the
612
+ * [Google Analytics Audience Export API
613
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
614
+ *
615
+ * @param {Object} request
616
+ * The request object that will be sent.
617
+ * @param {string} request.name
618
+ * Required. The audience export resource name.
619
+ * Format: `properties/{property}/audienceExports/{audience_export}`
620
+ * @param {object} [options]
621
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
622
+ * @returns {Promise} - The promise which resolves to an array.
623
+ * The first element of the array is an object representing {@link protos.google.analytics.data.v1beta.AudienceExport|AudienceExport}.
624
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
625
+ * for more details and examples.
626
+ * @example <caption>include:samples/generated/v1beta/beta_analytics_data.get_audience_export.js</caption>
627
+ * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_GetAudienceExport_async
628
+ */
629
+ getAudienceExport(request?: protos.google.analytics.data.v1beta.IGetAudienceExportRequest, options?: CallOptions): Promise<[
630
+ protos.google.analytics.data.v1beta.IAudienceExport,
631
+ protos.google.analytics.data.v1beta.IGetAudienceExportRequest | undefined,
632
+ {} | undefined
633
+ ]>;
634
+ getAudienceExport(request: protos.google.analytics.data.v1beta.IGetAudienceExportRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IAudienceExport, protos.google.analytics.data.v1beta.IGetAudienceExportRequest | null | undefined, {} | null | undefined>): void;
635
+ getAudienceExport(request: protos.google.analytics.data.v1beta.IGetAudienceExportRequest, callback: Callback<protos.google.analytics.data.v1beta.IAudienceExport, protos.google.analytics.data.v1beta.IGetAudienceExportRequest | null | undefined, {} | null | undefined>): void;
636
+ /**
637
+ * Creates an audience export for later retrieval. This method quickly returns
638
+ * the audience export's resource name and initiates a long running
639
+ * asynchronous request to form an audience export. To export the users in an
640
+ * audience export, first create the audience export through this method and
641
+ * then send the audience resource name to the `QueryAudienceExport` method.
642
+ *
643
+ * See [Creating an Audience
644
+ * Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
645
+ * for an introduction to Audience Exports with examples.
646
+ *
647
+ * An audience export is a snapshot of the users currently in the audience at
648
+ * the time of audience export creation. Creating audience exports for one
649
+ * audience on different days will return different results as users enter and
650
+ * exit the audience.
651
+ *
652
+ * Audiences in Google Analytics 4 allow you to segment your users in the ways
653
+ * that are important to your business. To learn more, see
654
+ * https://support.google.com/analytics/answer/9267572. Audience exports
655
+ * contain the users in each audience.
656
+ *
657
+ * Audience Export APIs have some methods at alpha and other methods at beta
658
+ * stability. The intention is to advance methods to beta stability after some
659
+ * feedback and adoption. To give your feedback on this API, complete the
660
+ * [Google Analytics Audience Export API
661
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
662
+ *
663
+ * @param {Object} request
664
+ * The request object that will be sent.
665
+ * @param {string} request.parent
666
+ * Required. The parent resource where this audience export will be created.
667
+ * Format: `properties/{property}`
668
+ * @param {google.analytics.data.v1beta.AudienceExport} request.audienceExport
669
+ * Required. The audience export to create.
670
+ * @param {object} [options]
671
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
672
+ * @returns {Promise} - The promise which resolves to an array.
673
+ * The first element of the array is an object representing
674
+ * a long running operation. Its `promise()` method returns a promise
675
+ * you can `await` for.
676
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
677
+ * for more details and examples.
678
+ * @example <caption>include:samples/generated/v1beta/beta_analytics_data.create_audience_export.js</caption>
679
+ * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_CreateAudienceExport_async
680
+ */
681
+ createAudienceExport(request?: protos.google.analytics.data.v1beta.ICreateAudienceExportRequest, options?: CallOptions): Promise<[
682
+ LROperation<protos.google.analytics.data.v1beta.IAudienceExport, protos.google.analytics.data.v1beta.IAudienceExportMetadata>,
683
+ protos.google.longrunning.IOperation | undefined,
684
+ {} | undefined
685
+ ]>;
686
+ createAudienceExport(request: protos.google.analytics.data.v1beta.ICreateAudienceExportRequest, options: CallOptions, callback: Callback<LROperation<protos.google.analytics.data.v1beta.IAudienceExport, protos.google.analytics.data.v1beta.IAudienceExportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
687
+ createAudienceExport(request: protos.google.analytics.data.v1beta.ICreateAudienceExportRequest, callback: Callback<LROperation<protos.google.analytics.data.v1beta.IAudienceExport, protos.google.analytics.data.v1beta.IAudienceExportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
688
+ /**
689
+ * Check the status of the long running operation returned by `createAudienceExport()`.
690
+ * @param {String} name
691
+ * The operation name that will be passed.
692
+ * @returns {Promise} - The promise which resolves to an object.
693
+ * The decoded operation object has result and metadata field to get information from.
694
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
695
+ * for more details and examples.
696
+ * @example <caption>include:samples/generated/v1beta/beta_analytics_data.create_audience_export.js</caption>
697
+ * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_CreateAudienceExport_async
698
+ */
699
+ checkCreateAudienceExportProgress(name: string): Promise<LROperation<protos.google.analytics.data.v1beta.AudienceExport, protos.google.analytics.data.v1beta.AudienceExportMetadata>>;
700
+ /**
701
+ * Lists all audience exports for a property. This method can be used for you
702
+ * to find and reuse existing audience exports rather than creating
703
+ * unnecessary new audience exports. The same audience can have multiple
704
+ * audience exports that represent the export of users that were in an
705
+ * audience on different days.
706
+ *
707
+ * See [Creating an Audience
708
+ * Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
709
+ * for an introduction to Audience Exports with examples.
710
+ *
711
+ * Audience Export APIs have some methods at alpha and other methods at beta
712
+ * stability. The intention is to advance methods to beta stability after some
713
+ * feedback and adoption. To give your feedback on this API, complete the
714
+ * [Google Analytics Audience Export API
715
+ * Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
716
+ *
717
+ * @param {Object} request
718
+ * The request object that will be sent.
719
+ * @param {string} request.parent
720
+ * Required. All audience exports for this property will be listed in the
721
+ * response. Format: `properties/{property}`
722
+ * @param {number} [request.pageSize]
723
+ * Optional. The maximum number of audience exports to return. The service may
724
+ * return fewer than this value. If unspecified, at most 200 audience exports
725
+ * will be returned. The maximum value is 1000 (higher values will be coerced
726
+ * to the maximum).
727
+ * @param {string} [request.pageToken]
728
+ * Optional. A page token, received from a previous `ListAudienceExports`
729
+ * call. Provide this to retrieve the subsequent page.
730
+ *
731
+ * When paginating, all other parameters provided to `ListAudienceExports`
732
+ * must match the call that provided the page token.
733
+ * @param {object} [options]
734
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
735
+ * @returns {Promise} - The promise which resolves to an array.
736
+ * The first element of the array is Array of {@link protos.google.analytics.data.v1beta.AudienceExport|AudienceExport}.
737
+ * The client library will perform auto-pagination by default: it will call the API as many
738
+ * times as needed and will merge results from all the pages into this array.
739
+ * Note that it can affect your quota.
740
+ * We recommend using `listAudienceExportsAsync()`
741
+ * method described below for async iteration which you can stop as needed.
742
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
743
+ * for more details and examples.
744
+ */
745
+ listAudienceExports(request?: protos.google.analytics.data.v1beta.IListAudienceExportsRequest, options?: CallOptions): Promise<[
746
+ protos.google.analytics.data.v1beta.IAudienceExport[],
747
+ protos.google.analytics.data.v1beta.IListAudienceExportsRequest | null,
748
+ protos.google.analytics.data.v1beta.IListAudienceExportsResponse
749
+ ]>;
750
+ listAudienceExports(request: protos.google.analytics.data.v1beta.IListAudienceExportsRequest, options: CallOptions, callback: PaginationCallback<protos.google.analytics.data.v1beta.IListAudienceExportsRequest, protos.google.analytics.data.v1beta.IListAudienceExportsResponse | null | undefined, protos.google.analytics.data.v1beta.IAudienceExport>): void;
751
+ listAudienceExports(request: protos.google.analytics.data.v1beta.IListAudienceExportsRequest, callback: PaginationCallback<protos.google.analytics.data.v1beta.IListAudienceExportsRequest, protos.google.analytics.data.v1beta.IListAudienceExportsResponse | null | undefined, protos.google.analytics.data.v1beta.IAudienceExport>): void;
752
+ /**
753
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
754
+ * @param {Object} request
755
+ * The request object that will be sent.
756
+ * @param {string} request.parent
757
+ * Required. All audience exports for this property will be listed in the
758
+ * response. Format: `properties/{property}`
759
+ * @param {number} [request.pageSize]
760
+ * Optional. The maximum number of audience exports to return. The service may
761
+ * return fewer than this value. If unspecified, at most 200 audience exports
762
+ * will be returned. The maximum value is 1000 (higher values will be coerced
763
+ * to the maximum).
764
+ * @param {string} [request.pageToken]
765
+ * Optional. A page token, received from a previous `ListAudienceExports`
766
+ * call. Provide this to retrieve the subsequent page.
767
+ *
768
+ * When paginating, all other parameters provided to `ListAudienceExports`
769
+ * must match the call that provided the page token.
770
+ * @param {object} [options]
771
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
772
+ * @returns {Stream}
773
+ * An object stream which emits an object representing {@link protos.google.analytics.data.v1beta.AudienceExport|AudienceExport} on 'data' event.
774
+ * The client library will perform auto-pagination by default: it will call the API as many
775
+ * times as needed. Note that it can affect your quota.
776
+ * We recommend using `listAudienceExportsAsync()`
777
+ * method described below for async iteration which you can stop as needed.
778
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
779
+ * for more details and examples.
780
+ */
781
+ listAudienceExportsStream(request?: protos.google.analytics.data.v1beta.IListAudienceExportsRequest, options?: CallOptions): Transform;
782
+ /**
783
+ * Equivalent to `listAudienceExports`, but returns an iterable object.
784
+ *
785
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
786
+ * @param {Object} request
787
+ * The request object that will be sent.
788
+ * @param {string} request.parent
789
+ * Required. All audience exports for this property will be listed in the
790
+ * response. Format: `properties/{property}`
791
+ * @param {number} [request.pageSize]
792
+ * Optional. The maximum number of audience exports to return. The service may
793
+ * return fewer than this value. If unspecified, at most 200 audience exports
794
+ * will be returned. The maximum value is 1000 (higher values will be coerced
795
+ * to the maximum).
796
+ * @param {string} [request.pageToken]
797
+ * Optional. A page token, received from a previous `ListAudienceExports`
798
+ * call. Provide this to retrieve the subsequent page.
799
+ *
800
+ * When paginating, all other parameters provided to `ListAudienceExports`
801
+ * must match the call that provided the page token.
802
+ * @param {object} [options]
803
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
804
+ * @returns {Object}
805
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
806
+ * When you iterate the returned iterable, each element will be an object representing
807
+ * {@link protos.google.analytics.data.v1beta.AudienceExport|AudienceExport}. The API will be called under the hood as needed, once per the page,
808
+ * so you can stop the iteration when you don't need more results.
809
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
810
+ * for more details and examples.
811
+ * @example <caption>include:samples/generated/v1beta/beta_analytics_data.list_audience_exports.js</caption>
812
+ * region_tag:analyticsdata_v1beta_generated_BetaAnalyticsData_ListAudienceExports_async
813
+ */
814
+ listAudienceExportsAsync(request?: protos.google.analytics.data.v1beta.IListAudienceExportsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.data.v1beta.IAudienceExport>;
815
+ /**
816
+ * Gets the latest state of a long-running operation. Clients can use this
817
+ * method to poll the operation result at intervals as recommended by the API
818
+ * service.
819
+ *
820
+ * @param {Object} request - The request object that will be sent.
821
+ * @param {string} request.name - The name of the operation resource.
822
+ * @param {Object=} options
823
+ * Optional parameters. You can override the default settings for this call,
824
+ * e.g, timeout, retries, paginations, etc. See {@link
825
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
826
+ * for the details.
827
+ * @param {function(?Error, ?Object)=} callback
828
+ * The function which will be called with the result of the API call.
829
+ *
830
+ * The second parameter to the callback is an object representing
831
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
832
+ * @return {Promise} - The promise which resolves to an array.
833
+ * The first element of the array is an object representing
834
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
835
+ * The promise has a method named "cancel" which cancels the ongoing API call.
836
+ *
837
+ * @example
838
+ * ```
839
+ * const client = longrunning.operationsClient();
840
+ * const name = '';
841
+ * const [response] = await client.getOperation({name});
842
+ * // doThingsWith(response)
843
+ * ```
844
+ */
845
+ getOperation(request: protos.google.longrunning.GetOperationRequest, options?: 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]>;
846
+ /**
847
+ * Lists operations that match the specified filter in the request. If the
848
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
849
+ *
850
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
851
+ *
852
+ * @param {Object} request - The request object that will be sent.
853
+ * @param {string} request.name - The name of the operation collection.
854
+ * @param {string} request.filter - The standard list filter.
855
+ * @param {number=} request.pageSize -
856
+ * The maximum number of resources contained in the underlying API
857
+ * response. If page streaming is performed per-resource, this
858
+ * parameter does not affect the return value. If page streaming is
859
+ * performed per-page, this determines the maximum number of
860
+ * resources in a page.
861
+ * @param {Object=} options
862
+ * Optional parameters. You can override the default settings for this call,
863
+ * e.g, timeout, retries, paginations, etc. See {@link
864
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
865
+ * details.
866
+ * @returns {Object}
867
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
868
+ *
869
+ * @example
870
+ * ```
871
+ * const client = longrunning.operationsClient();
872
+ * for await (const response of client.listOperationsAsync(request));
873
+ * // doThingsWith(response)
874
+ * ```
875
+ */
876
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
877
+ /**
878
+ * Starts asynchronous cancellation on a long-running operation. The server
879
+ * makes a best effort to cancel the operation, but success is not
880
+ * guaranteed. If the server doesn't support this method, it returns
881
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
882
+ * {@link Operations.GetOperation} or
883
+ * other methods to check whether the cancellation succeeded or whether the
884
+ * operation completed despite cancellation. On successful cancellation,
885
+ * the operation is not deleted; instead, it becomes an operation with
886
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
887
+ * 1, corresponding to `Code.CANCELLED`.
888
+ *
889
+ * @param {Object} request - The request object that will be sent.
890
+ * @param {string} request.name - The name of the operation resource to be cancelled.
891
+ * @param {Object=} options
892
+ * Optional parameters. You can override the default settings for this call,
893
+ * e.g, timeout, retries, paginations, etc. See {@link
894
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
895
+ * details.
896
+ * @param {function(?Error)=} callback
897
+ * The function which will be called with the result of the API call.
898
+ * @return {Promise} - The promise which resolves when API call finishes.
899
+ * The promise has a method named "cancel" which cancels the ongoing API
900
+ * call.
901
+ *
902
+ * @example
903
+ * ```
904
+ * const client = longrunning.operationsClient();
905
+ * await client.cancelOperation({name: ''});
906
+ * ```
907
+ */
908
+ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
909
+ /**
910
+ * Deletes a long-running operation. This method indicates that the client is
911
+ * no longer interested in the operation result. It does not cancel the
912
+ * operation. If the server doesn't support this method, it returns
913
+ * `google.rpc.Code.UNIMPLEMENTED`.
914
+ *
915
+ * @param {Object} request - The request object that will be sent.
916
+ * @param {string} request.name - The name of the operation resource to be deleted.
917
+ * @param {Object=} options
918
+ * Optional parameters. You can override the default settings for this call,
919
+ * e.g, timeout, retries, paginations, etc. See {@link
920
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
921
+ * for the details.
922
+ * @param {function(?Error)=} callback
923
+ * The function which will be called with the result of the API call.
924
+ * @return {Promise} - The promise which resolves when API call finishes.
925
+ * The promise has a method named "cancel" which cancels the ongoing API
926
+ * call.
927
+ *
928
+ * @example
929
+ * ```
930
+ * const client = longrunning.operationsClient();
931
+ * await client.deleteOperation({name: ''});
932
+ * ```
933
+ */
934
+ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
935
+ /**
936
+ * Return a fully-qualified audienceExport resource name string.
937
+ *
938
+ * @param {string} property
939
+ * @param {string} audience_export
940
+ * @returns {string} Resource name string.
941
+ */
942
+ audienceExportPath(property: string, audienceExport: string): string;
943
+ /**
944
+ * Parse the property from AudienceExport resource.
945
+ *
946
+ * @param {string} audienceExportName
947
+ * A fully-qualified path representing AudienceExport resource.
948
+ * @returns {string} A string representing the property.
949
+ */
950
+ matchPropertyFromAudienceExportName(audienceExportName: string): string | number;
951
+ /**
952
+ * Parse the audience_export from AudienceExport resource.
953
+ *
954
+ * @param {string} audienceExportName
955
+ * A fully-qualified path representing AudienceExport resource.
956
+ * @returns {string} A string representing the audience_export.
957
+ */
958
+ matchAudienceExportFromAudienceExportName(audienceExportName: string): string | number;
526
959
  /**
527
960
  * Return a fully-qualified metadata resource name string.
528
961
  *
@@ -538,6 +971,21 @@ export declare class BetaAnalyticsDataClient {
538
971
  * @returns {string} A string representing the property.
539
972
  */
540
973
  matchPropertyFromMetadataName(metadataName: string): string | number;
974
+ /**
975
+ * Return a fully-qualified property resource name string.
976
+ *
977
+ * @param {string} property
978
+ * @returns {string} Resource name string.
979
+ */
980
+ propertyPath(property: string): string;
981
+ /**
982
+ * Parse the property from Property resource.
983
+ *
984
+ * @param {string} propertyName
985
+ * A fully-qualified path representing Property resource.
986
+ * @returns {string} A string representing the property.
987
+ */
988
+ matchPropertyFromPropertyName(propertyName: string): string | number;
541
989
  /**
542
990
  * Terminate the gRPC channel and close the client.
543
991
  *