@google-analytics/data 5.0.0 → 5.2.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.
- package/README.md +2 -2
- package/build/protos/protos.d.ts +13 -196
- package/build/protos/protos.js +820 -625
- package/build/protos/protos.json +64 -16
- package/build/src/v1alpha/alpha_analytics_data_client.d.ts +145 -145
- package/build/src/v1alpha/alpha_analytics_data_client.js +200 -207
- package/build/src/v1beta/beta_analytics_data_client.d.ts +77 -77
- package/build/src/v1beta/beta_analytics_data_client.js +167 -158
- package/package.json +4 -4
- package/CHANGELOG.md +0 -395
|
@@ -378,7 +378,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
378
378
|
*/
|
|
379
379
|
batchRunPivotReports(request?: protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest, options?: CallOptions): Promise<[
|
|
380
380
|
protos.google.analytics.data.v1beta.IBatchRunPivotReportsResponse,
|
|
381
|
-
|
|
381
|
+
protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest | undefined,
|
|
382
382
|
{} | undefined
|
|
383
383
|
]>;
|
|
384
384
|
batchRunPivotReports(request: protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest, options: CallOptions, callback: Callback<protos.google.analytics.data.v1beta.IBatchRunPivotReportsResponse, protos.google.analytics.data.v1beta.IBatchRunPivotReportsRequest | null | undefined, {} | null | undefined>): void;
|
|
@@ -543,7 +543,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
543
543
|
*/
|
|
544
544
|
checkCompatibility(request?: protos.google.analytics.data.v1beta.ICheckCompatibilityRequest, options?: CallOptions): Promise<[
|
|
545
545
|
protos.google.analytics.data.v1beta.ICheckCompatibilityResponse,
|
|
546
|
-
|
|
546
|
+
protos.google.analytics.data.v1beta.ICheckCompatibilityRequest | undefined,
|
|
547
547
|
{} | undefined
|
|
548
548
|
]>;
|
|
549
549
|
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;
|
|
@@ -606,7 +606,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
606
606
|
*/
|
|
607
607
|
queryAudienceExport(request?: protos.google.analytics.data.v1beta.IQueryAudienceExportRequest, options?: CallOptions): Promise<[
|
|
608
608
|
protos.google.analytics.data.v1beta.IQueryAudienceExportResponse,
|
|
609
|
-
|
|
609
|
+
protos.google.analytics.data.v1beta.IQueryAudienceExportRequest | undefined,
|
|
610
610
|
{} | undefined
|
|
611
611
|
]>;
|
|
612
612
|
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;
|
|
@@ -711,50 +711,50 @@ export declare class BetaAnalyticsDataClient {
|
|
|
711
711
|
*/
|
|
712
712
|
checkCreateAudienceExportProgress(name: string): Promise<LROperation<protos.google.analytics.data.v1beta.AudienceExport, protos.google.analytics.data.v1beta.AudienceExportMetadata>>;
|
|
713
713
|
/**
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
714
|
+
* Lists all audience exports for a property. This method can be used for you
|
|
715
|
+
* to find and reuse existing audience exports rather than creating
|
|
716
|
+
* unnecessary new audience exports. The same audience can have multiple
|
|
717
|
+
* audience exports that represent the export of users that were in an
|
|
718
|
+
* audience on different days.
|
|
719
|
+
*
|
|
720
|
+
* See [Creating an Audience
|
|
721
|
+
* Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics)
|
|
722
|
+
* for an introduction to Audience Exports with examples.
|
|
723
|
+
*
|
|
724
|
+
* Audience Export APIs have some methods at alpha and other methods at beta
|
|
725
|
+
* stability. The intention is to advance methods to beta stability after some
|
|
726
|
+
* feedback and adoption. To give your feedback on this API, complete the
|
|
727
|
+
* [Google Analytics Audience Export API
|
|
728
|
+
* Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form.
|
|
729
|
+
*
|
|
730
|
+
* @param {Object} request
|
|
731
|
+
* The request object that will be sent.
|
|
732
|
+
* @param {string} request.parent
|
|
733
|
+
* Required. All audience exports for this property will be listed in the
|
|
734
|
+
* response. Format: `properties/{property}`
|
|
735
|
+
* @param {number} [request.pageSize]
|
|
736
|
+
* Optional. The maximum number of audience exports to return. The service may
|
|
737
|
+
* return fewer than this value. If unspecified, at most 200 audience exports
|
|
738
|
+
* will be returned. The maximum value is 1000 (higher values will be coerced
|
|
739
|
+
* to the maximum).
|
|
740
|
+
* @param {string} [request.pageToken]
|
|
741
|
+
* Optional. A page token, received from a previous `ListAudienceExports`
|
|
742
|
+
* call. Provide this to retrieve the subsequent page.
|
|
743
|
+
*
|
|
744
|
+
* When paginating, all other parameters provided to `ListAudienceExports`
|
|
745
|
+
* must match the call that provided the page token.
|
|
746
|
+
* @param {object} [options]
|
|
747
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
748
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
749
|
+
* The first element of the array is Array of {@link protos.google.analytics.data.v1beta.AudienceExport|AudienceExport}.
|
|
750
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
751
|
+
* times as needed and will merge results from all the pages into this array.
|
|
752
|
+
* Note that it can affect your quota.
|
|
753
|
+
* We recommend using `listAudienceExportsAsync()`
|
|
754
|
+
* method described below for async iteration which you can stop as needed.
|
|
755
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
756
|
+
* for more details and examples.
|
|
757
|
+
*/
|
|
758
758
|
listAudienceExports(request?: protos.google.analytics.data.v1beta.IListAudienceExportsRequest, options?: CallOptions): Promise<[
|
|
759
759
|
protos.google.analytics.data.v1beta.IAudienceExport[],
|
|
760
760
|
protos.google.analytics.data.v1beta.IListAudienceExportsRequest | null,
|
|
@@ -826,35 +826,35 @@ export declare class BetaAnalyticsDataClient {
|
|
|
826
826
|
*/
|
|
827
827
|
listAudienceExportsAsync(request?: protos.google.analytics.data.v1beta.IListAudienceExportsRequest, options?: CallOptions): AsyncIterable<protos.google.analytics.data.v1beta.IAudienceExport>;
|
|
828
828
|
/**
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
829
|
+
* Gets the latest state of a long-running operation. Clients can use this
|
|
830
|
+
* method to poll the operation result at intervals as recommended by the API
|
|
831
|
+
* service.
|
|
832
|
+
*
|
|
833
|
+
* @param {Object} request - The request object that will be sent.
|
|
834
|
+
* @param {string} request.name - The name of the operation resource.
|
|
835
|
+
* @param {Object=} options
|
|
836
|
+
* Optional parameters. You can override the default settings for this call,
|
|
837
|
+
* e.g, timeout, retries, paginations, etc. See {@link
|
|
838
|
+
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
|
|
839
|
+
* for the details.
|
|
840
|
+
* @param {function(?Error, ?Object)=} callback
|
|
841
|
+
* The function which will be called with the result of the API call.
|
|
842
|
+
*
|
|
843
|
+
* The second parameter to the callback is an object representing
|
|
844
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
|
845
|
+
* @return {Promise} - The promise which resolves to an array.
|
|
846
|
+
* The first element of the array is an object representing
|
|
847
|
+
* {@link google.longrunning.Operation | google.longrunning.Operation}.
|
|
848
|
+
* The promise has a method named "cancel" which cancels the ongoing API call.
|
|
849
|
+
*
|
|
850
|
+
* @example
|
|
851
|
+
* ```
|
|
852
|
+
* const client = longrunning.operationsClient();
|
|
853
|
+
* const name = '';
|
|
854
|
+
* const [response] = await client.getOperation({name});
|
|
855
|
+
* // doThingsWith(response)
|
|
856
|
+
* ```
|
|
857
|
+
*/
|
|
858
858
|
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]>;
|
|
859
859
|
/**
|
|
860
860
|
* Lists operations that match the specified filter in the request. If the
|
|
@@ -886,7 +886,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
886
886
|
* // doThingsWith(response)
|
|
887
887
|
* ```
|
|
888
888
|
*/
|
|
889
|
-
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.
|
|
889
|
+
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
|
|
890
890
|
/**
|
|
891
891
|
* Starts asynchronous cancellation on a long-running operation. The server
|
|
892
892
|
* makes a best effort to cancel the operation, but success is not
|