Google OpenSocial API Documentationを日本語に訳してみた。
ちょっとした調査を兼ねて、Googleの「OpenSocial API Documentation」を訳してみました。
== 和訳 ==
OpenSocial API Documentation
OpenSocial APIは、多くのWebサイトでSocial Applicationを構築する為の共通APIセットである。OpenSocial APIを利用するには2通りの手段が存在する。1つはクライアントサイドでJavaScript APIを利用する方法、もう1つはサーバサイドでRESTfulなAPIを利用する方法である。
JavaScript API
JavaScript APIは「opensocial.*」ネームスペースの元に配置されており、OpenSocial APIの3つの基本的な機能にアクセスする手段を提供する。
- People — 特定のユーザと、そのユーザの友達関係の情報
- Activities — ユーザの行動を確認／追加／更新する
- Persistence — シンプルなkey-valueデータを保存する（その結果、開発者はサーバフリーなステートフルアプリケーションを開発することができる）
JavaScript APIで可能なことは以下の通りである。
- 自身のサーバを持たずにアプリケーションを構築できる。
- オフラインでの動作や他のサイトからのアクセスなどを受け持つサーバサイドコンポーネントを含んだアプリケーションを開発できる。
- 全く新しいアプリケーションを作成できる。
- 既存のWebアプリケーションを既存のソーシャルサイトの内部に貼付けられる。
- 既存のGoogle Gadgetsにソーシャルな機能を持たせることができる。
- 1度構築したアプリケーションは、他の多くのソーシャルサイト上でも動作可能である。
JavaScript APIは、以下の点でWebの標準技術として用いられるように設計されている。
- 「opensocial.*」ネームスペース内に、method郡がパッケージングされている。
- どのようなJavaScript、どのようなサードパーティー製のライブラリでも利用できる。
- リッチなAJAXインタラクションをサポートするため、非同期呼び出しを実現している。
OpenSocial Data APIs
「People and Friends data API」を用いることで、クライアントアプリケーション上でユーザのプロフィールの閲覧／更新が可能である。またこのAPIは友達関係の閲覧／更新も可能にする。これらはGoogle data schemeにて定義されたAtomPub GData APIsを用いて実現されている。クライアントアプリケーションからこのAPIを経由することで、ユーザの友達リストを取得したり、現在のプロフィール内容を問い合わせることが可能になる。
「People and Friends data API」が提供する機能は以下の通りである。
- OpenSocial対応サービス上のユーザプロフィールを、構造化された形で取得することができる。
- OpenSocial対応サービス上のユーザの友達リストを取得できる。
- OpenSocial対応サービス上の友達関係を追いかけて、彼らの詳細なプロフィールを取得することができる。
「Activity data API」を用いると、OpenSocialプラットフォーム上でAtomPub GData APIsを用いて「アクション」を閲覧／新規作成／編集することができる。つまり、クライアントアプリケーションから新規エントリーを作成したり、エントリー編集／削除、エントリー一覧の閲覧が可能になる。
「Activity data API」を利用すると以下のようなことが可能となる。
- ユーザ行動に関する情報の公開（あるユーザがあなたのサイトにいつ動画ファイルをアップロードしたかなど）
- ユーザの友達が今何をしているか閲覧できるデスクトップアプリケーションやプラグインの開発
「Persistence data API」を用いると、クライアントアプリケーションからkey/valueコンテンツ（特定の「属性値」のこと？）を閲覧／更新することができる。これにより既存のアプリケーションやガジェットのコンテンツを編集／削除したり、既存のフィードコンテンツを取得したりすることができる。
「Persistence data API」を利用すると以下のようなことが可能となる。
- データを、開発者自身のアプリケーションガジェットやGoogleが提供するガジェットに、オープンに利用可能にする。
- 開発者のサービスから、開発者の提供するガジェットを通じて、利用者ごとに個別に独自コンテンツを配信する。
- その後の解析の為、ユーザが記述したデータをガジェットに読み込ませる。
一応原文も以下に引用しておく。
== 原文（「OpenSocial API Documentation」より引用） ==
OpenSocial API Documentation
The OpenSocial API is a set of common APIs for building social applications on many websites. There are two ways to access the OpenSocial API: client-side using the JavaScript API and server-side using RESTful data APIs.
JavaScript API
The JavaScript API lives under the opensocial.* namespace and provides access to three primary areas of functionality:
- People — information about individual people and their relationships to each other
- Activities — ability to post and view updates on what people are doing
- Persistence — a simple key-value data store to allow server-free stateful applications
Here are some of the things you can do with the JavaScript API:
- Build applications without maintaining your own server
- Build applications that include a server-side component (for offline processing and/or access from other websites)
- Create brand-new applications
- Expose existing web applications in the context of existing social websites
- Add social features to existing Google Gadgets
- Write one application that can run in the context of many different social websites
The JavaScript API is designed to use standard web technologies:
- It’s packaged as a set of methods in the opensocial.* namespace.
- It allows you to use any standard JavaScript programming techniques and third-party libraries.
- It includes a full asynchronous callback system to support rich AJAX interactivity.
OpenSocial Data APIs
The People and Friends data API allows client applications to view and update People Profiles and Friend relationships using AtomPub GData APIs with a Google data schema. Your client application can request a list of a user’s Friends and query the content in an existing Profile.
Here are some of the things you can do with the People and Friends data API:
- Get a structured version of a user’s profile in an OpenSocial service.
- Get a list of a user’s friends in an OpenSocial service.
- Follow friend connections to get detailed profiles in an OpenSocial service.
The Activities data API allows client applications to view and publish “actions” in the OpenSocial platform using AtomPub GData APIs with a Google data schema. Your client application can use the API to create new entries, edit or delete existing entries, and view lists of entries.
Here are some of the things you can do with the Activities data API:
- Publish information about user actions, such as indicating when a user uploads a video file to your site.
- Create a desktop application or plugin that allows users to see what their friends are doing in realtime.
The Persistence data API allows client applications to view and update key/value content using AtomPub GData APIs with a Google data schema. Your client application can edit or delete content for an existing application, user, or gadget instance, and query the content in an existing feed.
Here are some of the things you can do with the OpenSocial Persistence data API:
- Make data globally available to all of your application’s gadgets and have it served by Google.
- Push custom content specific to your gadget’s users from your own servers.
- Read data written by users to gadget data for later analysis.
OpenSocial API Developer’s Guideの翻訳については「[Press 0025] OpenSocial API Developer’s Guideを日本語に訳してみた。」をご覧下さい。
この記事がお役に立ちましたら、一言コメントもらえると嬉しいですm_ _m