Unity SDKセットアップ

​

概要

​

OneSignalを使用してUnityアプリのプッシュ通知を設定する

​

要件

• Unity 2022.3以降
• 設定済みのOneSignalアプリとプラットフォーム

• Xcode 14+を搭載したmacOS（セットアップ手順はXcode 16.2を使用）
• iOS 12+、iPadOS 12+、またはiOS 16.2+を実行するXcodeシミュレーターを搭載したデバイス

• Google Play Store（サービス）がインストールされたAndroid 7.0+デバイスまたはエミュレーター

​

OneSignalアプリとプラットフォームを設定

OneSignalアプリを設定するためのステップバイステップの手順

単一のOneSignalアプリで複数のプラットフォーム（iOS、Android、Huawei、Amazon、Web）を管理できます。

1

アプリを作成または選択

• 既存のアプリにプラットフォームを追加するには、OneSignalダッシュボードでSettings > Push & In-Appに移動します。
• 新規に開始するには、New App/Websiteをクリックしてプロンプトに従います。

2

プラットフォームをセットアップして有効化

• アプリと組織の明確で認識可能な名前を選択します。
• 設定するプラットフォーム（iOS、Androidなど）を選択します。
• Next: Configure Your Platformをクリックします。

3

プラットフォーム認証情報を設定

プラットフォームに基づいてプロンプトに従います：

• Android：Firebase認証情報をセットアップ
• iOS：p8トークン（推奨）またはp12証明書
• Amazon：APIキーを生成
• Huawei：OneSignalを承認

認証情報を入力した後、Save & Continueをクリックします。

4

ターゲットSDKを選択

開発プラットフォーム（iOS、Android、React Native、Unityなど）に一致するSDKを選択し、Save & Continueをクリックします。

5

SDKをインストールしてApp IDを保存

プラットフォームが設定されると、OneSignal App IDが表示されます。このIDをコピーして保存してください - SDKのインストールと初期化時に必要になります。他のユーザーと共同作業する場合は、Inviteボタンを使用して開発者またはチームメイトを追加し、Doneをクリックしてセットアップを完了します。

完了したら、選択したプラットフォームのSDKインストールガイドに従って、OneSignalの統合を完了します。

​

セットアップ

​

1. OneSignal Unity SDKを追加

• Unity Asset Store
• Unity Package Manager

1. Add to My Assets経由でSDKをアカウントに追加します。
2. Open in UnityをクリックしてUnity EditorとPackage Managerを起動します。
3. SDKをダウンロードしてインポートします。

4. すべてのファイルをインポートするプロンプトを受け入れます。
5. Window > OneSignal SDK Setupに移動し、特にImport OneSignal packagesのチェックリストに従います。
6. インポート後、Unityはレジストリを更新します。セットアップウィンドウに表示される残りのセットアップ手順を完了します。

1. Edit > Project Settings > Package Managerに移動します。

2. スコープ付きレジストリを追加します：

コピー

AIに質問

Name        npmjs
URL         https://registry.npmjs.org
Scope(s)    com.onesignal

3. Window > Package Managerを開き、My Registriesに切り替えます。
4. 必要なOneSignal SDKパッケージをインストールします。
5. Window > OneSignal SDK Setupを開き、最終手順を完了します。

​

2. プラットフォームのセットアップ

​

iOSセットアップ

• 自動署名（推奨）
• 手動プロビジョニング

1. File > Build Settings > Player Settingsに移動します。
2. Other Settingsの下で、Automatically Signをチェックします。

Apple Developer アカウントに次があることを確認してください：

• App Group: group.{your_bundle_id}.onesignal
• Push NotificationsとApp Groupsが有効化されている
• バンドルIDのプロビジョニングプロファイルが更新されている

​

Androidセットアップ

1. Edit > Project Settings > Player > Androidに移動します。
2. Publishing Settingsの下で、以下を有効にします：

• Custom Main Gradle Template
• Custom Gradle Properties Template

3. Assets > External Dependency Manager > Android Resolver > Force Resolveを実行します。

• Target API Levelは33+である必要があります（v5.0.6+）。
• Minifyが有効になっている場合は、OneSignal SDK SetupからCopy Android plugin to Assetsを実行してOneSignalConfig.androidlibを使用します。
• Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/res内のデフォルトアイコンを独自のものに置き換えます（小文字のファイル名のみ、アンダースコア許可）。詳細については、通知アイコンのカスタマイズを参照してください。

​

Amazonセットアップ

 xmlns:amazon="http://schemas.amazon.com/apk/res/android"

<uses-permission android:name="com.amazon.device.messaging.permission.RECEIVE" />
<permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="COM.YOUR.PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" />

<amazon:enable-feature android:name="com.amazon.device.messaging" android:required="false"/>
<service android:name="com.onesignal.notifications.services.ADMMessageHandler" android:exported="false" />
<service android:name="com.onesignal.notifications.services.ADMMessageHandlerJob"
         android:permission="android.permission.BIND_JOB_SERVICE"
         android:exported="false" />
<receiver android:name="com.onesignal.notifications.receivers.ADMMessageReceiver"
          android:permission="com.amazon.device.messaging.permission.SEND" >
  <intent-filter>
    <action android:name="com.amazon.device.messaging.intent.REGISTRATION" />
    <action android:name="com.amazon.device.messaging.intent.RECEIVE" />
    <category android:name="COM.YOUR.PACKAGE_NAME" />
  </intent-filter>
</receiver>

​

Huaweiセットアップ

​

3. SDKの初期化

using OneSignalSDK;

void Start () {
  // デバッグ用の詳細ログを有効にする（本番環境では削除）
  OneSignal.Debug.LogLevel = LogLevel.Verbose;
  // OneSignal App IDで初期化
  OneSignal.Initialize("YOUR_APP_ID");
  // プッシュ通知のプロンプトを表示するには、このメソッドを使用します。
  // テスト後にこのメソッドを削除し、代わりにアプリ内メッセージを使用して通知権限をプロンプトすることをお勧めします。
  await OneSignal.Notifications.RequestPermissionAsync(true);
}

​

OneSignal SDK統合のテスト

​

モバイルサブスクリプションを確認

1

テストデバイスでアプリを起動します。

初期化時にrequestPermissionメソッドを追加した場合、ネイティブのプッシュ許可プロンプトが自動的に表示されます。

2

OneSignalダッシュボードを確認

プロンプトを受け入れる前に、OneSignalダッシュボードを確認してください：

• Audience > Subscriptionsに移動します。
• ステータスが「Never Subscribed」の新しいエントリが表示されるはずです。

3

アプリに戻り、プロンプトで「許可」をタップします。

4

OneSignalダッシュボードのSubscriptionsページを更新します。

サブスクリプションのステータスがSubscribedと表示されるはずです。

モバイルサブスクリプションの作成に成功しました。 モバイルサブスクリプションは、ユーザーがデバイスで初めてアプリを開いたとき、またはユーザーが同じデバイスでアプリをアンインストールして再インストールしたときに作成されます。

​

テストサブスクリプションをセットアップ

1

Test Subscriptionsに追加します。

ダッシュボードで、サブスクリプションの横にある**Options（3つのドット）**ボタンをクリックし、Add to Test Subscriptionsを選択します。

2

サブスクリプションに名前を付けます。

Test Subscriptionsタブで後でデバイスを簡単に識別できるように、サブスクリプションに名前を付けます。

3

テストユーザーセグメントを作成します。

Audience > Segments > New Segmentに移動します。

4

セグメントに名前を付けます。

セグメントにTest Usersという名前を付けます（この名前は後で使用されるため重要です）。

5

Test Usersフィルターを追加し、Create Segmentをクリックします。

テストユーザーのセグメントの作成に成功しました。 この個別のデバイスとテストユーザーのグループにメッセージを送信するテストが可能になりました。

​

API経由でテストプッシュを送信

1

App API KeyとApp IDを取得します。

OneSignalダッシュボードで、**Settings > Keys & IDs**に移動します。

2

提供されたコードを更新します。

以下のコードのYOUR_APP_API_KEYとYOUR_APP_IDを実際のキーに置き換えます。このコードは、先ほど作成したTest Usersセグメントを使用します。

コピー

AIに質問

curl -X \
POST --url 'https://api.onesignal.com/notifications' \
 --header 'content-type: application/json; charset=utf-8' \
 --header 'authorization: Key YOUR_APP_API_KEY' \
 --data \
 '{
  "app_id": "YOUR_APP_ID",
  "target_channel": "push",
  "name": "Testing basic setup",
  "headings": {
  	"en": "👋"
  },
  "contents": {
    "en": "Hello world!"
  },
  "included_segments": [
    "Test Users"
  ],
  "ios_attachments": {
    "onesignal_logo": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
  },
  "big_picture": "https://avatars.githubusercontent.com/u/11823027?s=200&v=4"
}'

3

コードを実行します。

ターミナルでコードを実行します。

4

画像とConfirmed Deliveryを確認します。

すべてのセットアップ手順が正常に完了した場合、テストサブスクリプションは画像を含む通知を受信するはずです：

画像は折りたたまれた通知ビューでは小さく表示されます。通知を展開すると、完全な画像が表示されます。

5

Confirmed Deliveryを確認します。

ダッシュボードで、Delivery > Sent Messagesに移動し、メッセージをクリックして統計を表示します。confirmed統計が表示されるはずです。これは、デバイスがプッシュを受信したことを意味します。

Professionalプラン以上をご利用の場合は、Audience Activityまでスクロールして、サブスクリプションレベルの確認を表示します：

API経由でセグメントに通知を送信することに成功しました。

• 画像が受信されない場合は、Notification Service Extensionが不足している可能性があります。
• Confirmed Deliveryがない場合は、こちらのトラブルシューティングガイドを確認してください。
• 問題が発生した場合は、APIリクエストとアプリ起動の最初から最後までのログを.txtファイルにコピー&ペーストしてください。その後、両方をsupport@onesignal.comと共有してください。

​

アプリ内メッセージを送信

1

デバイスでアプリを閉じるか、バックグラウンドにします。

これは、ユーザーが新しいセッションを開始する_前_にアプリ内オーディエンスの基準を満たす必要があるためです。OneSignalでは、ユーザーがアプリをバックグラウンドまたは閉じた状態から少なくとも30秒後に開くと、新しいセッションが開始されます。詳細については、アプリ内メッセージの表示方法に関するガイドを参照してください。

2

アプリ内メッセージを作成します。

• OneSignalダッシュボードで、Messages > In-App > New In-Appに移動します。
• Welcomeメッセージを見つけて選択します。
• Audienceを、以前使用したTest Usersセグメントに設定します。

3

必要に応じてメッセージコンテンツをカスタマイズします。

4

トリガーを「On app open」に設定します。

5

頻度をスケジュールします。

**Schedule > How often do you want to show this message?**で、Every time trigger conditions are satisfiedを選択します。

6

メッセージをライブにします。

Make Message Liveをクリックして、Test Usersがアプリを開くたびにメッセージが利用できるようにします。

7

アプリを開いてメッセージを確認します。

アプリ内メッセージがライブになったら、アプリを開きます。次のように表示されるはずです：

メッセージが表示されない場合：

• 新しいセッションを開始します
  • 再度開く前に、少なくとも30秒間アプリを閉じるかバックグラウンドにする必要があります。これにより、新しいセッションが開始されます。
  • 詳細については、アプリ内メッセージの表示方法を参照してください。
• まだTest Usersセグメントに含まれていますか？
  • アプリを再インストールしたりデバイスを切り替えたりした場合は、デバイスをTest Subscriptionsに再度追加し、Test Usersセグメントの一部であることを確認してください。
• 問題が発生していますか？
  • 上記の手順を再現しながらデバッグログの取得に従ってください。これにより、support@onesignal.comと共有できる追加のログが生成され、何が起こっているかを調査するのに役立ちます。

​

ユーザー識別

​

External IDを割り当て

​

データタグを追加

​

メールおよび/またはSMSサブスクリプションを追加

• addEmailメソッドを使用してメールサブスクリプションを作成します。
• addSmsメソッドを使用してSMSサブスクリプションを作成します。

​

プライバシーとユーザー同意

• setConsentRequired(true)：同意が与えられるまでデータ収集を防ぎます。
• setConsentGiven(true)：同意が付与されるとデータ収集を有効にします。

• SDKによって収集されるデータ
• 個人データの取り扱い

​

プッシュ許可のプロンプト

​

プッシュ、ユーザー、アプリ内イベントをリッスン

​

プッシュ通知イベント

• addClickListener()：通知がタップされたときを検出します。ディープリンクに役立ちます。
• addForegroundLifecycleListener()：フォアグラウンドでの通知の動作を制御します。

​

ユーザー状態の変更

• ユーザー状態用のaddObserver()：External IDが設定されたときを検出します。
• addPermissionObserver()：ネイティブのプッシュ許可プロンプトとのユーザーの特定のインタラクションを追跡します。
• プッシュサブスクリプション用のaddObserver()：プッシュサブスクリプションのステータスが変更されたときを追跡します。

​

アプリ内メッセージイベント

• addClickListener()：アプリ内クリックアクションを処理します。ディープリンクやイベントの追跡に最適です。
• addLifecycleListener()：アプリ内メッセージの完全なライフサイクル（表示、クリック、閉じるなど）を追跡します。

​

高度なセットアップと機能

• 🔁 別のサービスからOneSignalへの移行
• 🌍 位置情報トラッキング
• 🔗 ディープリンク
• 🔌 統合
• 🧩 Mobile Service Extensions
• 🛎️ アクションボタン
• 🌐 多言語メッセージング
• 🛡️ Identity Verification
• 📊 カスタムアウトカム
• 📲 Live Activities

​

Mobile SDKのセットアップとリファレンス