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 的数据。

日期

表示整个或部分日历日期，例如生日。时段和时区要么在别处指定，要么不重要。该日期相对于公历。这可能表示以下类型之一：

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

相关类型：

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)

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

string (int64 format)

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

object (MessageOutcomePercents)

对消息传送结果相互排斥的细分。
deliveryPerformancePercents

object (DeliveryPerformancePercents)

有关成功递送的消息的递送性能的更多信息。
messageInsightPercents

object (MessageInsightPercents)

有关消息传送的其他常规数据分析。
proxyNotificationInsightPercents

object (ProxyNotificationInsightPercents)

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

消息结果百分比

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

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

number

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

number

当天由于设备断开连接而未丢弃且未递送的消息所占的百分比（截至消息发送到 FCM 的美洲/洛杉矶日结束时）。其中部分消息将在设备连接后的第二天传送，但其他消息可能会发往最终从未重新连接的设备。
droppedTooManyPendingMessages

number

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

number

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

number

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

分发性能百分比

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

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

number

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

number

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

number

因设备处于低电耗模式而延迟接收的消息所占的百分比。在低电耗模式下，应该只会延迟普通优先级消息。
delayedMessageThrottled

number

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

number

因发送时目标设备用户个人资料在目标设备上停止而导致延迟的已接受消息所占的百分比。此消息最终会在用户个人资料重新启动后递送。

消息数据分析百分比

有关邮件递送的更多信息。所有百分比都是以 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

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