跳到主要内容

アプリケーションデータを保存、取得、削除する

アプリケーションデータの保存​

OpenSocialでは、コンテナ上にデータを保存しておくことができます。コンテナ上のアプリケーションデータはAPIを通じて保存、取得、削除ができます。

以下はアプリケーションデータを保存するサンプルコードです。

var req = opensocial.newDataRequest();
req.add(req.newUpdatePersonAppDataRequest(opensocial.IdSpec.PersonId.VIEWER, "score", 1000), "res1");
req.add(req.newUpdatePersonAppDataRequest(opensocial.IdSpec.PersonId.VIEWER, "rank", "A"), "res2");
req.send(function(response){
if (response.hadError()) {
// error
} else {
// ...
}
});
  • opensocial.newDataRequest() を呼び出して DataRequest を作成します。
  • 生成した DataRequest の newUpdatePersonAppDataRequest() を呼び出してリクエストを生成します。
  • 引数にはアプリケーションデータのオーナー ( VIEWER 固定になります。)とデーターのキーと値を指定します。
  • DataRequest.add(request) を呼び出してリクエストを登録します。
  • DataRequest.send(callback) を呼び出して情報の取得を要求します。
  • サーバー要求の処理が完了すると、send() で指定されたコールバック関数が、要求結果を含む opensocial.ResponseItemクラスのオブジェクトを引数として実行されます。
  • DataResponse に格納されているデータを処理します。

アプリケーションデータの取得​

VIEWER が保存したアプリケーションデータを取得するサンプルコードは以下のようになります。

var params = {};
params[opensocial.IdSpec.Field.USER_ID] = opensocial.IdSpec.PersonId.VIEWER;
var idSpec = opensocial.newIdSpec(params);
var req = opensocial.newDataRequest();
req.add(req.newFetchPersonRequest(opensocial.IdSpec.PersonId.VIEWER), 'viewer');
req.add(req.newFetchPersonAppDataRequest(idSpec, ["score", "rank"]), "result");
req.send(function(response) {
if (response.hadError()) {
// error
} else {
var viewer = response.get("viewer").getData();
var result = response.get("result").getData();
var score = result[viewer.getId()]["score"];
var rank = result[viewer.getId()]["rank"];
// ...
}
});
  • アプリケーションデータのオーナーを表す IdSpec を opensocial.newIdSpec() を利用して生成します。ここでは VIEWER を指定します。
  • opensocial.newDataRequest() を呼び出して DataRequest を作成します。
  • VIEWERの情報を取得するため生成した DataRequest の newUpdatePersonRequest() を呼び出してリクエストを生成します。
  • DataRequest.add(request) を呼び出してリクエストを登録します。
  • newUpdatePersonAppDataRequest() を呼び出してリクエストを生成します。
  • 引数にはアプリケーションデータのオーナーを表す IdSpec とデーターのキーを配列で指定します。
  • DataRequest.add(request) を呼び出してリクエストを登録します。
  • DataRequest.send(callback) を呼び出して情報の取得を要求します。
  • サーバー要求の処理が完了すると、send() で指定されたコールバック関数が、要求結果を含む DataResponse を引数として実行されます。
  • DataResponse に格納されているデータを処理します。

次に VIEWER のモバ友が保存したアプリケーションデータを取得します。

var params = {};
params[opensocial.IdSpec.Field.USER_ID] = opensocial.IdSpec.PersonId.VIEWER;
params[opensocial.IdSpec.Field.GROUP_ID] = opensocial.IdSpec.GroupId.FRIENDS;
var idSpec = opensocial.newIdSpec(params);
var req = opensocial.newDataRequest();
req.add(req.newFetchPersonAppDataRequest(idSpec, ["score", "rank"]), "result");
req.send(function(response) {
if (response.hadError()) {
// error
} else {
var result = response.get("result").getData();
for (var id in result) {
var score = result[id]["score"];
var rank = result[id]["rank"];
// ...
}
}
});
  • アプリケーションデータのオーナーを表す IdSpec を opensocial.newIdSpec() を利用して生成します。ここでは VIEWER の FRIENDS を指定します。
  • opensocial.newDataRequest() を呼び出して DataRequest を作成します。
  • newUpdatePersonAppDataRequest() を呼び出してリクエストを生成します。
  • 引数にはアプリケーションデータのオーナーを表す IdSpec とデーターのキーを配列で指定します。
  • DataRequest.add(request) を呼び出してリクエストを登録します。
  • DataRequest.send(callback) を呼び出して情報の取得を要求します。
  • サーバー要求の処理が完了すると、send() で指定されたコールバック関数が、要求結果を含む DataResponse を引数として実行されます。
  • DataResponse に格納されているデータを処理します。

アプリケーションデータの削除​

保存したアプリケーションデータの削除は以下のようになります。

var req = opensocial.newDataRequest();
req.add(req.newRemovePersonAppDataRequest(opensocial.IdSpec.PersonId.VIEWER, ["score", "rank"]);
req.send(function(response) {
if (response.haError()) {
// error
} else {
// ...
}
});
  • opensocial.newDataRequest() を呼び出して DataRequest を作成します。
  • 生成した DataRequest の newRemovePersonAppDataRequest() を呼び出してリクエストを生成します。
  • 引数にはアプリケーションデータのオーナー ( VIEWER 固定になります。)とデーターのキーを指定します。
  • DataRequest.add(request) を呼び出してリクエストを登録します。
  • DataRequest.send(callback) を呼び出して情報の取得を要求します。
  • サーバー要求の処理が完了すると、send() で指定されたコールバック関数が、要求結果を含む DataResponse を引数として実行されます。
  • DataResponse に格納されているデータを処理します。

アプリケーションデータの制限​

現在アプリケーションデータの使用にはいくつかの制限事項があります。

  • アプリケーションデータの保存。削除は VIEWER 自身のアプリケーションデータに限ります。
  • アプリケーションデータの取得は VIEWER 自身および VIEWER の FRIENDS のアプリケーションデータに限ります。
  • キー、値のサイズ制限として、キーは 32 byte まで、値は 1024 byte までです。
  • キーと値のペアはアプリケーションをインストールしているユーザーごとに 30 件までです。

更新履歴​

  • 2013/03/15
    • ドキュメント移行