Flexible GA report

src/main/java/com/wechi/adweb/bridge/google/analytics/GADataService.java

@@ -173,6 +173,7 @@ public class GADataService {
                     SourceMediaViewData.toReport(reportRows, metrics, dimensions);
             case ADWEB_PAGE_PATH_VIEW -> PagePathViewData.toReport(reportRows, metrics, dimensions);
             case ADWEB_DATE_VIEW -> DateViewData.toReport(reportRows, metrics, dimensions);
+            case ADWEB_CUSTOM_REPORT -> CustomReportData.toReport(reportRows, metrics, dimensions);
         };
     }
 }

src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/ReportType.java

@@ -5,6 +5,7 @@ import static com.wechi.adweb.bridge.google.analytics.dto.report.ReportConstant.
 
 import lombok.Getter;
 
+import java.util.Collections;
 import java.util.List;
 
 /**
@@ -46,7 +47,9 @@ public enum ReportType {
             List.of(DIMENSION_DATE),
             DIMENSION_DATE,
             DIMENSIONS,
-            false);
+            false),
+    // For flexible query.
+    ADWEB_CUSTOM_REPORT(Collections.EMPTY_LIST, Collections.EMPTY_LIST);
 
     ReportType(List<String> defaultMetrics, List<String> defaultDimensions) {
         this.defaultMetrics = defaultMetrics;

src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/data/CustomReportData.java

@@ -0,0 +1,75 @@
+package com.wechi.adweb.bridge.google.analytics.dto.report.data;
+
+import static com.wechi.adweb.bridge.google.analytics.dto.report.ReportConstant.*;
+
+import com.google.analytics.data.v1beta.Row;
+import com.google.common.collect.Lists;
+import com.wechi.adweb.bridge.google.analytics.dto.report.ReportType;
+import com.wechi.adweb.bridge.util.DateUtils;
+
+import java.time.format.DateTimeFormatter;
+import java.util.*;
+
+/**
+ * Represents a flexible GA report for {@link ReportType#ADWEB_CUSTOM_REPORT}, structured as a
+ * {@link Map} collection.
+ *
+ * <p>This {@link Map} contains two types of key-value pairs:
+ *
+ * <ul>
+ *   <li><strong>Dimensions:</strong>
+ *       <ul>
+ *         <li><strong>Key:</strong> the name of the dimension.
+ *         <li><strong>Value:</strong> the value of the dimension.
+ *       </ul>
+ *   <li><strong>Metrics:</strong>
+ *       <ul>
+ *         <li><strong>Key:</strong> the name of the metric.
+ *         <li><strong>Value:</strong> the value of the metric.
+ *       </ul>
+ * </ul>
+ *
+ * <p>This structure allows for flexible representation of both dimensions and metrics in custom GA
+ * reports.
+ *
+ * @author wfansh
+ */
+public class CustomReportData extends LinkedHashMap<String, String> implements GAReportDataDTO {
+
+    private CustomReportData() {}
+
+    public static List<CustomReportData> toReport(
+            List<Row> reportRows, List<String> metrics, List<String> dimensions) {
+        List<CustomReportData> report = Lists.newArrayList();
+        for (Row reportRow : reportRows) {
+            CustomReportData reportData = new CustomReportData();
+            // Dimensions.
+            for (int i = 0; i < dimensions.size(); i++) {
+                String dimension = dimensions.get(i);
+                /**
+                 * Formatted as {@link DateTimeFormatter#ISO_LOCAL_DATE}, originated from {@link
+                 * DateTimeFormatter#BASIC_ISO_DATE}
+                 */
+                if (DIMENSION_DATE.equalsIgnoreCase(dimension)) {
+                    reportData.put(
+                            dimension,
+                            DateUtils.format(
+                                    reportRow.getDimensionValues(i).getValue(),
+                                    DateTimeFormatter.BASIC_ISO_DATE,
+                                    DateTimeFormatter.ISO_LOCAL_DATE));
+                } else {
+                    reportData.put(dimension, reportRow.getDimensionValues(i).getValue());
+                }
+            }
+
+            // Metrics.
+            for (int i = 0; i < metrics.size(); i++) {
+                reportData.put(metrics.get(i), reportRow.getMetricValues(i).getValue());
+            }
+
+            report.add(reportData);
+        }
+
+        return report;
+    }
+}

src/test/java/com/wechi/adweb/bridge/google/analytics/GAServiceTests.java

@@ -1,5 +1,7 @@
 package com.wechi.adweb.bridge.google.analytics;
 
+import static com.wechi.adweb.bridge.google.analytics.dto.report.ReportConstant.*;
+
 import com.google.gson.Gson;
 import com.wechi.adweb.bridge.exception.DataException;
 import com.wechi.adweb.bridge.google.analytics.dto.report.GAReportRequestDTO;
@@ -9,6 +11,8 @@ import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 
+import java.util.List;
+
 @SpringBootTest
 public class GAServiceTests {
 
@@ -54,5 +58,24 @@ public class GAServiceTests {
         reportRequest.setStartDate(startDate);
         reportRequest.setEndDate(endDate);
         System.out.println(gson.toJson(gaDataService.runReport(reportRequest)));
+
+        // 5. Custom report.
+        reportRequest = new GAReportRequestDTO();
+        reportRequest.setPropertyName(propertyName);
+        reportRequest.setReportType(ReportType.ADWEB_CUSTOM_REPORT);
+        reportRequest.setStartDate(startDate);
+        reportRequest.setEndDate(endDate);
+        reportRequest.setMetrics(
+                List.of(
+                        METRIC_TOTAL_USERS,
+                        METRIC_ACTIVE_USERS,
+                        METRIC_SCREEN_PAGE_VIEWS,
+                        METRIC_BOUNCE_RATE,
+                        METRIC_AVG_SESSION_DURATION));
+        reportRequest.setOrderBy(METRIC_TOTAL_USERS);
+        reportRequest.setOrderByType(GAReportRequestDTO.OrderByType.METRICS);
+        reportRequest.setDimensions(List.of(DIMENSION_DATE));
+        reportRequest.setOrderByDesc(true);
+        System.out.println(gson.toJson(gaDataService.runReport(reportRequest)));
     }
 }