Add RunRealtimeReportWithMinuteRanges sample and test

Author: jradcliff

google-analytics-data/src/main/java/com/example/analytics/RunRealtimeReportWithMinuteRangesSample.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.analytics;
+
+/* Google Analytics Data API sample application demonstrating the creation of
+a realtime report.
+
+See https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport
+for more information.
+
+Before you start the application, please review the comments starting with
+"TODO(developer)" and update the code to use correct values.
+
+To run this sample using Maven:
+  cd java-analytics-data/samples/snippets
+  mvn compile
+  mvn exec:java -Dexec.mainClass="com.example.analytics.RunRealtimeReportWithMultipleMetricsSample"
+ */
+
+// [START analyticsdata_run_realtime_report_with_minute_ranges]
+
+import com.google.analytics.data.v1beta.BetaAnalyticsDataClient;
+import com.google.analytics.data.v1beta.Metric;
+import com.google.analytics.data.v1beta.MinuteRange;
+import com.google.analytics.data.v1beta.RunRealtimeReportRequest;
+import com.google.analytics.data.v1beta.RunRealtimeReportResponse;
+
+public class RunRealtimeReportWithMinuteRangesSample {
+
+  public static void main(String... args) throws Exception {
+    // TODO(developer): Replace with your Google Analytics 4 property ID before running the sample.
+    String propertyId = "YOUR-GA4-PROPERTY-ID";
+    sampleRunRealtimeReportWithMinuteRanges(propertyId);
+  }
+
+  // Runs a realtime report on a Google Analytics 4 property.
+  static void sampleRunRealtimeReportWithMinuteRanges(String propertyId) throws Exception {
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests. After completing all of your requests, call
+    // the "close" method on the client to safely clean up any remaining background resources.
+    try (BetaAnalyticsDataClient analyticsData = BetaAnalyticsDataClient.create()) {
+      RunRealtimeReportRequest request =
+          RunRealtimeReportRequest.newBuilder()
+              .setProperty("properties/" + propertyId)
+              .addMetrics(Metric.newBuilder().setName(("activeUsers")))
+              .addMinuteRanges(
+                  MinuteRange.newBuilder().setName("0-4 minutes ago").setStartMinutesAgo(4))
+              .addMinuteRanges(
+                  MinuteRange.newBuilder()
+                      .setName("25-29 minutes ago")
+                      .setEndMinutesAgo(29)
+                      .setEndMinutesAgo(25))
+              .build();
+
+      // Make the request.
+      RunRealtimeReportResponse response = analyticsData.runRealtimeReport(request);
+      // Prints the response using a method in RunRealtimeReportSample.java
+      RunRealtimeReportSample.printRunRealtimeReportResponse(response);
+    }
+  }
+}
+// [END analyticsdata_run_realtime_report_with_minute_ranges]

google-analytics-data/src/test/java/com/example/analytics/RunRealtimeReportWithMinuteRangesSampleTest.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.analytics;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Tests for the RunRealtimeReportWithMinuteRanges sample. */
+@RunWith(JUnit4.class)
+public class RunRealtimeReportWithMinuteRangesSampleTest {
+
+  private String ga4PropertyId =
+      System.getProperty("analyticsdata.quickstart.ga4PropertyId", "222596558");
+
+  private String runSample(String ga4PropertyId) throws Exception {
+    PrintStream stdOut = System.out;
+    ByteArrayOutputStream bout = new ByteArrayOutputStream();
+    PrintStream out = new PrintStream(bout);
+    System.setOut(out);
+
+    // Run the test using default system credentials.
+    RunRealtimeReportWithMinuteRangesSample.sampleRunRealtimeReportWithMinuteRanges(ga4PropertyId);
+    System.setOut(stdOut);
+    return bout.toString();
+  }
+
+  @Test
+  public void testRunRealtimeReport() throws Exception {
+    // Act
+    String out = runSample(ga4PropertyId);
+
+    // Assert
+    assertThat(out).contains("Report result:");
+  }
+}