既存のアプリにSDKを適用する場合¶
新規にアプリを作る場合はこちら
App IDの確認¶
次の３つのモジュールのApp IDを用意します。
- アプリ本体
- Notification Service Extension
- Notification Content Extension
App Extension
- Notification Service ExtensionとNotification Content Extensionはプッシュ通知に添付されたリッチコンテンツを表示するための、Appleが提供している拡張機能です。
App IDについて¶
アプリ本体とApp ExtensionのApp IDはそれぞれ以下の規則に従って作成します。
| App IDの種類 | 規則 |
|---|---|
| アプリ本体 | アプリに設定するBundle Identifierと同じ |
| App Extension | アプリ本体のApp IDに付加 |
作成例
アプリ本体：jp.co.infocity.richflyer
Notification Service Extension：jp.co.infocity.richflyer.notificationService
Notification Content Extension：jp.co.infocity.richflyer.notificationContent
※App Extensionはアプリ本体のApp IDにそれぞれの値を付加している。
注意
- ルールに従っていないAppIDを使用した場合、ビルドエラーや通知が受信できないといったケースが発生します。
- ワイルドカードを利用したApp IDの場合、プッシュ通知は機能しません。
アプリ本体のApp IDの確認¶
Apple Deverloperサイトにてプッシュ通知機能が有効になっているか確認します。 無効になっている場合は設定を変更します。
確認方法は、App IDの確認と設定を参照してください。
証明書の設定
App IDの設定画面で証明書の指定が必要ですが後述しますのでこのまま続けてください。
Capabilitiesの設定¶
App IDにCapabilitiesを設定します。
設定したCapabilitiesは、Xcodeプロジェクトで有効化する必要があります。
| Capability | 内容 |
|---|---|
| Push Notifications | プッシュ通知を受信する。 |
| Time Sensitive Notifications | 優先度"高"のプッシュ通知を受信。オフの場合は、優先度"標準"として処理される。 |
| App Groups | リッチコンテンツを通知画面に表示。 |
設定方法は、App IDの確認と設定を参照してください。
App ExtensionのApp IDの作成¶
App Extensionで使用するApp IDを作成します。
「Notification Service Extension」と「Notification Content Extension」用に２種類作成します。
作成方法は、作成手順例を参照してください。
AppGroupsの設定¶
アプリ本体とApp Extensionがデータを共有するためにAppGroupsを設定します。
作成方法は、作成手順例を参照してください。
Time Sensitive Notifications Capabilityの設定¶
優先度が"高"のメッセージを受信するために有効にします。
これがオフの場合は、優先度"標準"として処理されます。
作成方法は、作成手順例を参照してください。
証明書の作成(Certificates)¶
証明書の種類¶
証明書にはアプリ用とプッシュ通知(Apple Push Notificationサービス)用があり、それぞれ配布用(Production)と開発用(Development)を用意します。
アプリ用の証明書は後述するプロビジョニングプロファイルの作成で使用します。
プッシュ通知用の証明書はApple社が運用する通知配信サーバ(APNsサーバ)へ通知の配信をリクエストする際の認証で使用します。同証明書はRichFlyerの管理サイトに登録します。
証明書を作成する際にはアプリ本体のApp IDを紐づけます。
| 証明書の種類 | Development | Production |
|---|---|---|
| アプリ用 | アプリの開発用途で利用する。 | アプリをAppStoreへの申請およびリリース用途で利用する。 |
| プッシュ通知用 | 開発向け(サンドボックス環境)のアプリがインストールされている端末に通知が配信される。 ※RichFlyer管理サイトに 開発環境用 として同証明書を登録します。 |
AppStoreで公開中されているアプリがインストールされている端末へ通知が配信される。 ※RichFlyer管理サイトに 本番環境用 として同証明書を登録します。 |
プッシュ通知用の証明書について
RichFlyerでは、APNsサーバへの認証では 証明書方式 と トークンベース方式 の２パターンが利用できます。
本項で説明しているプッシュ通知用の証明書とは、証明書方式 で使用するものになります。
トークンベース方式 でご利用される場合は、同証明書の作成は不要です。
詳細は管理サイトご利用マニュアルをご参照ください。
| トークンベース | 証明書ベース | |
|---|---|---|
| 認証情報の形式 | p8形式 | p12形式 |
| 更新の有無 | 更新期限なし | 更新期限あり(1年) |
| アプリ間共有 | 複数のアプリで同一の認証情報が利用可能 | アプリごとにそれぞれ証明書が必要 |
| 認証情報の発行数 | Apple開発者アカウントにつき最大３つまで | 制限なし |
プッシュ通知用証明書の作成¶
プッシュ通知用の証明書を公式リファレンスに従って作成します。
管理サイトへの登録
作成した証明書をRichFlyer管理サイトに登録します。
注意
- 証明書作成時に指定するApp IDはアプリ本体のものです。ここではApp Extension用のApp IDは不要です。
- すでにリモートプッシュ通知を利用されている場合は、既存の証明書をRichFlyer管理サイトに登録していただくことで利用可能になります。
プロビジョニングプロファイルの作成¶
プロビジョニングプロファイルは、上記で用意した証明書やAppID、インストール可能な端末情報などが記述されたファイルです。
アプリのビルド時に設定してこれらの情報とアプリを関連づけます。
利用用途¶
用途に応じてプロビジョニングプロファイルが異なります。
- 主に開発用途で利用する「Development」
- AppStoreでの配布用途で利用する「Distribution」
- 限られた人数に配布する「Ad Hoc」
情報
証明書が失効するとプロビジョニングプロファイルも無効になります。
種類¶
利用用途ごとに以下の３つのモジュール用にプロビジョニングプロファイルを作成します。
- アプリ本体用
- Notification Service Extension用
- Notification Content Extension用
注意
アプリ本体用のプロビジョニングプロファイルをすでにご利用されている場合でも、App IDの編集を行なうため再発行が必要です。
作成¶
作成方法は、作成手順例を参照してください。