はじめに
第3回までで、OpenSocialアプリケーションの基礎を考えてきました。いよいよ今回から本格的にソーシャル情報を扱うことになります。今回はOpenSocialコンテナへのリクエストをどのように行うのか、またソーシャル情報を取得するためにはどうすればよいかという部分を解説します。
DataRequestオブジェクトについて
OpenSocialアプリケーションがソーシャル情報を扱う際には、第1回で説明したとおり、OpenSocialコンテナへ情報をリクエストする必要があります。OpenSocial APIでこの役割を担うのがDataRequestオブジェクトです。DataRequestオブジェクトを使ったコンテナへのアクセスの概念図を以下に示します。
OpenSocialアプリケーションは、DataRequestオブジェクトのsendメソッドを使ってOpenSocialコンテナにソーシャル情報のリクエストを行い、処理結果はDataResponseオブジェクトとして返され、呼び出し時に指定したコールバック関数で処理されます。
DataRequestオブジェクトに複数のリクエストが含まれることに注目してください。一般にOpenSocialアプリケーションでソーシャル情報を扱う場合、複数のソーシャル情報を扱うことは少なくありません。例えば、前回のサンプルでは
- VIEWERの情報
- OWNERの情報
- OWNERのFRIENDSの情報
という3つのソーシャル情報を一画面に表示していました。
このような場合に、コンテナに対してそれぞれにソーシャル情報をリクエストすると、サーバ側の負荷も上がりますし、非同期通信を行うためのクライアント側のコールバック記述も複雑なものとなります。そのためOpenSocialでは、複数のリクエストをDataRequestオブジェクトにまとめて格納し、一回の非同期通信でまとめてコンテナで処理できるようになっています。図に示したように、DataRequestオブジェクトにはリクエストごとに名前を付けて格納し、結果のDataResponseオブジェクトには、リクエストの際と同じ名前で実行結果が格納されます。
DataRequestで扱うことのできるリクエスト
DataRequestオブジェクトには、情報の取得を行うリクエストだけではなく、情報を更新するリクエストも格納することができます。DataRequestオブジェクトのメソッドでそれぞれのリクエストを作成することができます。以下にDataRequestオブジェクトのメソッドと、作成されるリクエストの対応を表で示します。
| メソッド名 | 概要 |
| newFetchPersonRequest | 個人の情報を取得するリクエストを作成する |
| newFetchPeopleRequest | 友達の情報を取得するリクエストを作成する |
| newFetchActivitiesRequest | アクティビティを取得するリクエストを作成する |
| newFetchPersonAppDataRequest | 個人のアプリケーションデータを取得するリクエストを作成する |
| newRemovePersonAppDataRequest | 個人のアプリケーションデータを削除するリクエストを作成する |
| newUpdatePersonAppDataRequest | 個人のアプリケーションデータを格納するリクエストを作成する |
| newFetchAlbumsRequest | 個人のアルバムデータを取得するリクエストを作成する（OpenSocial v0.9より追加。mixiアプリでは使用可能） |
| newFetchMediaItemsRequest | アルバム内のメディアデータを取得するリクエストを作成する（OpenSocial v0.9より追加。mixiアプリでは使用可能） |
| mixi.newFetchCommunityRequest | コミュニティ情報を取得するリクエストを作成する関数（mixi専用） |
なお、末尾に記したmixi.newFetchCommunityRequest関数は、DataRequestオブジェクトのメソッドではなく、mixiが独自に拡張したものですが、リクエストの流れとしては他のものと同じですので、ここに記します。
また、OpenSocial v0.9より追加されたアルバム関連のメソッドは、取得以外にも作成、更新、削除を行うためのリクエストを作成するメソッドが準備されています。
これらのうち、最初に挙げたnewFetchPersonRequestとnewFetchPeopleRequestが、ソーシャル情報を取得するためのリクエストを作成するためのメソッドです。今回は個人の情報を取得するためのnewFetchPersonRequestメソッドを、次回は友達の情報を取得するためのnewFetchPeopleRequestメソッドを説明します。その他のリクエストのいくつかについては、連載の中で扱っていきます。
