Method: projects.androidApps.deliveryData.list

指定された Android アプリの集約配信データを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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)

提供されたアプリの配信データ。アプリ、日付、アナリティクス ラベルの組み合わせごとに 1 つのエントリがあります。
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

送信されたメールに関連付けられたアナリティクス ラベル。アナリティクス ラベルなしで送信されたメールはすべて、1 つのエントリにまとめられます。
data

object (Data)

指定された appId、date、analyticsLabel のデータ。

Date

誕生日など、カレンダーの日付全体または一部を表します。時刻とタイムゾーンが他の場所で指定されているか、重要ではありません。日付はグレゴリオ暦を基準にしています。次のいずれかを表します。

  • ゼロ以外の年、月、日の値を含む完全な日付。
  • 年が 0 の月と日（記念日など）。
  • 1 年、1 か月が 0 日、1 日が 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)

プロキシ通知の配信に関する追加の分析情報。

MessageOutcomePercents

メッセージ配信結果の割合の内訳。これらのカテゴリは相互に排他的です。すべての割合は、countMessagesAccepted を分母として計算されます。これらのカテゴリは、メッセージの結果をすべて考慮しているとは限りません。

JSON 表現 
{
  "delivered": number,
  "pending": number,
  "droppedTooManyPendingMessages": number,
  "droppedAppForceStopped": number,
  "droppedDeviceInactive": number
}
フィールド
delivered

number

すべての承諾済みメッセージのうち、デバイスに正常に配信されたメッセージの割合。
pending

number

この日に承諾されたメッセージのうち、デバイスの接続が解除されたために破棄されず、配信されなかったメッセージの割合（FCM にメッセージが送信された America/Los_Angeles 1 日の時点の時点）。これらのメッセージの一部はデバイスの接続の翌日に配信されますが、最終的には再接続されないデバイスを宛先とするメッセージもあります。
droppedTooManyPendingMessages

number

未配信の折りたたみできないメッセージが多すぎるために破棄された、承諾済みメッセージの割合。具体的には、切断されたデバイスについて、各アプリ インスタンスが Google のサーバーに保持できる保留中のメッセージは 100 件までです。そのデバイスが再接続されると、それらのメッセージが配信されます。保留中のメッセージが最大数を超えると、メッセージを配信する代わりに、SDK で OnDeletedMessages() を呼び出します。
droppedAppForceStopped

number

配信時にアプリがデバイス上で強制停止され、再試行に失敗したために破棄された、承諾済みメッセージの割合。
droppedDeviceInactive

number

対象デバイスが非アクティブであるために破棄された、承諾済みメッセージの割合。ターゲット デバイスが Google のサーバーによって非アクティブとみなされた場合、FCM はメッセージを破棄します。デバイスが再接続すると、メッセージを配信する代わりに、SDK で OnDeletedMessages() を呼び出します。

デリバリー パフォーマンスの割合

正常に配信されたメッセージの配信パフォーマンスの概要。すべての割合は、countMessagesAccepted を分母として計算されます。これらのカテゴリは相互に排他的ではなく、複数の理由でメールが遅延する可能性があります。

JSON 表現 
{
  "deliveredNoDelay": number,
  "delayedDeviceOffline": number,
  "delayedDeviceDoze": number,
  "delayedMessageThrottled": number,
  "delayedUserStopped": number
}
フィールド
deliveredNoDelay

number

FCM システムから遅延なくデバイスに配信された、承認済みメッセージの割合。
delayedDeviceOffline

number

送信時に対象デバイスが接続されていなかったために遅延した承認済みメッセージの割合。これらのメッセージは、最終的にデバイスが再接続したときに配信されました。
delayedDeviceDoze

number

デバイスが Doze モードだったために遅延した受信メッセージの割合。Doze モードにより遅延するのは、通常の優先度のメッセージのみです。
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

承認された通知のうち、アプリでこれらのメッセージのプロキシが許可されていないためにスキップされた通知の割合。