[PHP] PHPで「FCM HTTP v1 API」を叩いて通知を送る

FCMから通知メッセージを送る

以前の記事でAndroidから通知(Notification)を送る実装をしました。

[Android] Firebase Cloud Messaging(FCM)でpush通知を実装する

️2021年1月22日

Push通知を実装したくなる結構なサイトで解説されており手順通りに行えば特に問題もなく実装できそうだったけど、色々と躓いたところもあったので忘備録的なアレです。参考にしたサイトは以下のサイト。2019-2020年と新しいかったため参考になりました。実装は@yuppejpさんのほうで行いました。とFCMの公式の実装方法ですまずはテストプロジェクトで一番上のサイトの通りに実装しました。Firebaseのサイトの通知の作成より通知を作って送ることはできました。最後の「curlでメッセージを投げる」でPOSTでのやり方が書いてあります。こ...

実際の運用はサーバーから任意のタイミングで通知を生成してFCMに投げるということになるかと思います。このFCMを投げるプロトコルが「FCM HTTP v1 API」というわけです。

Firebase

サーバー環境と FCM | Firebase Documentation

https://firebase.google.com/docs/cloud-messaging/server?hl=ja

現在FCMが提供しているプロトコルは

FCM HTTP v1 API
レガシー HTTP プロトコル
レガシー XMPP プロトコル

の3つがありますが、推奨は1です。2と3はレガシーと名前がついている通り現在は非推奨ですが、ブログなどの実装例では2が多いです。OAuth 2.0 アクセストークン生成を利用せず、固定のトークンを取得すれば比較的簡単に実装できるので多いのかなと思います。

しかし今後は1のみになっていくのは間違いないと思いますので実装をトライしてみました。

PHPでFCM HTTP v1 APIを叩きたい

FCM HTTP v1 APIを利用する際、Googleが公式にサポートする言語(例示されている言語)として

Node.js
Java
Python
Go
C#

となっていて、OAuth 2.0 アクセストークン生成には

Node.js
Java
Python

しかないようです。利用しているバリューサーバーの利用可能言語は

バリューサーバー VALUE-SERVER.COM

料金・プラン | VALUE SERVER バリューサーバー

https://www.value-server.com/spec/

バリューサーバーの仕様詳細やご利用料金のページです。用途に合わせたエコ、スタンダード、ビジネスの3つのプランをご用意しました。

となっており、通常であればPythonを使えばいいのかなと思いましたが…

サーバーでPythonを使ったことがないのでPHPでゴリ押ししたい！！

という理由からPHPで実装してみます(需要も多そうだし)。PHPの公式サンプルは探してもないので、非公式ライブラリを用いての実装になるわけです。

GitHub

GitHub - googleapis/google-api-php-client: A PHP client library for accessing...

https://github.com/googleapis/google-api-php-client

A PHP client library for accessing Google APIs. Contribute to googleapis/google-api-php-client development by creating an account on GitHub.

ググってみるとgoogle-api-php-clientを用いた実装例が海外を中心に多く公開されていましたのでこれを使っていきたいと思います。

サーバーにgoogle-api-php-clientをインストール

この辺は人によって環境が違うのでレンタルサーバーの仕様と方法をよく読んで進めます。肝になる部分は

SSH接続ができる(Composerを使う為)
Composerが利用できる(google-api-php-clientのインストールする為)
PHP 5.6.0 or higherである(google-api-php-clientを使う為)

あたりとおもいます。

ここからはバリューサーバーでの方法を記しておきます。前提として「SSHを若干でも触ったことがある」「FTPでファイルの転送ができる」「Linuxを触ったことがある(viエディタなど)」程度の知識は必要です。

推奨されてる方法である「Composerを使ってgoogle-api-php-clientをサーバーにインストール」していきます。Composerとは依存しているライブラリを一発でインストールしてくれる便利なものらしいです。

Qiita

PHP開発でComposerを使わないなんてありえない！基礎編 - Qiita

https://qiita.com/niisan-tokyo/items/8cccec88d45f38171c94

久方ぶりにPHPのレガシーなシステムを触りましたが、なんというか。。。名前空間とcomposerが無いだけで、こうも大変になるのかと思いましたねというわけで、もはやデファクトスタンダードとなったcomposerを使用した開発につ...

Composerを使うためにはSSH接続をしなければなりません。この辺を参考にして接続できるようにします。クライアントはラズパイがらみで使い慣れたTeraTermにしました。

NP メモリア

[ValueServer] バリューサーバーにSSHで接続をする方法

https://nprog256.net/post/2019/01/connect-to-value-server-by-ssh/

Nプログラマ(@Nprog128)です。バリューサーバーでまるっとプランを利用している時に、SSH接続する場面が出てきたのでそのメモです。概

SSH接続が完了したらComposer使えるようにします。バリューサーバーではCLI版で実行しなければならないみたいなので下のサイトを参考にして

Qiita

レンタルサーバーの「Value Server」でComposerを利用する方法 - Qiita

https://qiita.com/owlbeck/items/b4a277e358bd210bd720

条件Value Server エコプランSSHでサーバーに接続可能。手順Composerは標準でインストールされているが、そのまま実行するとエラーが出る。$ composerYou are runnin...

.bashrcへエイリアスを登録して起動できるようにした。Composerのアップデートはせずに

# .bashrc

# Source global definitions
if [ -f /etc/bashrc ]; then
	. /etc/bashrc
fi

# User specific aliases and functions
# 追記
alias composer='php56cli /usr/bin/composer'

# .bashrc

# Source global definitions

if [ -f /etc/bashrc ]; then

. /etc/bashrc

# User specific aliases and functions

# 追記

alias composer='php56cli /usr/bin/composer'

phpも5.6のままにしときました。

そして任意のディレクトリで

composer require google/apiclient:”^2.7″

を実行したら無事にインストール完了できたようです。ここまできれば後はらくちんです。別なレンタルサーバーを利用している人などは仕様を確認してみる必要があります。

phpで実際FCMを送ってみる

ベースとなるsend.phpは下を参考にしています。

Gist

Google API PHP Client - Firebase Cloud Messaging Service v1 example

https://gist.github.com/Repox/64ac4b3582f8ac42a6a1b41667db7440

Google API PHP Client - Firebase Cloud Messaging Service v1 example - send.php

作業内容としては

auth.jsonの取得
Firebase project IDの確認
$messageの内容の編集
send.phpでのテスト

となります。

1は下の「認証情報を手動で提供する」を参考にしてjsonファイルを取得します。ダウンロードしたjsonファイルをauth.jsonとします。

Firebase

以前の HTTP から HTTP v1 に移行する | Firebase Documentation

https://firebase.google.com/docs/cloud-messaging/migrate-v1?hl=ja#provide-credentials-manually

2はFirebaseで該当アプリの設定-全般からプロジェクトIDがあるのでそれをメモしときます。

send.phpの書き換えるべき部位は下のような感じです

<?php

/**
 * This serves as an example of how to use the Google API PHP Client 
 * with Firebase Cloud Messaging Service.
 *
 * The client can be found here:
 * https://github.com/google/google-api-php-client
 *
 * At the time of writing this, there's no Service object for the correct 
 * scope for Firebase Messaging, so here's an example of how this can be
 * done with provididing the scope manually.
 *
 * Info regarding authorization and requests can be found here:
 * https://firebase.google.com/docs/cloud-messaging/server
 */

require 'vendor/autoload.php';  // インストールしたgoogle-api-php-clientのパスに合わせて変更

$client = new Google_Client();

// Authentication with the GOOGLE_APPLICATION_CREDENTIALS environment variable
$client->useApplicationDefaultCredentials(); 

// Alternatively, provide the JSON authentication file directly.
$client->setAuthConfig(__DIR__.'/auth.json'); // 1で取得したjsonファイルをサーバーに上げてパスに合わせて変更

// Add the scope as a string (multiple scopes can be provided as an array)
$client->addScope('https://www.googleapis.com/auth/firebase.messaging');

// Returns an instance of GuzzleHttp\Client that authenticates with the Google API.
$httpClient = $client->authorize();

// Your Firebase project ID
$project = "myproject-4e6ed";　// 2で取得したプロジェクト名に変更

// Creates a notification for subscribers to the debug topic
$message = [
    "message" => [
        "topic" => "debug",
        "notification" => [
            "body" => "This is an FCM notification message!",
            "title" => "FCM Message",
        ]
    ]
];

// Send the Push Notification - use $response to inspect success or errors
$response = $httpClient->post("https://fcm.googleapis.com/v1/projects/{$project}/messages:send", ['json' => $message]);

<?php

/**

* This serves as an example of how to use the Google API PHP Client

* with Firebase Cloud Messaging Service.

* The client can be found here:

* https://github.com/google/google-api-php-client

* At the time of writing this, there's no Service object for the correct

* scope for Firebase Messaging, so here's an example of how this can be

* done with provididing the scope manually.

* Info regarding authorization and requests can be found here:

* https://firebase.google.com/docs/cloud-messaging/server

require 'vendor/autoload.php'; // インストールしたgoogle-api-php-clientのパスに合わせて変更

$client = new Google_Client();

// Authentication with the GOOGLE_APPLICATION_CREDENTIALS environment variable

$client->useApplicationDefaultCredentials();

// Alternatively, provide the JSON authentication file directly.

$client->setAuthConfig(__DIR__.'/auth.json'); // 1で取得したjsonファイルをサーバーに上げてパスに合わせて変更

// Add the scope as a string (multiple scopes can be provided as an array)

$client->addScope('https://www.googleapis.com/auth/firebase.messaging');

// Returns an instance of GuzzleHttp\Client that authenticates with the Google API.

$httpClient = $client->authorize();

// Your Firebase project ID

$project = "myproject-4e6ed";　// 2で取得したプロジェクト名に変更

// Creates a notification for subscribers to the debug topic

$message = [

"message" => [

"topic" => "debug",

"notification" => [

"body" => "This is an FCM notification message!",

"title" => "FCM Message",

]

];

// Send the Push Notification - use $response to inspect success or errors

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

3の$messageですが、上のサンプルの例ではdebugトピックの購読者に通知を送るようになっているのでこれでphpが正しく通知を出せるかテストしてみるのがいいと思います。

テストの通知を確認出来たので、すこし拡張してみました。

～　略　～
$title = "通知タイトル";
$body = "通知内容です";
$topic = "hogehoge"; //このトピックの指定は/topics/[トピック名]ではなくトピック名のみでOKでした

//メッセージの有効時間の設定
$sec = 2 * 60 * 60;  //有効時間は2時間
$timestamp = time() + $sec;
$sec_st = $sec . "s";

// Creates a notification for subscribers to the debug topic
$message = [
    "message" => [
        "topic" => (string)$topic,
        "notification" => [
            "body" => (string)$body,
            "title" => (string)$title ,
        ],
        
        "apns" => [
            "headers" => [
               "apns-priority" => "10",
               "apns-expiration" => (string)$timestamp,
            ],
            "payload" => [
               "aps" => [
                  "sound" => "default",
               ]
            ]
        ],
        
        "android" => [
           "priority" => "high",
           "ttl" => (string)$sec_st,
           "notification" => [
              "sound" => "default",
           ]
        ],        
    ]
];

～　略　～

～　略　～

$title = "通知タイトル";

$body = "通知内容です";

$topic = "hogehoge"; //このトピックの指定は/topics/[トピック名]ではなくトピック名のみでOKでした

//メッセージの有効時間の設定

$sec = 2 * 60 * 60; //有効時間は2時間

$timestamp = time() + $sec;

$sec_st = $sec . "s";

// Creates a notification for subscribers to the debug topic

$message = [

"message" => [

"topic" => (string)$topic,

"notification" => [

"body" => (string)$body,

"title" => (string)$title ,

"apns" => [

"headers" => [

"apns-priority" => "10",

"apns-expiration" => (string)$timestamp,

"payload" => [

"aps" => [

"sound" => "default",

]

"android" => [

"priority" => "high",

"ttl" => (string)$sec_st,

"notification" => [

"sound" => "default",

]

];

～　略　～

上の例はメッセージの有効期限を2時間に設定し音を鳴らすメッセージです。apns(pple push notification service)とandroidで設定が異なるので別途指定します。通知のタイトルと内容は共通です。 $t i t l e と$ bodyを指定すれば通知を行えます。メッセージは色々指定できるようなので各自調べてみてください。

公開中アプリ「九九おぼえちゃお」のランキング通知に実装してみました。定期的にユーザーにランキングを通知する仕組みです。cronを使ってphpを叩いています。