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 之間；如要指定不含月和日的年份，請輸入 1 至 0。
day

integer

日期，值必須介於 1 至 31 之間且有效的年份和月份。如要單獨指定年份，或指定年份和月份，則不重要。

資料

訊息傳送的詳細資料

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)

關於 Proxy 通知傳送的其他深入分析。

MessageOutcomePercents

訊息傳送結果的細目百分比。這些類別彼此互斥，無法同時套用。所有百分比均以 countMessagesAccepted 做為分母計算。這些類別不一定會考量所有訊息結果。

JSON 表示法 
{
  "delivered": number,
  "pending": number,
  "droppedTooManyPendingMessages": number,
  "droppedAppForceStopped": number,
  "droppedDeviceInactive": number
}
欄位
delivered

number

所有成功傳送到裝置的訊息百分比。
pending

number

當天接受且未傳送且因裝置連線中斷 (截至美國/Los_Angeles) 與 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

因目標裝置在傳送訊息時，目標裝置已停止指定裝置使用者設定檔而延遲的已接受郵件百分比。訊息最終已再次啟動使用者設定檔時已送出。

MessageInsightPercents

有關郵件傳送的其他資訊。所有百分比均以 countMessagesAccepted 做為分母計算。

JSON 表示法 
{
  "priorityLowered": number
}
欄位
priorityLowered

number

有效郵件的優先程度由高至低降低的百分比。請參閱設定訊息優先順序的說明文件。

ProxyNotificationInsightPercents

其他關於 Proxy 通知傳遞的資訊。所有百分比均以 countNotificationsAccepted 做為分母計算。

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

number

成功透過 Google Play 服務進行 Proxy 處理的已接受通知百分比。
failed

number

無法由 Proxy 處理的已接受通知百分比。這通常是呼叫 notifyAsPackage 時發生的例外狀況。
skippedUnsupported

number

收件者不支援 Proxy 通知，因此遭略過的通知接受百分比。
skippedNotThrottled

number

因訊息未受限而遭略過的通知百分比。
skippedUnconfigured

number

因為缺少透過 Proxy 處理通知所需的設定，而略過的已接受通知百分比。
skippedOptedOut

number

因應用程式不允許對這些訊息進行 Proxy 處理，而略過的已接受通知百分比。