@google-analytics/data 3.2.2 → 4.0.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,4 +1,4 @@
1
- // Copyright 2022 Google LLC
1
+ // Copyright 2023 Google LLC
2
2
  //
3
3
  // Licensed under the Apache License, Version 2.0 (the "License");
4
4
  // you may not use this file except in compliance with the License.
@@ -21,8 +21,8 @@ option java_multiple_files = true;
21
21
  option java_outer_classname = "ReportingApiProto";
22
22
  option java_package = "com.google.analytics.data.v1beta";
23
23
 
24
- // A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests
25
- // are allowed up to 4 date ranges.
24
+ // A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`.
25
+ // Requests are allowed up to 4 date ranges.
26
26
  message DateRange {
27
27
  // The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
28
28
  // be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also
@@ -43,8 +43,8 @@ message DateRange {
43
43
  string name = 3;
44
44
  }
45
45
 
46
- // A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
47
- // endMinutesAgo. Requests are allowed up to 2 minute ranges.
46
+ // A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ...,
47
+ // `endMinutesAgo`. Requests are allowed up to 2 minute ranges.
48
48
  message MinuteRange {
49
49
  // The inclusive start minute for the query as a number of minutes before now.
50
50
  // For example, `"startMinutesAgo": 29` specifies the report should include
@@ -420,7 +420,7 @@ message Pivot {
420
420
  // single pivot requests.
421
421
  //
422
422
  // The product of the `limit` for each `pivot` in a `RunPivotReportRequest`
423
- // must not exceed 100,000. For example, a two pivot request with `limit:
423
+ // must not exceed 250,000. For example, a two pivot request with `limit:
424
424
  // 1000` in each pivot will fail because the product is `1,000,000`.
425
425
  int64 limit = 4;
426
426
 
@@ -581,6 +581,18 @@ message ResponseMetaData {
581
581
 
582
582
  // If true, indicates some buckets of dimension combinations are rolled into
583
583
  // "(other)" row. This can happen for high cardinality reports.
584
+ //
585
+ // The metadata parameter dataLossFromOtherRow is populated based on the
586
+ // aggregated data table used in the report. The parameter will be accurately
587
+ // populated regardless of the filters and limits in the report.
588
+ //
589
+ // For example, the (other) row could be dropped from the report because the
590
+ // request contains a filter on sessionSource = google. This parameter will
591
+ // still be populated if data loss from other row was present in the input
592
+ // aggregate data used to generate this report.
593
+ //
594
+ // To learn more, see [About the (other) row and data
595
+ // sampling](https://support.google.com/analytics/answer/13208658#reports).
584
596
  bool data_loss_from_other_row = 3;
585
597
 
586
598
  // Describes the schema restrictions actively enforced in creating this
@@ -739,13 +751,13 @@ message NumericValue {
739
751
  // property is exhausted, all requests to that property will return Resource
740
752
  // Exhausted errors.
741
753
  message PropertyQuota {
742
- // Standard Analytics Properties can use up to 25,000 tokens per day;
743
- // Analytics 360 Properties can use 250,000 tokens per day. Most requests
754
+ // Standard Analytics Properties can use up to 200,000 tokens per day;
755
+ // Analytics 360 Properties can use 2,000,000 tokens per day. Most requests
744
756
  // consume fewer than 10 tokens.
745
757
  QuotaStatus tokens_per_day = 1;
746
758
 
747
- // Standard Analytics Properties can use up to 5,000 tokens per hour;
748
- // Analytics 360 Properties can use 50,000 tokens per hour. An API request
759
+ // Standard Analytics Properties can use up to 40,000 tokens per hour;
760
+ // Analytics 360 Properties can use 400,000 tokens per hour. An API request
749
761
  // consumes a single number of tokens, and that number is deducted from all of
750
762
  // the hourly, daily, and per project hourly quotas.
751
763
  QuotaStatus tokens_per_hour = 2;
@@ -765,9 +777,9 @@ message PropertyQuota {
765
777
  // thresholded dimensions.
766
778
  QuotaStatus potentially_thresholded_requests_per_hour = 5;
767
779
 
768
- // Analytics Properties can use up to 25% of their tokens per project per
769
- // hour. This amounts to standard Analytics Properties can use up to 1,250
770
- // tokens per project per hour, and Analytics 360 Properties can use 12,500
780
+ // Analytics Properties can use up to 35% of their tokens per project per
781
+ // hour. This amounts to standard Analytics Properties can use up to 14,000
782
+ // tokens per project per hour, and Analytics 360 Properties can use 140,000
771
783
  // tokens per project per hour. An API request consumes a single number of
772
784
  // tokens, and that number is deducted from all of the hourly, daily, and per
773
785
  // project hourly quotas.