お気に入り | 日本語 | ログイン

OpenSocial API ドキュメント

OpenSocial API は、複数のウェブサイトでソーシャル アプリケーションを作成する一連の共通 API です。OpenSocial API へアクセスする方法には、クライアント側で JavaScript API を使用する方法と、サーバー側で RESTful Data API を使用する方法の 2 種類があります。

JavaScript API

JavaScript API は opensocial.* 名前空間 にあり、次の 3 つの主要な機能領域にアクセスします。

  • People - 個人や個人同士の関係についての情報
  • Activities - 個人の行動を投稿したり、最新情報を参照したりする機能
  • Persistence - サーバー不要のステートフルなアプリケーションを実現する、キーと値によるシンプルなデータ ストア

JavaScript API を使用すると、以下のような作業が可能になります。

  • サーバーの保守が不要なアプリケーションを作成
  • サーバー側のコンポーネント (オフライン処理や他のウェブサイトからのアクセス用) が組み込まれたアプリケーションを作成
  • 全く新しいアプリケーションを作成
  • 既存のウェブ アプリケーションを、既存のソーシャル ウェブサイトのコンテキストで公開
  • 既存のガジェットにソーシャル機能を追加
  • 複数の異なるソーシャル ウェブサイトのコンテキストで動作するアプリケーションを作成

JavaScript API は、標準的なウェブ テクノロジーを使用するように設計されています。

  • opensocial.* 名前空間に一連のメソッドとしてパッケージ化されています。
  • 標準的な JavaScript のプログラミング技術とサードパーティ製のライブラリを使用できます。
  • AJAX の豊富なインタラクティブ性をサポートする、完全な非同期コールバック システムが組み込まれています。

OpenSocial JavaScript API を使用してアプリケーションを作成するには、スタート ガイドをご覧になるか、OpenSocial チュートリアル で作成方法を学んでください。

RESTful Data API

RESTful Data API は JavaScript API を補完して、People、Activities、サーバーにあるデータにアクセスできる機能を提供します。

RESTful Data API も、標準のウェブ テクノロジーを使用するように設計されています。

  • サーバー間の通信は、RESTful AtomPub プロトコルに基づきます。
  • 認証は OAuth で処理されます。