- HTTPリクエスト
- パスパラメータ
- クエリパラメータ
- リクエストボディ
- レスポンスボディ
- 認可の範囲
- Android配信データ
- 日付
- データ
- メッセージ結果パーセント
- 配信パフォーマンスのパーセント
- メッセージインサイトパーセント
- それを試してみてください!
指定された 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[] | 提供されたアプリの配信データ。アプリ、日付、分析ラベルの組み合わせごとに 1 つのエントリがあります。 |
nextPageToken | 次のページを取得するために |
認可の範囲
次の OAuth スコープが必要です。
-
https://www.googleapis.com/auth/cloud-platform
Android配信データ
特定の日付、アプリ、分析ラベルの組み合わせのメッセージ配信データ。
JSON表現 |
---|
{ "appId": string, "date": { object ( |
田畑 | |
---|---|
appId | メッセージの送信先のアプリ ID。 |
date | このエントリで表される日付。 |
analyticsLabel | 送信されたメッセージに関連付けられた分析ラベル。分析ラベルなしで送信されたすべてのメッセージは、1 つのエントリにグループ化されます。 |
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 に送信されたアメリカ/ロサンゼルスの日の終わりの時点)。これらのメッセージの一部は、デバイスが接続された翌日に配信されますが、その他のメッセージは、最終的に再接続されないデバイスに送信される可能性があります。 |
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 | 受け入れられたメッセージのうち、優先度が高から通常に下げられたメッセージの割合。メッセージの優先順位の設定についてはドキュメントを参照してください。 |