PHP アプリケーションの FCM HTTP v1 API 移行手順

エキサイト株式会社の@mthiroshiです。

アプリのプッシュ通知は、Firebase Cloud Messaging を用いて実装できます。サーバー環境から FCM 実装でプッシュ通知を送る方法の一つとして、FCM HTTP API があります。現在、FCM HTTP API は、新しいAPIへの移行のアナウンスがされています。2024年6月にはレガシーAPIが利用できなくなります。

firebase.google.com

今回は、PHP の実装における FCM HTTP API v1 への移行について紹介します。

公式の移行ガイドによると、主な変更点は下記の3点です。

エンドポイントの変更
送信リクエストの認可
送信リクエストのペイロード

作業手順に沿ってこの3点を変更していきます。

サービスアカウントの準備
PHP アプリケーションの対応
最後に
採用情報
参考記事

サービスアカウントの準備

まず、送信リクエストの認可の方法が変更されています。 Firebase と連携しているGCPコンソールからからサービスアカウントを作成し、秘密鍵を生成します。

秘密鍵を生成すると、JSONファイルがローカルにダウンロードされます。このJSONファイルには、秘密鍵が含まれているため、安全に管理してください。

そして、このサービスアカウントに対して、Firebase Admin SDKのロールを割り当てます。

サービスアカウントに Firebase Admin SDK のロールを割り当てる

JSON ファイルを PHP アプリケーションが動作しているサーバーに設置し、環境変数 GOOGLE_APPLICATION_CREDENTIALS にそのパスを設定します。

export GOOGLE_APPLICATION_CREDENTIALS="/home/demo_user/service-account-file.json"

環境変数を設定することで、後述する Google API クライアントが認可する際に、環境変数から JSON ファイルを読み込んでくれます。

Google が提供するAPIやライブラリを利用する際には、アプリケーションのデフォルト認証情報（ADC）と呼ばれる仕組みが使われます。今回の環境変数の設定は、ADCに則った方法です。 cloud.google.com

PHP アプリケーションの対応

プッシュ通知実装の実体として、Google API を使って FCM サーバーにリクエストを行います。 Google API を利用するため、PHP の Google API クライアントのライブラリを composer を使ってインストールします。 github.com

下記が Google API クライアントを使ったプッシュ通知実装のサンプルコードです。

<?php

require_once 'vendor/autoload.php';

$client = new Google_Client();
$client->useApplicationDefaultCredentials();
$client->addScope('https://www.googleapis.com/auth/firebase.messaging');
$httpClient = $client->authorize();

$params = [
    'message' => [
        'topic' => 'demo_topic',
        'notification' => [
            'title' => 'demo_title',
            'body' => 'demo_body',
        ],
        'data' => [
            'demo_contents_id' => '12345',
        ],
    ],
];

$project = 'demo_firebase_project_id';
$response = $httpClient->post("https://fcm.googleapis.com/v1/projects/$project/messages:send", 
    ['json' => $params]
);