@google-analytics/data 4.10.0 → 4.12.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/CHANGELOG.md +14 -0
- package/build/protos/google/analytics/data/v1alpha/data.proto +18 -2
- package/build/protos/google/analytics/data/v1beta/analytics_data_api.proto +27 -21
- package/build/protos/google/analytics/data/v1beta/data.proto +8 -2
- package/build/protos/protos.d.ts +202 -2
- package/build/protos/protos.js +469 -4
- package/build/protos/protos.json +23 -2
- package/build/src/v1beta/beta_analytics_data_client.d.ts +23 -18
- package/package.json +1 -1
package/build/protos/protos.json
CHANGED
|
@@ -2878,7 +2878,8 @@
|
|
|
2878
2878
|
"stringFilter",
|
|
2879
2879
|
"inListFilter",
|
|
2880
2880
|
"numericFilter",
|
|
2881
|
-
"betweenFilter"
|
|
2881
|
+
"betweenFilter",
|
|
2882
|
+
"emptyFilter"
|
|
2882
2883
|
]
|
|
2883
2884
|
}
|
|
2884
2885
|
},
|
|
@@ -2902,6 +2903,10 @@
|
|
|
2902
2903
|
"betweenFilter": {
|
|
2903
2904
|
"type": "BetweenFilter",
|
|
2904
2905
|
"id": 5
|
|
2906
|
+
},
|
|
2907
|
+
"emptyFilter": {
|
|
2908
|
+
"type": "EmptyFilter",
|
|
2909
|
+
"id": 6
|
|
2905
2910
|
}
|
|
2906
2911
|
}
|
|
2907
2912
|
},
|
|
@@ -3039,6 +3044,9 @@
|
|
|
3039
3044
|
}
|
|
3040
3045
|
}
|
|
3041
3046
|
},
|
|
3047
|
+
"EmptyFilter": {
|
|
3048
|
+
"fields": {}
|
|
3049
|
+
},
|
|
3042
3050
|
"NumericValue": {
|
|
3043
3051
|
"oneofs": {
|
|
3044
3052
|
"oneValue": {
|
|
@@ -3193,6 +3201,11 @@
|
|
|
3193
3201
|
"options": {
|
|
3194
3202
|
"proto3_optional": true
|
|
3195
3203
|
}
|
|
3204
|
+
},
|
|
3205
|
+
"samplingMetadatas": {
|
|
3206
|
+
"rule": "repeated",
|
|
3207
|
+
"type": "SamplingMetadata",
|
|
3208
|
+
"id": 9
|
|
3196
3209
|
}
|
|
3197
3210
|
},
|
|
3198
3211
|
"nested": {
|
|
@@ -5354,7 +5367,8 @@
|
|
|
5354
5367
|
"stringFilter",
|
|
5355
5368
|
"inListFilter",
|
|
5356
5369
|
"numericFilter",
|
|
5357
|
-
"betweenFilter"
|
|
5370
|
+
"betweenFilter",
|
|
5371
|
+
"emptyFilter"
|
|
5358
5372
|
]
|
|
5359
5373
|
}
|
|
5360
5374
|
},
|
|
@@ -5378,6 +5392,10 @@
|
|
|
5378
5392
|
"betweenFilter": {
|
|
5379
5393
|
"type": "BetweenFilter",
|
|
5380
5394
|
"id": 6
|
|
5395
|
+
},
|
|
5396
|
+
"emptyFilter": {
|
|
5397
|
+
"type": "EmptyFilter",
|
|
5398
|
+
"id": 8
|
|
5381
5399
|
}
|
|
5382
5400
|
},
|
|
5383
5401
|
"nested": {
|
|
@@ -5458,6 +5476,9 @@
|
|
|
5458
5476
|
"id": 2
|
|
5459
5477
|
}
|
|
5460
5478
|
}
|
|
5479
|
+
},
|
|
5480
|
+
"EmptyFilter": {
|
|
5481
|
+
"fields": {}
|
|
5461
5482
|
}
|
|
5462
5483
|
}
|
|
5463
5484
|
},
|
|
@@ -131,7 +131,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
131
131
|
* @param {Object} request
|
|
132
132
|
* The request object that will be sent.
|
|
133
133
|
* @param {string} request.property
|
|
134
|
-
* A Google Analytics
|
|
134
|
+
* A Google Analytics property identifier whose events are tracked.
|
|
135
135
|
* Specified in the URL path and not the body. To learn more, see [where to
|
|
136
136
|
* find your Property
|
|
137
137
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
|
@@ -183,8 +183,12 @@ export declare class BetaAnalyticsDataClient {
|
|
|
183
183
|
* @param {number[]} request.metricAggregations
|
|
184
184
|
* Aggregation of metrics. Aggregated metric values will be shown in rows
|
|
185
185
|
* where the dimension_values are set to "RESERVED_(MetricAggregation)".
|
|
186
|
+
* Aggregates including both comparisons and multiple date ranges will
|
|
187
|
+
* be aggregated based on the date ranges.
|
|
186
188
|
* @param {number[]} request.orderBys
|
|
187
189
|
* Specifies how rows are ordered in the response.
|
|
190
|
+
* Requests including both comparisons and multiple date ranges will
|
|
191
|
+
* have order bys applied on the comparisons.
|
|
188
192
|
* @param {string} request.currencyCode
|
|
189
193
|
* A currency code in ISO4217 format, such as "AED", "USD", "JPY".
|
|
190
194
|
* If the field is empty, the report uses the property's default currency.
|
|
@@ -197,14 +201,14 @@ export declare class BetaAnalyticsDataClient {
|
|
|
197
201
|
* removed by a filter.
|
|
198
202
|
*
|
|
199
203
|
* Regardless of this `keep_empty_rows` setting, only data recorded by the
|
|
200
|
-
* Google Analytics
|
|
204
|
+
* Google Analytics property can be displayed in a report.
|
|
201
205
|
*
|
|
202
206
|
* For example if a property never logs a `purchase` event, then a query for
|
|
203
207
|
* the `eventName` dimension and `eventCount` metric will not have a row
|
|
204
208
|
* eventName: "purchase" and eventCount: 0.
|
|
205
209
|
* @param {boolean} request.returnPropertyQuota
|
|
206
|
-
* Toggles whether to return the current state of this Analytics
|
|
207
|
-
* quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
|
210
|
+
* Toggles whether to return the current state of this Google Analytics
|
|
211
|
+
* property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
|
208
212
|
* @param {number[]} [request.comparisons]
|
|
209
213
|
* Optional. The configuration of comparisons requested and displayed. The
|
|
210
214
|
* request only requires a comparisons field in order to receive a comparison
|
|
@@ -235,7 +239,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
235
239
|
* @param {Object} request
|
|
236
240
|
* The request object that will be sent.
|
|
237
241
|
* @param {string} request.property
|
|
238
|
-
* A Google Analytics
|
|
242
|
+
* A Google Analytics property identifier whose events are tracked.
|
|
239
243
|
* Specified in the URL path and not the body. To learn more, see [where to
|
|
240
244
|
* find your Property
|
|
241
245
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
|
@@ -280,14 +284,14 @@ export declare class BetaAnalyticsDataClient {
|
|
|
280
284
|
* removed by a filter.
|
|
281
285
|
*
|
|
282
286
|
* Regardless of this `keep_empty_rows` setting, only data recorded by the
|
|
283
|
-
* Google Analytics
|
|
287
|
+
* Google Analytics property can be displayed in a report.
|
|
284
288
|
*
|
|
285
289
|
* For example if a property never logs a `purchase` event, then a query for
|
|
286
290
|
* the `eventName` dimension and `eventCount` metric will not have a row
|
|
287
291
|
* eventName: "purchase" and eventCount: 0.
|
|
288
292
|
* @param {boolean} request.returnPropertyQuota
|
|
289
|
-
* Toggles whether to return the current state of this Analytics
|
|
290
|
-
* quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
|
293
|
+
* Toggles whether to return the current state of this Google Analytics
|
|
294
|
+
* property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
|
|
291
295
|
* @param {number[]} [request.comparisons]
|
|
292
296
|
* Optional. The configuration of comparisons requested and displayed. The
|
|
293
297
|
* request requires both a comparisons field and a comparisons dimension to
|
|
@@ -310,12 +314,12 @@ export declare class BetaAnalyticsDataClient {
|
|
|
310
314
|
runPivotReport(request: protos.google.analytics.data.v1beta.IRunPivotReportRequest, callback: Callback<protos.google.analytics.data.v1beta.IRunPivotReportResponse, protos.google.analytics.data.v1beta.IRunPivotReportRequest | null | undefined, {} | null | undefined>): void;
|
|
311
315
|
/**
|
|
312
316
|
* Returns multiple reports in a batch. All reports must be for the same
|
|
313
|
-
*
|
|
317
|
+
* Google Analytics property.
|
|
314
318
|
*
|
|
315
319
|
* @param {Object} request
|
|
316
320
|
* The request object that will be sent.
|
|
317
321
|
* @param {string} request.property
|
|
318
|
-
* A Google Analytics
|
|
322
|
+
* A Google Analytics property identifier whose events are tracked.
|
|
319
323
|
* Specified in the URL path and not the body. To learn more, see [where to
|
|
320
324
|
* find your Property
|
|
321
325
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
|
@@ -345,12 +349,12 @@ export declare class BetaAnalyticsDataClient {
|
|
|
345
349
|
batchRunReports(request: protos.google.analytics.data.v1beta.IBatchRunReportsRequest, callback: Callback<protos.google.analytics.data.v1beta.IBatchRunReportsResponse, protos.google.analytics.data.v1beta.IBatchRunReportsRequest | null | undefined, {} | null | undefined>): void;
|
|
346
350
|
/**
|
|
347
351
|
* Returns multiple pivot reports in a batch. All reports must be for the same
|
|
348
|
-
*
|
|
352
|
+
* Google Analytics property.
|
|
349
353
|
*
|
|
350
354
|
* @param {Object} request
|
|
351
355
|
* The request object that will be sent.
|
|
352
356
|
* @param {string} request.property
|
|
353
|
-
* A Google Analytics
|
|
357
|
+
* A Google Analytics property identifier whose events are tracked.
|
|
354
358
|
* Specified in the URL path and not the body. To learn more, see [where to
|
|
355
359
|
* find your Property
|
|
356
360
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
|
@@ -381,7 +385,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
381
385
|
/**
|
|
382
386
|
* Returns metadata for dimensions and metrics available in reporting methods.
|
|
383
387
|
* Used to explore the dimensions and metrics. In this method, a Google
|
|
384
|
-
* Analytics
|
|
388
|
+
* Analytics property identifier is specified in the request, and
|
|
385
389
|
* the metadata response includes Custom dimensions and metrics as well as
|
|
386
390
|
* Universal metadata.
|
|
387
391
|
*
|
|
@@ -395,7 +399,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
395
399
|
* @param {string} request.name
|
|
396
400
|
* Required. The resource name of the metadata to retrieve. This name field is
|
|
397
401
|
* specified in the URL path and not URL parameters. Property is a numeric
|
|
398
|
-
* Google Analytics
|
|
402
|
+
* Google Analytics property identifier. To learn more, see [where to find
|
|
399
403
|
* your Property
|
|
400
404
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
|
401
405
|
*
|
|
@@ -434,7 +438,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
434
438
|
* @param {Object} request
|
|
435
439
|
* The request object that will be sent.
|
|
436
440
|
* @param {string} request.property
|
|
437
|
-
* A Google Analytics
|
|
441
|
+
* A Google Analytics property identifier whose events are tracked.
|
|
438
442
|
* Specified in the URL path and not the body. To learn more, see [where to
|
|
439
443
|
* find your Property
|
|
440
444
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
|
@@ -465,8 +469,9 @@ export declare class BetaAnalyticsDataClient {
|
|
|
465
469
|
* @param {number[]} request.orderBys
|
|
466
470
|
* Specifies how rows are ordered in the response.
|
|
467
471
|
* @param {boolean} request.returnPropertyQuota
|
|
468
|
-
* Toggles whether to return the current state of this Analytics
|
|
469
|
-
* Realtime quota. Quota is returned in
|
|
472
|
+
* Toggles whether to return the current state of this Google Analytics
|
|
473
|
+
* property's Realtime quota. Quota is returned in
|
|
474
|
+
* [PropertyQuota](#PropertyQuota).
|
|
470
475
|
* @param {number[]} request.minuteRanges
|
|
471
476
|
* The minute ranges of event data to read. If unspecified, one minute range
|
|
472
477
|
* for the last 30 minutes will be used. If multiple minute ranges are
|
|
@@ -504,7 +509,7 @@ export declare class BetaAnalyticsDataClient {
|
|
|
504
509
|
* @param {Object} request
|
|
505
510
|
* The request object that will be sent.
|
|
506
511
|
* @param {string} request.property
|
|
507
|
-
* A Google Analytics
|
|
512
|
+
* A Google Analytics property identifier whose events are tracked. To
|
|
508
513
|
* learn more, see [where to find your Property
|
|
509
514
|
* ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
|
|
510
515
|
* `property` should be the same value as in your `runReport` request.
|