Skip to main content
このガイドでは、Android Studioを使用してAndroidアプリにOneSignalを追加する方法を説明します。SDKをインストールし、プッシュ通知とアプリ内メッセージを設定し、テストメッセージを送信してすべてが正常に動作していることを確認します。 OneSignalを初めて使用する場合は、手順を順番に進めてください。経験がある場合は、必要なセクションに直接ジャンプしてください。
AIコーディングアシスタントを使用していますか? AI駆動のインストールには、次のプロンプトを使用してください:

ステップ0. OneSignalでFCMを設定する(プッシュ配信に必須)

このステップを完了しなくても、OneSignal Android SDKをインストールして初期化できます。ただし、OneSignalアプリでFirebase Cloud Messaging(FCM)の認証情報が設定されるまで、プッシュ通知は配信されません
会社にすでにOneSignalアカウントがある場合は、アプリを設定するために管理者ロールとして招待してもらうよう依頼してください。それ以外の場合は、無料アカウントに登録して始めましょう。
これらの手順で、OneSignalアプリをFirebase Cloud Messaging(FCM)に接続します。アプリごとに一度だけ行う必要があります。
  1. https://onesignal.comにログインし、アプリを作成または選択します。
  2. Settings > Push & In-Appに移動します。
  3. Google Android (FCM)を選択し、セットアップウィザードをContinueで進めます。
  4. FCMサービスアカウントJSONをアップロードします。
  5. セットアップウィザードを続行してApp IDを取得します。これはSDKの初期化に使用されます。
完全なセットアップ手順については、モバイルプッシュセットアップガイドをご覧ください。

セットアップの契約と要件

このセクションでは、ガイド全体で使用するツール、バージョン、前提条件をまとめています。
  • SDKバージョン: 5.6.1+(最新版:releasesを確認)
  • AIセットアップ手順: https://raw.githubusercontent.com/OneSignal/sdk-ai-prompts/main/docs/android/ai-prompt.md
  • SDKリポジトリ: https://github.com/OneSignal/OneSignal-Android-SDK
  • Android Studio: Meerkat | 2024.3.1+
  • Android API: 最低23+(Android 6.0+)、推奨31+(Android 12+)
  • デバイス/エミュレータ: Google Play Servicesがインストールされた Android 7.0+
  • 必須依存関係: com.onesignal:OneSignal:[5.6.1, 5.99.99]
  • Applicationクラス: SDKの適切な初期化に必須
  • App ID形式: 36文字のUUID(例:12345678-1234-1234-1234-123456789012)。Dashboard > Settings > Keys & IDsで確認できます。
  • 初期化: OneSignal.initWithContext(this, "YOUR_APP_ID")
  • バッテリー最適化: バックグラウンド通知に影響する可能性があります
  • 推奨: OneSignal.login("user_id")でExternal IDを割り当て、デバイス間でユーザーを統一

Androidセットアップ手順

以下の手順を完了すると:
  • AndroidアプリにOneSignal SDKがインストールされ、初期化されます
  • 実機でプッシュ通知の権限プロンプトが正しく表示されます
  • テストプッシュとアプリ内メッセージが正常に配信されます
**ステップ0(OneSignalでFCMを設定する)**をスキップした場合でも、以下のAndroid Studioのセットアップを完了できます。プッシュ通知のテストや送信の前にステップ0を完了してください。

ステップ1. OneSignal SDKを追加する

  1. Android Studioで、build.gradle.kts (Module: app)またはbuild.gradle (Module: app)ファイルを開きます
  2. dependenciesセクションにOneSignalを追加します:
OneSignalのimplementation依存関係が追加されたAndroid Studioのapp build.gradle.kts

アプリのbuild.gradle.ktsファイルにOneSignalを追加する例。

  1. Gradleを同期: 表示されるバナーのSync Nowをクリックするか、File > Sync Project with Gradle Filesに移動します
Gradleの同期が依存関係の競合なく正常に完了したことを確認してください。

ステップ2. Applicationクラスを作成して設定する

すべてのエントリポイントで適切なSDKセットアップを確保するため、ApplicationクラスのonCreateメソッドでOneSignalを初期化することがベストプラクティスです。 Applicationクラスがまだない場合は作成してください:
  1. File > New > Kotlin Class/File(またはJava Class)
  2. 名前:ApplicationClass(またはお好みの名前)
ApplicationClassという名前が入力されたAndroid StudioのNew Kotlin Classダイアログ

ApplicationClassという名前の新しいKotlinクラスを作成する例。

Applicationクラスに以下のOneSignalコードを追加してください。 YOUR_APP_IDをDashboard > Settings > Keys & IDsで取得した実際のOneSignal App IDに置き換えてください。
OneSignalのinitWithContextとrequestPermissionを示すAndroid StudioのApplicationClass.kt

ApplicationClass.ktファイルの例。

ActivityMainActivityなど)での初期化は推奨されません。ディープリンクや通知からのコールドスタート時に呼び出されない可能性があるためです。信頼性を確保するため、常にApplicationクラスでOneSignalを初期化してください。
Applicationクラスを登録する:
  1. アプリのAndroidManifest.xmlを開きます
  2. <application>タグにandroid:name=".ApplicationClass"を追加します(異なるクラス名を設定した場合は.ApplicationClassを置き換えてください)。
AndroidManifest.xml
<application>タグにtools:node="replace"がないか確認してください。このマーカーは、OneSignalのPermissionsActivityを含むライブラリ由来のマージ済みコンポーネントを削除します。その結果、通知許可フローがActivityNotFoundExceptionでクラッシュします。tools:node="replace"を削除してください。属性を1つだけ上書きする場合は、tools:replace="android:theme"(または変更する属性)を使用してください。
android:nameが.ApplicationClassに設定されたAndroidManifest.xmlのapplicationタグ

.ApplicationClass名を含むAndroidManifest.xml。

アプリがエラーなくビルドおよび実行されることを確認してください。

ステップ3. デフォルト通知アイコンを設定する(推奨)

デフォルトのベルアイコンを、ic_stat_onesignal_defaultという名前の小さいアイコンに置き換えてください。透明な背景にモノクロのシルエットを使用してください。そうしないと、Androidは白い四角を表示します。
  1. Android Asset Studioで各密度のアイコンを生成します。
  2. ic_stat_onesignal_defaultを各密度フォルダに配置します:res/drawable-mdpi/(24×24)からres/drawable-xxxhdpi/(96×96)まで。
大きいアイコン、アクセントカラー、Android 17のランチャーアイコンの動作については、通知アイコンをご覧ください。

ステップ4. 統合をテストする

サブスクリプションの作成を確認:
  1. Google Play Servicesが搭載されたデバイスまたはエミュレータでアプリを起動します。
  2. Dashboard > Audience > Subscriptionsを確認します。ステータスがNever Subscribedと表示されます。
  3. 権限プロンプトが表示されたら承認します。
  4. ダッシュボードを更新します。ステータスがSubscribedに変わります。
通知の許可を求めるAndroidのプッシュ権限プロンプト

Androidのプッシュ権限プロンプト

ダッシュボードに「Never Subscribed」ステータスのサブスクリプションが表示される。

ダッシュボードに「Never Subscribed」ステータスのサブスクリプションが表示される

プッシュ権限を許可した後、ダッシュボードを更新するとサブスクリプションステータスが「Subscribed」に更新されます。

プッシュ権限を許可した後、ダッシュボードを更新するとサブスクリプションステータスが「Subscribed」に更新されます

モバイルサブスクリプションは、ユーザーがデバイスでアプリを初めて開いたとき、または同じデバイスでアンインストール後に再インストールしたときに作成されます。ユーザーが権限プロンプトを承認すると、ダッシュボードのステータスがSubscribedと表示されるはずです。

テストユーザーとセグメントを作成する

  1. サブスクリプションの横にあるOptions > Add as test userを選択し、名前を入力します。
  2. Audience > Segments > New Segmentに移動します。
  3. 名前:Test UsersTest Usersフィルターを追加 > Create Segment
Add as test userがハイライトされたサブスクリプションレコードのOptionsメニュー

テストユーザーを追加する

Test Usersフィルターで「Test Users」セグメントを作成する。

Test Usersフィルターで「Test Users」セグメントを作成する

これで、このデバイスとTest Usersセグメントにテストメッセージを送信できます。

APIでテストプッシュを送信する

  1. **Settings > Keys & IDs**に移動します。
  2. 提供されたコードで、以下のコードのYOUR_APP_API_KEYYOUR_APP_IDを実際のキーに置き換えてください。このコードは先ほど作成したTest Usersセグメントを使用します。
プッシュ通知の画像は折りたたんだ通知ビューでは小さく表示されます。通知を展開すると完全な画像が表示されます。

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

確認済み受信を示す配信統計(無料プランでは利用不可)。

確認済み受信を示す配信統計(無料プランでは利用不可)

テストデバイスが、カスタムアイコン(設定済みの場合)と展開時の大きな画像を含む通知を受信したことを確認してください。有料プランでは、Dashboard > Delivery > Sent Messagesで確認済み受信(Confirmed receipt)を確認できます。
  • 通知が届かない?モバイルプッシュが表示されないをご覧ください。
  • カスタムアイコンがない?アイコン名がic_stat_onesignal_defaultで、正しいdrawableフォルダにあることを確認してください。
  • 問題がありますか?APIリクエストとアプリ起動から終了までのログを.txtファイルにコピー&ペーストし、両方をsupport@onesignal.comに送信してください。

アプリ内メッセージをテストする

  1. アプリを30秒以上閉じます
  2. Dashboard > Messages > In-App > New In-App > Welcomeテンプレートを選択
  3. オーディエンス:Test Usersセグメント
  4. トリガー:On app open
  5. スケジュール:Every time trigger conditions are satisfied
  6. Make Message Liveをクリック
  7. アプリを開きます
アプリ内メッセージで「Test Users」セグメントをターゲティング。

アプリ内メッセージで「Test Users」セグメントをターゲティング

アプリ内Welcomeメッセージのカスタマイズ例。

アプリ内Welcomeメッセージのカスタマイズ例

アプリ内メッセージのスケジュールオプション。

アプリ内メッセージのスケジュールオプション

デバイスに表示されるWelcomeアプリ内メッセージ。

デバイスに表示されるWelcomeアプリ内メッセージ

テストデバイスにWelcomeアプリ内メッセージが表示されるはずです。詳細については、アプリ内メッセージのセットアップをご覧ください。
メッセージが表示されない?
  • 新しいセッションを開始する
    • アプリを強制終了して再度開くか、30秒以上閉じるかバックグラウンドにしてから再度開きます。いずれの場合も新しいセッションが開始されます。セッションを参照してください。
    • 詳細については、アプリ内メッセージの表示方法をご覧ください。
  • まだTest Usersセグメントに含まれていますか?
    • 再インストールまたはデバイスを切り替えた場合は、デバイスをテストユーザーに再追加し、Test Usersセグメントに含まれていることを確認してください。
  • 問題がありますか?
    • 上記の手順を再現しながらデバッグログの取得の手順に従ってください。追加のログが生成され、support@onesignal.comに共有していただければ調査をお手伝いします。
これでサブスクリプションテストユーザーセグメントが用意できました。メッセージ作成 APIで画像付きのプッシュ通知アプリ内メッセージを送信しました。以下に進んで、ユーザーを識別し、さらに機能を追加してください。
OneSignal SDKのセットアップに成功し、次の重要な概念を学びました:このガイドを続けて、アプリ内でユーザーを識別し、追加機能をセットアップしてください。

一般的なエラーと修正

ユーザー管理

以前、モバイルサブスクリプションの作成方法を説明しました。ここでは、OneSignal SDKを使用して、すべてのサブスクリプション(プッシュ、メール、SMSを含む)を通じてユーザーを識別する方法に拡張します。

External IDを割り当てる(推奨)

External IDを使用して、バックエンドのユーザー識別子でデバイス、メールアドレス、電話番号を横断してユーザーを一貫して識別します。これにより、チャネルとサードパーティシステム間でメッセージングが統一されます。
OneSignalはサブスクリプション(Subscription ID)とユーザー(OneSignal ID)に対して一意の読み取り専用IDを生成します。SDKを通じてExternal IDを設定することを強く推奨します。これにより、作成方法に関係なく、すべてのサブスクリプションでユーザーを識別できます。SDKリファレンスでloginメソッドの詳細をご覧ください。

タグとカスタムイベントを追加する

タグとカスタムイベントはどちらもユーザーにデータを追加します。タグはkey-value文字列で、ユーザープロパティ(usernamerolestatusなど)に使用します。カスタムイベントはJSONを使用し、通常はアクション(new_purchaseabandoned_cartなど)を表します。両方ともメッセージパーソナライゼーションとJourneysを駆動するために使用できます。
詳細については、タグカスタムイベントをご覧ください。

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

プッシュ通知に加えて、メールとSMSを通じてユーザーにリーチできます。メールアドレスや電話番号がすでにOneSignalアプリに存在する場合、SDKは既存のユーザーに追加し、重複を作成しません。先にlogin()を呼び出して、アドレスが識別済みのユーザーに紐づくようにしてください。
External IDで統一されたプッシュ、メール、SMSサブスクリプションを持つユーザープロファイル。

External IDで統一されたプッシュ、メール、SMSサブスクリプションを持つユーザープロファイル

マルチチャネルコミュニケーションのベストプラクティス
  • メールまたはSMSサブスクリプションを追加する前に明示的な同意を取得してください。
  • 各コミュニケーションチャネルの利点をユーザーに説明してください。
  • チャネル設定を提供して、ユーザーが希望するチャネルを選択できるようにしてください。

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

OneSignalがユーザーデータを収集するタイミングを制御するには、SDKの同意管理メソッドを使用します。consentRequiredinitWithContext前に呼び出してください。

プッシュ権限のプロンプト

アプリを開いた直後にrequestPermission()を呼び出す代わりに、より戦略的なアプローチを取りましょう。アプリ内メッセージを使用して、権限をリクエストする前にプッシュ通知の価値を説明してください。 ベストプラクティスと実装の詳細については、プッシュ権限のプロンプトガイドをご覧ください。

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

SDKリスナーを使用して、ユーザーのアクションと状態変化に反応します。OneSignal.initWithContext()の後にApplicationクラスに追加してください。

プッシュ通知イベント

ユーザー状態の変更

この例では、プッシュサブスクリプションオブザーバーを使用しています。ユーザー状態オブザーバーと通知権限オブザーバーは、モバイルSDKリファレンスで確認できます。

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

追加のアプリ内メッセージメソッドは、モバイルSDKリファレンスで確認できます。

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

Android固有の機能

ユニバーサル機能

SDKメソッドの完全なドキュメントについては、モバイルSDKリファレンスをご覧ください。

FAQ

Android StudioがOneSignalを解決できないのはなぜですか?

SDK依存関係がないか、Gradleが同期されていません。アプリモジュールのbuild.gradlecom.onesignal:OneSignal:[5.6.1, 5.99.99]を追加し、File > Sync Project with Gradle Filesを使用してください。

Applicationクラスが見つからないのはなぜですか?

クラスがマニフェストに登録されていません。AndroidManifest.xml<application>タグにandroid:name=".ApplicationClass"(またはお使いのクラス名)を追加してください。

エミュレータでGoogle Play Servicesが利用できないと表示されるのはなぜですか?

エミュレータのイメージにPlay Servicesが含まれていません。Play Storeが搭載されたデバイス、またはGoogle APIsを含むエミュレータのシステムイメージを使用してください。

通知にデフォルトのAndroidアイコンが表示されるのはなぜですか?

小さいアイコンがないか、名前が間違っています。各res/drawable-*密度フォルダにic_stat_onesignal_defaultを追加してください。通知アイコンをご覧ください。

テストデバイスにプッシュが届かなかったのはなぜですか?

FCM認証情報が設定されていないか、デバイスが購読していません。ステップ0を完了し、サブスクリプションステータスがSubscribedであることを確認してください。それでも解決しない場合は、モバイルプッシュが表示されないをご覧ください。

アプリ内メッセージが表示されないのはなぜですか?

アプリ内メッセージには新しいセッションが必要です。アプリを強制終了するか、30秒以上バックグラウンドにしてから再度開いてください。デバイスがまだTest Usersセグメントに含まれていることを確認してください。セッションアプリ内メッセージの表示方法をご覧ください。

Manifest merger failedの原因は何ですか?

<application>android:name値の競合、または権限の重複です。マージ済みマニフェストで2つ目のApplicationクラスを検索し、android:nameを1つだけ残してください。

バッテリー最適化が通知をブロックするのはなぜですか?

一部のOEMはバックグラウンド処理を制限します。デバイスのスリープ後に通知が止まる場合は、ユーザーにアプリのバッテリー最適化を無効にするよう依頼してください。

より多くのログ出力を取得するにはどうすればよいですか?

OneSignal.Debug.logLevel = LogLevel.VERBOSE(Kotlin)またはOneSignal.getDebug().setLogLevel(LogLevel.VERBOSE)(Java)を設定し、問題を再現してlogcatをキャプチャしてください。デバッグログの取得をご覧ください。
サポートが必要ですか?サポートチームとチャットするか、support@onesignal.comにメールしてください以下を含めてください:
  • 発生している問題の詳細と再現手順(利用可能な場合)
  • OneSignal App ID
  • 該当する場合は、External IDまたはSubscription ID
  • 該当する場合は、OneSignalダッシュボードでテストしたメッセージのURL
  • 関連するログまたはエラーメッセージ
お気軽にお問い合わせください!