Merge branch 'page_path_report' of wangfan/adweb3-server into master

jeecg-module-system/jeecg-system-biz/src/main/java/org/jeecg/modules/adweb/dmp/entity/GAPagePathReport.java

@@ -0,0 +1,70 @@
+package org.jeecg.modules.adweb.dmp.entity;
+
+import com.baomidou.mybatisplus.annotation.IdType;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
+import com.fasterxml.jackson.annotation.JsonFormat;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.experimental.Accessors;
+
+import org.jeecgframework.poi.excel.annotation.Excel;
+import org.springframework.format.annotation.DateTimeFormat;
+
+import java.io.Serializable;
+import java.util.Date;
+
+/**
+ * @Description: dmp_ga_page_path_report
+ * @Author: jeecg-boot
+ * @Date:   2024-10-11
+ * @Version: V1.0
+ */
+@Data
+@TableName("dmp_ga_page_path_report")
+@Accessors(chain = true)
+@EqualsAndHashCode(callSuper = false)
+@Schema(description="dmp_ga_page_path_report")
+public class GAPagePathReport implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+	/**id*/
+	@TableId(type = IdType.AUTO)
+    @Schema(description = "id")
+    private Long id;
+	/**站点id*/
+	@Excel(name = "站点id", width = 15)
+    @Schema(description = "站点id")
+    private Integer siteId;
+	/**统计时间*/
+	@Excel(name = "统计时间", width = 15, format = "yyyy-MM-dd")
+	@JsonFormat(timezone = "GMT+8",pattern = "yyyy-MM-dd")
+    @DateTimeFormat(pattern="yyyy-MM-dd")
+    @Schema(description = "统计时间")
+    private Date date;
+	/**pagePath*/
+	@Excel(name = "pagePath", width = 15)
+    @Schema(description = "pagePath")
+    private String pagePath;
+	/**engagementRate*/
+	@Excel(name = "engagementRate", width = 15)
+    @Schema(description = "engagementRate")
+    private Double engagementRate;
+	/**页面访问量*/
+	@Excel(name = "页面访问量", width = 15)
+    @Schema(description = "页面访问量")
+    private Integer pageViews;
+	/**avgTimeOnPage*/
+	@Excel(name = "avgTimeOnPage", width = 15)
+    @Schema(description = "avgTimeOnPage")
+    private Double avgTimeOnPage;
+	/**ctime*/
+	@Excel(name = "ctime", width = 20, format = "yyyy-MM-dd HH:mm:ss")
+	@JsonFormat(timezone = "GMT+8",pattern = "yyyy-MM-dd HH:mm:ss")
+    @DateTimeFormat(pattern="yyyy-MM-dd HH:mm:ss")
+    @Schema(description = "ctime")
+    private Date ctime;
+}

jeecg-module-system/jeecg-system-biz/src/main/java/org/jeecg/modules/adweb/dmp/mapper/GAPagePathReportMapper.java

@@ -0,0 +1,16 @@
+package org.jeecg.modules.adweb.dmp.mapper;
+
+
+import com.baomidou.mybatisplus.core.mapper.BaseMapper;
+
+import org.jeecg.modules.adweb.dmp.entity.GAPagePathReport;
+
+/**
+ * @Description: dmp_ga_page_path_report
+ * @Author: jeecg-boot
+ * @Date:   2024-10-11
+ * @Version: V1.0
+ */
+public interface GAPagePathReportMapper extends BaseMapper<GAPagePathReport> {
+
+}

jeecg-module-system/jeecg-system-biz/src/main/java/org/jeecg/modules/adweb/dmp/mapper/xml/GAPagePathReportMapper.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
+<mapper namespace="org.jeecg.modules.adweb.dmp.mapper.GAPagePathReportMapper">
+
+</mapper>

jeecg-module-system/jeecg-system-biz/src/main/java/org/jeecg/modules/adweb/dmp/service/IGAPagePathReportService.java

@@ -0,0 +1,15 @@
+package org.jeecg.modules.adweb.dmp.service;
+
+import com.baomidou.mybatisplus.extension.service.IService;
+
+import org.jeecg.modules.adweb.dmp.entity.GAPagePathReport;
+
+/**
+ * @Description: dmp_ga_page_path_report
+ * @Author: jeecg-boot
+ * @Date:   2024-10-11
+ * @Version: V1.0
+ */
+public interface IGAPagePathReportService extends IService<GAPagePathReport> {
+
+}

jeecg-module-system/jeecg-system-biz/src/main/java/org/jeecg/modules/adweb/dmp/service/google/GAReportService.java

@@ -1,5 +1,7 @@
 package org.jeecg.modules.adweb.dmp.service.google;
 
+import static org.jeecg.modules.adweb.dmp.dto.google.analytics.report.ReportConstant.*;
+
 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.google.common.annotations.VisibleForTesting;
 
@@ -24,9 +26,11 @@ import org.jeecg.modules.adweb.dmp.dto.google.analytics.report.ReportType;
 import org.jeecg.modules.adweb.dmp.dto.google.analytics.report.data.CustomReportData;
 import org.jeecg.modules.adweb.dmp.dto.google.analytics.report.data.GAReportDataDTO;
 import org.jeecg.modules.adweb.dmp.entity.GACountryReport;
+import org.jeecg.modules.adweb.dmp.entity.GAPagePathReport;
 import org.jeecg.modules.adweb.dmp.entity.GASourceMediumReport;
 import org.jeecg.modules.adweb.dmp.entity.GoogleGTM;
 import org.jeecg.modules.adweb.dmp.service.IGACountryReportService;
+import org.jeecg.modules.adweb.dmp.service.IGAPagePathReportService;
 import org.jeecg.modules.adweb.dmp.service.IGASourceMediumReportService;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -34,6 +38,7 @@ import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.stereotype.Service;
 import org.springframework.web.client.RestTemplate;
 
+import java.util.Collections;
 import java.util.Date;
 import java.util.List;
 import java.util.Objects;
@@ -59,6 +64,8 @@ public class GAReportService {
 
     @Autowired private IGASourceMediumReportService gaSourceMediumReportService;
 
+    @Autowired private IGAPagePathReportService gaPagePathReportService;
+
     @Autowired private CommonMapper commonMapper;
 
     private RestTemplate restTemplate;
@@ -68,6 +75,23 @@ public class GAReportService {
         this.restTemplate = RestTemplateUtil.getRestTemplate(60, 60, dataBridgeApiToken);
     }
 
+    /** 拉取并同步Google Analytics报表 */
+    public void syncGAReport() {
+        // TODO
+        List<GoogleGTM> googleGTMS = Collections.emptyList();
+
+        // 每个帐号同步三张报表
+        for (GoogleGTM googleGTM : googleGTMS) {
+            try {
+                this.syncGACountryReport(googleGTM);
+                this.syncGASourceMediumReport(googleGTM);
+                this.syncGAPagePathReport(googleGTM);
+            } catch (RuntimeException e) {
+                log.warn("同步GA报表异常, siteId = {], error = {}", googleGTM.getSiteId(), e);
+            }
+        }
+    }
+
     /**
      * 拉取并同步Google Analytics - Country报表
      *
@@ -193,6 +217,67 @@ public class GAReportService {
     }
 
     /**
+     * 拉取并同步Google Analytics - Page Path报表
+     *
+     * @param googleGTM
+     */
+    private void syncGAPagePathReport(GoogleGTM googleGTM) {
+        // 1. 报表时间区间
+        Date startDate = this.getReportStartDate("dmp_ga_page_path_report", googleGTM.getSiteId());
+        Date endDate = new Date();
+
+        // 2. 构建GA报表请求参数
+        // 使用ADWEB_CUSTOM_REPORT，不是ADWEB_PAGE_PATH_VIEW - 需要date作为dimension
+        GAReportRequestDTO gaReportRequest = new GAReportRequestDTO();
+        gaReportRequest.setPropertyResourceName(
+                GAPropertyDTO.toResourceName(googleGTM.getGaPropertyId()));
+        gaReportRequest.setReportType(ReportType.ADWEB_CUSTOM_REPORT);
+        gaReportRequest.setStartDate(DateUtils.date2Str(startDate, DateUtils.date_sdf.get()));
+        gaReportRequest.setEndDate(DateUtils.date2Str(endDate, DateUtils.date_sdf.get()));
+        gaReportRequest.setMetrics(
+                List.of(
+                        ReportConstant.METRIC_ENGAGEMENT_RATE,
+                        ReportConstant.METRIC_SCREEN_PAGE_VIEWS,
+                        ReportConstant.METRIC_USER_ENGAGEMENT_DURATION));
+        gaReportRequest.setDimensions(
+                List.of(ReportConstant.DIMENSION_DATE, ReportConstant.DIMENSION_PAGE_PATH));
+        gaReportRequest.setOrderByType(OrderByType.DIMENSIONS);
+        gaReportRequest.setOrderBy(ReportConstant.DIMENSION_DATE);
+        List<CustomReportData> reportDataList =
+                runGAReport(gaReportRequest, CustomReportData.class);
+
+        // 2. 转化为DB entity
+        List<GAPagePathReport> pagePathReport = Lists.newArrayList();
+        for (CustomReportData reportData : reportDataList) {
+            GAPagePathReport reportRow = new GAPagePathReport();
+            reportRow.setSiteId(googleGTM.getSiteId());
+            reportRow.setDate(
+                    DateUtils.str2Date(
+                            reportData.get(ReportConstant.DIMENSION_DATE),
+                            DateUtils.date_sdf.get()));
+            reportRow.setPagePath(reportData.get(DIMENSION_PAGE_PATH));
+            reportRow.setEngagementRate(
+                    Double.parseDouble(reportData.get(ReportConstant.METRIC_ENGAGEMENT_RATE)));
+            reportRow.setPageViews(
+                    Integer.parseInt(reportData.get(ReportConstant.METRIC_SCREEN_PAGE_VIEWS)));
+            reportRow.setAvgTimeOnPage(
+                    Double.parseDouble(
+                            reportData.get(ReportConstant.METRIC_USER_ENGAGEMENT_DURATION)));
+
+            pagePathReport.add(reportRow);
+        }
+
+        // 3. 更新数据库 - 删除旧数据，插入新数据
+        QueryWrapper<GAPagePathReport> queryWrapper = new QueryWrapper<>();
+        queryWrapper.eq("site_id", googleGTM.getSiteId());
+        queryWrapper.ge("date", startDate);
+        queryWrapper.le("date", endDate);
+        gaPagePathReportService.remove(queryWrapper);
+
+        gaPagePathReportService.saveBatch(pagePathReport, pagePathReport.size());
+    }
+
+    /**
      * 请求Google Analytics报表，http://data-bridge.v3.adwebcloud.com:9002/swagger-ui/index.html
      *
      * @param gaReportRequest

jeecg-module-system/jeecg-system-biz/src/main/java/org/jeecg/modules/adweb/dmp/service/impl/GAPagePathReportServiceImpl.java

@@ -0,0 +1,19 @@
+package org.jeecg.modules.adweb.dmp.service.impl;
+
+import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
+
+import org.jeecg.modules.adweb.dmp.entity.GAPagePathReport;
+import org.jeecg.modules.adweb.dmp.mapper.GAPagePathReportMapper;
+import org.jeecg.modules.adweb.dmp.service.IGAPagePathReportService;
+import org.springframework.stereotype.Service;
+
+/**
+ * @Description: dmp_ga_page_path_report
+ * @Author: jeecg-boot
+ * @Date:   2024-10-11
+ * @Version: V1.0
+ */
+@Service
+public class GAPagePathReportServiceImpl extends ServiceImpl<GAPagePathReportMapper, GAPagePathReport> implements IGAPagePathReportService {
+
+}