ユーザーに権限付与をリクエストし、認証コード (authCode) を返します。
概要
wv.getAuthCode メソッドは、権限付与ポップアップを表示して、ユーザー情報のアクセス権限をリクエストします。良好なユーザーエクスペリエンスを提供するために、ユーザーが権限付与の必要性を理解している場合にのみ、このメソッドを呼び出してください。ミニアプリの初期画面で wv.getAuthCode を呼び出すことは避けてください。
返された認証コード (authCode) は、ユーザーの同意を示します。ミニアプリのサーバーは、このコードを使用して、プラットフォームから user_id、アバター、ニックネーム、携帯電話番号、リージョン、性別、生年月日などのユーザー情報を取得する必要があります。
リクエストパラメーター
以下のパラメーターを持つオブジェクトです。
パラメーター | 型 | 必須 | 説明 |
scopes | Array | いいえ | 権限付与スコープの配列です。有効な値のリストについては、後述の「スコープ」セクションをご参照ください。デフォルト値は |
success | Function | いいえ | 成功時に実行されるコールバック関数です。 |
fail | Function | いいえ | 失敗時に実行されるコールバック関数です。 |
スコープ
スコープは、ミニアプリがユーザーにリクエストする権限を定義します。
スコープ | 説明 | サーバー操作 |
USER_ID | 非推奨。このスコープは |
|
USER_NICKNAME | ミニアプリがユーザーのニックネームを取得することを許可します。 |
|
USER_NAME | ミニアプリがユーザーの名前を取得することを許可します。 |
|
USER_LOGIN_ID | ミニアプリがユーザーのログイン ID を取得することを許可します。 |
|
HASH_LOGIN_ID | ミニアプリがユーザーのログイン ID のハッシュ値を取得することを許可します。 |
|
USER_AVATAR | ミニアプリがユーザーのアバターを取得することを許可します。 |
|
USER_GENDER | ミニアプリがユーザーの性別を取得することを許可します。 |
|
USER_BIRTHDAY | ミニアプリがユーザーの生年月日を取得することを許可します。 |
|
USER_NATIONALITY | ミニアプリがユーザーの国籍を取得することを許可します。 |
|
USER_CONTACTINFO | ミニアプリがユーザーの連絡先情報を取得することを許可します。 |
|
auth_base | ミニアプリがユーザーの一意の識別子 ( |
|
auth_user | ミニアプリがユーザーのアカウント情報を取得することを許可します。 |
|
レスポンスパラメーター
成功時のコールバック関数は、以下のプロパティを持つオブジェクトを受け取ります。
プロパティ | 型 | 説明 |
authCode | String | 認証コードです。 |
authErrorScopes | Object | 失敗したスコープとそれに対応するエラーコードをマッピングするオブジェクトです。 |
authSuccessScopes | Array | 正常に権限付与されたスコープの配列です。 |
ユーザーが権限を付与するたびに、新しい authCode が生成されます。
fail コールバック関数は、error プロパティ (エラーコード) と errorMessage プロパティ (エラーメッセージ) を持つオブジェクトを受け取ります。
エラーコード | エラーメッセージ | 解決策 |
11 | ユーザーが権限付与をキャンセルしました | ユーザーになぜ情報が必要なのかを説明し、再試行するように案内してください。 |
12 | ネットワークエラー | 権限付与リクエストが失敗したか、タイムアウトしました。後でもう一度お試しください。 |
13 | 権限付与の結果が見つかりません |
|
サンプルコード
window.WindVane.call('wv', 'getAuthCode', {scopes: ['auth_user']}, function(res) {
authCode = res.authCode;
}, function(e) {
alert('failure:' + JSON.stringify(e));
});