メインコンテンツへスキップ

Windowsアプリセットアップ

要件

WindowsアプリにOneSignalをセットアップする前に、次を確認してください:
  • Universal Windows Platform(UWP)アプリ - OneSignalは現在UWPアプリのみをサポートしています
  • Microsoft Storeアプリ登録 - Package SIDとSecret Keyの取得に必要です
  • OneSignalアカウント - 設定済みのアプリとプラットフォーム設定を持つ無料アカウント
OneSignalは現在Windows App SDK(WinUI 3)をサポートしていません。UWPの代わりにWindows App SDKを使用するアプリの場合は、support@onesignal.comに連絡して移行オプションのガイダンスを受けてください。

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

ステップ1:OneSignalアカウントのセットアップ

チームがすでにOneSignalアカウントを持っている場合は、プラットフォーム設定を構成するために管理者アクセスをリクエストしてください。それ以外の場合は、無料アカウントを作成して開始してください。

ステップ2:OneSignalアプリの作成または設定

OneSignalでは、クロスプラットフォームメッセージング用に単一のアプリ内で複数のプラットフォーム(iOS、Android、Huawei、Amazon、Windows)を設定できます。

新しいアプリを作成

  1. ダッシュボードからNew App/Websiteをクリックします
  2. 認識可能なアプリ名と組織名を選択します
  3. プラットフォームとして**Windows(UWP)**を選択します
  4. Next: Configure Your Platformをクリックします

Windowsプラットフォームで新しいOneSignalアプリを作成

既存のアプリにプラットフォームを追加

  1. 既存のアプリを選択します
  2. Settings > Push & In-Appに移動します
  3. Add Platformをクリックして**Windows(UWP)**を選択します

OneSignalアプリをセットアップしてWindowsプラットフォームを選択

ステップ3:追加プラットフォームの設定(オプション)

クロスプラットフォームアプリを構築している場合は、今すぐ追加のプラットフォームを設定します: 各プラットフォームの認証情報を入力した後、Save & Continueをクリックします。

ステップ4:ターゲットSDKの選択

ターゲットSDKとしてWindows UWPを選択し、Save & Continueをクリックします。

プラットフォーム固有のドキュメントにアクセスするためにWindows UWP SDKを選択

ステップ5:App IDの保存

重要: OneSignal App IDをコピーして安全に保管してください - API呼び出しとユーザー登録にこれが必要になります。

App IDを保存し、アクセスが必要なチームメンバーを招待

オプションで、Inviteをクリックしてチームメンバーを招待し、Doneをクリックして続行します。

Windowsプラットフォーム設定

Microsoft Store認証情報の取得

OneSignalはWindows Push Notification Service(WNS)を使用するため、Microsoft Storeから認証情報が必要です:
  1. Microsoft Storeに公開 - アプリはMicrosoft Storeに登録されている必要があります(一般公開されていなくても可)
  2. Package SIDとSecret Keyの取得 - Microsoftの詳細ガイドに従ってこれらの認証情報を取得します
  3. OneSignalプラットフォームの設定
    • OneSignalダッシュボードで**Settings > Windows(UWP)**に移動します
    • Package SIDとSecret Keyを貼り付けます
    • Saveをクリックしてプラットフォームをアクティブ化します

OneSignalダッシュボードでWindowsプラットフォーム認証情報を設定

注意: Package SIDとSecret Keyは、アプリがMicrosoft Storeに登録された後にのみ利用可能です。これらの認証情報なしではローカルでプッシュ通知をテストできません。

SDK統合

アーキテクチャの理解

OneSignalは専用のUWP SDKを提供していません。代わりに、次を使用して統合します:
  1. Windows Push Notification Service(WNS) - Microsoftのネイティブプッシュサービス
  2. OneSignal REST API - ユーザー管理とメッセージ送信用
  3. 通知チャネルURI - プッシュ通知のデバイストークンとして機能
WNSの包括的な理解については、MicrosoftのWNSドキュメントを確認してください。

プッシュ通知用のユーザー登録

ステップ1:通知チャネルのリクエスト

Microsoftのガイドに従って通知チャネルを作成します。WNSによって返されるチャネルURIがデバイストークンとして機能します。
// Example: Getting notification channel URI
var channel = await PushNotificationChannelManager.CreatePushNotificationChannelForApplicationAsync();
string channelUri = channel.Uri; // This is your token for OneSignal

ステップ2:OneSignalユーザーレコードの作成

OneSignalのCreate user APIを呼び出してデバイスを登録します: 必須パラメーター:
  • subscription.type"WindowsPush"
  • subscription.token:ステップ1のチャネルURI
推奨パラメーター:
  • identity.external_id:ユーザーの一意の識別子(システムのユーザーIDなど)
  • properties:ターゲティング用のカスタムユーザープロパティ
{
  "identity": {
    "external_id": "your-user-id-123"
  },
  "subscriptions": [
    {
      "type": "WindowsPush",
      "token": "https://cloud.notify.windows.com/?token=..."
    }
  ],
  "properties": {
    "tags": {
      "user_type": "premium",
      "app_version": "1.2.0"
    }
  }
}
Gotcha: Channel URIs can expire and change. Implement logic to refresh the channel URI periodically and update the OneSignal user record when it changes.

チャネルURI変更の処理

WNSチャネルURIは期限切れになる可能性があります。更新が必要な場合を検出するためにPushNotificationReceivedイベントを実装します:
channel.PushNotificationReceived += OnPushNotificationReceived;

// Check if channel URI has changed
if (channel.Uri != storedChannelUri) {
    // Update OneSignal user record with new URI
    await UpdateOneSignalUser(channel.Uri);
}

プッシュ通知の送信

OneSignalダッシュボードの使用

  1. OneSignalダッシュボードでMessages > Pushに移動します
  2. 新しいプッシュ通知を作成します
  3. Windowsプラットフォームを選択します
  4. メッセージコンテンツとターゲティングを設定します
  5. すぐに送信するか、後でスケジュールします

OneSignal APIの使用

Create notification APIを使用してプログラムで通知を送信します:
{
  "app_id": "your-onesignal-app-id",
  "contents": {"en": "Your notification message"},
  "headings": {"en": "Notification Title"},
  "include_external_user_ids": ["your-user-id-123"],
  "channel_for_external_user_ids": "push"
}
For detailed messaging options and advanced targeting, see Sending Push Messages.

次のステップとベストプラクティス

統合のテスト

  1. 通知チャネル作成のテスト - アプリがWNSチャネルを正常に作成および維持することを確認します
  2. ユーザー登録の確認 - ユーザーがOneSignalダッシュボードに適切に登録されていることを確認します
  3. テスト通知の送信 - OneSignalダッシュボードを使用してテストメッセージを送信します
  4. 通知イベントの処理 - 通知の受信、開封、却下イベントの適切な処理を実装します

よくある問題と解決策

チャネルURIが機能しない
  • Package SIDとSecret Keyが正しく設定されていることを確認してください
  • アプリがMicrosoft Storeに適切に登録されていることを確認してください
  • チャネルURIが期限切れになっていないことを確認してください
ユーザーが通知を受信しない
  • OneSignalユーザーレコードが正常に作成されたことを確認してください
  • WindowsプラットフォームがOneSignalで適切に設定されていることを確認してください
  • Windowsの通知設定で通知がブロックされていないことを確認してください
API統合の問題
  • OneSignal App IDが正しいことを検証してください
  • 正しいAPIエンドポイントと認証を使用していることを確認してください
  • トラブルシューティングのためにAPI応答コードとエラーメッセージを確認してください

本番環境での考慮事項

  • すべてのOneSignal API呼び出しに対して適切なエラー処理を実装してください
  • チャネルURI更新失敗の監視を設定してください
  • ネットワーク問題時のAPI呼び出しにオフラインキューイングの実装を検討してください
  • アプリ使用のピーク時にユーザー登録をスケーリングする計画を立ててください
追加のサポートと高度な実装ガイダンスについては、OneSignalサポートに連絡するか、包括的なAPIドキュメントをご覧ください。