Method: projects.androidApps.deliveryData.list

列出给定 Android 应用的汇总提交数据。

HTTP 请求

GET https://fcmdata.googleapis.com/v1beta1/{parent=projects/*/androidApps/*}/deliveryData

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要为其列出配送数据的应用。格式：projects/{projectId}/androidApps/{appId}

查询参数

参数
pageSize

integer

要返回的最大条目数。服务返回的值可能小于此值。如果未指定，则最多返回 1,000 个条目。最大值为 10,000；大于 10,000 的值上限为 10,000。此默认值可能会随时间而变化。
pageToken

string

从之前的 ListAndroidDeliveryDataRequest 调用接收的页面令牌。提供此令牌以检索后续页面。进行分页时，提供给 ListAndroidDeliveryDataRequest 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

deliveryData.list 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "androidDeliveryData": [
    {
      object (AndroidDeliveryData)
    }
  ],
  "nextPageToken": string
}
字段
androidDeliveryData[]

object (AndroidDeliveryData)

所提供应用的投放数据。每个应用、日期和分析标签的组合将有一个条目。
nextPageToken

string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/cloud-platform

AndroidDeliveryData

给定日期、应用和分析标签组合的消息传送数据。

JSON 表示法 
{
  "appId": string,
  "date": {
    object (Date)
  },
  "analyticsLabel": string,
  "data": {
    object (Data)
  }
}
字段
appId

string

消息发送到的应用 ID。
date

object (Date)

此条目表示的日期。
analyticsLabel

string

与发送的邮件相关联的分析标签。所有不带分析标签的邮件都将组合到一个条目中。
data

object (Data)

指定的 appId、date 和 analyticsLabel 的数据。

日期

表示整个或部分日历日期（例如生日）。一天中的时间和时区要么在别处指定，要么不重要。日期相对于公历。可以表示以下任一情况：

  • 包含非零年份、月份和天值的完整日期。
  • 月份和天，年份值为零（例如周年纪念日）。
  • 单独的年份，月份和天值为零。
  • 年份和月份，天值为零（例如，信用卡到期日期）。

相关类型：

JSON 表示法 
{
  "year": integer,
  "month": integer,
  "day": integer
}
字段
year

integer

日期中的年份。必须介于 1 到 9999 之间，或为 0（即指定不含年份的日期）。
month

integer

一年中的第几个月。必须介于 1 到 12 之间，或为 0（即只指定年份，不指定月份和天值）。
day

integer

一个月中的第几天。必须介于 1 到 31 之间并且对年份和月份有效，或为 0（即天不重要，指定单独的年份或者年份和月份）。

数据

详细说明消息传递的数据

JSON 表示法 
{
  "countMessagesAccepted": string,
  "countNotificationsAccepted": string,
  "messageOutcomePercents": {
    object (MessageOutcomePercents)
  },
  "deliveryPerformancePercents": {
    object (DeliveryPerformancePercents)
  },
  "messageInsightPercents": {
    object (MessageInsightPercents)
  },
  "proxyNotificationInsightPercents": {
    object (ProxyNotificationInsightPercents)
  }
}
字段
countMessagesAccepted

string (int64 format)

FCM 接受的适用于 Android 设备的消息数。目标设备必须已选择启用使用情况和诊断信息收集功能。
countNotificationsAccepted

string (int64 format)

FCM 接受的适用于 Android 设备的通知数。目标设备必须已选择启用使用情况和诊断信息收集功能。
messageOutcomePercents

object (MessageOutcomePercents)

消息传送结果相互排斥。
deliveryPerformancePercents

object (DeliveryPerformancePercents)

有关已成功递送的邮件的递送性能的额外信息。
messageInsightPercents

object (MessageInsightPercents)

有关消息传送的其他一般数据分析。
proxyNotificationInsightPercents

object (ProxyNotificationInsightPercents)

有关代理通知递送的其他数据分析。

MessageOutputPercents

消息传送结果的百分比细分。这些类别相互排斥。所有百分比都是以 countMessagesAccepted 为分母计算的。这些类别可能不会考虑所有消息结果。

JSON 表示法 
{
  "delivered": number,
  "pending": number,
  "collapsed": number,
  "droppedTooManyPendingMessages": number,
  "droppedAppForceStopped": number,
  "droppedDeviceInactive": number,
  "droppedTtlExpired": number
}
字段
delivered

number

已成功传送到设备的所有已接受消息所占的百分比。
pending

number

当天已接受的消息中，由于设备断开连接（截至消息发送到 FCM 之日的美国/洛杉矶日结束时）而丢弃且未传送的消息所占的百分比。其中一部分消息将在设备连接次日时传递，但其他消息可能被发送到最终永远无法重新连接的设备。
collapsed

number

被其他消息收起的已接受消息所占的百分比。
droppedTooManyPendingMessages

number

由于未递送的不可折叠消息过多而被丢弃的已接受消息所占的百分比。具体来说，对于已断开连接的设备，每个应用实例只能在我们的服务器上存储 100 条待处理消息。当该设备重新连接后，系统就会传递这些消息。当待处理消息数超过上限时，我们会在 SDK 中调用 OnDeletedMessages()，而不会传送消息。
droppedAppForceStopped

number

因传送时应用在设备上强行停止且重试失败而丢弃的已接受消息所占的百分比。
droppedDeviceInactive

number

由于目标设备处于非活动状态而丢弃的已接受消息所占的百分比。如果我们的服务器认为目标设备处于非活动状态，FCM 将丢弃消息。如果设备确实重新连接了，我们会在 SDK 中调用 OnDeletedMessages()，而不是传递消息。
droppedTtlExpired

number

因在目标设备重新连接前存留时间 (TTL) 而过期的已接受消息所占的百分比。

投放效果百分比

已成功递送的邮件的递送性能概览。所有百分比都是以 countMessagesAccepted 为分母计算的。这些类别不会相互排斥；邮件可能会由于多种原因而延迟。

JSON 表示法 
{
  "deliveredNoDelay": number,
  "delayedDeviceOffline": number,
  "delayedDeviceDoze": number,
  "delayedMessageThrottled": number,
  "delayedUserStopped": number
}
字段
deliveredNoDelay

number

从 FCM 系统无延迟地传送至设备的已接受消息所占的百分比。
delayedDeviceOffline

number

由于发送时目标设备未连接而出现延迟的已接受消息所占的百分比。这些消息最终在设备重新连接后传送。
delayedDeviceDoze

number

由于设备处于低电耗模式而出现延迟的已接受消息所占的百分比。低电耗模式应延迟仅一般优先级消息。
delayedMessageThrottled

number

由于消息限制（例如可折叠消息限制或消息速率上限限制）而延迟的已接受消息所占的百分比。
delayedUserStopped

number

由于目标设备在发送时停用了目标设备配置文件而出现延迟的已接受消息所占的百分比。这些消息最终会在用户个人资料重新启用后递送。

MessageInsightPercents

有关邮件递送的更多信息。所有百分比都是以 countMessagesAccepted 为分母计算的。

JSON 表示法 
{
  "priorityLowered": number
}
字段
priorityLowered

number

将优先级从高降至正常的已接受消息所占的百分比。请参阅关于如何设置消息优先级的文档。

ProxyNotificationInsightPercents

有关代理通知递送的更多信息。所有百分比都是以 countNotificationsAccepted 为分母计算的。

JSON 表示法 
{
  "proxied": number,
  "failed": number,
  "skippedUnsupported": number,
  "skippedNotThrottled": number,
  "skippedUnconfigured": number,
  "skippedOptedOut": number
}
字段
proxied

number

Google Play 服务成功代理的已接受通知所占的百分比。
failed

number

未能代理的已接受通知所占的百分比。这通常是调用 notifyAsPackage 时发生的异常引起的。
skippedUnsupported

number

因收件人不支持代理通知而跳过的已接受通知所占的百分比。
skippedNotThrottled

number

由于消息未受限而跳过的已接受通知所占的百分比。
skippedUnconfigured

number

由于缺少通知代理所需的配置而被跳过的已接受通知的百分比。
skippedOptedOut

number

由于应用禁止代理这些消息而跳过的已接受通知所占的百分比。