Refactor

src/main/java/com/wechi/adweb/bridge/google/analytics/controller/GAController.java

@@ -41,13 +41,13 @@ public class GAController extends BaseController {
 
     @PostMapping("/accounts/list")
     @ResponseBody
-    public OpenAPIResponse<List<GAAccountDTO>> listGAAccounts() throws DataException {
+    public OpenAPIResponse<List<GAAccountDTO>> listAccounts() throws DataException {
         long start = System.currentTimeMillis();
-        log.info("****** listGAAccounts() ******");
+        log.info("****** listAccounts() ******");
 
-        List<GAAccountDTO> gaAccounts = gaAdminService.listGAAccounts();
+        List<GAAccountDTO> gaAccounts = gaAdminService.listAccounts();
 
-        log.info("****** listGAAccounts() ****** duration = {} seconds", getElapsedSeconds(start));
+        log.info("****** listAccounts() ****** duration = {} seconds", getElapsedSeconds(start));
         return OpenAPIResponse.<List<GAAccountDTO>>builder()
                 .status(APIStatus.SUCCESS)
                 .data(gaAccounts)
@@ -57,11 +57,11 @@ public class GAController extends BaseController {
     @Operation(summary = "List the properties under a GA account resource name.")
     @PostMapping("/properties/list")
     @ResponseBody
-    public OpenAPIResponse<List<GAPropertyDTO>> listGAProperties(
+    public OpenAPIResponse<List<GAPropertyDTO>> listProperties(
             @RequestBody OpenAPIRequest<String> apiRequest)
             throws BadRequestException, DataException {
         long start = System.currentTimeMillis();
-        log.info("****** listGAProperties() ****** apiRequest = {}", JsonUtils.toJson(apiRequest));
+        log.info("****** listProperties() ****** apiRequest = {}", JsonUtils.toJson(apiRequest));
         String accountResourceName = apiRequest.getData();
 
         // 1. Validates the request parameters.
@@ -71,11 +71,10 @@ public class GAController extends BaseController {
 
         // 2. Executes the API request.
         List<GAPropertyDTO> gaProperties =
-                gaAdminService.listGAProperties(
+                gaAdminService.listProperties(
                         // Converts to resource name if the account ID is provided by mistake.
                         GAAccountDTO.toResourceName(accountResourceName), false);
-        log.info(
-                "****** listGAProperties() ****** duration = {} seconds", getElapsedSeconds(start));
+        log.info("****** listProperties() ****** duration = {} seconds", getElapsedSeconds(start));
         return OpenAPIResponse.<List<GAPropertyDTO>>builder()
                 .status(APIStatus.SUCCESS)
                 .data(gaProperties)
@@ -84,12 +83,12 @@ public class GAController extends BaseController {
 
     @PostMapping("/properties/create")
     @ResponseBody
-    public OpenAPIResponse<GAPropertyDTO> createGAPropertyWithDataStream(
+    public OpenAPIResponse<GAPropertyDTO> createPropertyWithDataStream(
             @RequestBody OpenAPIRequest<CreatePropertyRequestDTO> apiRequest)
             throws BadRequestException, DataException {
         long start = System.currentTimeMillis();
         log.info(
-                "****** createGAPropertyWithDataStream() ****** apiRequest = {}",
+                "****** createPropertyWithDataStream() ****** apiRequest = {}",
                 JsonUtils.toJson(apiRequest));
         CreatePropertyRequestDTO createPropertyRequest = apiRequest.getData();
 
@@ -102,12 +101,12 @@ public class GAController extends BaseController {
 
         // 2. Executes the API request.
         GAPropertyDTO gaProperty =
-                gaAdminService.createGAPropertyWithDataStream(
+                gaAdminService.createPropertyWithDataStream(
                         createPropertyRequest.getAccountResourceName(),
                         createPropertyRequest.getDisplayName(),
                         createPropertyRequest.getUrl());
         log.info(
-                "****** createGAPropertyWithDataStream() ****** duration = {} seconds",
+                "****** createPropertyWithDataStream() ****** duration = {} seconds",
                 getElapsedSeconds(start));
         return OpenAPIResponse.<GAPropertyDTO>builder()
                 .status(APIStatus.SUCCESS)
@@ -117,11 +116,11 @@ public class GAController extends BaseController {
 
     @PostMapping("/report")
     @ResponseBody
-    public OpenAPIResponse<List<? extends GAReportDataDTO>> getGAReport(
+    public OpenAPIResponse<List<? extends GAReportDataDTO>> runReport(
             @RequestBody OpenAPIRequest<GAReportRequestDTO> apiRequest)
             throws BadRequestException, DataException {
         long start = System.currentTimeMillis();
-        log.info("****** getGAReport() ****** apiRequest = {}", JsonUtils.toJson(apiRequest));
+        log.info("****** runReport() ****** apiRequest = {}", JsonUtils.toJson(apiRequest));
         GAReportRequestDTO reportRequest = apiRequest.getData();
 
         // 1. Validates the request parameters.
@@ -138,7 +137,7 @@ public class GAController extends BaseController {
 
         // 2. Executes the API request.
         List<? extends GAReportDataDTO> report = gaDataService.runReport(apiRequest.getData());
-        log.info("****** getGAReport() ****** duration = {} seconds", getElapsedSeconds(start));
+        log.info("****** runReport() ****** duration = {} seconds", getElapsedSeconds(start));
         return OpenAPIResponse.<List<? extends GAReportDataDTO>>builder()
                 .status(APIStatus.SUCCESS)
                 .data(report)

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

@@ -51,7 +51,7 @@ public class GAAdminService {
                         .build();
     }
 
-    public List<GAAccountDTO> listGAAccounts() throws DataException {
+    public List<GAAccountDTO> listAccounts() throws DataException {
         try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
                 AnalyticsAdminServiceClient.create(adminServiceSettings)) {
             List<GAAccountDTO> gaAccounts = Lists.newArrayList();
@@ -72,7 +72,7 @@ public class GAAdminService {
                 gaAccounts.add(gaAccount);
             }
 
-            log.info("listGAAccounts : {}", JsonUtils.toJson(gaAccounts));
+            log.info("listAccounts : {}", JsonUtils.toJson(gaAccounts));
             return gaAccounts;
         } catch (IOException e) {
             log.error(e.getMessage());
@@ -80,7 +80,7 @@ public class GAAdminService {
         }
     }
 
-    public List<GAPropertyDTO> listGAProperties(String accountResourceName, boolean withDataStreams)
+    public List<GAPropertyDTO> listProperties(String accountResourceName, boolean withDataStreams)
             throws DataException {
         try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
                 AnalyticsAdminServiceClient.create(adminServiceSettings)) {
@@ -112,7 +112,7 @@ public class GAAdminService {
                                 // Sets the data streams associated with this property.
                                 .dataStreams(
                                         withDataStreams
-                                                ? listGADataStreams(property.getName())
+                                                ? listDataStreams(property.getName())
                                                 : Collections.EMPTY_LIST)
                                 .build();
 
@@ -130,7 +130,7 @@ public class GAAdminService {
                             .toList();
 
             log.info(
-                    "listGAProperties for {} : {}",
+                    "listProperties for {} : {}",
                     accountResourceName,
                     JsonUtils.toJson(gaProperties));
             return gaProperties;
@@ -140,7 +140,7 @@ public class GAAdminService {
         }
     }
 
-    private List<GADataStreamDTO> listGADataStreams(String propertyResourceName)
+    private List<GADataStreamDTO> listDataStreams(String propertyResourceName)
             throws DataException {
         try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
                 AnalyticsAdminServiceClient.create(adminServiceSettings)) {
@@ -167,7 +167,7 @@ public class GAAdminService {
             }
 
             log.info(
-                    "listGADataStreams for {} : {}",
+                    "listDataStreams for {} : {}",
                     propertyResourceName,
                     JsonUtils.toJson(gaDataStreams));
             return gaDataStreams;
@@ -177,7 +177,7 @@ public class GAAdminService {
         }
     }
 
-    public GAPropertyDTO createGAPropertyWithDataStream(
+    public GAPropertyDTO createPropertyWithDataStream(
             String accountResourceName, String displayName, String url) throws DataException {
         try (AnalyticsAdminServiceClient analyticsAdminServiceClient =
                 AnalyticsAdminServiceClient.create(adminServiceSettings)) {

src/main/java/com/wechi/adweb/bridge/google/gtm/controller/GTMController.java

@@ -31,13 +31,13 @@ public class GTMController extends BaseController {
 
     @PostMapping("/accounts/list")
     @ResponseBody
-    public OpenAPIResponse<List<GTMAccountDTO>> listGTMAccounts() throws DataException {
+    public OpenAPIResponse<List<GTMAccountDTO>> listAccounts() throws DataException {
         long start = System.currentTimeMillis();
-        log.info("****** listGTMAccounts() ******");
+        log.info("****** listAccounts() ******");
 
-        List<GTMAccountDTO> gtmAccounts = gtmService.listGTMAccounts();
+        List<GTMAccountDTO> gtmAccounts = gtmService.listAccounts();
 
-        log.info("****** listGTMAccounts() ****** duration = {} seconds", getElapsedSeconds(start));
+        log.info("****** listAccounts() ****** duration = {} seconds", getElapsedSeconds(start));
         return OpenAPIResponse.<List<GTMAccountDTO>>builder()
                 .status(APIStatus.SUCCESS)
                 .data(gtmAccounts)
@@ -46,11 +46,11 @@ public class GTMController extends BaseController {
 
     @PostMapping("/containers/list")
     @ResponseBody
-    public OpenAPIResponse<List<GTMContainerDTO>> listGTMContainers(
+    public OpenAPIResponse<List<GTMContainerDTO>> listContainers(
             @RequestBody OpenAPIRequest<String> apiRequest)
             throws BadRequestException, DataException {
         long start = System.currentTimeMillis();
-        log.info("****** listGTMContainers() ****** apiRequest = {}", JsonUtils.toJson(apiRequest));
+        log.info("****** listContainers() ****** apiRequest = {}", JsonUtils.toJson(apiRequest));
         String accountResourceName = apiRequest.getData();
 
         // 1. Validates the request parameters.
@@ -60,12 +60,10 @@ public class GTMController extends BaseController {
 
         // 2. Executes the API request.
         List<GTMContainerDTO> gtmContainers =
-                gtmService.listGTMContainers(
+                gtmService.listContainers(
                         // Converts to resource name if the account ID is provided by mistake.
                         GTMAccountDTO.toResourceName(accountResourceName));
-        log.info(
-                "****** listGTMContainers() ****** duration = {} seconds",
-                getElapsedSeconds(start));
+        log.info("****** listContainers() ****** duration = {} seconds", getElapsedSeconds(start));
         return OpenAPIResponse.<List<GTMContainerDTO>>builder()
                 .status(APIStatus.SUCCESS)
                 .data(gtmContainers)

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

@@ -43,7 +43,7 @@ public class GTMService {
     @Value("${google.gtm.container.admins}")
     private List<String> containerAdmins;
 
-    public TagManager tagManager;
+    private TagManager tagManager;
 
     @PostConstruct
     private void init() throws GeneralSecurityException, IOException {
@@ -63,7 +63,7 @@ public class GTMService {
                         .build();
     }
 
-    public List<GTMAccountDTO> listGTMAccounts() throws DataException {
+    public List<GTMAccountDTO> listAccounts() throws DataException {
         try {
             List<GTMAccountDTO> gtmAccounts = Lists.newArrayList();
             for (Account account : tagManager.accounts().list().execute().getAccount()) {
@@ -82,7 +82,7 @@ public class GTMService {
                 gtmAccounts.add(gtmAccount);
             }
 
-            log.info("listGTMAccounts : {}", JsonUtils.toJson(gtmAccounts));
+            log.info("listAccounts : {}", JsonUtils.toJson(gtmAccounts));
             return gtmAccounts;
         } catch (IOException e) {
             log.error(e.getMessage());
@@ -90,8 +90,7 @@ public class GTMService {
         }
     }
 
-    public List<GTMContainerDTO> listGTMContainers(String accountResourceName)
-            throws DataException {
+    public List<GTMContainerDTO> listContainers(String accountResourceName) throws DataException {
         try {
             List<GTMContainerDTO> gtmContainers = Lists.newArrayList();
             for (Container container :
@@ -120,7 +119,7 @@ public class GTMService {
             }
 
             log.info(
-                    "listGTMContainers for {} : {}",
+                    "listContainers for {} : {}",
                     accountResourceName,
                     JsonUtils.toJson(gtmContainers));
             return gtmContainers;
@@ -130,17 +129,13 @@ public class GTMService {
         }
     }
 
-    public GTMContainerDTO createGTMContainer(String accountResourceName, String displayName)
+    public GTMContainerDTO createContainer(String accountResourceName, String displayName)
             throws DataException {
         try {
             Container container = new Container();
             container.setName(displayName);
             container.setUsageContext(Collections.singletonList("web"));
 
-            ContainerFeatures containerFeatures = new ContainerFeatures();
-            containerFeatures.setSupportUserPermissions(false);
-            container.setFeatures(containerFeatures);
-
             Container createdContainer =
                     tagManager
                             .accounts()
@@ -168,10 +163,6 @@ public class GTMService {
         }
     }
 
-    /**
-     * See
-     * https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/user_permissions
-     */
     @VisibleForTesting
     void initContainerAccess(String accountResourceName, String containerId) throws DataException {
         try {
@@ -228,7 +219,7 @@ public class GTMService {
                             .get();
 
             log.info(
-                    "Get default workspace for {} : {}",
+                    "Default workspace for {} : {}",
                     containerResourceName,
                     JsonUtils.toJson(workspace));
 
@@ -249,14 +240,13 @@ public class GTMService {
     }
 
     @VisibleForTesting
-    public GTMTriggerDTO createGTMTrigger(String workspaceResourceName, String displayName)
-            throws DataException {
+    GTMTriggerDTO createTrigger(String workspaceResourceName) throws DataException {
         try {
             Trigger trigger = new Trigger();
             // See
             // https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/triggers#type
             trigger.setType("pageview");
-            trigger.setName("Page View");
+            trigger.setName("Page View Trigger");
 
             Trigger createdTrigger =
                     tagManager
@@ -285,4 +275,33 @@ public class GTMService {
             throw new DataException(e);
         }
     }
+
+    @VisibleForTesting
+    void createGoogleTag(String workspaceResourceName, String googleTagId) throws DataException {
+        try {
+            Parameter parameter = new Parameter();
+            // See
+            // https://developers.google.com/tag-platform/tag-manager/api/v2/reference/accounts/containers/workspaces/tags#parameter.type
+            parameter.setType("template");
+            parameter.setKey("tagId");
+            parameter.setValue(googleTagId);
+
+            Tag tag = new Tag();
+            tag.setType("googtag");
+            tag.setParameter(Collections.singletonList(parameter));
+
+            Tag createdTag =
+                    tagManager
+                            .accounts()
+                            .containers()
+                            .workspaces()
+                            .tags()
+                            .create(workspaceResourceName, tag)
+                            .execute();
+            log.info("Created tag {}", JsonUtils.toJson(createdTag));
+        } catch (IOException e) {
+            log.error(e.getMessage());
+            throw new DataException(e);
+        }
+    }
 }

src/test/java/com/wechi/adweb/bridge/google/gtm/service/GTMServiceTest.java

@@ -1,5 +1,6 @@
 package com.wechi.adweb.bridge.google.gtm.service;
 
+import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 
@@ -9,5 +10,10 @@ import org.springframework.boot.test.context.SpringBootTest;
 @SpringBootTest
 public class GTMServiceTest {
 
+    private final String containerResourceName = "accounts/6000226571/containers/196039856";
+
     @Autowired private GTMService gtmService;
+
+    @Test
+    void testGTMWorkflow() throws Exception {}
 }