【iOS】プッシュ通知のOneSignalで、独自のユーザーID「ExternalUserId」を設定する

概要

OneSignalとは無料で使えるプッシュ通知サービスです。

特定のユーザーのプッシュ通知を送りたい場合、これまではplayer ID（OneSignalが個別に割り当てるID）をもとに識別して送る必要がありましたが、
2018年12月にリリースされたver2.9.4からは、**独自のUserIDを使ってプッシュ通知を送り分けることができるようになりました。**それがExternalUserId機能です。
Release 2.9.4 Release · OneSignal/OneSignal-iOS-SDK · GitHub

初めて使ってみたのでメモを残します。

使い方

とても簡単です。
UseIDを登録したい箇所で以下のメソッドを呼びます。

OneSignal.setExternalUserId(customUserId)

ユーザーがログアウトした場合など、登録解除したい箇所では以下のメソッドを呼びます。

OneSignal.removeExternalUserId()

ダッシュボードで確認する

登録ができたかどうかをどうやったら確認できるのか若干迷ったのですが、USERSページの右上「DISPLAYED COLUMNS」からEXTERNAL USER IDにチェックを入れることでデータ一覧に表示させることができました。