1 Star 10 Fork 4

sunron/getui-pushapi-java-client-v2

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

欢迎使用个推PUSH SDK For Java

个推PUSH SDK For Java的主要目标是提升开发者在服务端集成个推推送服务的开发效率。 开发者不需要进行复杂编程即可使用个推推送服务的各项常用功能,SDK可以自动帮您满足调用过程中所需的鉴权、组装参数、发送HTTP请求等非功能性要求。

下面向您介绍个推PUSH SDK For Java的使用方法。

环境要求

  1. 需要配合JDK 1.6或其以上版本。

  2. 使用个推PUSH SDK前,您需要先前往个推开发者中心 完成开发者接入的一些准备工作,创建应用。详细见操作步骤

  3. 准备工作完成后,前往个推开发者中心获取应用配置,后续将作为使用SDK的输入。详细见操作步骤

安装依赖

通过Maven来管理项目依赖

推荐通过Maven来管理项目依赖,您只需在项目的pom.xml文件中声明如下依赖

    <dependency>
        <groupId>com.getui.push</groupId>
        <artifactId>restful-sdk</artifactId>
        <version>1.0.0.1</version>
    </dependency>

快速开始

普通调用

下列代码示例向您展示了使用个推Push SDK For Java调用一个API的3个主要步骤:

  1. 设置参数,创建API。
  2. 发起API调用。
  3. 处理响应。
使用示例:创建API
public class TestCreatApi {
    public void test() {
        GtApiConfiguration apiConfiguration = new GtApiConfiguration();
        //填写应用配置
        apiConfiguration.setAppId("xxx");
        apiConfiguration.setAppKey("xxx");
        apiConfiguration.setMasterSecret("xxx");
        // 接口调用前缀,请查看文档: 接口调用规范 -> 接口前缀, 可不填写appId
        apiConfiguration.setDomain("https://restapi.getui.com/v2/");
        // 实例化ApiHelper对象,用于创建接口对象
        ApiHelper apiHelper = ApiHelper.build(apiConfiguration);
        // 创建对象,建议复用。目前有PushApi、StatisticApi、UserApi
        PushApi pushApi = apiHelper.creatApi(PushApi.class);
        }
    }
使用示例:推送API_根据cid进行单推
public class TestPushApi {
    //pushApi的创建见上述使用示例:创建API
    public PushApi pushApi;
    public void test() {        
        //根据cid进行单推
        PushDTO<Audience> pushDTO = new PushDTO<Audience>();
        // 设置推送参数
        pushDTO.setRequestId(System.currentTimeMillis() + "");
        PushMessage pushMessage = new PushMessage();
        pushDTO.setPushMessage(pushMessage);
        GTNotification notification = new GTNotification();
        pushMessage.setNotification(notification);
        notification.setTitle("标题" + new Date());
        notification.setBody("body");
        notification.setClickType("url");
        notification.setUrl("https://www.getui.com");
        // 设置接收人信息
        Audience audience = new Audience();
        pushDTO.setAudience(audience);
        audience.addCid("xxx");

        // 进行cid单推
        ApiResult<Map<String, Map<String, String>>> apiResult = pushApi.pushToSingleByCid(pushDTO);
        if (apiResult.isSuccess()) {
            // success
            System.out.println(apiResult.getData());
        } else {
            // failed
            System.out.println("code:" + apiResult.getCode() + ", msg: " + apiResult.getMsg());
        }
    }
}
使用示例:统计API_获取单日推送数据
public class TestStatisticApi {
    //StatisticApi的创建见上述使用示例:创建API
    public StatisticApi statisticApi;
    public void test() {
        // 获取单日推送数据
        Set<String> taskIds = new HashSet<String>();
        taskIds.add("xxx");
        ApiResult<Map<String, Map<String, StatisticDTO>>> apiResult = statisticApi.queryPushResultByTaskIds(taskIds);
        if (apiResult.isSuccess()) {
            // success
            System.out.println(apiResult.getData());
        } else {
            // failed
            System.out.println("code:" + apiResult.getCode() + ", msg: " + apiResult.getMsg());
        }
    }
}
使用示例:用户API_查询用户状态
public class TestUserApi {
    //UserApi的创建见上述使用示例:创建API
    public UserApi userApi;
    public void test() {
        Set<String> cids = new HashSet<String>();
        cids.add("xxx");
        // 查询用户状态
        ApiResult<Map<String, CidStatusDTO>> apiResult = userApi.queryUserStatus(cids);
        if (apiResult.isSuccess()) {
            // success
            System.out.println(apiResult.getData());
        } else {
            // failed
            System.out.println("code:" + apiResult.getCode() + ", msg: " + apiResult.getMsg());
        }
    }
}

其余推送功能可参考该链接

设置代理

当需要使用代理进行http访问时,可以参考如下设置

        GtApiConfiguration apiConfiguration = new GtApiConfiguration();
        //设置代理对象,参数依次为host、端口、鉴权账户、鉴权密码。其中鉴权账户密码可选
        GtHttpProxyConfig proxyConfig = new GtHttpProxyConfig("xxx",xxx,"xxx","xxx");
        apiConfiguration.setProxyConfig(proxyConfig);
        ApiHelper apiHelper = ApiHelper.build(apiConfiguration);
        PushApi pushApi = apiHelper.creatApi(PushApi.class);

已支持的API列表

以下是消息推送功能与推送API的对应关系

API类别 功能 调用的API名称
鉴权API 鉴权 com.getui.push.v2.sdk.api.AuthApi.auth
鉴权API 删除鉴权 com.getui.push.v2.sdk.api.AuthApi.close
推送API cid单推 com.getui.push.v2.sdk.api.PushApi.pushToSingleByCid
推送API 别名单推 com.getui.push.v2.sdk.api.PushApi.pushToSingleByAlias
推送API cid批量单推 com.getui.push.v2.sdk.api.PushApi.pushBatchByCid
推送API 别名批量单推 com.getui.push.v2.sdk.api.PushApi.pushBatchByAlias
推送API tolist创建消息 com.getui.push.v2.sdk.api.PushApi.createMsg
推送API cid批量推 com.getui.push.v2.sdk.api.PushApi.pushListByCid
推送API 别名批量推 com.getui.push.v2.sdk.api.PushApi.pushListByAlias
推送API 群推 com.getui.push.v2.sdk.api.PushApi.pushAll
推送API 条件筛选用户推送 com.getui.push.v2.sdk.api.PushApi.pushByTag
推送API 标签快速推送 com.getui.push.v2.sdk.api.PushApi.pushByFastCustomTag
推送API 停止任务 com.getui.push.v2.sdk.api.PushApi.stopPush
推送API 查询定时任务 com.getui.push.v2.sdk.api.PushApi.queryScheduleTask
推送API 删除定时任务 com.getui.push.v2.sdk.api.PushApi.deleteScheduleTask
统计API 获取推送结果 com.getui.push.v2.sdk.api.StatisticApi.queryPushResultByTaskIds
统计API 任务组名查报表 com.getui.push.v2.sdk.api.StatisticApi.queryPushResultByGroupName
统计API 单日推送数据 com.getui.push.v2.sdk.api.StatisticApi.queryPushResultByDate
统计API 单日用户数据接口 com.getui.push.v2.sdk.api.StatisticApi.queryUserDataByDate
统计API 24小时在线用户数 com.getui.push.v2.sdk.api.StatisticApi.queryOnlineUserData
用户API 绑定别名 com.getui.push.v2.sdk.api.UserApi.bindAlias
用户API 根据cid查询别名 com.getui.push.v2.sdk.api.UserApi.queryAliasByCid
用户API 根据别名查询cid com.getui.push.v2.sdk.api.UserApi.queryCidByAlias
用户API 批量解绑别名 com.getui.push.v2.sdk.api.UserApi.batchUnbindAlias
用户API 解绑所有别名 com.getui.push.v2.sdk.api.UserApi.unbindAllAlias
用户API 一个用户绑定一批标签 com.getui.push.v2.sdk.api.UserApi.userBindTags
用户API 一批用户绑定一个标签 com.getui.push.v2.sdk.api.UserApi.usersBindTag
用户API 一批用户解绑一个标签 com.getui.push.v2.sdk.api.UserApi.deleteUsersTag
用户API 查询标签 com.getui.push.v2.sdk.api.UserApi.queryUserTags
用户API 添加黑名单用户 com.getui.push.v2.sdk.api.UserApi.addBlackUser
用户API 移除黑名单用户 com.getui.push.v2.sdk.api.UserApi.removeBlackUser
用户API 查询用户状态 com.getui.push.v2.sdk.api.UserApi.queryUserStatus
用户API 设置角标(仅支持IOS) com.getui.push.v2.sdk.api.UserApi.setBadge
用户API 查询用户总量 com.getui.push.v2.sdk.api.UserApi.queryUser

注:更多API持续更新中,敬请期待。

新API接口开发指南

  1. 新建api接口类,使用类注解com.getui.push.v2.sdk.anno.GtApi标记为个推接口类

  2. 接口,使用com.getui.push.v2.sdk.anno.method包下的方法注解GtGet/GtPost/GtPut/GtDelete标记请求方式,分别代表GETPOSTPUTDELETE四种HTTP请求方式

  3. 参数,使用com.getui.push.v2.sdk.anno.param包下的参数注解GtPathParam/GtHeaderParam/GtQueryParam/GtBodyParam标记参数类型,分别表示HTTP请求中的四种参数: 路径参数/header参数/query参数/body参数

其他链接

个推开发者平台

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

个推官方提供的推送服务端SDK(Java语言),基于全新的RestAPI V2接口(https://docs.getui.com/getui/server/rest_v2/introduction/),因为在github上太慢了,故此导入码云 展开 收起
README
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/sunronsoft/getui-pushapi-java-client-v2.git
git@gitee.com:sunronsoft/getui-pushapi-java-client-v2.git
sunronsoft
getui-pushapi-java-client-v2
getui-pushapi-java-client-v2
main

搜索帮助