最速!Google Wave API解説

第2回 ロボットAPI

この記事を読むのに必要な時間:およそ 4.5 分

先日横浜みなとみらいのパシフィコ横浜においてGoogle Developer Day 2009(GDD)が開催されました。会場に足を運び,実際にGoogle Waveが動作する様子を目にした方も多いのではないでしょうか。

嬉しいことにその基調講演の中でGDD参加者には数週間以内にGoogle Waveのアカウントが発行されるという発表がありました。GDDに参加してもうしばらくすればアカウントが手に入るという予定の方は,ぜひこの連載で予習して数週間後に備えていただければ幸いです。

また,残念ながらGDDに参加できずGoogle Waveアカウントの発行が遅れそうな方も,この連載でWave API利用の雰囲気だけでも感じて頂ければと思います。

ロボットとは

Google Waveでいう「ロボット」とは,Wave内で参加者と同じように振る舞えるWebサーバー上で動くプログラムのことです。

ロボットがどういうものか理解するには、実際にロボットを使ってみるのが早いでしょう。ロボットをWaveに追加するには,参加者をWaveに追加するときと同じようにWave ヘッダの「+Add」ボタンを押下したあとWave IDを指定します。

図1 ロボットのWave IDを入力

図1 ロボットのWave ID(nikkeisoftware@appspot.com)を入力

図2 ロボットが追加された

図2 ロボットが追加された

ここではGoogle API Expertの松尾さんが作ったKayという赤ん坊ロボットを試してみることにします。アイコンからもプロフィールからも通常の参加者と全く区別がつきませんが(実際のところ作成者がそれと分かるように作らない限り,現時点ではロボットと参加者を区別する方法はありません),実は彼はロボットで私の発言を単純におうむ返ししようとします。それではなにか話しかけてみましょう。

図3 Kay

図3 Kay

残念ながらKayは赤ん坊なので,まだうまく私の発言を真似できないようですね(実を言えばKayは発言を少しランダマイズして返すロボットです)。このようにWave上で発生したイベントを受け取って,返事を返す,文章を書き変える,参加者を追加する,など様々な処理をサーバー側からWaveに対して施すものがWaveロボットです。

ロボットが処理するイベント

ロボットはWave上でイベントが発生したときに,そのイベント内容を伴うPOSTリクエストで呼び出されます。ロボットの処理するイベントについて説明する前に,まずはその発生元となるGoogle Waveのデータモデルについて説明しましょう。

Waveグローバルで一意なIDを持つエンティティ。複数のWaveletからなる。Playback機構はこの内部で動作する
WaveletWaveに含まれ,Wave内で一意なIDを持つエンティティ。参加者の一覧と複数のドキュメントからなる。同時編集の制御はこのエンティティ内で行われる
DocumentWaveletに含まれ、Wavelet内で一意なIDを持つエンティティ。一つのXMLドキュメントと,それとは独立したアノテーションの組からなる。アノテーションはXMLドキュメント内の特定の場所を指し,テキストフォーマット,スペルサジェスト,ハイパーリンクなどを表す。またドキュメントはWavelet内でツリー構造になっている
Blipドキュメントの一種でリッチテキスト形式のもの

上記のエンティティのうちイベントを発生するのはWaveを除く3つです。

そこから発生するイベントの一覧は,現在のところ以下のようになっています。ただし,イベントは今後もまだまだ変更される可能性が高いのでご注意ください(実際,Google I/O翌日に行われたHackathonの時とはすでに少し変わっています)。

wavelet_blip_created
wavelet内でblipが新しく作成された場合に発生するイベント
wavelet_participants_changed
参加者(ロボットも含む)がwaveletに追加またはwaveから削除された場合に発生するイベント
wavelet_title_changed
waveletのタイトルが変更された場合に発生するイベント
blip_contributors_changed
blipの編集者が変更された場合に発生するイベント
blip_deleted
blipがwaveletから削除された場合に発生するイベント
blip_submitted
blipが確定された場合に発生するイベント。このイベントはユーザーがDoneボタンをクリックするか,他のblipにフォーカスを移動したときに一度だけ発生します
document_changed
blipにコンテンツが追加された場合にさまざまな間隔で発生するイベント

もちろんロボットがこれらのイベント全てに反応するわけではありません。ロボットが反応するイベントはロボットと同じサーバー上に置かれたXMLファイル(capabilities.xml)で指定されていて,例えばKayの場合は以下のようになっています。

リスト1 capabilities.xml

<?xml version="1.0"?>
<w:robot xmlns:w="http://wave.google.com/extensions/robots/1.0">
<w:version>1.0</w:version>
<w:capabilities>
  <w:capability name="BLIP_SUBMITTED"/>
  <w:capability name="WAVELET_SELF_ADDED"/>
</w:capabilities>
<w:profile name="Kay" imageurl="http://nikkeisoftware.appspot.com/icon.png" 
  profileurl="http://nikkeisoftware.appspot.com/_wave/robot/profile"/>
</w:robot>

二つの<capability>タグで指定されているイベント,BLIP_SUBMITTEDとWAVELET_SELF_ADDEDがKayの受け取るするイベントです。

一点注意事項ですが,ロボットは自分自身が原因となったイベントは受け取りません。もしこの制約がなければKayが赤ちゃん言葉で真似した発言をWave に追加したときにもBLIP_SUBMITTEDは発生しますので,自分の発言を再び真似することになり無限ループに陥ってしまいます。

著者プロフィール

あんどうやすし

シーサー株式会社 プログラマ。Google App Engine API Expert。

Google I/O翌日にGoogleオフィスで開かれたWave Hackathonに潜り込んできました。そこで得られた知識を,記憶が温かいうちにみなさんと共有できればと思います。

URLhttp://d.hatena.ne.jp/technohippy/

Wave ID:technohippy@wavesandbox.com

コメント

コメントの記入