アプリデータを更新、取得、削除する

出典: goo Developer's Kitchen

OpenSocialに準拠したコンテナ上では、データを保存しておくことのできる領域が利用できます。OpenSocialではAppDataやPersistent Dataと呼ばれていますが、goo Social Platformでは「アプリデータ」と呼びます。アプリデータの実体はkey/value型のストレージで、Persistent APIを使って取得、更新、削除することができます。

目次 1 アプリデータの基礎知識 1.1 goo Social Platformの保存領域 1.2 JavaScriptオブジェクトの保存 1.3 JavaScriptオブジェクトの復元 1.4 パーミッションについて 2 アプリデータの取得 3 アプリデータの更新 4 アプリデータの削除

アプリデータの基礎知識

goo Social Platformの保存領域

goo Social Platformでは、ガジェットをインストールしたユーザーIDごとに、それぞれのガジェットが保存できる領域が決まっています。1つのガジェットIDに最大10個のキーを持つアプリデータを保存することができます。言い換えると、同じガジェットIDのガジェットを複数インストールしても、10個のキーが共有されることになります。また、各キーの最大保存文字数は1万文字となっています。

JavaScriptオブジェクトの保存

アプリデータは文字列のみ保存することができます。そのため、JavaScriptで扱うオブジェクトを保存する場合には文字列に変換する必要があります。OpenSocialでは、JSON形式の文字列に変換する方法が推奨されます。

OpenSocialでは、JavaScriptのオブジェクトをJSON形式に変換するメソッドとして、gadgets.json.stringify()が用意されています。

JavaScriptオブジェクトの復元

アプリデータに保存したJSON形式の文字列からJavaScriptのオブジェクトに復元するためには、適用されたエスケープを解除してから、JSONオブジェクトをパースする必要があります。これはgadgets.util.unescapeString()およびgadgets.json.parse()メソッドで行うことができます。

パーミッションについて

アプリデータの更新や取得、削除については、パーミッションモデルをしっかり理解してから利用して頂く必要があります。詳しくはこちらをご覧ください。

アプリデータの取得

指定した個人のアプリデータを取得するためにはnewFetchPersonAppDataRequest()を利用します。IdSpecを使って個人を指定し、その上でアプリデータのキーを指定します。「*」を指定すると、「すべてのキー」という意味になります。

サンプルガジェットはこちら

 // ビューアーを示すIdSpecを生成
 // opensocial.IdSpecを使わずに簡易指定
 var idspec = opensocial.newIdSpec({'userId':'VIEWER', 'groupId':'SELF'});
 var req = opensocial.newDataRequest();
 // ビューアーの情報を取得するリクエストを生成
 req.add(req.newFetchPersonRequest(opensocial.IdSpec.PersonId.VIEWER), 'viewer');
 // アプリデータ取得のリクエストを生成
 req.add(req.newFetchPersonAppDataRequest(idspec, 'appdata_key'), 'response_key');
 // リクエストを送信
 req.send(function(response){
   var viewer = response.get('viewer');
   if (viewer.hadError()) {
     alert(viewer.getErrorMessage());
   } else {
     var appdata = response.get('response_key');
     if (appdata.hadError()) {
       alert(appdata.getErrorMessage());
     } else {
       if (appdata.getData()[viewer.getData().getId()]) {
         // ビューアーのアプリデータを取り出す
         var appdata_param = appdata.getData()[viewer.getData().getId()];
         // エスケープされている文字列をアンエスケープ
         var json = gadgets.util.unescapeString(appdata_param);
         // JSON文字列をオブジェクトに変換
         var obj = gadgets.json.parse(json);
         // HTMLに挿入
         document.getElementById('dom').innerHTML = appdata_param['data1'];
       } else {
         alert('empty');
       }
     }
   }
 });

アプリデータの更新

アプリデータ内の内容を更新するにはnewUpdatePersonAppDataRequest()を使います。更新する対象となるキーの名前を、引数で指定することができます。

サンプルガジェットはこちら

 // サンプルオブジェクト
 var obj = {'data1':'param1', 'data2':'param2'};
 // オブジェクトを文字列に変換
 var str = gadgets.json.stringify(obj);

 var req = opensocial.newDataRequest();
 // 変換した文字列でアプリデータを更新するリクエストを生成
 req.add(req.newUpdatePersonAppDataRequest(opensocial.IdSpec.PersonId.VIEWER, 'appdata_key', str),
   'response_key');
 // リクエストを送信
 req.send(function(response){
   var result = response.get('response_key');
   if (result.hadError()) {
     alert(result.getErrorMessage());
   } else {
     document.getElementById('dom').innerHTML = 'succeeded';
   }
 });

アプリデータの削除

アプリデータ内に保存した個人のキーを削除するにはnewRemovePersonAppDataRequest()を使います。キーには「*」（すべてのキー）も指定することができます。

サンプルガジェットはこちら

 var req = opensocial.newDataRequest();
 // ビューアーのアプリデータを削除するリクエストを生成し、追加
 req.add(req.newRemovePersonAppDataRequest(opensocial.IdSpec.PersonId.VIEWER, 'appdata_key'));
 // リクエストを送信
 req.send(function(response){
   if (response.hadError()) {
     alert(response.getErrorMessage());
   } else {
     document.getElementById('dom').innerHTML = 'removed';
   }
 });