@google-analytics/data 4.10.0 → 4.11.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 CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.11.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.10.0...data-v4.11.0) (2024-11-21)
4
+
5
+
6
+ ### Features
7
+
8
+ * [analytics-data] add `EmptyFilter` type to the Data API v1beta ([#5831](https://github.com/googleapis/google-cloud-node/issues/5831)) ([ced8054](https://github.com/googleapis/google-cloud-node/commit/ced80544ee74321deb881ee42dc5c2db05fbd0a4))
9
+
3
10
  ## [4.10.0](https://github.com/googleapis/google-cloud-node/compare/data-v4.9.0...data-v4.10.0) (2024-10-30)
4
11
 
5
12
 
@@ -71,7 +71,7 @@ service BetaAnalyticsData {
71
71
  }
72
72
 
73
73
  // Returns multiple reports in a batch. All reports must be for the same
74
- // GA4 Property.
74
+ // Google Analytics property.
75
75
  rpc BatchRunReports(BatchRunReportsRequest)
76
76
  returns (BatchRunReportsResponse) {
77
77
  option (google.api.http) = {
@@ -81,7 +81,7 @@ service BetaAnalyticsData {
81
81
  }
82
82
 
83
83
  // Returns multiple pivot reports in a batch. All reports must be for the same
84
- // GA4 Property.
84
+ // Google Analytics property.
85
85
  rpc BatchRunPivotReports(BatchRunPivotReportsRequest)
86
86
  returns (BatchRunPivotReportsResponse) {
87
87
  option (google.api.http) = {
@@ -92,7 +92,7 @@ service BetaAnalyticsData {
92
92
 
93
93
  // Returns metadata for dimensions and metrics available in reporting methods.
94
94
  // Used to explore the dimensions and metrics. In this method, a Google
95
- // Analytics GA4 Property Identifier is specified in the request, and
95
+ // Analytics property identifier is specified in the request, and
96
96
  // the metadata response includes Custom dimensions and metrics as well as
97
97
  // Universal metadata.
98
98
  //
@@ -256,7 +256,7 @@ service BetaAnalyticsData {
256
256
  // report; fields shared with the `runReport` request should be the same values
257
257
  // as in your `runReport` request.
258
258
  message CheckCompatibilityRequest {
259
- // A Google Analytics GA4 property identifier whose events are tracked. To
259
+ // A Google Analytics property identifier whose events are tracked. To
260
260
  // learn more, see [where to find your Property
261
261
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
262
262
  // `property` should be the same value as in your `runReport` request.
@@ -318,7 +318,7 @@ message Metadata {
318
318
 
319
319
  // The request to generate a report.
320
320
  message RunReportRequest {
321
- // A Google Analytics GA4 property identifier whose events are tracked.
321
+ // A Google Analytics property identifier whose events are tracked.
322
322
  // Specified in the URL path and not the body. To learn more, see [where to
323
323
  // find your Property
324
324
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -378,9 +378,13 @@ message RunReportRequest {
378
378
 
379
379
  // Aggregation of metrics. Aggregated metric values will be shown in rows
380
380
  // where the dimension_values are set to "RESERVED_(MetricAggregation)".
381
+ // Aggregates including both comparisons and multiple date ranges will
382
+ // be aggregated based on the date ranges.
381
383
  repeated MetricAggregation metric_aggregations = 9;
382
384
 
383
385
  // Specifies how rows are ordered in the response.
386
+ // Requests including both comparisons and multiple date ranges will
387
+ // have order bys applied on the comparisons.
384
388
  repeated OrderBy order_bys = 10;
385
389
 
386
390
  // A currency code in ISO4217 format, such as "AED", "USD", "JPY".
@@ -396,15 +400,15 @@ message RunReportRequest {
396
400
  // removed by a filter.
397
401
  //
398
402
  // Regardless of this `keep_empty_rows` setting, only data recorded by the
399
- // Google Analytics (GA4) property can be displayed in a report.
403
+ // Google Analytics property can be displayed in a report.
400
404
  //
401
405
  // For example if a property never logs a `purchase` event, then a query for
402
406
  // the `eventName` dimension and `eventCount` metric will not have a row
403
407
  // eventName: "purchase" and eventCount: 0.
404
408
  bool keep_empty_rows = 13;
405
409
 
406
- // Toggles whether to return the current state of this Analytics Property's
407
- // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
410
+ // Toggles whether to return the current state of this Google Analytics
411
+ // property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
408
412
  bool return_property_quota = 14;
409
413
 
410
414
  // Optional. The configuration of comparisons requested and displayed. The
@@ -448,7 +452,7 @@ message RunReportResponse {
448
452
  // Metadata for the report.
449
453
  ResponseMetaData metadata = 8;
450
454
 
451
- // This Analytics Property's quota state including this request.
455
+ // This Google Analytics property's quota state including this request.
452
456
  PropertyQuota property_quota = 9;
453
457
 
454
458
  // Identifies what kind of resource this message is. This `kind` is always the
@@ -459,7 +463,7 @@ message RunReportResponse {
459
463
 
460
464
  // The request to generate a pivot report.
461
465
  message RunPivotReportRequest {
462
- // A Google Analytics GA4 property identifier whose events are tracked.
466
+ // A Google Analytics property identifier whose events are tracked.
463
467
  // Specified in the URL path and not the body. To learn more, see [where to
464
468
  // find your Property
465
469
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -513,15 +517,15 @@ message RunPivotReportRequest {
513
517
  // removed by a filter.
514
518
  //
515
519
  // Regardless of this `keep_empty_rows` setting, only data recorded by the
516
- // Google Analytics (GA4) property can be displayed in a report.
520
+ // Google Analytics property can be displayed in a report.
517
521
  //
518
522
  // For example if a property never logs a `purchase` event, then a query for
519
523
  // the `eventName` dimension and `eventCount` metric will not have a row
520
524
  // eventName: "purchase" and eventCount: 0.
521
525
  bool keep_empty_rows = 10;
522
526
 
523
- // Toggles whether to return the current state of this Analytics Property's
524
- // quota. Quota is returned in [PropertyQuota](#PropertyQuota).
527
+ // Toggles whether to return the current state of this Google Analytics
528
+ // property's quota. Quota is returned in [PropertyQuota](#PropertyQuota).
525
529
  bool return_property_quota = 11;
526
530
 
527
531
  // Optional. The configuration of comparisons requested and displayed. The
@@ -590,7 +594,7 @@ message RunPivotReportResponse {
590
594
  // Metadata for the report.
591
595
  ResponseMetaData metadata = 6;
592
596
 
593
- // This Analytics Property's quota state including this request.
597
+ // This Google Analytics property's quota state including this request.
594
598
  PropertyQuota property_quota = 7;
595
599
 
596
600
  // Identifies what kind of resource this message is. This `kind` is always the
@@ -601,7 +605,7 @@ message RunPivotReportResponse {
601
605
 
602
606
  // The batch request containing multiple report requests.
603
607
  message BatchRunReportsRequest {
604
- // A Google Analytics GA4 property identifier whose events are tracked.
608
+ // A Google Analytics property identifier whose events are tracked.
605
609
  // Specified in the URL path and not the body. To learn more, see [where to
606
610
  // find your Property
607
611
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -630,7 +634,7 @@ message BatchRunReportsResponse {
630
634
 
631
635
  // The batch request containing multiple pivot report requests.
632
636
  message BatchRunPivotReportsRequest {
633
- // A Google Analytics GA4 property identifier whose events are tracked.
637
+ // A Google Analytics property identifier whose events are tracked.
634
638
  // Specified in the URL path and not the body. To learn more, see [where to
635
639
  // find your Property
636
640
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -661,7 +665,7 @@ message BatchRunPivotReportsResponse {
661
665
  message GetMetadataRequest {
662
666
  // Required. The resource name of the metadata to retrieve. This name field is
663
667
  // specified in the URL path and not URL parameters. Property is a numeric
664
- // Google Analytics GA4 Property identifier. To learn more, see [where to find
668
+ // Google Analytics property identifier. To learn more, see [where to find
665
669
  // your Property
666
670
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
667
671
  //
@@ -680,7 +684,7 @@ message GetMetadataRequest {
680
684
 
681
685
  // The request to generate a realtime report.
682
686
  message RunRealtimeReportRequest {
683
- // A Google Analytics GA4 property identifier whose events are tracked.
687
+ // A Google Analytics property identifier whose events are tracked.
684
688
  // Specified in the URL path and not the body. To learn more, see [where to
685
689
  // find your Property
686
690
  // ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id).
@@ -719,8 +723,9 @@ message RunRealtimeReportRequest {
719
723
  // Specifies how rows are ordered in the response.
720
724
  repeated OrderBy order_bys = 8;
721
725
 
722
- // Toggles whether to return the current state of this Analytics Property's
723
- // Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
726
+ // Toggles whether to return the current state of this Google Analytics
727
+ // property's Realtime quota. Quota is returned in
728
+ // [PropertyQuota](#PropertyQuota).
724
729
  bool return_property_quota = 9;
725
730
 
726
731
  // The minute ranges of event data to read. If unspecified, one minute range
@@ -760,7 +765,8 @@ message RunRealtimeReportResponse {
760
765
  // only 50 rows.
761
766
  int32 row_count = 7;
762
767
 
763
- // This Analytics Property's Realtime quota state including this request.
768
+ // This Google Analytics property's Realtime quota state including this
769
+ // request.
764
770
  PropertyQuota property_quota = 8;
765
771
 
766
772
  // Identifies what kind of resource this message is. This `kind` is always the
@@ -318,6 +318,9 @@ message Filter {
318
318
  NumericValue to_value = 2;
319
319
  }
320
320
 
321
+ // Filter for empty values.
322
+ message EmptyFilter {}
323
+
321
324
  // The dimension name or metric name.
322
325
  //
323
326
  // In most methods, dimensions & metrics can be used for the first time in
@@ -339,6 +342,9 @@ message Filter {
339
342
 
340
343
  // A filter for two values.
341
344
  BetweenFilter between_filter = 6;
345
+
346
+ // A filter for empty values such as "(not set)" and "" values.
347
+ EmptyFilter empty_filter = 8;
342
348
  }
343
349
  }
344
350
 
@@ -1048,8 +1054,8 @@ enum MetricType {
1048
1054
  TYPE_KILOMETERS = 13;
1049
1055
  }
1050
1056
 
1051
- // Categories of data that you may be restricted from viewing on certain GA4
1052
- // properties.
1057
+ // Categories of data that you may be restricted from viewing on certain
1058
+ // Google Analytics properties.
1053
1059
  enum RestrictedMetricType {
1054
1060
  // Unspecified type.
1055
1061
  RESTRICTED_METRIC_TYPE_UNSPECIFIED = 0;
@@ -20569,6 +20569,9 @@ export namespace google {
20569
20569
 
20570
20570
  /** Filter betweenFilter */
20571
20571
  betweenFilter?: (google.analytics.data.v1beta.Filter.IBetweenFilter|null);
20572
+
20573
+ /** Filter emptyFilter */
20574
+ emptyFilter?: (google.analytics.data.v1beta.Filter.IEmptyFilter|null);
20572
20575
  }
20573
20576
 
20574
20577
  /** Represents a Filter. */
@@ -20595,8 +20598,11 @@ export namespace google {
20595
20598
  /** Filter betweenFilter. */
20596
20599
  public betweenFilter?: (google.analytics.data.v1beta.Filter.IBetweenFilter|null);
20597
20600
 
20601
+ /** Filter emptyFilter. */
20602
+ public emptyFilter?: (google.analytics.data.v1beta.Filter.IEmptyFilter|null);
20603
+
20598
20604
  /** Filter oneFilter. */
20599
- public oneFilter?: ("stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter");
20605
+ public oneFilter?: ("stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter"|"emptyFilter");
20600
20606
 
20601
20607
  /**
20602
20608
  * Creates a new Filter instance using the specified properties.
@@ -21122,6 +21128,97 @@ export namespace google {
21122
21128
  */
21123
21129
  public static getTypeUrl(typeUrlPrefix?: string): string;
21124
21130
  }
21131
+
21132
+ /** Properties of an EmptyFilter. */
21133
+ interface IEmptyFilter {
21134
+ }
21135
+
21136
+ /** Represents an EmptyFilter. */
21137
+ class EmptyFilter implements IEmptyFilter {
21138
+
21139
+ /**
21140
+ * Constructs a new EmptyFilter.
21141
+ * @param [properties] Properties to set
21142
+ */
21143
+ constructor(properties?: google.analytics.data.v1beta.Filter.IEmptyFilter);
21144
+
21145
+ /**
21146
+ * Creates a new EmptyFilter instance using the specified properties.
21147
+ * @param [properties] Properties to set
21148
+ * @returns EmptyFilter instance
21149
+ */
21150
+ public static create(properties?: google.analytics.data.v1beta.Filter.IEmptyFilter): google.analytics.data.v1beta.Filter.EmptyFilter;
21151
+
21152
+ /**
21153
+ * Encodes the specified EmptyFilter message. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
21154
+ * @param message EmptyFilter message or plain object to encode
21155
+ * @param [writer] Writer to encode to
21156
+ * @returns Writer
21157
+ */
21158
+ public static encode(message: google.analytics.data.v1beta.Filter.IEmptyFilter, writer?: $protobuf.Writer): $protobuf.Writer;
21159
+
21160
+ /**
21161
+ * Encodes the specified EmptyFilter message, length delimited. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
21162
+ * @param message EmptyFilter message or plain object to encode
21163
+ * @param [writer] Writer to encode to
21164
+ * @returns Writer
21165
+ */
21166
+ public static encodeDelimited(message: google.analytics.data.v1beta.Filter.IEmptyFilter, writer?: $protobuf.Writer): $protobuf.Writer;
21167
+
21168
+ /**
21169
+ * Decodes an EmptyFilter message from the specified reader or buffer.
21170
+ * @param reader Reader or buffer to decode from
21171
+ * @param [length] Message length if known beforehand
21172
+ * @returns EmptyFilter
21173
+ * @throws {Error} If the payload is not a reader or valid buffer
21174
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
21175
+ */
21176
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.data.v1beta.Filter.EmptyFilter;
21177
+
21178
+ /**
21179
+ * Decodes an EmptyFilter message from the specified reader or buffer, length delimited.
21180
+ * @param reader Reader or buffer to decode from
21181
+ * @returns EmptyFilter
21182
+ * @throws {Error} If the payload is not a reader or valid buffer
21183
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
21184
+ */
21185
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.data.v1beta.Filter.EmptyFilter;
21186
+
21187
+ /**
21188
+ * Verifies an EmptyFilter message.
21189
+ * @param message Plain object to verify
21190
+ * @returns `null` if valid, otherwise the reason why it is not
21191
+ */
21192
+ public static verify(message: { [k: string]: any }): (string|null);
21193
+
21194
+ /**
21195
+ * Creates an EmptyFilter message from a plain object. Also converts values to their respective internal types.
21196
+ * @param object Plain object
21197
+ * @returns EmptyFilter
21198
+ */
21199
+ public static fromObject(object: { [k: string]: any }): google.analytics.data.v1beta.Filter.EmptyFilter;
21200
+
21201
+ /**
21202
+ * Creates a plain object from an EmptyFilter message. Also converts values to other types if specified.
21203
+ * @param message EmptyFilter
21204
+ * @param [options] Conversion options
21205
+ * @returns Plain object
21206
+ */
21207
+ public static toObject(message: google.analytics.data.v1beta.Filter.EmptyFilter, options?: $protobuf.IConversionOptions): { [k: string]: any };
21208
+
21209
+ /**
21210
+ * Converts this EmptyFilter to JSON.
21211
+ * @returns JSON object
21212
+ */
21213
+ public toJSON(): { [k: string]: any };
21214
+
21215
+ /**
21216
+ * Gets the default type url for EmptyFilter
21217
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
21218
+ * @returns The default type url
21219
+ */
21220
+ public static getTypeUrl(typeUrlPrefix?: string): string;
21221
+ }
21125
21222
  }
21126
21223
 
21127
21224
  /** Properties of an OrderBy. */
@@ -54015,6 +54015,7 @@
54015
54015
  * @property {google.analytics.data.v1beta.Filter.IInListFilter|null} [inListFilter] Filter inListFilter
54016
54016
  * @property {google.analytics.data.v1beta.Filter.INumericFilter|null} [numericFilter] Filter numericFilter
54017
54017
  * @property {google.analytics.data.v1beta.Filter.IBetweenFilter|null} [betweenFilter] Filter betweenFilter
54018
+ * @property {google.analytics.data.v1beta.Filter.IEmptyFilter|null} [emptyFilter] Filter emptyFilter
54018
54019
  */
54019
54020
 
54020
54021
  /**
@@ -54072,17 +54073,25 @@
54072
54073
  */
54073
54074
  Filter.prototype.betweenFilter = null;
54074
54075
 
54076
+ /**
54077
+ * Filter emptyFilter.
54078
+ * @member {google.analytics.data.v1beta.Filter.IEmptyFilter|null|undefined} emptyFilter
54079
+ * @memberof google.analytics.data.v1beta.Filter
54080
+ * @instance
54081
+ */
54082
+ Filter.prototype.emptyFilter = null;
54083
+
54075
54084
  // OneOf field names bound to virtual getters and setters
54076
54085
  var $oneOfFields;
54077
54086
 
54078
54087
  /**
54079
54088
  * Filter oneFilter.
54080
- * @member {"stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter"|undefined} oneFilter
54089
+ * @member {"stringFilter"|"inListFilter"|"numericFilter"|"betweenFilter"|"emptyFilter"|undefined} oneFilter
54081
54090
  * @memberof google.analytics.data.v1beta.Filter
54082
54091
  * @instance
54083
54092
  */
54084
54093
  Object.defineProperty(Filter.prototype, "oneFilter", {
54085
- get: $util.oneOfGetter($oneOfFields = ["stringFilter", "inListFilter", "numericFilter", "betweenFilter"]),
54094
+ get: $util.oneOfGetter($oneOfFields = ["stringFilter", "inListFilter", "numericFilter", "betweenFilter", "emptyFilter"]),
54086
54095
  set: $util.oneOfSetter($oneOfFields)
54087
54096
  });
54088
54097
 
@@ -54120,6 +54129,8 @@
54120
54129
  $root.google.analytics.data.v1beta.Filter.NumericFilter.encode(message.numericFilter, writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim();
54121
54130
  if (message.betweenFilter != null && Object.hasOwnProperty.call(message, "betweenFilter"))
54122
54131
  $root.google.analytics.data.v1beta.Filter.BetweenFilter.encode(message.betweenFilter, writer.uint32(/* id 6, wireType 2 =*/50).fork()).ldelim();
54132
+ if (message.emptyFilter != null && Object.hasOwnProperty.call(message, "emptyFilter"))
54133
+ $root.google.analytics.data.v1beta.Filter.EmptyFilter.encode(message.emptyFilter, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim();
54123
54134
  return writer;
54124
54135
  };
54125
54136
 
@@ -54174,6 +54185,10 @@
54174
54185
  message.betweenFilter = $root.google.analytics.data.v1beta.Filter.BetweenFilter.decode(reader, reader.uint32());
54175
54186
  break;
54176
54187
  }
54188
+ case 8: {
54189
+ message.emptyFilter = $root.google.analytics.data.v1beta.Filter.EmptyFilter.decode(reader, reader.uint32());
54190
+ break;
54191
+ }
54177
54192
  default:
54178
54193
  reader.skipType(tag & 7);
54179
54194
  break;
@@ -54251,6 +54266,16 @@
54251
54266
  return "betweenFilter." + error;
54252
54267
  }
54253
54268
  }
54269
+ if (message.emptyFilter != null && message.hasOwnProperty("emptyFilter")) {
54270
+ if (properties.oneFilter === 1)
54271
+ return "oneFilter: multiple values";
54272
+ properties.oneFilter = 1;
54273
+ {
54274
+ var error = $root.google.analytics.data.v1beta.Filter.EmptyFilter.verify(message.emptyFilter);
54275
+ if (error)
54276
+ return "emptyFilter." + error;
54277
+ }
54278
+ }
54254
54279
  return null;
54255
54280
  };
54256
54281
 
@@ -54288,6 +54313,11 @@
54288
54313
  throw TypeError(".google.analytics.data.v1beta.Filter.betweenFilter: object expected");
54289
54314
  message.betweenFilter = $root.google.analytics.data.v1beta.Filter.BetweenFilter.fromObject(object.betweenFilter);
54290
54315
  }
54316
+ if (object.emptyFilter != null) {
54317
+ if (typeof object.emptyFilter !== "object")
54318
+ throw TypeError(".google.analytics.data.v1beta.Filter.emptyFilter: object expected");
54319
+ message.emptyFilter = $root.google.analytics.data.v1beta.Filter.EmptyFilter.fromObject(object.emptyFilter);
54320
+ }
54291
54321
  return message;
54292
54322
  };
54293
54323
 
@@ -54328,6 +54358,11 @@
54328
54358
  if (options.oneofs)
54329
54359
  object.oneFilter = "betweenFilter";
54330
54360
  }
54361
+ if (message.emptyFilter != null && message.hasOwnProperty("emptyFilter")) {
54362
+ object.emptyFilter = $root.google.analytics.data.v1beta.Filter.EmptyFilter.toObject(message.emptyFilter, options);
54363
+ if (options.oneofs)
54364
+ object.oneFilter = "emptyFilter";
54365
+ }
54331
54366
  return object;
54332
54367
  };
54333
54368
 
@@ -55448,6 +55483,181 @@
55448
55483
  return BetweenFilter;
55449
55484
  })();
55450
55485
 
55486
+ Filter.EmptyFilter = (function() {
55487
+
55488
+ /**
55489
+ * Properties of an EmptyFilter.
55490
+ * @memberof google.analytics.data.v1beta.Filter
55491
+ * @interface IEmptyFilter
55492
+ */
55493
+
55494
+ /**
55495
+ * Constructs a new EmptyFilter.
55496
+ * @memberof google.analytics.data.v1beta.Filter
55497
+ * @classdesc Represents an EmptyFilter.
55498
+ * @implements IEmptyFilter
55499
+ * @constructor
55500
+ * @param {google.analytics.data.v1beta.Filter.IEmptyFilter=} [properties] Properties to set
55501
+ */
55502
+ function EmptyFilter(properties) {
55503
+ if (properties)
55504
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
55505
+ if (properties[keys[i]] != null)
55506
+ this[keys[i]] = properties[keys[i]];
55507
+ }
55508
+
55509
+ /**
55510
+ * Creates a new EmptyFilter instance using the specified properties.
55511
+ * @function create
55512
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55513
+ * @static
55514
+ * @param {google.analytics.data.v1beta.Filter.IEmptyFilter=} [properties] Properties to set
55515
+ * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter instance
55516
+ */
55517
+ EmptyFilter.create = function create(properties) {
55518
+ return new EmptyFilter(properties);
55519
+ };
55520
+
55521
+ /**
55522
+ * Encodes the specified EmptyFilter message. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
55523
+ * @function encode
55524
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55525
+ * @static
55526
+ * @param {google.analytics.data.v1beta.Filter.IEmptyFilter} message EmptyFilter message or plain object to encode
55527
+ * @param {$protobuf.Writer} [writer] Writer to encode to
55528
+ * @returns {$protobuf.Writer} Writer
55529
+ */
55530
+ EmptyFilter.encode = function encode(message, writer) {
55531
+ if (!writer)
55532
+ writer = $Writer.create();
55533
+ return writer;
55534
+ };
55535
+
55536
+ /**
55537
+ * Encodes the specified EmptyFilter message, length delimited. Does not implicitly {@link google.analytics.data.v1beta.Filter.EmptyFilter.verify|verify} messages.
55538
+ * @function encodeDelimited
55539
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55540
+ * @static
55541
+ * @param {google.analytics.data.v1beta.Filter.IEmptyFilter} message EmptyFilter message or plain object to encode
55542
+ * @param {$protobuf.Writer} [writer] Writer to encode to
55543
+ * @returns {$protobuf.Writer} Writer
55544
+ */
55545
+ EmptyFilter.encodeDelimited = function encodeDelimited(message, writer) {
55546
+ return this.encode(message, writer).ldelim();
55547
+ };
55548
+
55549
+ /**
55550
+ * Decodes an EmptyFilter message from the specified reader or buffer.
55551
+ * @function decode
55552
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55553
+ * @static
55554
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
55555
+ * @param {number} [length] Message length if known beforehand
55556
+ * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter
55557
+ * @throws {Error} If the payload is not a reader or valid buffer
55558
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
55559
+ */
55560
+ EmptyFilter.decode = function decode(reader, length) {
55561
+ if (!(reader instanceof $Reader))
55562
+ reader = $Reader.create(reader);
55563
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.analytics.data.v1beta.Filter.EmptyFilter();
55564
+ while (reader.pos < end) {
55565
+ var tag = reader.uint32();
55566
+ switch (tag >>> 3) {
55567
+ default:
55568
+ reader.skipType(tag & 7);
55569
+ break;
55570
+ }
55571
+ }
55572
+ return message;
55573
+ };
55574
+
55575
+ /**
55576
+ * Decodes an EmptyFilter message from the specified reader or buffer, length delimited.
55577
+ * @function decodeDelimited
55578
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55579
+ * @static
55580
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
55581
+ * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter
55582
+ * @throws {Error} If the payload is not a reader or valid buffer
55583
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
55584
+ */
55585
+ EmptyFilter.decodeDelimited = function decodeDelimited(reader) {
55586
+ if (!(reader instanceof $Reader))
55587
+ reader = new $Reader(reader);
55588
+ return this.decode(reader, reader.uint32());
55589
+ };
55590
+
55591
+ /**
55592
+ * Verifies an EmptyFilter message.
55593
+ * @function verify
55594
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55595
+ * @static
55596
+ * @param {Object.<string,*>} message Plain object to verify
55597
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
55598
+ */
55599
+ EmptyFilter.verify = function verify(message) {
55600
+ if (typeof message !== "object" || message === null)
55601
+ return "object expected";
55602
+ return null;
55603
+ };
55604
+
55605
+ /**
55606
+ * Creates an EmptyFilter message from a plain object. Also converts values to their respective internal types.
55607
+ * @function fromObject
55608
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55609
+ * @static
55610
+ * @param {Object.<string,*>} object Plain object
55611
+ * @returns {google.analytics.data.v1beta.Filter.EmptyFilter} EmptyFilter
55612
+ */
55613
+ EmptyFilter.fromObject = function fromObject(object) {
55614
+ if (object instanceof $root.google.analytics.data.v1beta.Filter.EmptyFilter)
55615
+ return object;
55616
+ return new $root.google.analytics.data.v1beta.Filter.EmptyFilter();
55617
+ };
55618
+
55619
+ /**
55620
+ * Creates a plain object from an EmptyFilter message. Also converts values to other types if specified.
55621
+ * @function toObject
55622
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55623
+ * @static
55624
+ * @param {google.analytics.data.v1beta.Filter.EmptyFilter} message EmptyFilter
55625
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
55626
+ * @returns {Object.<string,*>} Plain object
55627
+ */
55628
+ EmptyFilter.toObject = function toObject() {
55629
+ return {};
55630
+ };
55631
+
55632
+ /**
55633
+ * Converts this EmptyFilter to JSON.
55634
+ * @function toJSON
55635
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55636
+ * @instance
55637
+ * @returns {Object.<string,*>} JSON object
55638
+ */
55639
+ EmptyFilter.prototype.toJSON = function toJSON() {
55640
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
55641
+ };
55642
+
55643
+ /**
55644
+ * Gets the default type url for EmptyFilter
55645
+ * @function getTypeUrl
55646
+ * @memberof google.analytics.data.v1beta.Filter.EmptyFilter
55647
+ * @static
55648
+ * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
55649
+ * @returns {string} The default type url
55650
+ */
55651
+ EmptyFilter.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
55652
+ if (typeUrlPrefix === undefined) {
55653
+ typeUrlPrefix = "type.googleapis.com";
55654
+ }
55655
+ return typeUrlPrefix + "/google.analytics.data.v1beta.Filter.EmptyFilter";
55656
+ };
55657
+
55658
+ return EmptyFilter;
55659
+ })();
55660
+
55451
55661
  return Filter;
55452
55662
  })();
55453
55663
 
@@ -5354,7 +5354,8 @@
5354
5354
  "stringFilter",
5355
5355
  "inListFilter",
5356
5356
  "numericFilter",
5357
- "betweenFilter"
5357
+ "betweenFilter",
5358
+ "emptyFilter"
5358
5359
  ]
5359
5360
  }
5360
5361
  },
@@ -5378,6 +5379,10 @@
5378
5379
  "betweenFilter": {
5379
5380
  "type": "BetweenFilter",
5380
5381
  "id": 6
5382
+ },
5383
+ "emptyFilter": {
5384
+ "type": "EmptyFilter",
5385
+ "id": 8
5381
5386
  }
5382
5387
  },
5383
5388
  "nested": {
@@ -5458,6 +5463,9 @@
5458
5463
  "id": 2
5459
5464
  }
5460
5465
  }
5466
+ },
5467
+ "EmptyFilter": {
5468
+ "fields": {}
5461
5469
  }
5462
5470
  }
5463
5471
  },
@@ -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 GA4 property identifier whose events are tracked.
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 (GA4) property can be displayed in a report.
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 Property's
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 GA4 property identifier whose events are tracked.
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 (GA4) property can be displayed in a report.
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 Property's
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
- * GA4 Property.
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 GA4 property identifier whose events are tracked.
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
- * GA4 Property.
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 GA4 property identifier whose events are tracked.
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 GA4 Property Identifier is specified in the request, and
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 GA4 Property identifier. To learn more, see [where to find
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 GA4 property identifier whose events are tracked.
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 Property's
469
- * Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
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 GA4 property identifier whose events are tracked. To
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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google-analytics/data",
3
- "version": "4.10.0",
3
+ "version": "4.11.0",
4
4
  "description": "Data client for Node.js",
5
5
  "repository": {
6
6
  "type": "git",