SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

mixiアプリで始めるOpenSocial入門

mixiアプリで始めるOpenSocial入門(1)
――OpenSocialの概要とmixiアプリ

OpenSocial 基本のキ(1)

  • X ポスト
  • このエントリーをはてなブックマークに追加

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には次のようなクラス/関数が含まれています。

gadgets.*名前空間に含まれる主なクラス・関数
クラス/関数名 説明
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には次のようなクラス/関数が含まれています。

opensocial.*名前空間に含まれる主なクラス・関数
クラス/関数名 説明
Activity アクティビティを表すクラス
DataRequest ソーシャル情報を取得したり、データを読み書きするための、非常に重要なクラス
Person 人を表すクラス。プロフィール情報などを含む
Message メッセージを表すクラス
opensocial.* OpenSocial APIの処理の基点となる関数群。Activityクラス、DataRequestクラス、Messageクラスなどを作成する機能を持つ

 表でも示しているように、DataRequestクラスと、そこに含まれるメソッドは非常に重要であり、ソーシャル情報へのアクセスを必要とする場合には、すべてこのDataRequestクラスを使ってリクエストを行う必要があります。

次のページ
OpenSocialアプリケーションの仕組み

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
mixiアプリで始めるOpenSocial入門連載記事一覧

もっと読む

この記事の著者

山田 祥寛(ヤマダ ヨシヒロ)

静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるReact実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

WINGSプロジェクト 土井 毅(ドイ ツヨシ)

WINGSプロジェクトについて>有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂きたい。著書記事多数。 RSS X: @WingsPro_info(公式)、@WingsPro_info/wings(メンバーリスト) Facebook

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/4345 2009/09/23 14:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング