@maxim_mazurok/gapi.client.analyticsdata-v1beta 0.0.20230221 → 0.0.20230228

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.
Files changed (3) hide show
  1. package/index.d.ts +18 -4
  2. package/package.json +1 -1
  3. package/tests.ts +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20230221
12
+ // Revision: 20230228
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -447,7 +447,13 @@ declare namespace gapi.client {
447
447
  * types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179.
448
448
  */
449
449
  currencyCode?: string;
450
- /** If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. */
450
+ /**
451
+ * If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is
452
+ * populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the
453
+ * (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was
454
+ * present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data
455
+ * sampling](https://support.google.com/analytics/answer/13208658#reports).
456
+ */
451
457
  dataLossFromOtherRow?: boolean;
452
458
  /** If empty reason is specified, the report is empty for this reason. */
453
459
  emptyReason?: string;
@@ -488,7 +494,11 @@ declare namespace gapi.client {
488
494
  dimensionFilter?: FilterExpression;
489
495
  /** The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys. */
490
496
  dimensions?: Dimension[];
491
- /** If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. */
497
+ /**
498
+ * If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless
499
+ * of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event,
500
+ * then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0.
501
+ */
492
502
  keepEmptyRows?: boolean;
493
503
  /**
494
504
  * The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this
@@ -604,7 +614,11 @@ declare namespace gapi.client {
604
614
  dimensionFilter?: FilterExpression;
605
615
  /** The dimensions requested and displayed. */
606
616
  dimensions?: Dimension[];
607
- /** If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. */
617
+ /**
618
+ * If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless
619
+ * of this `keep_empty_rows` setting, only data recorded by the Google Analytics (GA4) property can be displayed in a report. For example if a property never logs a `purchase` event,
620
+ * then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0.
621
+ */
608
622
  keepEmptyRows?: boolean;
609
623
  /**
610
624
  * The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.analyticsdata-v1beta",
3
- "version": "0.0.20230221",
3
+ "version": "0.0.20230228",
4
4
  "description": "TypeScript typings for Google Analytics Data API v1beta",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230221
6
+ // Revision: 20230228
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */