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 的月份和日期，例如週年紀念日。
  • 有 1 年，第 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)

FCM 針對 Android 裝置接受的訊息數。指定裝置必須選擇允許收集使用狀況與診斷資訊。
countNotificationsAccepted

string (int64 format)

FCM 針對 Android 裝置接受的通知數量。指定裝置必須選擇允許收集使用狀況與診斷資訊。
messageOutcomePercents

object (MessageOutcomePercents)

訊息傳送結果的互斥詳細分析。
deliveryPerformancePercents

object (DeliveryPerformancePercents)

針對成功送達的郵件提供傳送成效的額外資訊。
messageInsightPercents

object (MessageInsightPercents)

有關訊息傳送的其他一般洞察。
proxyNotificationInsightPercents

object (ProxyNotificationInsightPercents)

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

郵件結果百分比

訊息傳送結果的百分比細目。這些類別互斥，無法並用。所有百分比都會以 countMessagesAccepted 做為分母計算。不過，這些類別可能無法涵蓋所有訊息結果。

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

number

成功傳送至裝置的可接受訊息百分比。
pending

number

當天接受訊息後，因裝置連線中斷而未傳送且未傳送的訊息百分比 (即訊息傳送至 FCM 的 America/Los_Angeles 日結束)。系統會在隔天在裝置連線時傳送部分訊息，但其他訊息可能會被送往最終從未重新連線的裝置。
collapsed

number

已接受訊息中其他訊息收合的百分比。
droppedTooManyPendingMessages

number

受允許訊息因無法送達的無法收合訊息過多而遭捨棄的百分比。具體來說，對於已中斷連線的裝置，每個應用程式執行個體最多只能在我們的伺服器上儲存 100 則待處理訊息。該裝置重新連線後，系統就會開始傳送這些訊息。當待處理訊息數量超過上限時，我們會在 SDK 中呼叫 OnDeletedMessages()，而是改為傳送訊息。
droppedAppForceStopped

number

裝置在推送與重試失敗時，強制在裝置上停止應用程式，因此已接受訊息的百分比。
droppedDeviceInactive

number

因為目標裝置處於閒置狀態，而遭捨棄的訊息百分比。如果 Google 伺服器判定目標裝置處於閒置狀態，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

接受訊息的百分比因為預定裝置使用者設定檔在傳送時遭到目標裝置上的停止而延遲。系統最後是在使用者設定檔重新啟動時傳送這些訊息。

訊息深入分析百分比

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

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

number

已接受訊息的優先順序從高到一般的百分比。請參閱設定郵件優先順序的說明文件。

Proxy 通知深入分析百分比

關於 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 傳送這類訊息，因此略過通知的接受次數百分比。