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