mirror of
https://gitee.com/binary/weixin-java-tools.git
synced 2025-08-20 00:44:25 +08:00
🎨 优化小程序数据分析接口类的注释文档
This commit is contained in:
Binary Wang
parent
a45f0ac048
commit
5b816242a4
@ -7,7 +7,7 @@ import java.util.Date;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* 小程序数据分析相关接口
|
||||
* 小程序数据分析相关接口。
|
||||
* 文档：https://mp.weixin.qq.com/debug/wxadoc/dev/api/analysis.html
|
||||
*
|
||||
* @author <a href="https://github.com/charmingoh">Charming</a>
|
||||
@ -16,114 +16,114 @@ import java.util.List;
|
||||
public interface WxMaAnalysisService {
|
||||
|
||||
/**
|
||||
* 查询概况趋势
|
||||
* 查询概况趋势。
|
||||
* 温馨提示：小程序接口目前只能查询一天的数据，即 beginDate 和 endDate 一样
|
||||
*
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 概况趋势
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 概况趋势列表
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
List<WxMaSummaryTrend> getDailySummaryTrend(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 获取日访问趋势
|
||||
* 获取日访问趋势。
|
||||
* 温馨提示：小程序接口目前只能查询一天的数据，即 beginDate 和 endDate 一样
|
||||
*
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 日访问趋势
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 日访问趋势列表
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
List<WxMaVisitTrend> getDailyVisitTrend(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 获取周访问趋势
|
||||
* 获取周访问趋势。
|
||||
* 限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)
|
||||
*
|
||||
* @param beginDate 开始日期，为周一日期
|
||||
* @param endDate 结束日期，为周日日期，限定查询一周数据
|
||||
* @return 周访问趋势（每项数据都是一个自然周汇总）
|
||||
* @param beginDate 开始日期，为周一日期
|
||||
* @param endDate 结束日期，为周日日期，限定查询一周数据
|
||||
* @return 周访问趋势列表（每项数据都是一个自然周汇总）
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
List<WxMaVisitTrend> getWeeklyVisitTrend(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 获取月访问趋势
|
||||
* 获取月访问趋势。
|
||||
* 限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170201(月初), 20170228(月末)
|
||||
*
|
||||
* @param beginDate 开始日期，为自然月第一天
|
||||
* @param endDate 结束日期，为自然月最后一天，限定查询一个月数据
|
||||
* @return 月访问趋势（每项数据都是一个自然月汇总）
|
||||
* @param beginDate 开始日期，为自然月第一天
|
||||
* @param endDate 结束日期，为自然月最后一天，限定查询一个月数据
|
||||
* @return 月访问趋势列表（每项数据都是一个自然月汇总）
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
List<WxMaVisitTrend> getMonthlyVisitTrend(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 获取访问分布
|
||||
* 获取访问分布。
|
||||
* （此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样）
|
||||
*
|
||||
* @param beginDate 开始日期，为周一日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 访问分布
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 访问分布对象
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
WxMaVisitDistribution getVisitDistribution(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 日留存
|
||||
* 获取日留存数据。
|
||||
* （此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样）
|
||||
*
|
||||
* @param beginDate 开始日期，为周一日期
|
||||
* @param endDate 结束日期，限定查询 1 天数据，endDate 允许设置的最大值为昨日
|
||||
* @return 日留存
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询 1 天数据，endDate 允许设置的最大值为昨日
|
||||
* @return 日留存信息对象
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
WxMaRetainInfo getDailyRetainInfo(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 周留存
|
||||
* 获取周留存数据。
|
||||
* 限定查询一个自然周的数据，时间必须按照自然周的方式输入： 如：20170306(周一), 20170312(周日)
|
||||
*
|
||||
* @param beginDate 开始日期，为周一日期
|
||||
* @param endDate 结束日期，为周日日期，限定查询一周数据
|
||||
* @return 周留存
|
||||
* @param beginDate 开始日期，为周一日期
|
||||
* @param endDate 结束日期，为周日日期，限定查询一周数据
|
||||
* @return 周留存信息对象
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
WxMaRetainInfo getWeeklyRetainInfo(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 月留存
|
||||
* 获取月留存数据。
|
||||
* 限定查询一个自然月的数据，时间必须按照自然月的方式输入： 如：20170201(月初), 20170228(月末)
|
||||
*
|
||||
* @param beginDate 开始日期，为自然月第一天
|
||||
* @param endDate 结束日期，为自然月最后一天，限定查询一个月数据
|
||||
* @return 月留存
|
||||
* @param beginDate 开始日期，为自然月第一天
|
||||
* @param endDate 结束日期，为自然月最后一天，限定查询一个月数据
|
||||
* @return 月留存信息对象
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
WxMaRetainInfo getMonthlyRetainInfo(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 获取访问页面数据
|
||||
* 获取访问页面数据。
|
||||
* 温馨提示：此接口目前只能查询一天的数据，即 beginDate 和 endDate 一样
|
||||
*
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 访问页面数据
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日
|
||||
* @return 访问页面数据列表
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
List<WxMaVisitPage> getVisitPage(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
/**
|
||||
* 获取小程序新增或活跃用户的画像分布数据
|
||||
* 获取小程序新增或活跃用户的画像分布数据。
|
||||
* 时间范围支持昨天、最近7天、最近30天。
|
||||
* 其中，新增用户数为时间范围内首次访问小程序的去重用户数，
|
||||
* 活跃用户数为时间范围内访问过小程序的去重用户数。
|
||||
* 画像属性包括用户年龄、性别、省份、城市、终端类型、机型。
|
||||
*
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，end_date允许设置的最大值为昨日
|
||||
* @return 小程序新增或活跃用户的画像分布数据
|
||||
* @param beginDate 开始日期
|
||||
* @param endDate 结束日期，开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，end_date允许设置的最大值为昨日
|
||||
* @return 小程序新增或活跃用户的画像分布数据对象
|
||||
* @throws WxErrorException 获取失败时抛出，具体错误码请看文档
|
||||
*/
|
||||
WxMaUserPortrait getUserPortrait(Date beginDate, Date endDate) throws WxErrorException;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user