Merge pull request #54 from ZJUCJH/main

[feature] 1.支持活跃行为过滤功能;2.新增cidByTag推送方式

Author: jianbin2001

CHANGES.md

@@ -1,5 +1,12 @@
 # Release Notes
 
+## 1.0.4.0
+
+### update
+
+* 支持活跃行为过滤功能
+* 新增pushToSingleCidByTag和pushListCidByTag推送接口
+
 ## 1.0.3.0
 
 ### update

README.md

@@ -22,7 +22,7 @@
 <dependency>
     <groupId>com.getui.push</groupId>
     <artifactId>restful-sdk</artifactId>
-    <version>1.0.3.0</version>
+    <version>1.0.4.0</version>
 </dependency>
 ```
 

pom.xml

@@ -7,7 +7,7 @@
     <groupId>com.getui.push</groupId>
     <artifactId>restful-sdk</artifactId>
     <packaging>jar</packaging>
-    <version>1.0.3.0</version>
+    <version>1.0.4.0</version>
     <url>https://github.com/GetuiLaboratory/getui-pushapi-java-client-v2</url>
     <name>Getui Push API Java Client</name>
     <description>Getui's officially supported Java client library for accessing Getui APIs.</description>

src/main/java/com/getui/push/v2/sdk/api/PushApi.java

@@ -23,11 +23,13 @@
 public interface PushApi {
 
     String singleCidUri = "/push/single/cid";
+    String singleCidByTagUri = "/push/single/cid_by_tag";
     String singleAliasUri = "/push/single/alias";
     String singleBatchCidUri = "/push/single/batch/cid";
     String singleBatchAliasUri = "/push/single/batch/alias";
     String pushListMessageUri = "/push/list/message";
     String pushListCidUri = "/push/list/cid";
+    String pushListCidByTagUri = "/push/list/cid_by_tag";
     String pushListAliasUri = "/push/list/alias";
 
     /**
@@ -39,6 +41,16 @@ public interface PushApi {
     @GtPost(uri = singleCidUri)
     ApiResult<Map<String, Map<String, String>>> pushToSingleByCid(@GtBodyParam PushDTO<Audience> pushDTO);
 
+    /**
+     * 根据标签条件过滤后的cid推送（异步）
+     * 定制接口，需申请开通才可以使用
+     *
+     * @param pushDTO pushDTO
+     * @return ApiResult
+     */
+    @GtPost(uri = singleCidByTagUri)
+    ApiResult<Map<String, Map<String, String>>> pushToSingleCidByTag(@GtBodyParam PushDTO<Audience> pushDTO);
+
     /**
      * 根据别名推送
      *
@@ -57,6 +69,16 @@ public interface PushApi {
     @GtPost(uri = singleBatchCidUri)
     ApiResult<Map<String, Map<String, String>>> pushBatchByCid(@GtBodyParam PushBatchDTO pushBatchDTO);
 
+    /**
+     * 根据标签条件过滤后的cid批量推送（异步）
+     * 定制接口，需申请开通才可以使用
+     *
+     * @param audienceDTO audienceDTO
+     * @return ApiResult
+     */
+    @GtPost(uri = pushListCidByTagUri)
+    ApiResult<Map<String, Map<String, String>>> pushListCidByTag(@GtBodyParam AudienceDTO audienceDTO);
+
     /**
      * 根据别名批量推送
      *

src/main/java/com/getui/push/v2/sdk/core/Configs.java

@@ -13,7 +13,7 @@ public interface Configs {
 
     String HEADER_DOMAIN_HASH_KEY = "domainHash";
     String HEADER_OPEN_STABLE_DOMAIN = "openStableDomain";
-    String SDK_VERSION = "1.0.3.0";
+    String SDK_VERSION = "1.0.4.0";
     /**
      * 预置域名列表
      */

src/main/java/com/getui/push/v2/sdk/dto/CommonEnum.java

@@ -7,6 +7,33 @@
  */
 public interface CommonEnum {
 
+    enum ActivateFilterTypeEnum {
+        ACTIVE(1, "活跃"),
+        INACTIVE(-1, "非活跃");
+
+        public final int type;
+        public final String msg;
+
+        ActivateFilterTypeEnum(int type, String msg) {
+            this.type = type;
+            this.msg = msg;
+        }
+    }
+
+    enum CidByTagOpTypeEnum {
+        OR(0, "只要包含一个就推"),
+        AND(1, "全包含才推送, 默认值"),
+        NOT(2, "全不包含才推送");
+
+        public final int type;
+        public final String msg;
+
+        CidByTagOpTypeEnum(int type, String msg) {
+            this.type = type;
+            this.msg = msg;
+        }
+    }
+
     enum ClickTypeEnum {
         TYPE_INTENT("intent", "打开应用内特定页面"),
         TYPE_URL("url", "打开网页地址"),
@@ -26,8 +53,7 @@ enum ClickTypeEnum {
 
     enum HarmonyClickTypeEnum {
         TYPE_WANT("want", "打开应用内特定页面"),
-        TYPE_STARTAPP("startapp", "打开应用首页")
-        ;
+        TYPE_STARTAPP("startapp", "打开应用首页");
         public final String type;
         public final String msg;
 

src/main/java/com/getui/push/v2/sdk/dto/req/Audience.java

@@ -13,6 +13,7 @@ public class Audience {
     private String fastCustomTag;
     private List<Condition> tag;
     private String all;
+    private List<CidByTagDTO> cidByTag;
 
     public void addCid(String cid) {
         if (this.cid == null) {
@@ -21,6 +22,13 @@ public void addCid(String cid) {
         this.cid.add(cid);
     }
 
+    public void addCidByTag(CidByTagDTO cidByTag) {
+        if (this.cidByTag == null) {
+            this.cidByTag = new ArrayList<>();
+        }
+        this.cidByTag.add(cidByTag);
+    }
+
     public void addAlias(String alias) {
         if (this.alias == null) {
             this.alias = new ArrayList<String>();
@@ -83,6 +91,14 @@ public void setAll(String all) {
         this.all = all;
     }
 
+    public List<CidByTagDTO> getCidByTag() {
+        return cidByTag;
+    }
+
+    public void setCidByTag(List<CidByTagDTO> cidByTag) {
+        this.cidByTag = cidByTag;
+    }
+
     @Override
     public String toString() {
         return "Audience{" +
@@ -92,6 +108,7 @@ public String toString() {
                 ", fastCustomTag='" + fastCustomTag + '\'' +
                 ", tag=" + tag +
                 ", all='" + all + '\'' +
+                ", cidByTag=" + cidByTag +
                 '}';
     }
 }

src/main/java/com/getui/push/v2/sdk/dto/req/CidByTagDTO.java

@@ -0,0 +1,59 @@
+package com.getui.push.v2.sdk.dto.req;
+
+import com.getui.push.v2.sdk.dto.CommonEnum;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class CidByTagDTO {
+    private String cid;
+    /**
+     * 标签列表
+     */
+    private List<String> tag;
+    /**
+     * @see CommonEnum.CidByTagOpTypeEnum
+     * 标签条件过滤类型
+     */
+    private Integer opType = CommonEnum.CidByTagOpTypeEnum.OR.type;
+
+    public String getCid() {
+        return cid;
+    }
+
+    public void setCid(String cid) {
+        this.cid = cid;
+    }
+
+    public List<String> getTag() {
+        return tag;
+    }
+
+    public void setTag(List<String> tag) {
+        this.tag = tag;
+    }
+
+    public void addTag(String tag) {
+        if (this.tag == null) {
+            this.tag = new ArrayList<>();
+        }
+        this.tag.add(tag);
+    }
+
+    public Integer getOpType() {
+        return opType;
+    }
+
+    public void setOpType(CommonEnum.CidByTagOpTypeEnum opType) {
+        this.opType = opType.type;
+    }
+
+    @Override
+    public String toString() {
+        return "CidByTagDTO{" +
+                "cid='" + cid + '\'' +
+                ", tag=" + tag +
+                ", opType=" + opType +
+                '}';
+    }
+}

src/main/java/com/getui/push/v2/sdk/dto/req/Settings.java

@@ -1,5 +1,7 @@
 package com.getui.push.v2.sdk.dto.req;
 
+import com.getui.push.v2.sdk.dto.CommonEnum;
+
 /**
  * 推送条件
  */
@@ -42,6 +44,16 @@ public class Settings {
      */
     private Boolean needBackup;
 
+    /**
+     * 活跃行为的自定义天数，近${activate_filter_day}天活跃/非活跃用户
+     */
+    private Integer activateFilterDay;
+    /**
+     * @see CommonEnum.ActivateFilterTypeEnum
+     * 活跃行为的类型
+     */
+    private Integer activateFilterType;
+
     public Integer getTtl() {
         return ttl;
     }
@@ -106,6 +118,22 @@ public void setNeedBackup(Boolean needBackup) {
         this.needBackup = needBackup;
     }
 
+    public Integer getActivateFilterDay() {
+        return activateFilterDay;
+    }
+
+    public void setActivateFilterDay(Integer activateFilterDay) {
+        this.activateFilterDay = activateFilterDay;
+    }
+
+    public Integer getActivateFilterType() {
+        return activateFilterType;
+    }
+
+    public void setActivateFilterType(CommonEnum.ActivateFilterTypeEnum activateFilterTypeEnum) {
+        this.activateFilterType = activateFilterTypeEnum.type;
+    }
+
     @Override
     public String toString() {
         return "Settings{" +
@@ -117,6 +145,8 @@ public String toString() {
                 ", filterNotifyOff=" + filterNotifyOff +
                 ", activeDays=" + activeDays +
                 ", needBackup=" + needBackup +
+                ", activateFilterDay=" + activateFilterDay +
+                ", activateFilterType=" + activateFilterType +
                 '}';
     }
 }

src/test/java/com/getui/push/v2/sdk/api/PushApiTest.java

@@ -11,14 +11,14 @@
 import com.getui.push.v2.sdk.dto.req.message.PushMessage;
 import com.getui.push.v2.sdk.dto.req.message.android.AndroidDTO;
 import com.getui.push.v2.sdk.dto.req.message.android.GTNotification;
-import com.getui.push.v2.sdk.dto.req.message.harmony.HarmonyDTO;
-import com.getui.push.v2.sdk.dto.req.message.harmony.HarmonyNotification;
-import com.getui.push.v2.sdk.dto.res.ScheduleTaskDTO;
 import com.getui.push.v2.sdk.dto.req.message.android.ThirdNotification;
 import com.getui.push.v2.sdk.dto.req.message.android.Ups;
+import com.getui.push.v2.sdk.dto.req.message.harmony.HarmonyDTO;
+import com.getui.push.v2.sdk.dto.req.message.harmony.HarmonyNotification;
 import com.getui.push.v2.sdk.dto.req.message.ios.Alert;
 import com.getui.push.v2.sdk.dto.req.message.ios.Aps;
 import com.getui.push.v2.sdk.dto.req.message.ios.IosDTO;
+import com.getui.push.v2.sdk.dto.res.ScheduleTaskDTO;
 import com.getui.push.v2.sdk.dto.res.TaskIdDTO;
 import org.junit.Before;
 import org.junit.Test;
@@ -65,6 +65,17 @@ public void pushToSingleByCid() throws InterruptedException {
         }
     }
 
+    @Test
+    public void pushToSingleCidByTag() {
+        PushDTO<Audience> pushDTO = pushDTO();
+        fullCidByTag(pushDTO);
+        pushDTO.getSettings().setActivateFilterDay(4);
+        pushDTO.getSettings().setActivateFilterType(CommonEnum.ActivateFilterTypeEnum.INACTIVE);
+        pushDTO.getSettings().setActivateFilterType(CommonEnum.ActivateFilterTypeEnum.ACTIVE);
+        ApiResult<Map<String, Map<String, String>>> apiResult = pushApi.pushToSingleCidByTag(pushDTO);
+        System.out.println(apiResult);
+    }
+
     @Test
     public void pushToSingleByAlias() {
         PushDTO<Audience> pushDTO = pushDTO();
@@ -119,6 +130,33 @@ public void pushListByCid() {
         }
     }
 
+    @Test
+    public void pushListCidByTag() {
+        while (true) {
+            String taskId = "taskId";
+            AudienceDTO audienceDTO = new AudienceDTO();
+            audienceDTO.setTaskid(taskId);
+            audienceDTO.setAsync(true);
+            audienceDTO.setNeedAliasDetail(false);
+            Audience audience = new Audience();
+
+            CidByTagDTO cidByTagDTO = new CidByTagDTO();
+            cidByTagDTO.setCid(cid);
+            cidByTagDTO.addTag("tag");
+            cidByTagDTO.setOpType(CommonEnum.CidByTagOpTypeEnum.AND);
+            audience.addCidByTag(cidByTagDTO);
+            audience.addCidByTag(cidByTagDTO);
+            audienceDTO.setAudience(audience);
+
+            System.out.println(pushApi.pushListCidByTag(audienceDTO));
+            try {
+                Thread.sleep(1000);
+            } catch (InterruptedException e) {
+            }
+            return;
+        }
+    }
+
     @Test
     public void pushListByAlias() {
         String taskId = "taskId";
@@ -289,6 +327,16 @@ private void fullCid(PushDTO<Audience> pushDTO) {
         pushDTO.setAudience(audience);
     }
 
+    private void fullCidByTag(PushDTO<Audience> pushDTO) {
+        Audience audience = new Audience();
+        pushDTO.setAudience(audience);
+        CidByTagDTO cidByTagDTO = new CidByTagDTO();
+        cidByTagDTO.setCid(cid);
+        cidByTagDTO.addTag("11");
+        cidByTagDTO.setOpType(CommonEnum.CidByTagOpTypeEnum.AND);
+        audience.addCidByTag(cidByTagDTO);
+    }
+
     private void fullAlias(PushDTO<Audience> pushDTO) {
         Audience audience = new Audience();
         String alias = "";