既定フィールド
Kii Cloud SDK は、以下の情報を管理するための既定フィールドを定義しています。
| フィールド | JSON でのフィールド名 | 説明 |
|---|---|---|
| ユーザー ID | userID | REST API などで使用する文字列形式のユーザー ID です。1234567-89ab-cdef-0123-456789abcdef のような形式です。 |
| 内部ユーザー ID | internalUserID | 内部的に使用している数値のユーザー ID です。 |
| ユーザー名 | loginName | ログインで使用するユーザー名です。ユーザー名の指定がないとき、フィールドはありません。 |
| メールアドレス | emailAddress | ログインで使用するメールアドレスです。メールアドレスの指定がないとき、フィールドはありません。 |
| メールアドレスが確認済みかどうか | emailAddressVerified | ログインで使用するメールアドレスを認証する設定で確認済みのとき true、未確認のとき false です。認証機能を使用しないときは true です。 |
| 電話番号 | phoneNumber | ログインで使用する電話番号です。指定方法によらず、常に国際電話番号の形式で保存されます。電話番号を指定しないとき、フィールドはありません。 |
| 電話番号が確認済みかどうか | phoneNumberVerified | ログインで使用する電話番号を認証する設定で確認済みのとき true、未確認のとき false です。認証機能を使用しないときは true です。 |
| ディスプレイネーム | displayName | システム的に特に意味は持ちません。モバイルアプリで自由に使用できます。ディスプレイネームを指定しないとき、フィールドはありません。Unicode で 1～50 文字の範囲で入力します。 |
| 所在国 | country | US、JP、CN などが入ります。値を設定していない場合、フィールドはありません。電話番号として国内電話番号形式を指定した場合に限り、国際電話番号形式に変換するための情報としても使用されます（ JP を設定して電話番号に 09011111111 を指定すると、+819011111111 に自動変換）。逆に、国際電話番号から所在国を自動設定したり、所在国から国際電話番号形式の電話番号を自動修正したりする機能はありません。 |
| ロケール | locale | ユーザーのロケールです。メールアドレスや電話番号の認証を行う際、ここで設定したロケールのテンプレートが使用されます。 |
ログイン中のユーザー以外からユーザー属性を取得する場合、"Expose Full User Data to Others" オプションの変更が必要なものがあります。オプション設定によってはユーザー ID、ユーザー名、ディスプレイネームしか取得されません。詳細は、他ユーザーの属性の読み込み を参照してください。