greport

Documentation

Index

• type APIv3
• type APIv3Builder
  • func NewAPIv3Builder() *APIv3Builder
  • func (b *APIv3Builder) Build() (APIv3, error)
  • func (b *APIv3Builder) DisableHttpLogging() *APIv3Builder
  • func (b *APIv3Builder) SetClient(client api.Client) *APIv3Builder
  • func (b *APIv3Builder) SetGroupKey(groupKey string) *APIv3Builder
  • func (b *APIv3Builder) SetGroupMasterSecret(groupMasterSecret string) *APIv3Builder
  • func (b *APIv3Builder) SetHost(host string) *APIv3Builder
  • func (b *APIv3Builder) SetHttpLogLevel(httpLogLevel api.HttpLogLevel) *APIv3Builder
  • func (b *APIv3Builder) SetLogger(logger jiguang.Logger) *APIv3Builder
• type AndroidPnsStats
• type HmosStats
• type IosStats
• type JPushStats
• type MessageDetail
• type MessageDetailGetResult
  • func (rs *MessageDetailGetResult) IsSuccess() bool
  • func (rs *MessageDetailGetResult) MarshalJSON() ([]byte, error)
  • func (rs *MessageDetailGetResult) UnmarshalJSON(data []byte) error
• type UserDetailGetResult

Types

type APIv3

type APIv3 interface {
	// 消息统计详情（VIP）
	//  - 功能说明：针对分组应用，获取指定 groupMsgIDs（最多支持 10 个）的消息统计数据。只支持查询 30 天以内的推送信息。
	//  - 调用地址：GET `/v3/group/messages/detail`
	//  - 接口文档：https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report#%E5%88%86%E7%BB%84%E7%BB%9F%E8%AE%A1-%E6%B6%88%E6%81%AF%E7%BB%9F%E8%AE%A1%EF%BC%88vip%EF%BC%89
	GetMessageDetail(ctx context.Context, groupMsgIDs []string) (*MessageDetailGetResult, error)

	// 用户统计（VIP）
	//  - 功能说明：针对分组应用，提供近 1 个月内某时间段的用户相关统计数据：新增用户、在线用户、活跃用户。
	//  `start` 起始时间，它的时间单位支持：HOUR（小时，格式例：2020-08-11 09）、DAY（天，格式例：2020-08-11）、MONTH（月，格式例：2020-08）。
	//  `duration` 持续时长，如果时间单位是天，则是持续的天数，以此类推；只支持查询 30 天以内的用户信息，对于时间单位为 HOUR 的，只支持输出当天的统计结果。
	//  - 调用地址：GET `/v3/group/users`
	//  - 接口文档：https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report#%E5%88%86%E7%BB%84%E7%BB%9F%E8%AE%A1-%E7%94%A8%E6%88%B7%E7%BB%9F%E8%AE%A1%EF%BC%88vip%EF%BC%89
	GetUserDetail(ctx context.Context, start jiguang.UnitTime, duration int) (*UserDetailGetResult, error)
}

Group Report API v3【极光推送 > REST API > 统计 API】

• 功能说明：提供分组应用的各类统计数据查询功能。
• 极光文档：https://docs.jiguang.cn/jpush/server/push/rest_api_v3_report

type APIv3Builder

type APIv3Builder struct {
	// contains filtered or unexported fields
}

用于构建和配置 Group Report API v3 访问客户端的构建器。

func NewAPIv3Builder

func NewAPIv3Builder() *APIv3Builder

func (*APIv3Builder) Build

func (b *APIv3Builder) Build() (APIv3, error)

func (*APIv3Builder) DisableHttpLogging

func (b *APIv3Builder) DisableHttpLogging() *APIv3Builder

【可选】禁用 API 的 HTTP 日志记录，即不记录 API 的 HTTP 请求和响应的日志信息。

func (*APIv3Builder) SetClient

func (b *APIv3Builder) SetClient(client api.Client) *APIv3Builder

【可选】设置 API 的客户端，用于发送 HTTP 请求，默认值为 api.DefaultClient。

func (*APIv3Builder) SetGroupKey

func (b *APIv3Builder) SetGroupKey(groupKey string) *APIv3Builder

【必填】设置 API 的应用分组标识。

func (*APIv3Builder) SetGroupMasterSecret

func (b *APIv3Builder) SetGroupMasterSecret(groupMasterSecret string) *APIv3Builder

【必填】设置 API 的应用分组主密钥。

func (*APIv3Builder) SetHost

func (b *APIv3Builder) SetHost(host string) *APIv3Builder

【可选】设置 API 的 Host 基础 URL，默认值为 api.HostJPushReportV3。

func (*APIv3Builder) SetHttpLogLevel

func (b *APIv3Builder) SetHttpLogLevel(httpLogLevel api.HttpLogLevel) *APIv3Builder

【可选】设置 API 的 HTTP 日志记录级别，用于指定记录 API 的 HTTP 请求和响应的日志信息的详细程度，默认值为 api.HttpLogLevelBasic。

• 可用的级别：api.HttpLogLevelNone、api.HttpLogLevelBasic、api.HttpLogLevelHeaders、api.HttpLogLevelFull；
• 若要禁用 HTTP 日志记录，可使用 DisableHttpLogging。

func (*APIv3Builder) SetLogger

func (b *APIv3Builder) SetLogger(logger jiguang.Logger) *APIv3Builder

【可选】设置 API 的日志记录器，默认值为 api.DefaultLogger。

type AndroidPnsStats

type AndroidPnsStats = report.LegacyAndroidPns

type HmosStats

type HmosStats struct {
	HmpnsTarget   *uint64 `json:"hmpns_target,omitempty"`   // 鸿蒙通知推送目标数
	HmpnsSent     *uint64 `json:"hmpns_sent,omitempty"`     // 鸿蒙通知成功推送数，发送到 HMPNs 服务器成功
	HmpnsReceived *uint64 `json:"hmpns_received,omitempty"` // 鸿蒙通知送达展示数，HMPNs 服务器下发到设备并成功展示
	HmpnsClick    *uint64 `json:"hmpns_click,omitempty"`    // 鸿蒙通知用户点击数
	MsgTarget     *uint64 `json:"msg_target,omitempty"`     // 鸿蒙自定义消息推送目标数
	MsgReceived   *uint64 `json:"msg_received,omitempty"`   // 鸿蒙自定义消息推送送达数
	MsgClick      *uint64 `json:"msg_click,omitempty"`      // 鸿蒙自定义消息用户点击数
}

HmosStats 鸿蒙平台统计数据（2024.08.13 新增指标）

type IosStats

type IosStats = report.LegacyIos

type JPushStats

type JPushStats = report.LegacyJPush

type MessageDetail

type MessageDetail struct {
	GroupMsgID string           `json:"group_msgid"`           // 分组推送消息 ID
	JPush      *JPushStats      `json:"jpush,omitempty"`       // 极光通道统计数据，走极光通道下发的普通 Android 用户通知/自定义消息以及 iOS 用户自定义消息总体情况
	AndroidPns *AndroidPnsStats `json:"android_pns,omitempty"` // Android 厂商通道统计数据，走厂商通道下发统计数据
	IOS        *IosStats        `json:"ios,omitempty"`         // iOS 平台统计数据
	HMOS       *HmosStats       `json:"hmos,omitempty"`        // 鸿蒙平台统计数据
}

分组消息统计详情

type MessageDetailGetResult

type MessageDetailGetResult struct {
	*api.Response  `json:"-"`
	Error          *api.CodeError  `json:"error,omitempty"`
	MessageDetails []MessageDetail `json:"-"`
}

func (*MessageDetailGetResult) IsSuccess

func (rs *MessageDetailGetResult) IsSuccess() bool

func (*MessageDetailGetResult) MarshalJSON

func (rs *MessageDetailGetResult) MarshalJSON() ([]byte, error)

func (*MessageDetailGetResult) UnmarshalJSON

func (rs *MessageDetailGetResult) UnmarshalJSON(data []byte) error

type UserDetailGetResult

type UserDetailGetResult = report.UserDetailGetResult