Firebase Cloud Messaging の HTTP プロトコル

このパラメータでは、メッセージの受信者を指定します。

指定できる値は、デバイスの登録トークン、デバイス グループの通知キー、または（/topics/ の接頭辞が付いた）単一のトピックです。複数のトピックに送信するには、condition パラメータを使用します。

このパラメータは、複数の登録トークンに送信されるマルチキャスト メッセージの受信者を指定します。

値には、マルチキャスト メッセージの送信先となる登録トークンの配列を指定します。配列には少なくとも 1 つの登録トークンが含まれている必要があります。指定可能な最大登録トークン数は 1,000 個です。単一のデバイスにメッセージを送信するには、to パラメータを使用します。

マルチキャスト メッセージには HTTP JSON 形式のみを使用できます。

このパラメータでは、メッセージのターゲットを決定する条件の論理式を指定します。

サポートされる条件: 「'yourTopic' in topics」の形式で表したトピック。この値は大文字と小文字が区別されません。

サポートされる演算子: &&、||。トピック メッセージ 1 つあたり演算子は 2 つまで使用できます。

このパラメータは廃止されました。代わりに、to を使用してメッセージの受信者を指定してください。複数のデバイスにメッセージを送信する方法の詳細については、お使いのプラットフォームのドキュメントをご覧ください。

このパラメータは、配信が再開されるときに最後のメッセージだけが送信されるように、折りたたみ可能なメッセージのグループを（たとえば collapse_key: "Updates Available" により）識別します。これは、デバイスがオンラインに戻るか、アクティブになったときに、同じメッセージが過剰に送信されないようにするためのものです。

メッセージが送信される順序は保証されません。

注: 任意の時点で最大 4 つの異なる折りたたみキーを使用できます。つまり、FCM はクライアント アプリごとに 4 つの異なるメッセージを同時に保存できます。この数を超えた場合、FCM が保存する 4 つの折りたたみキーがどれになるかは保証されません。

メッセージの優先度を設定します。有効な値は「normal」と「high」です。Apple プラットフォームでは、これらは APNs 優先度の 5 と 10 に相当します。

デフォルトでは、通知メッセージは high（高）の優先度で送信され、データ メッセージは normal（標準）の優先度で送信されます。優先度が normal の場合、クライアント アプリのバッテリー消費量が最適化されるため、すぐに配信する必要がない限り、これを使用してください。 この優先度を指定されたメッセージは、アプリで受信されるまでに不特定の遅延が発生する可能性があります。

優先度が high のメッセージはすぐに送信され、アプリに通知が表示されます。

Apple プラットフォームでは、このフィールドを使用して APNs ペイロード内の content-available を表します。通知やメッセージの送信時にこのフィールドが true に設定されている場合、非アクティブなクライアント アプリのスリープ状態が解除されます。また、メッセージは FCM ではなく APNs を介して、サイレント通知として送信されます。APNs のサイレント通知の配信は保証されておらず、ユーザーが [低電力モード] をオンにする、アプリを強制終了するなどの要因によって結果が異なる場合があるので注意してください。Android では、デフォルトでデータ メッセージによってアプリが復帰します。Chrome では現在サポートされていません。

Apple プラットフォームでは、このフィールドを使用して APNs ペイロード内の mutable-content を表します。通知の送信時にこのフィールドが true に設定されている場合、その通知が表示される前に通知サービスアプリ拡張機能を使って通知の内容を変更できます。このパラメータは Android とウェブでは無視されます。

このパラメータでは、デバイスがオフラインの場合にメッセージを FCM のストレージに保持する期間（秒単位）を指定します。サポートされている最大有効期間は 4 週間で、デフォルト値は 4 週間です。 詳細については、メッセージの有効期間の設定をご覧ください。

このパラメータが true に設定されている場合、デベロッパーは実際にメッセージを送信せずにリクエストをテストできます。

デフォルト値は false です。

このパラメータは、メッセージのペイロードのカスタム Key-Value ペアを指定します。

たとえば、data:{"score":"3x1"}: と指定した場合は次のようになります。

Apple プラットフォームでは、メッセージが APNs 経由で送信された場合、カスタムデータ フィールドを表します。FCM 経由で送信された場合は、AppDelegate application:didReceiveRemoteNotification: で Key-Value の辞書として表されます。

Android では、score というインテントの extra に文字列値 3x1 が設定されます。

キーを予約語（「from」や「message_type」、または「google」や「gcm」で始まる語）にすることはできません。この表に定義されたどの単語も使用しないでください（collapse_key など）。

値は文字列型にすることをおすすめします。オブジェクトに含まれる値や文字列型以外のデータ型（整数またはブール値）は、文字列型に変換する必要があります。

通知のタイトル。

このフィールドはスマートフォンやタブレットには表示されません。

通知の本文。

デバイスが通知を受信したときに再生される通知音。

クライアント アプリのメインバンドル内またはアプリのデータコンテナの Library/Sounds フォルダ内にある通知音ファイルを指定する文字列。詳細については、iOS デベロッパー ライブラリをご覧ください。

ホーム画面のアプリアイコンのバッジの値。

これを指定しなかった場合、バッジは変更されません。

0 に設定するとバッジは削除されます。

ユーザーが通知をクリックしたときに実行されるアクション。

APNs ペイロード内の category に対応します。

通知のサブタイトル。

ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、アプリの文字列リソース内の本文文字列のキー。

APNs ペイロード内の loc-key に対応します。

詳細については、ペイロードキーのリファレンスとリモート通知内容のローカライズをご覧ください。

ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、body_loc_key で指定された書式指定子を置き換える可変文字列値。

APNs ペイロード内の loc-args に対応します。

詳細については、ペイロードキーのリファレンスとリモート通知内容のローカライズをご覧ください。

ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、アプリの文字列リソース内のタイトル文字列のキー。

APNs ペイロード内の title-loc-key に対応します。

詳細については、ペイロードキーのリファレンスとリモート通知内容のローカライズをご覧ください。

ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、title_loc_key で指定された書式指定子を置き換える可変文字列値。

APNs ペイロード内の title-loc-args に対応します。

詳細については、ペイロードキーのリファレンスとリモート通知内容のローカライズをご覧ください。

通知のタイトル。

通知の本文。

通知のチャネル ID（Android O の新機能）。

このチャネル ID を含む通知を受け取るには、アプリが事前にこのチャネル ID を持つチャネルを作成する必要があります。

リクエストでこのチャネル ID を送信しなかった場合、または提供されたチャネル ID がアプリによってまだ作成されていない場合は、アプリ マニフェストで指定されたチャネル ID が使用されます。

通知アイコン。

通知アイコンをドローアブル リソース myicon の myicon に設定します。リクエストでこのキーを送信しなかった場合は、アプリ マニフェストで指定されたランチャー アイコンが表示されます。

デバイスが通知を受信したときに再生される通知音。

"default"、またはアプリにバンドルされた通知音リソースのファイル名を指定できます。通知音ファイルは /res/raw/ に置く必要があります。

通知ドロワーにある既存の通知を置き換えるために使用される識別子。

指定されていない場合、リクエストごとに新しい通知が作成されます。

このタグが指定されていて、同じタグを持つ通知がすでに表示されている場合は、新しい通知によって通知ドロワー内の既存の通知が置き換えられます。

通知のアイコンの色。#rrggbb 形式で表します。

ユーザーが通知をクリックしたときに実行されるアクション。

これが指定されている場合、ユーザーが通知をクリックすると、一致するインテント フィルタを持つアクティビティが起動します。

ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、アプリの文字列リソース内の本文文字列のキー。

詳細については、文字列リソースをご覧ください。

ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、body_loc_key で指定された書式指定子を置き換える可変文字列値。

詳細については、書式設定とスタイル設定をご覧ください。

ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、アプリの文字列リソース内のタイトル文字列のキー。

詳細については、文字列リソースをご覧ください。

ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、title_loc_key で指定された書式指定子を置き換える可変文字列値。

詳細については、書式設定とスタイル設定をご覧ください。

通知のタイトル。

通知の本文。

通知のアイコンに使用する URL。

ユーザーが通知をクリックしたときに実行されるアクション。

すべての URL 値で HTTPS が必須です。

このパラメータでは、メッセージを受信するクライアント アプリ（登録トークン）を指定します。

マルチキャスト メッセージング（複数の登録トークンに送信）には HTTP JSON 形式のみを使用できます。

このパラメータでは、メッセージのペイロードの Key-Value ペアを指定します。Key-Value パラメータの数に上限はありませんが、合計メッセージ サイズは 4,000 バイトまでに制限されています。

たとえば、Android で "data.score"."3x1" とすると、score というインテントの extra に文字列値 3x1 が設定されます。

キーを予約語（「from」や「message_type」、または「google」や「gcm」で始まる語）にすることはできません。この表に定義されたどの単語も使用しないでください（collapse_key など）。

• message_id: 正常に処理されたメッセージごとに一意の ID を指定する文字列。
• error: 受信者のためにメッセージを処理する際に発生したエラーを指定する文字列。想定される値は表 9 に記載されています。

• クライアント アプリが FCM から登録解除した場合。
• クライアント アプリが自動的に登録解除された場合。これはユーザーがアプリケーションをアンインストールしたときに発生する可能性があります。たとえば iOS で、APNs フィードバック サービスによって APNs トークンが無効であると報告された場合です。
• 登録トークンが期限切れになった場合（たとえば、Google が登録トークンを更新する場合、iOS デバイスの APNs トークンが期限切れになった場合）。
• クライアント アプリが更新されたが、新しいバージョンはメッセージを受信するように構成されていない場合。

• 認証ヘッダーが見つからないか、HTTP リクエストに含まれた構文が無効です。
• 指定されたサーバーキーの Firebase プロジェクトが正しくありません。
• 以前のサーバーキーのみ - リクエストが、サーバーキーの IP でホワイトリストに登録されていないサーバーから送信されています。

サーバーで時間内にリクエストを処理できませんでした。同じリクエストを再試行してください。ただし、次の条件を満たす必要があります。

• FCM 接続サーバーからのレスポンスに Retry-After ヘッダーが含まれている場合は、それに従います。
• 再試行メカニズムに指数バックオフを実装します。（例: 最初に再試行する前に 1 秒間待機した場合は、次の再試行までに少なくとも 2 秒間待機し、さらに次は 4 秒間待機します。）複数のメッセージを再送信する場合は、すべてのメッセージに対して新規リクエストが同時に発行されないように、各メッセージにランダムな秒数を加えて送信を個別に遅らせます。

問題を引き起こす送信者はブラックリストに登録されるおそれがあります。

特定のデバイスへのメッセージ レートが高すぎます。Apple アプリが APNs の制限を超えるレートでメッセージを送信した場合、このエラー メッセージが発生することがあります

このデバイスに送信されるメッセージの数を減らし、指数バックオフを使用して送信を再試行します。