【技術ネタ】 Google Calendar API のTips(覚え書き)

Google Calendar APIをC#で弄っていたんだけど、まだまだ日本語情報は少ないですね。
「Developer's Guide」も網羅されているようで、細かいところがよく分からない。特にC#とかのライブラリを使った場合の動作とか。(英文をいまいち理解していないという話はある・・)
で、特にUpdate/Deleteあたりではまったので、自分用も含めて覚え書き。
基本的にC#前提ですが、要領は他の言語でも同じかと。

■最初のFeed取得URLでRead OnlyかWrite可能か決定される

後述になるけど、Google Calendar(以下GC)のデータをUpdate/Deleteするには最初にFeedを取り出しておく必要がある。C#ではAtomFeedクラスへ読み込むことになる。
ここでFeedを取り出すためのURLは、

http://www.google.com/calendar/feeds/userID/visibility/projection

となる。
このvisibilityとprojectionの組み合わせでFeed中のEntry(C#ではAtomEntryクラス)を用いてRead OnlyのみかWrite可能が決定してしまう。
Write可能にするためには、「Developer's Guide」のCalendar feed typesにもあるように、visibilityを「private」としておく必要がある。
例えば、「http://www.google.com/calendar/feeds/userID/private/full」という感じ。
当然認証が事前に必要になるけど、C#ならsetUserCredentials一発で問題なし。ラクチン。
例えば、以下のようなコードになる。

CalendarService service = new CalendarService("Sample/1.0");
service.setUserCredentials("[e-mail]", "password");

FeedQuery query = new FeedQuery();
query.Uri = new Uri("http://www.google.com/calendar/feeds/[e-mail]/private/full");
AtomFeed calFeed = service.Query(query);

因みにvisibilityがprivate-magicCookieの場合はRead Onlyなので注意。
これは多分RSSリーダーでPrivateなFeedを読みたい時用で、プログラミング向けでは無い。

また、projectionは基本的にFeedに含まれる情報量を指定する。大抵fullでいいんじゃないかなー。

■EntryがRead OnlyかWrite可能かはEditUri変数/ReadOnly変数が決定する

Atomの規定そのままなんだけど、XML的には前項のFeed中の

<link href="http://www.google.com/calendar/feeds/[e-mail]/private/full/pbsclfag96hjkkno6d2mgb2gi40/53294949780" rel="edit" type="application/atom+xml" />

といったURLへPUTすることでUpdateが行える。同じURLへDELETEするとDeleteになる。
で、このURLは可変なため、事前にFeedを入手しない限りリクエスト先URLが分からないのでUpdate/Deleteが不能、というのが前項の意味。

一方C#では、AtomEntryクラスにReadOnly変数があって、上記のアトリビュート(EditUri変数に格納される)が無いとtrueとなり、UpdateやDeleteをしてもエラーになってしまう。
(但しInsertは可能。)
またAtomEntryをnewした場合もtrueのままで、かつEditUri変数自体もReadのみのようなので、何らかの方法でEditUriを入手したとしてもユーザーが作成したAtomEntryでUpdate/Deleteは不可となっている。
素直にFeedを手に入れてからUpdate/Deleteしましょう。

なお、Insertの場合は認証さえ通っていればOKなので、AtomEntryをnewして、適当に値をぶちこんでInsertしましょう。

■開始/終了時刻とロケーションの指定方法

Javaの場合はサンプルが載っているのですぐ分かるんだけど、C#は軽くスルーされているのでよく分からず。この辺は不親切。
勘で試したら、うまくいった(ので、本当にこれが正式な方法かどうかは不明・・)。

開始/終了時刻はWhenクラス、ロケーションはWhereクラスで指定できる。
これをAllayList AtomEntry.ExtensionElementsへAddしてやればいい。
こんな感じ。

When when = new When();
when.StartTime = new DateTime(2006, 6, 1, 10, 0, 0);
when.EndTime = new DateTime(2006, 6, 1, 11, 0, 0);

Where where = new Where();
where.ValueString = "Tokyo, Japan";

entry.ExtensionElements.Clear();
entry.ExtensionElements.Add(when);
entry.ExtensionElements.Add(where);

■終日予定の指定方法が分からない・・

「Developer's Guide」のCommon Elementsによれば、

A one-day event: 
<gd:when startTime="2005-06-06"/>

とある(つまり時刻を付加しない)のだけど、C#的にはWhen.StartTimeとWhen.EndTimeはDateTimeなので・・。
試しに時刻を「00:00:00」としてみたり、EndTimeを追加しなかったり、同一時刻にもしてみたけど、終日にならない。
もう少し見てみます・・。

→ 追記しました。