列出給定 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 | 優先順序從高降低到正常的已接受訊息的百分比。請參閱有關設定訊息優先順序的文件。 |