キー値ストア(kvstore)
進捗のような小さな値をサーバーに保存して読み取ります。値は自分・この資料の単位で、誰の値かはサーバーがトークンで判断します。
個人情報の禁止
key・値に学習者の個人情報(氏名・連絡先・学籍番号など)を保存しないでください。値はサーバーに残り、教育者・運営者・チューターが閲覧できます。誰の値かはサーバーがトークンで判断するため、名前やIDを値に入れる必要はありません。
await sdk.kvstore.post({ key: 'userProgress', value: { step: 3, completed: false } });
const step = await sdk.kvstore.get<number>({ key: 'userProgress.step' }); // 3
await sdk.kvstore.delete('userProgress');
// 저장한 값 전체: 맨 위 key별 { key: value }
const all = await sdk.kvstore.get({ key: '' }); // { userProgress: { … }, … }
keyのルール
- 英字・数字・
_・ハングル(가–힣)の名前を.でつないだパスです(最大256文字)。例:userProgress.step post・deleteは空のkeyを受け付けません。get({ key: '' })は最上位のkeyすべてを{ key: value }で返します。- 形式が正しくなければ、サーバーに問い合わせる前に
invalid_paramです。
動作
- 存在しない値は
nullで、存在しないkeyのdeleteはエラーになりません。 postはパスの途中で存在しないオブジェクトを作成します。パスの途中の値がオブジェクトでなければinvalid_inputです。- 値はJSONで保存され、key・値の中の名前(
userProgress、snake_keyなど)は変換せずにそのままやり取りします。 - チューターは、見ている学生の値を読み取ります。チューターによる保存・削除は
read_only_modeです。
上限
| 上限 | 超えた場合 |
|---|---|
| この資料の自分の値の合計512KB | storage_limit_exceeded |
| 保存・削除は1秒あたり20回 | rate_limited |