メインコンテンツへスキップ
カスタムエイリアスを使用すると、OneSignalのユーザーにカスタムキーと値の識別子を割り当てることができ、独自の内部IDを使用してクロスプラットフォームのユーザー追跡と識別が可能になります。
重要: カスタムエイリアスを使用する前に、External IDを設定する必要があります。OneSignalは、ユーザーを識別するために一意のonesignal_idを使用します。このIDは、同じexternal_idを持つ場合にのみサブスクリプション間で一貫性を保ちます。カスタムエイリアスは、サブスクリプションをリンクしません—正しく機能するにはexternal_idに依存します。これがないと、エイリアスはデバイスまたはプラットフォーム間で同じユーザーに関連付けられません。

​
カスタムエイリアスとは？

カスタムエイリアスはキー : 値のペアです：
  • alias_label（キー）は、すべてのユーザーに共通する一貫した静的な識別子です（例：facebook_id、firebase_id、crm_user_id）。
  • alias_id（値）は、そのラベルに対する特定のユーザーのIDです（例：facebook_id: 3453443、firebase_id: test3555）。
これにより、OneSignalユーザーレコードを他のプラットフォームやデータベースからの識別子にリンクできます。

​
エイリアスを使用する理由

  1. 複数のプラットフォームとデータベース間でユーザーを識別します。
  2. Create Message REST APIを使用してターゲットを絞ったトランザクションメッセージを送信します。
  3. User REST APIを介してユーザーを取得、更新、または削除します。

​
エイリアスの設定方法

OneSignal SDKまたはREST APIを使用してエイリアスを設定できます。

​
SDKを使用する

アプリで以下の手順に従ってください：
  1. External IDを設定する OneSignal.login(externalId)を呼び出して、ユーザーレコードを関連付けます。
  2. カスタムエイリアスを設定する OneSignal.User.addAlias(label, id)を使用して単一のエイリアスを追加するか、OneSignal.User.addAliases({ label1: id1, label2: id2 })を使用して複数を設定します。
  3. ログアウト（オプション） OneSignal.logout()を使用して、そのデバイスまたはセッションのexternal IDと関連するエイリアスを削除します。
例： 
OneSignal.login("user_123");

OneSignal.User.addAliases({
  facebook_id: "3453443",
  firebase_id: "test3555"
});

// 後で、ユーザーがログアウトする際
OneSignal.logout();

​
REST APIを使用する

API経由でカスタムエイリアスを設定するには、Create Aliasエンドポイントを使用します。この方法は、通常、サーバー側のユーザー管理のためにバックエンドシステムで使用されます。 リクエスト例： 
POST /aliases
{
  "subscription_id": "abc123",
  "aliases": {
    "facebook_id": "3453443",
    "crm_user_id": "XYZ789"
  }
}

​
ベストプラクティス

  • エイリアスを割り当てる前に、必ずexternal_idを設定してください。
  • チーム間での混乱を避けるために、安定した説明的なラベル（例：crm_user_id、legacy_user_id）を使用してください。
  • エイリアス値としてメールアドレスや電話番号などの機密情報を使用しないでください。
  • デバイスのサインアウトやユーザー切り替えイベント時にlogout()を使用してエイリアスをクリーンアップしてください。
カスタムエイリアスチュートリアル完了！ 次のステップ：
  • まだの場合は、ユーザーとサブスクリプションのドキュメントを確認してください。
  • APIを介してエイリアスを使用する詳細については、REST APIドキュメントを探索してください。
  • 統合を設定して、システム間でユーザーデータを同期します。