Skip to content

Commit 6e7d719

Browse files
jianbin2001jianbin2001
authored
Merge pull request #59 from ZJUCJH/main
[update] 1.StatisticApi Query参数完善;2.新增适配需要返回别名详情响应体的方法;3.新增active_pus…
2 parents a1cb36a + fd5c580 commit 6e7d719

7 files changed

Lines changed: 116 additions & 33 deletions

File tree

‎CHANGES.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Release Notes
22

3+
## 1.0.8.0
4+
5+
### update
6+
7+
* 统计API(StatisticApi) Query参数完善
8+
* 执行别名批量推API(/push/list/alias) 新增适配需要返回别名详情响应体的方法
9+
* 新增active_push_platform参数控制需要启用亮屏推送的平台
10+
311
## 1.0.7.0
412

513
### update

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
<dependency>
2323
<groupId>com.getui.push</groupId>
2424
<artifactId>restful-sdk</artifactId>
25-
<version>1.0.7.0</version>
25+
<version>1.0.8.0</version>
2626
</dependency>
2727
```
2828

‎pom.xml‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<groupId>com.getui.push</groupId>
88
<artifactId>restful-sdk</artifactId>
99
<packaging>jar</packaging>
10-
<version>1.0.7.0</version>
10+
<version>1.0.8.0</version>
1111
<url>https://github.com/GetuiLaboratory/getui-pushapi-java-client-v2</url>
1212
<name>Getui Push API Java Client</name>
1313
<description>Getui's officially supported Java client library for accessing Getui APIs.</description>
@@ -153,17 +153,16 @@
153153
</execution>
154154
</executions>
155155
</plugin>
156+
<plugin>
157+
<groupId>org.sonatype.central</groupId>
158+
<artifactId>central-publishing-maven-plugin</artifactId>
159+
<version>0.6.0</version>
160+
<extensions>true</extensions>
161+
<configuration>
162+
<publishingServerId>central</publishingServerId>
163+
<autoPublish>true</autoPublish>
164+
</configuration>
165+
</plugin>
156166
</plugins>
157167
</build>
158-
159-
<distributionManagement>
160-
<snapshotRepository>
161-
<id>sonatype-nexus-snapshots</id>
162-
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
163-
</snapshotRepository>
164-
<repository>
165-
<id>sonatype-nexus-staging</id>
166-
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2</url>
167-
</repository>
168-
</distributionManagement>
169168
</project>

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,23 @@ public interface PushApi {
107107
ApiResult<Map<String, Map<String, String>>> pushListByCid(@GtBodyParam AudienceDTO audienceDTO);
108108

109109
/**
110-
* 根据别名批量推送
110+
* 根据别名批量推送(不需要返回别名详情)
111111
*
112-
* @param audienceDTO
113-
* @return
112+
* @param audienceDTO 请求body参数
113+
* @return 当need_alias_detail=false时，不返回别名详情时的响应结果
114114
*/
115115
@GtPost(uri = pushListAliasUri)
116116
ApiResult<Map<String, Map<String, String>>> pushListByAlias(@GtBodyParam AudienceDTO audienceDTO);
117117

118+
/**
119+
* 根据别名批量推送(需要返回别名详情)
120+
*
121+
* @param audienceDTO 请求body参数
122+
* @return 当请求参数is_async=false，need_alias_detail=true时，返回别名详情时的响应结果
123+
*/
124+
@GtPost(uri = pushListAliasUri)
125+
ApiResult<Map<String, Map<String, Map<String, String>>>> pushListByAliasNeedAliasDetail(@GtBodyParam AudienceDTO audienceDTO);
126+
118127
/**
119128
* 执行群推
120129
*

‎src/main/java/com/getui/push/v2/sdk/api/StatisticApi.java‎

Lines changed: 58 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,53 +22,95 @@ public interface StatisticApi {
2222
/**
2323
* 获取推送结果
2424
*
25-
* @param taskIds
26-
* @return
25+
* @param taskIds 任务id集合
26+
* @return 推送结果（不含自定义事件）
2727
*/
2828
@GtGet(uri = "/report/push/task/")
2929
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByTaskIds(@GtPathParam Set<String> taskIds);
3030

3131
/**
3232
* 获取推送结果
3333
*
34-
* @param taskIds
35-
* @param actionIds
36-
* @return
34+
* @param taskIds 任务id集合
35+
* @param actionIds 自定义事件id集合
36+
* @return 推送结果（含自定义事件）
3737
*/
3838
@GtGet(uri = "/report/push/task/")
39-
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByTaskIdsAndActionIds(@GtPathParam Set<String> taskIds, @GtQueryParam(name = "actionIdList") Set<String> actionIds);
39+
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByTaskIdsAndActionIds(@GtPathParam Set<String> taskIds,
40+
@GtQueryParam(name = "actionIdList") Set<String> actionIds);
41+
42+
/**
43+
* 获取推送结果
44+
*
45+
* @param taskIds 任务id集合
46+
* @param actionIds 自定义事件id列表
47+
* @param needGetuiByBrand 是否需要个推品牌报表
48+
* @return 推送结果（含自定义事件）
49+
*/
50+
@GtGet(uri = "/report/push/task/")
51+
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByTaskIdsAndActionIds(@GtPathParam Set<String> taskIds,
52+
@GtQueryParam(name = "actionIdList") Set<String> actionIds,
53+
@GtQueryParam(name = "needGetuiByBrand") Boolean needGetuiByBrand);
4054

4155
/**
4256
* 根据组名查询报表
4357
*
44-
* @param groupName
45-
* @return
58+
* @param groupName 任务组名
59+
* @return 任务组名对应的推送结果
4660
*/
4761
@GtGet(uri = "/report/push/task_group/")
4862
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByGroupName(@GtPathParam String groupName);
4963

64+
65+
/**
66+
* 根据组名查询报表
67+
*
68+
* @param groupName 任务组名
69+
* @param needGetuiByBrand 是否需要个推品牌报表
70+
* @param startDate 查询报表开始日期,格式: yyyy-MM-dd
71+
* @param endDate 查询报表结束日期,格式: yyyy-MM-dd
72+
* @return 任务组名对应的推送结果
73+
*/
74+
@GtGet(uri = "/report/push/task_group/")
75+
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByGroupName(@GtPathParam String groupName,
76+
@GtQueryParam(name = "needGetuiByBrand") Boolean needGetuiByBrand,
77+
@GtQueryParam(name = "startDate") String startDate,
78+
@GtQueryParam(name = "endDate") String endDate);
79+
5080
/**
5181
* 获取单日推送数据
5282
*
53-
* @param date formatted as yyyy-MM-dd
54-
* @return
83+
* @param date 日期，格式: yyyy-MM-dd
84+
* @return 某个应用单日的推送数据(推送数据包括 ： 下发数 ， 接收数 、 展示数 、 点击数)
5585
*/
5686
@GtGet(uri = "/report/push/date/")
5787
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByDate(@GtPathParam String date);
5888

89+
90+
/**
91+
* 获取单日推送数据
92+
*
93+
* @param date 日期，格式: yyyy-MM-dd
94+
* @param needGetuiByBrand 是否需要个推品牌报表
95+
* @return 某个应用单日的推送数据(推送数据包括 ： 下发数 ， 接收数 、 展示数 、 点击数)
96+
*/
97+
@GtGet(uri = "/report/push/date/")
98+
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushResultByDate(@GtPathParam String date,
99+
@GtQueryParam(name = "needGetuiByBrand") Boolean needGetuiByBrand);
100+
59101
/**
60102
* 获取单日用户数据
61103
*
62-
* @param date formatted as yyyy-MM-dd
63-
* @return
104+
* @param date 日期，格式: yyyy-MM-dd
105+
* @return 某个应用单日的用户数据(用户数据包括 : 新增用户数 ， 累计注册用户总数 ， 在线峰值 ， 日联网用户数)
64106
*/
65107
@GtGet(uri = "/report/user/date/")
66108
ApiResult<Map<String, Map<String, UserStatisticDTO>>> queryUserDataByDate(@GtPathParam String date);
67109

68110
/**
69111
* 获取24小时在线用户数
70112
*
71-
* @return
113+
* @return 当前时间一天内的在线用户数
72114
*/
73115
@GtGet(uri = "/report/online_user")
74116
ApiResult<Map<String, Map<String, Integer>>> queryOnlineUserData();
@@ -77,16 +119,16 @@ public interface StatisticApi {
77119
/**
78120
* 查询推送量
79121
*
80-
* @return
122+
* @return 应用当日可推送量和推送余量
81123
*/
82124
@GtGet(uri = "/report/push/count")
83125
ApiResult<Map<String, Map<String, PushCountDTO>>> queryPushCountData();
84126

85127
/**
86128
* 获取推送实时结果
87129
*
88-
* @param taskIds
89-
* @return
130+
* @param taskIds 任务id集合
131+
* @return 推送实时结果，下发数，接收数、展示数、点击数和消息折损详情等结果。
90132
*/
91133
@GtGet(uri = "/report/push/task/${taskid}/detail")
92134
ApiResult<Map<String, Map<String, StatisticDTO>>> queryPushTaskDetailData(@GtPathParam Set<String> taskIds);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public interface Configs {
1313

1414
String HEADER_DOMAIN_HASH_KEY = "domainHash";
1515
String HEADER_OPEN_STABLE_DOMAIN = "openStableDomain";
16-
String SDK_VERSION = "1.0.7.0";
16+
String SDK_VERSION = "1.0.8.0";
1717
/**
1818
* 预置域名列表
1919
*/

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
import com.getui.push.v2.sdk.dto.CommonEnum;
44

5+
import java.util.Set;
6+
57
/**
68
* 推送条件
79
*/
@@ -65,6 +67,20 @@ public class Settings {
6567
*/
6668
private Boolean activePush;
6769

70+
/**
71+
* 需要启用亮屏推送的平台列表
72+
* <p>
73+
* 启用亮屏推送才需要设置，未设置默认为[1,3]
74+
* <p>
75+
* 支持的平台：
76+
* <ul>
77+
* <li>1：android平台</li>
78+
* <li>2：ios平台</li>
79+
* <li>3：harmony平台</li>
80+
* </ul>
81+
*/
82+
private Set<Integer> activePushPlatform;
83+
6884
public Integer getTtl() {
6985
return ttl;
7086
}
@@ -161,6 +177,14 @@ public void setActivePush(Boolean activePush) {
161177
this.activePush = activePush;
162178
}
163179

180+
public Set<Integer> getActivePushPlatform() {
181+
return activePushPlatform;
182+
}
183+
184+
public void setActivePushPlatform(Set<Integer> activePushPlatform) {
185+
this.activePushPlatform = activePushPlatform;
186+
}
187+
164188
@Override
165189
public String toString() {
166190
return "Settings{" +
@@ -176,6 +200,7 @@ public String toString() {
176200
", activateFilterType=" + activateFilterType +
177201
", lst=" + lst +
178202
", activePush=" + activePush +
203+
", activePushPlatform=" + activePushPlatform +
179204
'}';
180205
}
181206
}

0 commit comments

Comments
 (0)