App Data の取得

 

ユーザのアプリデータ(appdata)を取得します。

  • Appdata に利用できるキーは 32 バイトまでです。一方、バリューに関しては 1024 バイトまでです。
  • 一つのアプリに対して、ユーザ一人が保存できるキー・バリュー・ペアの数は最大 30 個までです。

URI Fragment

/appdata/{-list|,|userId}/@self/@app

パラメータ名

説明

userId

文字列/ユーザ ID

現在ログインしているユーザを表す @me、またはユーザID

署名方式

  • 2-legged(Trusted モデル)
  • 3-legged(Proxy モデル)

OAuth 認証についてはこちら、リクエストの署名や Authorization ヘッダーの作成についてはこちらを参照して下さい。

HTTP メソッド

GET

リクエストヘッダー

  • Authorization ヘッダーは必須になります。

URL クエリパラメータ

パラメータ名

説明

必須

fields

リスト

取得したい Appdata のキーをカンマ区切りで指定します。指定されない場合は全てのキー・バリュー・ペアが返されます

No

format

文字列

"json"を指定して下さい

No

リクエスト本文

なし

レスポンスコード

HTTP ステータスコード

HTTP ステータスメッセージ

説明

200

OK

データの取得が成功した場合

400

Bad Request

クライアント側のリクエストデータが不正です

401

Unauthorized

認証エラーです

403

Forbidden

リソースは存在するが認証エラー以外の理由でアクセス出来ない場合です

404

Not Found

存在しないリソースです

500

Internal Server Error

API サーバー側のエラーです

503

Service Unavailable

一時的に API が利用不可となっている場合です

レスポンス本文

  • Appdata 一覧。下記実例参照。
  • Content-Type: application/json; charset=utf-8

実例

現在ログイン中ユーザの Appdata を取得します
Base String
HTTP リクエスト
HTTP レスポンス
複数ユーザの Appdata を取得します
Base String
HTTP リクエスト
HTTP レスポンス

PREVIOUS

App Data の削除

NEXT

App Data の作成