2008 年 4 月
- はじめに
- Ruby の取得とインストール
- 認証 | スプレッドシート API の使用
- ワークシートの取得
- listFeed にコンテンツを投稿する
- cellsFeed を使用してコンテンツを更新する
- まとめ
はじめに
Ruby は動的スクリプト言語で、近年では人気の高い Rails ウェブ開発フレームワークのおかげで注目を集めています。この記事では、Ruby を使用して Google Data API サービスを操作する方法について説明します。Rails には焦点を当てず、基盤となる HTTP コマンドとフィードの構造について説明します。ここで紹介する例はすべて、Ruby のインタラクティブ シェルである irb を使用してコマンドラインから実行できます。
cURL の記事で説明したように、Google Data API は Atom Publishing Protocol を使用してウェブ リソースの表現、作成、更新を行います。このプロトコルの利点は、標準の HTTP 動詞を使用してリクエストを定式化し、標準の HTTP ステータス コードで応答することです。
この記事で使用する動詞は、コンテンツを取得する GET、新しいコンテンツをアップロードする POST、既存のコンテンツを更新する PUT です。Google Data API の使用時に発生する可能性のある標準コードには、フィードまたはエントリの取得の成功を表す 200 や、リソースの作成または更新の成功を表す 201 などがあります。リクエストの形式が正しくない場合など、エラーが発生した場合は、400 コード（「Bad Request」を意味します）が返されます。レスポンス本文に、何が問題だったのかを説明する詳細なメッセージが返されます。
Ruby には、Net モジュールの一部として優れたデバッグ オプションが用意されています。ただし、これらのコードサンプルを適度に短くするために、ここでは有効にしていません。
Ruby の取得とインストール
Linux を使用している場合は、ほとんどのパッケージ管理システムを使用して Ruby をインストールできます。その他のオペレーティング システムや完全なソースコードについては、http://www.ruby-lang.org/en/downloads/ をご覧ください。これらの例で使用するインタラクティブ シェルである Irb は、デフォルトでインストールされているはずです。ここに記載されているコード例を実行するには、XML を Ruby データ構造に解析するための小さなライブラリである XmlSimple もインストールする必要があります。XmlSimple を取得/インストールするには、http://xml-simple.rubyforge.org/ にアクセスしてください。
マシンで Ruby のコピーを実行したら、Net:HTTP パッケージを使用して Google のデータサービスに基本的なリクエストを行うことができます。次のスニペットは、Ruby のインタラクティブ シェルから必要なインポートを行う方法を示しています。ここでは、'net/http' パッケージを必要とし、YouTube の高評価動画フィードの URL を解析してから、HTTP GET リクエストを実行しています。
irb(main):001:0> require 'net/http' => true irb(main):002:0> youtube_top_rated_videos_feed_uri = \ 'http://gdata.youtube.com/feeds/api/standardfeeds/top_rated' => "http://gdata.youtube.com/feeds/api/standardfeeds/top_rated" irb(main):003:0> uri = \ URI.parse(youtube_top_rated_videos_feed_uri) => #<URI::HTTP:0xfbf826e4 URL:http://gdata.youtube.com/feeds/api/standardfeeds/top_rated> irb(main):004:0> uri.host => "gdata.youtube.com" irb(main):005:0> Net::HTTP.start(uri.host, uri.port) do |http| irb(main):006:1* puts http.get(uri.path) irb(main):007:1> end #<Net::HTTPOK:0xf7ef22cc>
このリクエストは、コマンドラインに大量の XML をエコーバックします。すべてのアイテムが <feed> 要素内に含まれ、<entry> 要素として参照されていることに気づかれたかもしれません。XML 形式については後で説明します。ここでは、HTTP を使用して基本的な Google Data API リクエストを行う方法について説明します。送信および取得できる情報がより「コマンドライン フレンドリー」であるため、ここで API を切り替えてスプレッドシートに焦点を当てます。
認証 | Google スプレッドシート API の使用
まず、エントリ要素のフィードを取得します。今回は、独自のスプレッドシートを使用します。そのためには、まず Google アカウント サービスで認証を行う必要があります。
GData 認証に関するドキュメントで説明したように、Google のサービスで認証を行う方法は 2 つあります。AuthSub はウェブベースのアプリケーション用で、簡単に言うとトークン交換プロセスです。AuthSub の最大のメリットは、アプリケーションでユーザー認証情報を保存する必要がないことです。ClientLogin は「インストール済み」のアプリケーション用です。ClientLogin プロセスでは、使用するサービスを識別する文字列とともに、ユーザー名とパスワードが https 経由で Google のサービスに送信されます。Google スプレッドシート API サービスは、文字列 wise で識別されます。
インタラクティブ シェルに戻り、Google で認証しましょう。認証リクエストと認証情報の送信に https を使用していることに注意してください。
irb(main):008:0> require 'net/https'
=> true
irb(main):009:0> http = Net::HTTP.new('www.google.com', 443)
=> #<Net::HTTP www.google.com:443 open=false>
irb(main):010:0> http.use_ssl = true
=> true
irb(main):011:0> path = '/accounts/ClientLogin'
=> "/accounts/ClientLogin"
# Now we are passing in our actual authentication data.
# Please visit OAuth For Installed Apps for more information
# about the accountType parameter
irb(main):014:0> data = \
irb(main):015:0* 'accountType=HOSTED_OR_GOOGLE&Email=your email' \
irb(main):016:0* '&Passwd=your password' \
irb(main):017:0* '&service=wise'
=> accountType=HOSTED_OR_GOOGLE&Email=your email&Passwd=your password&service=wise"
# Set up a hash for the headers
irb(main):018:0> headers = \
irb(main):019:0* { 'Content-Type' => 'application/x-www-form-urlencoded'}
=> {"Content-Type"=>"application/x-www-form-urlencoded"}
# Post the request and print out the response to retrieve our authentication token
irb(main):020:0> resp, data = http.post(path, data, headers)
warning: peer certificate won't be verified in this SSL session
=> [#<Net::HTTPOK 200 OK readbody=true>, "SID=DQAAAIIAAADgV7j4F-QVQjnxdDRjpslHKC3M ... [ snipping out the rest of the authentication strings ]
# Strip out our actual token (Auth) and store it
irb(main):021:0> cl_string = data[/Auth=(.*)/, 1]
=> "DQAAAIUAAADzL... [ snip ]
# Build our headers hash and add the authorization token
irb(main):022:0> headers["Authorization"] = "GoogleLogin auth=#{cl_string}"
=> "GoogleLogin auth=DQAAAIUAAADzL... [ snip ]
承知しました。認証が完了したので、次のリクエストを使用して自分のスプレッドシートを取得してみましょう。
http://spreadsheets.google.com/feeds/spreadsheets/private/full
これは認証されたリクエストなので、ヘッダーも渡します。実際には、さまざまなフィードに対して複数のリクエストを行うため、この機能を get_feed というシンプルな関数にラップすることをおすすめします。
# Store the URI to the feed since we may want to use it again
irb(main):023:0> spreadsheets_uri = \
irb(main):024:0* 'http://spreadsheets.google.com/feeds/spreadsheets/private/full'
# Create a simple method to obtain a feed
irb(main):025:0> def get_feed(uri, headers=nil)
irb(main):026:1> uri = URI.parse(uri)
irb(main):027:1> Net::HTTP.start(uri.host, uri.port) do |http|
irb(main):028:2* return http.get(uri.path, headers)
irb(main):029:2> end
irb(main):030:1> end
=> nil
# Lets make a request and store the response in 'my_spreadsheets'
irb(main):031:0> my_spreadsheets = get_feed(spreadsheets_uri, headers)
=> #<Net::HTTPOK 200 OK readbody=true>
irb(main):032:0> my_spreadsheets
=> #<Net::HTTPOK 200 OK readbody=true>
# Examine our XML (showing only an excerpt here...)
irb(main):033:0> my_spreadsheets.body
=> "<?xml version='1.0' encoding='UTF-8'?><feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/'>
<id>http://spreadsheets.google.com/feeds/spreadsheets/private/full</id><updated>2008-03-20T20:49:39.211Z</updated>
<category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#spreadsheet'/>
<title type='text'>Available Spreadsheets - test.api.jhartmann@gmail.com</title><link rel='alternate' type='text/html' href='http://docs.google.com'/>
<link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/spreadsheets/private/full'/><link rel='self' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/spreadsheets/private/full?tfe='/>
<openSearch:totalResults>6</openSearch:totalResults><openSearch:startIndex>1</openSearch:startIndex><entry>
<id>http://spreadsheets.google.com/feeds/spreadsheets/private/full/o04927555739056712307.4365563854844943790</id><updated>2008-03-19T20:44:41.055Z</updated><category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#spreadsheet'/><title type='text'>test02</title><content type='text'>test02</content><link rel='http://schemas.google.com/spreadsheets/2006#worksheetsfeed' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/worksheets/o04927555739056712307.4365563854844943790/private/full'/><link rel='alternate' type='text/html' href='http://spreadsheets.google.com/ccc?key=o04927555739056712307.4365563854844943790'/><link rel='self' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/spreadsheets/private/full/o04927555739056712307.4365563854844943790'/><author><name>test.api.jhartmann</name><email>test.api.jhartmann@gmail.com</email></author></entry><entry> ...
ここでも XML がたくさん表示されていますが、コマンドラインから解読する必要はないため、上記では強調していません。ユーザーフレンドリーにするため、代わりに XmlSimple を使用してデータ構造に解析しましょう。
# Perform imports
irb(main):034:0> require 'rubygems'
=> true
irb(main):035:0> require 'xmlsimple'
=> true
irb(main):036:0> doc = \
irb(main):037:0* XmlSimple.xml_in(my_spreadsheets.body, 'KeyAttr' => 'name')
# Import the 'pp' module for 'pretty printing'
irb(main):038:0> require 'pp'
=> true
# 'Pretty-print' our XML document
irb(main):039:0> pp doc
{"totalResults"=>["6"],
"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#spreadsheet",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"title"=>
[{"type"=>"text",
"content"=>"Available Spreadsheets - Test-account"}],
"startIndex"=>["1"],
"id"=>["http://spreadsheets.google.com/feeds/spreadsheets/private/full"],
"entry"=>
[{"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#spreadsheet",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"title"=>[{"type"=>"text", "content"=>"blank"}],
"author"=>
[{"name"=>["Test-account"],
"email"=>["my email"]}],
"id"=>
["http://spreadsheets.google.com/feeds/spreadsheets/private/full/o04927555739056712307.3387874275736238738"],
"content"=>{"type"=>"text", "content"=>"blank"},
"link"=>
[ snipping out the rest of the XML ]
ワークシートの取得
上記の出力からわかるように、このフィードには 6 個のスプレッドシートが含まれています。この記事を短くするために、上記の XML 出力の残りの部分（および他のほとんどのリスト）を切り捨てました。このスプレッドシートを詳しく調べるには、次の手順を行う必要があります。
- スプレッドシート キーを取得する
- スプレッドシート キーを使用してワークシート フィードを取得する
- 使用するワークシートの ID を取得する
- cellsFeed または listFeed のいずれかをリクエストして、ワークシートの実際のコンテンツにアクセスします。
大変そうに聞こえるかもしれませんが、簡単なメソッドをいくつか記述すれば、すべて簡単に実行できることを説明します。cellsFeed と listFeed は、ワークシートの実際のセル コンテンツを表す 2 つの異なる表現です。listFeed は情報の行全体を表し、新しいデータを POST する場合に推奨されます。cellFeed は個々のセルを表し、個々のセルの更新または多くの個々のセルへのバッチ更新（どちらも PUT を使用）に使用されます。詳細については、Google スプレッドシート API のドキュメントをご覧ください。
まず、スプレッドシート キー（上記の XML 出力でハイライト表示）を抽出して、ワークシート フィードを取得する必要があります。
# Extract the spreadsheet key from our datastructure
irb(main):040:0> spreadsheet_key = \
irb(main):041:0* doc["entry"][0]["id"][0][/full\/(.*)/, 1]
=> "o04927555739056712307.3387874275736238738"
# Using our get_feed method, let's obtain the worksheet feed
irb(main):042:0> worksheet_feed_uri = \
irb(main):043:0* "http://spreadsheets.google.com/feeds/worksheets/#{spreadsheet_key}/private/full"
=> "http://spreadsheets.google.com/feeds/worksheets/o04927555739056712307.3387874275736238738/private/full"
irb(main):044:0> worksheet_response = get_feed(worksheet_feed_uri, headers)
=> #<Net::HTTPOK 200 OK readbody=true>
# Parse the XML into a datastructure
irb(main):045:0> worksheet_data = \
irb(main):046:0* XmlSimple.xml_in(worksheet_response.body, 'KeyAttr' => 'name')
=> {"totalResults"=>["1"], "category"=>[{"term ... [ snip ]
# And pretty-print it
irb(main):047:0> pp worksheet_data
{"totalResults"=>["1"],
"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#worksheet",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"title"=>[{"type"=>"text", "content"=>"blank"}],
"author"=>
[{"name"=>["test.api.jhartmann"],
"email"=>["test.api.jhartmann@gmail.com"]}],
"startIndex"=>["1"],
"id"=>
["http://spreadsheets.google.com/feeds/worksheets/o04927555739056712307.3387874275736238738/private/full"],
"entry"=>
[{"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#worksheet",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"title"=>[{"type"=>"text", "content"=>"Sheet 1"}],
"rowCount"=>["100"],
"colCount"=>["20"],
"id"=>
["http://spreadsheets.google.com/feeds/worksheets/o04927555739056712307.3387874275736238738/private/full/od6"],
"content"=>{"type"=>"text", "content"=>"Sheet 1"},
"link"=>
[{"href"=>
"http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full",
"rel"=>"http://schemas.google.com/spreadsheets/2006#listfeed",
"type"=>"application/atom+xml"},
{"href"=>
"http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full",
"rel"=>"http://schemas.google.com/spreadsheets/2006#cellsfeed",
"type"=>"application/atom+xml"},
[ snip: cutting off the rest of the XML ]
ご覧のとおり、listFeed と cellsFeed にアクセスするためのリンク（highlighted above）が見つかりました。listFeed の詳細に入る前に、サンプル スプレッドシートに現在存在するデータを簡単に説明します。これにより、検索対象を把握できます。
スプレッドシートは非常にシンプルで、次のようになっています。
| language | ウェブサイト |
|---|---|
| Java | http://java.com |
| php | http://php.net |
このデータは listFeed では次のように表示されます。
irb(main):048:0> listfeed_uri = \
irb(main):049:0* worksheet_data["entry"][0]["link"][0]["href"]
=> "http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full"
irb(main):050:0> response = get_feed(listfeed_uri, headers)
=> #<Net::HTTPOK 200 OK readbody=true>
irb(main):051:0> listfeed_doc = \
irb(main):052:0* XmlSimple.xml_in(response.body, 'KeyAttr' => 'name')
=> {"totalResults"=>["2"], "category"=>[{"term" ... [ snip ]
# Again we parse the XML and then pretty print it
irb(main):053:0> pp listfeed_doc
{"totalResults"=>["2"],
"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#list",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"title"=>[{"type"=>"text", "content"=>"Programming language links"}],
"author"=>
[{"name"=>["test.api.jhartmann"],
"email"=>["test.api.jhartmann@gmail.com"]}],
"startIndex"=>["1"],
"id"=>
["http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full"],
"entry"=>
[{"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#list",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"language"=>["java"],
"title"=>[{"type"=>"text", "content"=>"ruby"}],
"website"=>["http://java.com"],
"id"=>
["http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cn6ca"],
"content"=>
{"type"=>"text", "content"=>"website: http://java.com"},
"link"=>
[{"href"=>
"http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cn6ca",
"rel"=>"self",
"type"=>"application/atom+xml"},
{"href"=>
"http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cn6ca/1j81anl6096",
"rel"=>"edit",
"type"=>"application/atom+xml"}],
"updated"=>["2008-03-20T22:19:51.739Z"]},
{"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#list",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"language"=>["php"],
"title"=>[{"type"=>"text", "content"=>"php"}],
"website"=>["http://php.net"],
"id"=>
["http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cokwr"],
"content"=>{"type"=>"text", "content"=>"website: http://php.net"},
[ snip ]
ご覧のとおり、listFeed は各行のエントリを作成して、ワークシートのコンテンツを返します。スプレッドシートの最初の行にセルヘッダーが含まれていることを前提として、その行のデータに基づいて XML ヘッダーを動的に生成します。実際の XML を見ると、さらに理解が深まります。
<?xml version='1.0' encoding='UTF-8'?><feed [ snip namespaces ]> <id>http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full</id> <updated>2008-03-20T22:19:51.739Z</updated> <category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#list'/> <title type='text'>Programming language links</title> [ snip: cutting out links and author information ] <entry> <id>http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cn6ca</id> [ snip: updated and category ] <title type='text'>java</title> <content type='text'>website: http://java.com</content> <link rel='self' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cn6ca'/> <link rel='edit' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cn6ca/1j81anl6096'/> <gsx:language>java</gsx:language> <gsx:website>http://java.com</gsx:website> </entry> <entry> <id>http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cokwr</id> [ snip: updated and category ] <title type='text'>php</title> <content type='text'>website: http://php.net</content> <link rel='self' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cokwr'/> <link rel='edit' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full/cokwr/41677fi0nc'/> <gsx:language>php</gsx:language> <gsx:website>http://php.net</gsx:website> </entry> </feed>
簡単に比較するために、同じ情報が cellsFeed でどのように表されるかを見てみましょう。
# Extract the cellfeed link
irb(main):054:0> cellfeed_uri = \
irb(main):055:0* worksheet_data["entry"][0]["link"][1]["href"]
=> "http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full"
irb(main):056:0> response = \
irb(main):057:0* get_feed(cellfeed_uri, headers)
=> #<Net::HTTPOK 200 OK readbody=true>
# Parse into datastructure and print
irb(main):058:0> cellfeed_doc = \
irb(main):059:0* XmlSimple.xml_in(response.body, 'KeyAttr' => 'name')
=> {"totalResults"=>["6"], [ snip ]
irb(main):060:0> pp cellfeed_doc
{"totalResults"=>["6"],
"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#cell",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"title"=>[{"type"=>"text", "content"=>"Programming language links"}],
"rowCount"=>["101"],
"colCount"=>["20"],
"author"=>
[{"name"=>["test.api.jhartmann"],
"email"=>["test.api.jhartmann@gmail.com"]}],
"startIndex"=>["1"],
"id"=>
["http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full"],
"entry"=>
[{"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#cell",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"cell"=>
[{"col"=>"1",
"row"=>"1",
"content"=>"language",
"inputValue"=>"language"}],
"title"=>[{"type"=>"text", "content"=>"A1"}],
"id"=>
["http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R1C1"],
"content"=>{"type"=>"text", "content"=>"language"},
"link"=>
[{"href"=>
"http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R1C1",
"rel"=>"self",
"type"=>"application/atom+xml"},
{"href"=>
"http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R1C1/8srvbs",
"rel"=>"edit",
"type"=>"application/atom+xml"}],
"updated"=>["2008-03-20T22:19:51.739Z"]},
[ snip ]
このように、セルごとに 1 つずつ、6 個のエントリが返されます。「language」という単語を含むセル A1 の値以外の出力はすべて切り捨てました。また、上記に表示されている [編集] リンクにも注目してください。このリンクの末尾にはバージョン文字列（8srvbs）が含まれています。バージョン文字列は、この記事の最後で行うセルデータの更新時に重要になります。これにより、アップデートが上書きされないようにします。セルデータを更新する PUT リクエストを行うときは、リクエストにセルの最新バージョン文字列を含める必要があります。更新のたびに新しいバージョン文字列が返されます。
listFeed へのコンテンツの投稿
コンテンツを投稿するために最初に必要なのは、listFeed の POST リンクです。このリンクは、リストフィードがリクエストされたときに返されます。rel 属性の値として URL http://schemas.google.com/g/2005#post が含まれます。このリンク要素を解析して、href 属性を抽出する必要があります。まず、投稿を簡単にするための小さなメソッドを作成します。
irb(main):061:0> def post(uri, data, headers) irb(main):062:1> uri = URI.parse(uri) irb(main):063:1> http = Net::HTTP.new(uri.host, uri.port) irb(main):064:1> return http.post(uri.path, data, headers) irb(main):065:1> end => nil # Set up our POST url irb(main):066:0> post_url = \ irb(main):067:0* "http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full" => "http://spreadsheets.google.com/feeds/list/o04927555739056712307.3387874275736238738/od6/private/full" # We must use 'application/atom+xml' as MIME type so let's change our headers # which were still set to 'application/x-www-form-urlencoded' when we sent our # ClientLogin information over https irb(main):068:0> headers["Content-Type"] = "application/atom+xml" => "application/atom+xml" # Setting up our data to post, using proper namespaces irb(main):069:0> new_row = \ irb(main):070:0* '<atom:entry xmlns:atom="http://www.w3.org/2005/Atom">' << irb(main):071:0* '<gsx:language xmlns:gsx="http://schemas.google.com/spreadsheets/2006/extended">' << irb(main):072:0* 'ruby</gsx:language>' << irb(main):073:0* '<gsx:website xmlns:gsx="http://schemas.google.com/spreadsheets/2006/extended">' << irb(main):074:0* 'http://ruby-lang.org</gsx:website>' << irb(main):075:0* '</atom:entry>' => "<atom:entry xmlns:atom=\"http://www.w3.org/2005/Atom\"><gsx:language ... [ snip ] # Performing the post irb(main):076:0> post_response = post(post_url, new_row, headers) => #<Net::HTTPCreated 201 Created readbody=true>
ステータス 201 は、投稿が成功したことを示します。
cellsFeed を使用してコンテンツを更新する
ドキュメントから、セルフィードは既存のコンテンツに対する PUT リクエストを優先することがわかります。しかし、上記の cellsFeed から取得した情報は、実際のスプレッドシートにすでに存在するデータのみでした。新しい情報を追加するにはどうすればよいでしょうか？データを入力する空のセルごとにリクエストを行う必要があります。次のスニペットは、Python プログラミング言語に関する情報を挿入する空のセル R5C1（5 行目、1 列目）を取得する方法を示しています。
元の変数 cellfeed_uri には、cellfeed 自体の URI のみが含まれていました。編集するセルを追加し、そのセルのバージョン文字列を取得して編集します。
# Set our query URI irb(main):077:0> cellfeed_query = cellfeed_uri + '/R5C1' => "http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R5C1" # Request the information to extract the edit link irb(main):078:0> cellfeed_data = get_feed(cellfeed_query, headers) => #<Net::HTTPOK 200 OK readbody=true> irb(main):079:0> cellfeed_data.body => "<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:gs='http://schemas.google.com/spreadsheets/2006' xmlns:batch='http://schemas.google.com/gdata/batch'>
<id>http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R5C1</id>
<updated>2008-03-24T21:55:36.462Z</updated>
<category scheme='http://schemas.google.com/spreadsheets/2006' term='http://schemas.google.com/spreadsheets/2006#cell'/>
<title type='text'>A5</title>
<content type='text'>
</content>
<link rel='self' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R5C1'/>
<link rel='edit' type='application/atom+xml' href='http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R5C1/47pc'/>
<gs:cell row='5' col='1' inputValue=''>
</gs:cell>
</entry>"
上記のコードリストで確認できるように、バージョン文字列は 47pc です。（右端までスクロールする必要がある場合があります）。簡単に処理できるように、対象のセルのバージョン文字列を取得する便利なメソッドを作成しましょう。
irb(main):080:0> def get_version_string(uri, headers=nil)
irb(main):081:1> response = get_feed(uri, headers)
irb(main):082:1> require 'rexml/document'
irb(main):083:1> xml = REXML::Document.new response.body
irb(main):084:1> edit_link = REXML::XPath.first(xml, '//[@rel="edit"]')
irb(main):085:1> edit_link_href = edit_link.attribute('href').to_s
irb(main):086:1> return edit_link_href.split(/\//)[10]
irb(main):087:1> end
=> nil
# A quick test
irb(main):088:0> puts get_version_string(cellfeed_query, headers)
47pc
=> nil
ついでに、PUT リクエストを実行するメソッドも作成しましょう。いや、バッチ更新全体を実行するメソッドを作成しましょう。この関数は、次の変数を含むハッシュの配列を受け取ります。
:batch_id- バッチ リクエストの各部分の一意の識別子。:cell_id- 更新するセルの ID。R#C# 形式で指定します。セル A1 は R1C1 と表されます。:data- 挿入するデータ。
irb(main):088:0> def batch_update(batch_data, cellfeed_uri, headers)
irb(main):089:1> batch_uri = cellfeed_uri + '/batch'
irb(main):090:1> batch_request = <<FEED
irb(main):091:1" <?xml version="1.0" encoding="utf-8"?> \
irb(main):092:1" <feed xmlns="http://www.w3.org/2005/Atom" \
irb(main):093:1" xmlns:batch="http://schemas.google.com/gdata/batch" \
irb(main):094:1" xmlns:gs="http://schemas.google.com/spreadsheets/2006" \
irb(main):095:1" xmlns:gd="http://schemas.google.com/g/2005">
irb(main):096:1" <id>#{cellfeed_uri}</id>
irb(main):097:1" FEED
irb(main):098:1> batch_data.each do |batch_request_data|
irb(main):099:2* version_string = get_version_string(cellfeed_uri + '/' + batch_request_data[:cell_id], headers)
irb(main):100:2> data = batch_request_data[:data]
irb(main):101:2> batch_id = batch_request_data[:batch_id]
irb(main):102:2> cell_id = batch_request_data[:cell_id]
irb(main):103:2> row = batch_request_data[:cell_id][1,1]
irb(main):104:2> column = batch_request_data[:cell_id][3,1]
irb(main):105:2> edit_link = cellfeed_uri + '/' + cell_id + '/' + version_string
irb(main):106:2> batch_request<< <<ENTRY
irb(main):107:2" <entry>
irb(main):108:2" <gs:cell col="#{column}" inputValue="#{data}" row="#{row}"/>
irb(main):109:2" <batch:id>#{batch_id}</batch:id>
irb(main):110:2" <batch:operation type="update" />
irb(main):111:2" <id>#{cellfeed_uri}/#{cell_id}</id>
irb(main):112:2" <link href="#{edit_link}" rel="edit" type="application/atom+xml" />
irb(main):113:2" </entry>
irb(main):114:2" ENTRY
irb(main):115:2> end
irb(main):116:1> batch_request << '</feed>'
irb(main):117:1> return post(batch_uri, batch_request, headers)
irb(main):118:1> end
=> nil
# Our sample batch data to insert information about the Python programming language into our worksheet
irb(main):119:0> batch_data = [ \
irb(main):120:0* {:batch_id => 'A', :cell_id => 'R5C1', :data => 'Python'}, \
irb(main):121:0* {:batch_id => 'B', :cell_id => 'R5C2', :data => 'http://python.org' } ]
=> [{:cell_id=>"R5C1", :data=>"Python", :batch_id=>"A"}=>{:cell_id=>"R5C2", :data=>"http://python.org", :batch_id=>"B"}]
# Perform the update
irb(main):122:0> response = batch_update(batch_data, cellfeed_uri, headers)
=> #<Net::HTTPOK 200 OK readbody=true>
# Parse the response.body XML and print it
irb(main):123:0> response_xml = XmlSimple.xml_in(response.body, 'KeyAttr' => 'name')
=> [ snip ]
irb(main):124:0> pp response_xml
{"title"=>[{"type"=>"text", "content"=>"Batch Feed"}],
"xmlns:atom"=>"http://www.w3.org/2005/Atom",
"id"=>
["http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full"],
"entry"=>
[{"status"=>[{"code"=>"200", "reason"=>"Success"}],
"category"=>
[{"term"=>"http://schemas.google.com/spreadsheets/2006#cell",
"scheme"=>"http://schemas.google.com/spreadsheets/2006"}],
"cell"=>
[{"col"=>"1", "row"=>"5", "content"=>"Python", "inputValue"=>"Python"}],
"title"=>[{"type"=>"text", "content"=>"A5"}],
"id"=>
["http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R5C1",
"A"],
"operation"=>[{"type"=>"update"}],
"content"=>{"type"=>"text", "content"=>"Python"},
"link"=>
[{"href"=>
"http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R5C1",
"rel"=>"self",
"type"=>"application/atom+xml"},
{"href"=>
"http://spreadsheets.google.com/feeds/cells/o04927555739056712307.3387874275736238738/od6/private/full/R5C1/49kwzg",
"rel"=>"edit",
"type"=>"application/atom+xml"}],
"updated"=>["2008-03-27T15:48:48.470Z"]},
[ snip ]
200 OK レスポンス コードを受け取ったため、バッチ リクエストは成功しています。レスポンス XML を解析すると、response_data 配列で設定した個々の :batch_id ごとに個別のメッセージが返されていることがわかります。バッチ処理の詳細については、GData のバッチ処理のドキュメントをご覧ください。
まとめ
ご覧のとおり、Ruby のインタラクティブ シェルを使用して Google Data API を操作するのは非常に簡単です。listFeed と cellsFeed の両方を使用して、スプレッドシートとワークシートにアクセスできました。また、POST リクエストを使用して新しいデータを挿入し、約 120 行のコードでバッチ更新を実行するメソッドを作成しました。ここから、これらのシンプルなメソッドの一部をクラスにラップして、再利用可能なフレームワークを構築するのは難しくありません。
お気に入りの Google Data API でこれらのツールを使用する方法についてご不明な点がございましたら、ディスカッション グループにご参加ください。
上記のコードサンプルを含むクラスファイルは、http://code.google.com/p/google-data-samples-ruby で確認できます。