列出给定 Android 应用程序的聚合交付数据。
HTTP请求
GET https://fcmdata.googleapis.com/v1beta1/{parent=projects/*/androidApps/*}/deliveryData
URL 使用gRPC 转码语法。
路径参数
参数 | |
---|---|
parent | 必需的。列出传送数据的应用程序。格式: |
查询参数
参数 | |
---|---|
pageSize | 要返回的最大条目数。该服务返回的值可能会少于此值。如果未指定,最多将返回 1,000 个条目。最大值为10,000;超过 10,000 的值将限制为 10,000。此默认值可能会随着时间的推移而改变。 |
pageToken | 从之前的 |
请求正文
请求正文必须为空。
响应体
如果成功,响应正文包含具有以下结构的数据:
DeliveryData.list 的响应消息。
JSON 表示 |
---|
{
"androidDeliveryData": [
{
object ( |
领域 | |
---|---|
androidDeliveryData[] | 所提供应用程序的交付数据。应用程序、日期和分析标签的每个组合都会有一个条目。 |
nextPageToken | 一个令牌,可以作为 |
授权范围
需要以下 OAuth 范围:
-
https://www.googleapis.com/auth/cloud-platform
AndroidDeliveryData
给定日期、应用程序和分析标签组合的消息传递数据。
JSON 表示 |
---|
{ "appId": string, "date": { object ( |
领域 | |
---|---|
appId | 消息发送到的应用程序 ID。 |
date | 此条目表示的日期。 |
analyticsLabel | 与发送的消息关联的分析标签。所有发送的没有分析标签的消息将被分组到一个条目中。 |
data | 指定的 |
日期
表示整个或部分日历日期,例如生日。一天中的时间和时区要么在其他地方指定,要么无关紧要。该日期是相对于公历的。这可以代表以下之一:
- 完整日期,具有非零年、月和日值。
- 一个月和一天,年份为零(例如周年纪念日)。
- 一年本身,有零个月和零日。
- 年和月,带有零日(例如,信用卡到期日期)。
相关类型:
-
google.type.TimeOfDay
-
google.type.DateTime
-
google.protobuf.Timestamp
JSON 表示 |
---|
{ "year": integer, "month": integer, "day": integer } |
领域 | |
---|---|
year | 日期年份。必须介于 1 到 9999 之间,或使用 0 来指定不带年份的日期。 |
month | 一年中的一个月。必须介于 1 到 12 之间,或者使用 0 来指定没有月份和日期的年份。 |
day | 一个月中的一天。必须介于 1 到 31 之间,并且对年份和月份有效,或者使用 0 来单独指定年份,或者指定年份和月份(其中日期不重要)。 |
数据
详细说明消息传递的数据
JSON 表示 |
---|
{ "countMessagesAccepted": string, "messageOutcomePercents": { object ( |
领域 | |
---|---|
countMessagesAccepted | FCM 接受的发往 Android 设备的消息计数。目标设备必须选择收集使用情况和诊断信息。 |
messageOutcomePercents | 消息传递结果的互斥细分。 |
deliveryPerformancePercents | 有关已成功传递的消息的传递性能的其他信息。 |
messageInsightPercents | 有关消息传递的其他一般见解。 |
消息结果百分比
消息传递结果的百分比细分。这些类别是相互排斥的。所有百分比均以countMessagesAccepted
作为分母计算。这些类别可能无法解释所有消息结果。
JSON 表示 |
---|
{ "delivered": number, "pending": number, "droppedTooManyPendingMessages": number, "droppedAppForceStopped": number, "droppedDeviceInactive": number } |
领域 | |
---|---|
delivered | 成功传送到设备的所有已接受消息的百分比。 |
pending | 由于设备断开连接(截至消息发送到 FCM 的 America/Los_Angeles 日结束时),当天接受的未丢弃和未传递的消息的百分比。这些消息的一部分将在第二天设备连接时传递,但其他消息可能会发送到最终永远不会重新连接的设备。 |
droppedTooManyPendingMessages | 由于太多未传递的不可折叠消息而被丢弃的已接受消息的百分比。具体来说,对于断开连接的设备,每个应用程序实例只能在我们的服务器上存储 100 条待处理消息。当该设备重新连接时,这些消息将被传递。当待处理消息数量超过最大数量时,我们会在 SDK 中调用OnDeletedMessages() ,而不是传递消息。 |
droppedAppForceStopped | 由于应用程序在传送时在设备上强制停止且重试不成功而被丢弃的已接受消息的百分比。 |
droppedDeviceInactive | 由于目标设备不活动而被丢弃的已接受消息的百分比。如果我们的服务器认为目标设备处于非活动状态,FCM 将丢弃消息。如果设备重新连接,我们会在 SDK 中调用OnDeletedMessages() ,而不是传递消息。 |
交付绩效百分比
已成功传递的消息的传递性能概述。所有百分比均以countMessagesAccepted
作为分母计算。这些类别并不相互排斥;消息可能因多种原因而延迟。
JSON 表示 |
---|
{ "deliveredNoDelay": number, "delayedDeviceOffline": number, "delayedDeviceDoze": number, "delayedMessageThrottled": number, "delayedUserStopped": number } |
领域 | |
---|---|
deliveredNoDelay | 从 FCM 系统立即传送到设备的已接受消息的百分比。 |
delayedDeviceOffline | 由于发送时目标设备未连接而延迟的已接受消息的百分比。当设备重新连接时,这些消息最终被传递。 |
delayedDeviceDoze | 由于设备处于休眠模式而延迟的已接受消息的百分比。由于打瞌睡模式,只有正常优先级的消息才会被延迟。 |
delayedMessageThrottled | |
delayedUserStopped | 由于发送时预期设备用户配置文件在目标设备上停止而导致延迟的已接受消息的百分比。当用户配置文件再次启动时,消息最终被传递。 |
消息洞察百分比
有关消息传递的附加信息。所有百分比均以countMessagesAccepted
作为分母计算。
JSON 表示 |
---|
{ "priorityLowered": number } |
领域 | |
---|---|
priorityLowered | 优先级从高降低到正常的已接受消息的百分比。请参阅有关设置消息优先级的文档。 |