- サードパーティアプリのユーザーのアカウントをAmazonアカウントにリンクする。
- サードパーティアプリのユーザー向けの既存のリンクを取得する。
- サードパーティアプリのユーザーのログイン用オプションを含む選択画面を表示する。
- ビジネス指標を記録する。
はじめに
セットアップ
- package.jsonファイルの
dependenciesセクションに、以下のライブラリ依存関係を追加します。
-
manifest.tomlに、以下の権限を追加します。
これらの権限により、以下が可能になります。
- シンプルサインインシステムサービスにアクセスする。
- ユーザーの同意を求める画面を許可する。
- ユーザーにログインオプションを表示する画面を許可する。
使用方法
次のセクションでは、シンプルサインインを使用してアカウントリンクを実行し、ユーザーをログインさせる方法を示します。GetUserAndLinks
次の例では、アプリを実行しているデバイスで現在アクティブなAmazonユーザーのシンプルサインイン関連のデータを取得するリクエストを開始します。LinkUserAccount
次の例では、ユーザーのアプリアカウントのアカウントリンクを開始します。この例では、Amazonとアプリアカウントの間の多対多マッピングが可能になります。1つのAmazonアカウントに複数のアプリアカウントを同時にリンクさせることができ、また、1つのアプリアカウントに複数のAmazonアカウントをリンクさせることもできます。ShowLoginSelection
次の例では、ユーザーにログインオプションを表示するダイアログを開きます。このメソッドを呼び出す前に、リンク済みアカウントごとにユーザーが認識しやすい識別子を取得してリクエストに含めます。識別子を取得するには、getUserAndLinks()メソッドを呼び出します。ユーザーが認識できる識別子には、ログイン名、Eメールアドレス、プロフィール名などがありまます。このコードではこれらの識別子が画面に表示されるため、リンクされたアプリアカウントをユーザーが認識しやすくなります。
RecordMetricEvent
次の例では、指標の公開用に記録されたイベントを起動します。シンプルサインインのビジネス指標レポートは、開発者コンソールの [レポート] タブでダウンロードできます。これらの指標は、シンプルサインインの統合によるビジネス価値や影響を把握するためのものです。サインインフローの実装
サインインフローを実装する前に、IDプロバイダー名(IDP_NAME)が必要になります。これは、開発者コンソールでのアプリのオンボーディングプロセス中に提供されます。この一意の識別子により、アプリをシンプルサインインサービスに接続できます。
サインインについて
通常、サインインプロセスは次の場合に開始されます。- アプリが起動したとき
- ユーザーがログインボタンをクリックしたとき
- セッションで認証が必要になったとき
GetUserAndLinks()メソッドを使用して基本的なサインインフローを実装する方法を示しています。
アカウントリンクのプロセス
標準ログインに成功したら、ユーザーのアカウントをリンクして、今後のセッションでスムーズにサインインできるようにする必要があります。このプロセスにより、ユーザーのAmazonアカウントとアプリのアカウントが安全に接続されます。 次の例では、アプリの標準ログイン方法を使用してユーザーアカウントをアプリにリンクします。 ユーザーがアプリの標準ログインプロセスを使用してサインインするたびに、LinkUserAccount()メソッドを呼び出します。
トラブルシューティング
-
同意画面またはログイン選択画面が表示されません。\
マニフェストが更新されていることを確認してください。
-
API呼び出しで、リクエストステータスに
FEATURE_TURNED_OFFが返されます。 ユーザーが、アカウントレベル、デバイスレベル、またはアプリでシンプルサインイン機能を無効にしました。 -
API呼び出しで、リクエストステータスに
NOT_AVAILABLEが返されます。 デバイスが実行されている地域では、シンプルサインイン機能を利用できません。
APIリファレンス
クラス
- SimpleSignInService - Amazonシンプルサインインフレームワークとやり取りするための主要なAPIを提供します。
列挙型
- FailureReason - 出力された指標でのエラーの理由を表します。
- LinkAccountSuccessCode - ユーザーアカウントのリンクアクションの成功コードを表します。
- RequestStatus - SSI APIに対して行われたリクエストのステータスを表します。
- SSIEvent - 指標を公開できるSSIイベントを表します。
- UserSelection - ログイン選択画面でユーザーが選択したオプションの種類を表します。
型エイリアス
- GetUserAndLinksResponse - Copyright 2024 Amazon.com, Inc. or its affiliates.All rights reserved.
- Link - サードパーティアプリによって生成されたリンクに関する情報。
- LinkUserAccountRequest - SimpleSignInService.LinkUserAccountを呼び出すためのリクエストを表します。
- LinkUserAccountResponse - SimpleSignInService.LinkUserAccountの呼び出し結果を表します。
- LoginNameValue - ユーザーのログイン名とリンクIDのマップを表します。
- RecordMetricsEventResponse - SimpleSignInService.RecordMetricEventへの呼び出しの応答を表します。
- ShowLoginSelectionResponse - SimpleSignInService.ShowLoginSelectionへの呼び出しの応答を表します。
- SSIEventRequest - SimpleSignInService.RecordMetriceventを呼び出すためのリクエストを表します。
- Token - 使用されているトークンとスキーマを表します。

