Refactor

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

@@ -11,8 +11,6 @@ import com.wechi.adweb.bridge.google.analytics.dto.GAAccountDTO;
 import com.wechi.adweb.bridge.google.analytics.dto.GADataStreamDTO;
 import com.wechi.adweb.bridge.google.analytics.dto.GAPropertyDTO;
 
-import jakarta.annotation.PostConstruct;
-
 import lombok.extern.slf4j.Slf4j;
 
 import org.springframework.beans.factory.annotation.Value;
@@ -23,6 +21,8 @@ import java.util.Collections;
 import java.util.List;
 import java.util.stream.Collectors;
 
+import javax.annotation.PostConstruct;
+
 /**
  * @author wfansh
  */
@@ -35,7 +35,7 @@ public class GAAdminService {
 
     private AnalyticsAdminServiceSettings adminServiceSettings;
 
-    private Gson gson = new Gson();
+    private final Gson gson = new Gson();
 
     @PostConstruct
     private void init() throws IOException {

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

@@ -1,7 +1,6 @@
 package com.wechi.adweb.bridge.google.analytics;
 
 import static com.wechi.adweb.bridge.google.analytics.dto.report.GAReportRequestDTO.*;
-import static com.wechi.adweb.bridge.google.analytics.dto.report.ReportType.*;
 
 import com.google.analytics.data.v1beta.*;
 import com.google.api.gax.core.FixedCredentialsProvider;
@@ -10,15 +9,14 @@ import com.google.gson.Gson;
 import com.wechi.adweb.bridge.exception.DataException;
 import com.wechi.adweb.bridge.google.analytics.dto.report.GAReportRequestDTO;
 import com.wechi.adweb.bridge.google.analytics.dto.report.ReportType;
-import com.wechi.adweb.bridge.google.analytics.dto.report.row.CountryChartData;
-import com.wechi.adweb.bridge.google.analytics.dto.report.row.GAReportDataDTO;
-import com.wechi.adweb.bridge.google.analytics.dto.report.row.PagePathViewData;
-import com.wechi.adweb.bridge.google.analytics.dto.report.row.SourceMediaViewData;
-
-import jakarta.annotation.PostConstruct;
+import com.wechi.adweb.bridge.google.analytics.dto.report.data.CountryChartData;
+import com.wechi.adweb.bridge.google.analytics.dto.report.data.GAReportDataDTO;
+import com.wechi.adweb.bridge.google.analytics.dto.report.data.PagePathViewData;
+import com.wechi.adweb.bridge.google.analytics.dto.report.data.SourceMediaViewData;
 
 import lombok.extern.slf4j.Slf4j;
 
+import org.apache.commons.lang3.BooleanUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
@@ -29,6 +27,8 @@ import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 
+import javax.annotation.PostConstruct;
+
 /**
  * @author wfansh
  *     <p>See https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema for GA
@@ -43,7 +43,7 @@ public class GADataService {
 
     private BetaAnalyticsDataSettings dataSettings;
 
-    private Gson gson = new Gson();
+    private final Gson gson = new Gson();
 
     @PostConstruct
     private void init() throws IOException {
@@ -59,7 +59,7 @@ public class GADataService {
 
     public List<? extends GAReportDataDTO> runReport(GAReportRequestDTO reportRequest)
             throws DataException {
-        // 0. Enhances the report request.
+        // 0. Enhances the report request with default settings.
         this.amplifyReportRequest(reportRequest);
 
         try (BetaAnalyticsDataClient analyticsDataClient =
@@ -67,6 +67,7 @@ public class GADataService {
             // 1. Dimensions.
             List<Dimension> dimensions =
                     reportRequest.getDimensions().stream()
+                            .map(String::trim)
                             .filter(StringUtils::isNotEmpty)
                             .map(dimension -> Dimension.newBuilder().setName(dimension).build())
                             .toList();
@@ -74,6 +75,7 @@ public class GADataService {
             // 2. Metrics.
             List<Metric> metrics =
                     reportRequest.getMetrics().stream()
+                            .map(String::trim)
                             .filter(StringUtils::isNotEmpty)
                             .map(metric -> Metric.newBuilder().setName(metric).build())
                             .toList();
@@ -102,7 +104,7 @@ public class GADataService {
                 }
 
                 // Desc.
-                orderBy.setDesc(reportRequest.getOrderByDesc());
+                orderBy.setDesc(BooleanUtils.isTrue(reportRequest.getOrderByDesc()));
             }
 
             RunReportRequest.Builder request =
@@ -128,7 +130,7 @@ public class GADataService {
         }
     }
 
-    /** Enhances the report request by applying default settings from {@link ReportType}. */
+    /** Enhances the report request with default settings from {@link ReportType}. */
     private void amplifyReportRequest(GAReportRequestDTO reportRequest) {
         ReportType reportType = reportRequest.getReportType();
         if (Objects.isNull(reportType)) {
@@ -152,18 +154,24 @@ public class GADataService {
         }
 
         if (Objects.isNull(reportRequest.getOrderByDesc())) {
-            reportRequest.setOrderByDesc(reportType.isDefaultOrderByDesc());
+            reportRequest.setOrderByDesc(reportType.getDefaultOrderByDesc());
         }
     }
 
-    private List<? extends GAReportDataDTO> toReportData(
+    private List<? extends GAReportDataDTO> toReport(
             List<Row> reportRows, GAReportRequestDTO reportRequest) {
+        if (Objects.isNull(reportRequest.getReportType())) {
+            return Collections.EMPTY_LIST;
+        }
+
+        List<String> metrics = reportRequest.getMetrics();
+        List<String> dimensions = reportRequest.getDimensions();
+
         return switch (reportRequest.getReportType()) {
-            case ADWEB_COUNTRY_CHART -> CountryChartData.fromReportRows(reportRows, reportRequest);
-            case ADWEB_SOURCE_MEDIUM_VIEW ->
-                    SourceMediaViewData.fromReportRows(reportRows, reportRequest);
-            case ADWEB_PATH_PATH_VIEW -> PagePathViewData.fromReportRows(reportRows, reportRequest);
-            default -> Collections.emptyList();
+            case ADWEB_COUNTRY_CHART -> CountryChartData.toReport(reportRows, metrics, dimensions);
+            case ADWEB_SESSION_SOURCE_MEDIUM_VIEW ->
+                    SourceMediaViewData.toReport(reportRows, metrics, dimensions);
+            case ADWEB_PAGE_PATH_VIEW -> PagePathViewData.toReport(reportRows, metrics, dimensions);
         };
     }
 }

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

@@ -13,7 +13,7 @@ import java.util.List;
 @Getter
 public enum ReportType {
     ADWEB_COUNTRY_CHART(List.of(METRIC_TOTAL_USERS), List.of(DIMENSION_COUNTRY)),
-    ADWEB_SOURCE_MEDIUM_VIEW(
+    ADWEB_SESSION_SOURCE_MEDIUM_VIEW(
             List.of(
                     METRIC_TOTAL_USERS,
                     METRIC_NEW_USERS,
@@ -22,7 +22,7 @@ public enum ReportType {
                     METRIC_AVG_SESSION_DURATION,
                     METRIC_SCREEN_PAGE_VIEWS_PER_SESSION),
             List.of(DIMENSION_SESSION_SOURCE_MEDIUM)),
-    ADWEB_PATH_PATH_VIEW(
+    ADWEB_PAGE_PATH_VIEW(
             List.of(
                     METRIC_ENGAGEMENT_RATE,
                     METRIC_SCREEN_PAGE_VIEWS,
@@ -32,7 +32,7 @@ public enum ReportType {
             METRICS,
             true);
 
-    private ReportType(List<String> defaultMetrics, List<String> defaultDimensions) {
+    ReportType(List<String> defaultMetrics, List<String> defaultDimensions) {
         this.defaultMetrics = defaultMetrics;
         this.defaultDimensions = defaultDimensions;
         this.defaultOrderBy = null;
@@ -40,7 +40,7 @@ public enum ReportType {
         this.defaultOrderByDesc = false;
     }
 
-    private ReportType(
+    ReportType(
             List<String> defaultMetrics,
             List<String> defaultDimensions,
             String defaultOrderBy,
@@ -53,9 +53,9 @@ public enum ReportType {
         this.defaultOrderByDesc = defaultOrderByDesc;
     }
 
-    private List<String> defaultMetrics;
-    private List<String> defaultDimensions;
-    private String defaultOrderBy;
-    private GAReportRequestDTO.OrderByType defaultOrderByType;
-    private boolean defaultOrderByDesc;
+    private final List<String> defaultMetrics;
+    private final List<String> defaultDimensions;
+    private final String defaultOrderBy;
+    private final GAReportRequestDTO.OrderByType defaultOrderByType;
+    private final Boolean defaultOrderByDesc;
 }

src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/row/CountryChartData.java → src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/data/CountryChartData.java

@@ -1,9 +1,8 @@
-package com.wechi.adweb.bridge.google.analytics.dto.report.row;
+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.wechi.adweb.bridge.google.analytics.dto.report.GAReportRequestDTO;
 
 import lombok.Builder;
 import lombok.Data;
@@ -19,16 +18,16 @@ public class CountryChartData implements GAReportDataDTO {
     private String country;
     private int num;
 
-    public static List<CountryChartData> fromReportRows(
-            List<Row> reportRows, GAReportRequestDTO reportRequest) {
-        int indexCountry = reportRequest.getDimensions().indexOf(DIMENSION_COUNTRY);
+    public static List<CountryChartData> toReport(
+            List<Row> reportRows, List<String> metrics, List<String> dimensions) {
+        int indexCountry = dimensions.indexOf(DIMENSION_COUNTRY);
 
         return reportRows.stream()
                 .map(
                         row ->
                                 CountryChartData.builder()
                                         .country(row.getDimensionValues(indexCountry).getValue())
-                                        // The first metric value.
+                                        // The first metric value - for customized metrics query.
                                         .num(Integer.parseInt(row.getMetricValues(0).getValue()))
                                         .build())
                 .toList();

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

@@ -0,0 +1,6 @@
+package com.wechi.adweb.bridge.google.analytics.dto.report.data;
+
+/**
+ * @author wfansh
+ */
+public interface GAReportDataDTO {}

src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/row/PagePathViewData.java → src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/data/PagePathViewData.java

@@ -1,9 +1,8 @@
-package com.wechi.adweb.bridge.google.analytics.dto.report.row;
+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.wechi.adweb.bridge.google.analytics.dto.report.GAReportRequestDTO;
 import com.wechi.adweb.bridge.util.NumberUtils;
 
 import lombok.Builder;
@@ -21,19 +20,18 @@ public class PagePathViewData implements GAReportDataDTO {
 
     private String pagePath;
 
-    private String engagementRate;
+    private BigDecimal engagementRate;
 
     private int pageViews;
 
     private BigDecimal avgTimeOnPage;
 
-    public static List<PagePathViewData> fromReportRows(
-            List<Row> reportRows, GAReportRequestDTO reportRequest) {
-        int indexPagePath = reportRequest.getDimensions().indexOf(DIMENSION_PAGE_PATH);
-        int indexEngagementRate = reportRequest.getMetrics().indexOf(METRIC_ENGAGEMENT_RATE);
-        int indexPageViews = reportRequest.getMetrics().indexOf(METRIC_SCREEN_PAGE_VIEWS);
-        int indexUserEngagementDuration =
-                reportRequest.getMetrics().indexOf(METRIC_USER_ENGAGEMENT_DURATION);
+    public static List<PagePathViewData> toReport(
+            List<Row> reportRows, List<String> metrics, List<String> dimensions) {
+        int indexPagePath = dimensions.indexOf(DIMENSION_PAGE_PATH);
+        int indexEngagementRate = metrics.indexOf(METRIC_ENGAGEMENT_RATE);
+        int indexPageViews = metrics.indexOf(METRIC_SCREEN_PAGE_VIEWS);
+        int indexUserEngagementDuration = metrics.indexOf(METRIC_USER_ENGAGEMENT_DURATION);
 
         return reportRows.stream()
                 .map(
@@ -41,12 +39,12 @@ public class PagePathViewData implements GAReportDataDTO {
                                 PagePathViewData.builder()
                                         .pagePath(row.getDimensionValues(indexPagePath).getValue())
                                         .engagementRate(
-                                                NumberUtils.formatPercentage(
+                                                NumberUtils.formatDecimal(
                                                         Double.parseDouble(
                                                                 row.getMetricValues(
                                                                                 indexEngagementRate)
                                                                         .getValue()),
-                                                        2))
+                                                        4))
                                         .pageViews(
                                                 Integer.parseInt(
                                                         row.getMetricValues(indexPageViews)

src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/row/SourceMediaViewData.java → src/main/java/com/wechi/adweb/bridge/google/analytics/dto/report/data/SourceMediaViewData.java

@@ -1,9 +1,8 @@
-package com.wechi.adweb.bridge.google.analytics.dto.report.row;
+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.wechi.adweb.bridge.google.analytics.dto.report.GAReportRequestDTO;
 import com.wechi.adweb.bridge.util.NumberUtils;
 
 import lombok.Builder;
@@ -26,23 +25,21 @@ public class SourceMediaViewData implements GAReportDataDTO {
 
     private int sessions;
 
-    private String bounceRate;
+    private BigDecimal bounceRate;
 
     private BigDecimal avgSessionDuration;
 
     private BigDecimal pageViewsPerSession;
 
-    public static List<SourceMediaViewData> fromReportRows(
-            List<Row> reportRows, GAReportRequestDTO reportRequest) {
-        int indexType = reportRequest.getDimensions().indexOf(DIMENSION_SESSION_SOURCE_MEDIUM);
-        int indexTotalUsers = reportRequest.getMetrics().indexOf(METRIC_TOTAL_USERS);
-        int indexNewUsers = reportRequest.getMetrics().indexOf(METRIC_NEW_USERS);
-        int indexSessions = reportRequest.getMetrics().indexOf(METRIC_SESSIONS);
-        int indexBounceRate = reportRequest.getMetrics().indexOf(METRIC_BOUNCE_RATE);
-        int indexAvgSessionDuration =
-                reportRequest.getMetrics().indexOf(METRIC_AVG_SESSION_DURATION);
-        int indexPageViewsPerSession =
-                reportRequest.getMetrics().indexOf(METRIC_SCREEN_PAGE_VIEWS_PER_SESSION);
+    public static List<SourceMediaViewData> toReport(
+            List<Row> reportRows, List<String> metrics, List<String> dimensions) {
+        int indexType = dimensions.indexOf(DIMENSION_SESSION_SOURCE_MEDIUM);
+        int indexTotalUsers = metrics.indexOf(METRIC_TOTAL_USERS);
+        int indexNewUsers = metrics.indexOf(METRIC_NEW_USERS);
+        int indexSessions = metrics.indexOf(METRIC_SESSIONS);
+        int indexBounceRate = metrics.indexOf(METRIC_BOUNCE_RATE);
+        int indexAvgSessionDuration = metrics.indexOf(METRIC_AVG_SESSION_DURATION);
+        int indexPageViewsPerSession = metrics.indexOf(METRIC_SCREEN_PAGE_VIEWS_PER_SESSION);
 
         return reportRows.stream()
                 .map(
@@ -62,11 +59,11 @@ public class SourceMediaViewData implements GAReportDataDTO {
                                                         row.getMetricValues(indexSessions)
                                                                 .getValue()))
                                         .bounceRate(
-                                                NumberUtils.formatPercentage(
+                                                NumberUtils.formatDecimal(
                                                         Double.parseDouble(
                                                                 row.getMetricValues(indexBounceRate)
                                                                         .getValue()),
-                                                        2))
+                                                        4))
                                         .avgSessionDuration(
                                                 NumberUtils.formatDecimal(
                                                         Double.parseDouble(

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

@@ -1,6 +0,0 @@
-package com.wechi.adweb.bridge.google.analytics.dto.report.row;
-
-/**
- * @author wfansh
- */
-public interface GAReportDataDTO {}

src/main/java/com/wechi/adweb/bridge/google/gtm/service/GTMService.java

@@ -7,8 +7,6 @@ import com.google.api.client.json.gson.GsonFactory;
 import com.google.api.services.tagmanager.TagManager;
 import com.google.api.services.tagmanager.TagManagerScopes;
 
-import jakarta.annotation.PostConstruct;
-
 import lombok.extern.slf4j.Slf4j;
 
 import org.springframework.beans.factory.annotation.Value;
@@ -17,6 +15,8 @@ import org.springframework.stereotype.Service;
 import java.io.IOException;
 import java.security.GeneralSecurityException;
 
+import javax.annotation.PostConstruct;
+
 /**
  * @author wfansh
  */

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

@@ -0,0 +1,50 @@
+package com.wechi.adweb.bridge.google.analytics;
+
+import com.google.gson.Gson;
+import com.wechi.adweb.bridge.exception.DataException;
+import com.wechi.adweb.bridge.google.analytics.dto.report.GAReportRequestDTO;
+import com.wechi.adweb.bridge.google.analytics.dto.report.ReportType;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+
+@SpringBootTest
+public class GAServiceTests {
+
+    @Autowired private GAAdminService gaAdminService;
+    @Autowired private GADataService gaDataService;
+
+    private final String propertyName = "properties/457183952";
+    private final String startDate = "2023-10-01";
+    private final String endDate = "2024-10-01";
+    private final Gson gson = new Gson();
+
+    @Test
+    void runReport() throws DataException {
+
+        // 1. Country chart.
+        GAReportRequestDTO reportRequest = new GAReportRequestDTO();
+        reportRequest.setPropertyName(propertyName);
+        reportRequest.setReportType(ReportType.ADWEB_COUNTRY_CHART);
+        reportRequest.setStartDate(startDate);
+        reportRequest.setEndDate(endDate);
+        System.out.println(gson.toJson(gaDataService.runReport(reportRequest)));
+
+        // 2. Session source medium view.
+        reportRequest = new GAReportRequestDTO();
+        reportRequest.setPropertyName(propertyName);
+        reportRequest.setReportType(ReportType.ADWEB_SESSION_SOURCE_MEDIUM_VIEW);
+        reportRequest.setStartDate(startDate);
+        reportRequest.setEndDate(endDate);
+        System.out.println(gson.toJson(gaDataService.runReport(reportRequest)));
+
+        // 3. Page path view.
+        reportRequest = new GAReportRequestDTO();
+        reportRequest.setPropertyName(propertyName);
+        reportRequest.setReportType(ReportType.ADWEB_PAGE_PATH_VIEW);
+        reportRequest.setStartDate(startDate);
+        reportRequest.setEndDate(endDate);
+        System.out.println(gson.toJson(gaDataService.runReport(reportRequest)));
+    }
+}