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

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

  • ゼロ以外の年、月、日の値を含む完全な日付。
  • 年の値がゼロである月と日（記念日など）。
  • 月と日の値がゼロである単独の年。
  • 日がゼロである年と月（クレジット カードの有効期限など）

関連するタイプ:

JSON 表現 
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1～9999、または年のない日付を指定する場合は 0 にする必要があります。
month

integer

1 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。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)

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

MessageOutcomePercent

メッセージ配信結果の割合の内訳。これらのカテゴリは相互に排他的です。すべてのパーセンテージは、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

ターゲット デバイスがアクティブでないためにドロップされた、受け入れられたメッセージの割合。ターゲット デバイスがサーバーによって非アクティブとみなされた場合、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

デバイスが Doze モードになっているために遅延した、承諾済みのメッセージの割合。Doze モードにより遅延されるのは、優先度が標準のメッセージのみです。
delayedMessageThrottled

number

折りたたみ可能なメッセージ スロットリングや最大メッセージ レート スロットリングなどのメッセージ スロットリングによって遅延した、承諾済みのメッセージの割合。
delayedUserStopped

number

送信時に対象デバイスで対象デバイスのユーザー プロファイルが停止されていたために遅延した承諾メッセージの割合です。user-profile が再起動されたとき、最終的にメッセージは配信されました。

MessageInsightPercent

メッセージ配信に関する追加情報。すべてのパーセンテージは、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

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