OpenSocialの提供するAPI
OpenSocialは、以下の3種類のAPIを提供しています。
- JavaScript API:SNSの画面上でガジェットとして実行されるアプリケーションのためのJavaScript用API
- RESTful Protocol:SNS以外のサーバからSNSが持つ情報にアクセスするためのAPI
- RPC Protocol:JSONによるサーバ間通信のためのAPI
本連載では、このうちのJavaScript APIを主に扱います。他の2つは主にサーバ間で利用されるAPIです。
JavaScript APIについて
OpenSocialのJavaScript APIは、gadgets名前空間(Gadgets API)とopensocial名前空間(OpenSocial API)の2つの名前空間で構成されています。
「OpenSocial」の「JavaScript API」の中に「OpenSocial API」という名前のAPIが存在するのはなんだか不思議に感じられますが、もともとiGoogleなどのガジェット用に作られたGadgets APIをベースに、ソーシャル情報を扱うOpenSocial APIを追加して、OpenSocialのJavaScript APIが完成したため、このような構造となっています(Gadgets API自体も以前のAPIから拡張されています)。
以下にこれらのAPIの概要を示します。それぞれのAPIについては、第4回以降に説明します。
1. Gadgets API
Gadgets APIはその名の通り、WebアプリケーションをSNS内のガジェットとして動作させるためのAPIです。また、OpenSocialアプリケーションの実体であるガジェットXMLの仕様もGadgets APIで規定されています。
このAPIには次のようなクラス/関数が含まれています。
クラス/関数名 | 説明 |
Prefs | ガジェットの設定値を保存するクラス |
Tab | タブインターフェイスを実現するためのクラス |
flash | Flashコンポーネントを表示するためのクラス |
io.makeRequest | コンテナを経由してインターネット上のWebサービス、リソースにアクセスするための関数 |
json.* | オブジェクトとJSONを相互変換するための関数群 |
MiniMessage | ガジェット内でユーザーへのメッセージを表示するためのクラス |
views.* | ガジェットのビュー(第3回で解説予定)を切り替えるための関数群 |
window.* | ガジェットの高さやタイトルなどを設定するための関数群 |
このAPI自体はSNSに依存するものではなく、提供される機能もアプリケーションのUIを中心とした基本的なものとなっています。特に活用する機会が多いのは設定値を扱うPrefs
クラスと、インターネット上のリソースにアクセスするためのio.makeRequest
関数でしょう。
Gadgets APIはモジュール化されており、いくつかのクラスを使う際には後述のガジェットXMLで使用するモジュールを指定する必要があります。
2. OpenSocial API
OpenSocial APIは、ソーシャル情報の取得やアクティビティの作成など、SNSに依存する機能を提供するAPIです。
このAPIには次のようなクラス/関数が含まれています。
クラス/関数名 | 説明 |
Activity | アクティビティを表すクラス |
DataRequest | ソーシャル情報を取得したり、データを読み書きするための、非常に重要なクラス |
Person | 人を表すクラス。プロフィール情報などを含む |
Message | メッセージを表すクラス |
opensocial.* | OpenSocial APIの処理の基点となる関数群。Activity クラス、DataRequest クラス、Message クラスなどを作成する機能を持つ |
表でも示しているように、DataRequest
クラスと、そこに含まれるメソッドは非常に重要であり、ソーシャル情報へのアクセスを必要とする場合には、すべてこのDataRequest
クラスを使ってリクエストを行う必要があります。