REST API APPENDIX (REST API)
最終更新日 2015-9-1

データストアの基本構造

データストアの基本構造について説明します。

データストアでできること

  • 管理画面から登録、参照、更新、削除などの操作を可能にします。
  • REST API から登録、参照、更新、削除などの操作を可能にします。
  • コレクション単位かつ、操作(*1)毎にアクセス権限の設定を実現します。

(*1)操作とは、データの登録、参照、更新および削除を言います。

データストアに保持するオブジェクトの格納イメージ

データストアでは下図のような形式でオブジェクトを保存します。

Datastore

またオブジェクトは下記に示すような階層構造で格納されています。

obj

API で利用するアクセストークンに関して

データストア関連 API で利用するアクセストークンは下記2つです。それぞれのトークンを利用してオブジェクトの各操作 (登録、参照、更新、削除) のアクセス制御を実施します。

  • アプリトークン

アプリ単位に1つ発行されるトークン。管理画面にて、各アプリのダッシュボードから確認できます。

  • ストアトークン

ユーザ単位に発行されるトークン。ユーザサインインにともない、発行されます。

データストア関連 API を介した操作に対するアクセス権限

  • データ操作は大きく「Create(登録)」「Read(参照)」「Update(更新)」「Delete(削除)」に分類され、それら4つの操作に対しアクセス権限を設定することができます。
  • アクセス権限はコレクション単位のデータ格納領域に対し設定します。
  • アクセス権限の設定はコントロールパネルの データ管理 にて設定します。

以下にアクセス権の名称とその制限範囲を記述します。

アクセス権限 アクセス可能なユーザ 操作対象のオブジェクト 必要となるトークン
ALL データストア関連 APIへアクセス可能なユーザ全て すべてのオブジェクト ストアトークン
アプリトークン
(*2)
SIGN IN サインインしたユーザ アプリにひもづくオブジェクトのみ ストアトークン
OWNER サインインしたユーザ サインインしたユーザが自分で登録したオブジェクトのみ ストアトークン

4つめのアクセス権限 ADMIN はデータストア関連 API を介したアクセスをすべて拒否し、コントロールパネル上での操作のみ許容します。

(*2)アクセス権限 ALL の参照時のみアクセストークンは不要です

アクセス権限の設定は、コントロールパネル内、データ管理のコレクションの編集より行うことが可能です。

datastore_crud