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

RESTful Data API の概要

OpenSocial モデルには、サーバー間通信の開発に活用できる一連の RESTful data API も含まれています。この API を使用すると、デスクトップ、モバイル デバイスなど、JavaScript がサポートされていないチャンネルでソーシャル アプリケーションを実行できます。OpenSocial には、以下の 3 種類の RESTful data API が用意されています。

People and Friends data API は、クライアント アプリケーションで、ユーザーのプロファイルや関係を表示したり更新したりできるようにする API です。クライアント アプリケーションでユーザーの友だちリストを要求したり、既存のプロファイルのコンテンツを照会したりできます。

People and Friends data API を使用すると、以下のような作業を行えます。

  • OpenSocial サービスから構造化されたユーザー プロファイルを取得します。
  • OpenSocial サービスからユーザーの友だちリストを取得します。
  • OpenSocial サービスから友人関係をたどり、詳細なプロフィールを取得します。

Activities data API は、クライアント アプリケーションで OpenSocial プラットフォーム内の「アクション」を表示したり公開したりできるようにする API です。クライアント アプリケーションでは、この API を使用して、新しいエントリの作成、既存のエントリの編集や削除、エントリの一覧の表示を行うことができます。

Activities data API を使用すると、以下のような作業を行えます。

  • あるユーザーがあなたのサイトにいつ動画ファイルをアップロードしたかを示す情報など、ユーザーのアクションに関する情報を公開します。
  • 友だちの行動をユーザーがリアルタイムで把握できる、デスクトップ アプリケーションやプラグインを作成します。

Persistence data API は、クライアント アプリケーションで、そのアプリケーションのキー/値コンテンツを表示したり更新したりできるようにする API です。既存のアプリケーション、ユーザー、ガジェットのインスタンスについてコンテンツの編集や削除を行ったり、既存のフィード内でコンテンツを検索したりできます。

OpenSocial Persistence data API を使用すると、以下のような作業を行えます。

  • 使用するすべてのアプリケーションのガジェットで、データをグローバルに利用できるようにして、Google でそのデータを提供できるようにします。
  • ガジェットのユーザー専用のカスタム コンテンツを、サーバーから配信します。
  • ユーザーによってガジェット データに書き込まれたデータを読み取って、今後の分析に役立てます。

注: これらの API は、OpenSocial コミュニティーでの設計と議論が続いています。現在提案されている API の 1 つは AtomPub をベースにしたものです。ドキュメントの初期改訂版については、People data API リファレンス ガイドおよび Persistence data API リファレンス ガイド をご覧ください。