feat: add minute_ranges field to RunRealtimeReportRequest object which can be used to specify the time range (in minutes) for realtime report queries

Google APIs · copybara-github · commit 41b50a384825 · 2021-07-09T15:03:29.000-07:00
docs: document the increase from 8 to 9 of the number of allowed dimensions in a report query

PiperOrigin-RevId: 383930639
diff --git a/google/analytics/data/v1beta/analytics_data_api.proto b/google/analytics/data/v1beta/analytics_data_api.proto
@@ -506,6 +506,13 @@ message RunRealtimeReportRequest {
   // Toggles whether to return the current state of this Analytics Property's
   // Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota).
   bool return_property_quota = 9;
+
+  // The minute ranges of event data to read. If unspecified, one minute range
+  // for the last 30 minutes will be used. If multiple minute ranges are
+  // requested, each response row will contain a zero based minute range index.
+  // If two minute ranges overlap, the event data for the overlapping minutes is
+  // included in the response rows for both minute ranges.
+  repeated MinuteRange minute_ranges = 10;
 }
 
 // The response realtime report table corresponding to a request.
diff --git a/google/analytics/data/v1beta/data.proto b/google/analytics/data/v1beta/data.proto
@@ -43,10 +43,41 @@ message DateRange {
   string name = 3;
 }
 
+// A contiguous set of minutes: startMinutesAgo, startMinutesAgo + 1, ...,
+// endMinutesAgo. Requests are allowed up to 2 minute ranges.
+message MinuteRange {
+  // The inclusive start minute for the query as a number of minutes before now.
+  // For example, `"startMinutesAgo": 29` specifies the report should include
+  // event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`.
+  //
+  // If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics
+  // properties can request up to the last 30 minutes of event data
+  // (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to
+  // the last 60 minutes of event data (`startMinutesAgo <= 59`).
+  optional int32 start_minutes_ago = 1;
+
+  // The inclusive end minute for the query as a number of minutes before now.
+  // Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15`
+  // specifies the report should include event data from prior to 15 minutes
+  // ago.
+  //
+  // If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics
+  // properties can request any minute in the last 30 minutes of event data
+  // (`endMinutesAgo <= 29`), and 360 Analytics properties can request any
+  // minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).
+  optional int32 end_minutes_ago = 2;
+
+  // Assigns a name to this minute range. The dimension `dateRange` is valued to
+  // this name in a report response. If set, cannot begin with `date_range_` or
+  // `RESERVED_`. If not set, minute ranges are named by their zero based index
+  // in the request: `date_range_0`, `date_range_1`, etc.
+  string name = 3;
+}
+
 // Dimensions are attributes of your data. For example, the dimension city
 // indicates the city from which an event originates. Dimension values in report
 // responses are strings; for example, city could be "Paris" or "New York".
-// Requests are allowed up to 8 dimensions.
+// Requests are allowed up to 9 dimensions.
 message Dimension {
   // The name of the dimension. See the [API
   // Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
