.NET クライアント ライブラリを使ってみる

Google Data API チーム Jeff Fisher
2007 年 8 月

はじめに

Google Data API ソリューション
図 1: Google Data API ソリューション

多くのデベロッパーにとって、新しいプロジェクトで最も困難な部分は、新しいソフトウェア パッケージのインストール、開発環境の構成、新しいライブラリの習得に苦労することです。この記事では、Visual Studio 2005(Windows の場合)または Mono for Linux(その他の Unix オペレーティング システム)を使用して .NET クライアント ライブラリを使い始めるための詳しい手順を示しました。これによって、ある程度の時間をかけずにコードをすぐに使い始めることができます。

Visual Studio 2008

Visual Studio 2008 をまだインストールしていない場合は、Visual Studio の無料版である Visual C# 2008 Express Edition を使用すると、.NET クライアント ライブラリを使用できます。

環境設定

  1. クライアント ライブラリの最新の MSI リリースを http://code.google.com/p/google-uses/downloads/list からダウンロードします。
  2. ダウンロードした MSI ファイルを実行してパッケージをインストールします。この SDK は、デフォルトで「C:\Program Files\Google\Google Data API SDK\"」にインストールされます。この記事の以降の例では、この場所にクライアント ライブラリがインストールされていることを前提としています。
  3. [スタート] メニューの [Google Data API SDK] フォルダにある [Google Data API SDK] というソリューション ファイルを開きます。

サンプルのコンパイルと実行

  1. 「Build > Build Solution」の実行がエラーなしで完了することを確認します。
  2. デバッグビルドを作成するには、[Build] > [Configuration Manager] に移動して、有効なソリューション設定として [Debug] を選択します。次に、[Build] > [Build Solution] を選択します。
  3. コンパイルしたバイナリと DLL ファイルは、「C:\Program Files\Google\Google Data API SDK\Sources\Samples\"」にあります。たとえば、「C:\Program Files\Google\Google Data API SDK\Sources\Samples\calendar\bin\Debug\Calendar.exe」を実行することで、カレンダーのサンプル アプリケーションを実行できます。これらのサンプルに対するスタート メニュー ショートカットもあります。

独自のアプリケーションの開発

MSI ファイルで提供されるソリューション ファイル以外のプロジェクトで開発を行う場合は、クライアント ライブラリの DLL ファイルを参照パスとして追加する必要があります。

  1. Google API SDK ソリューションの外部でプロジェクトを作成または開きます。
  2. [Project] メニューから [Add Reference] を選択します。
  3. [参照] タブをクリックします。
  4. SDK の Redis ディレクトリ(C:\Program Files\Google\Google Data API SDK\Redist)に移動します。
  5. コードで使用する DLL ファイルを選択します。ほとんどのプロジェクトで、Google.GData.Extensions.dll と Google.GData.Client.dll のほか、アプリケーションで使用している Google サービスに固有の DLL ファイルが必要です。

注: モバイル デバイス用のクライアント ライブラリのソリューション ファイルもあります。デフォルトで「C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005.mobile」にあります。このソリューションでは、クライアント ライブラリの DLL ファイルのみをコンパイルします。

NUnit テストの実行

クライアント ライブラリに変更を加える場合や、ライブラリに変更を加えた場合は、適切な NUnit テストに合格することが重要な手順となります。クライアント ライブラリを変更せずに使用する場合は、通常、実行する必要はありません。

  1. http://www.nunit.org/index.php?p=download から、NUnit の .NET 2.0 MSI ファイル リリースをダウンロードします。
  2. MSI ファイルを実行して NUnit をインストールします。デフォルトのインストール場所は「C:\Program Files\NUnit 2.4.8」のようになります。これを「C:\Program Files\NUnit」などに変更することで、今後 Visual Studio プロジェクトのパスを変更せずに NUnit をアップグレードすることができます。
  3. 「C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005」ディレクトリに移動して、「Google Data API」という名前のソリューション ファイルを開きます。 Visual Studio 2005 プロジェクト ファイルであるため、変換ウィザードが表示されます。プロンプトをクリックするか、[完了] ボタンをクリックします。コンバージョン ログが表示されますが、無視してかまいません。
  4. NUnit が参照パスとして追加されるようになりました。右側のソリューション エクスプローラで「unittests」プロジェクトを右クリックし、[Properties] を選択します。表示されたウィンドウの [Reference Paths] タブをクリックします。参照ユニットとして、NUnit インストールの「bin」サブディレクトリの場所を入力し、[Add Folder] をクリックします。たとえば、NUnit が「C:\Program Files\NUnit\"」にインストールされている場合、「C:\Program Files\NUnit\bin」と入力します。続行する前に、必ずこの変更を保存してください。
  5. サンプルのコンパイルと実行に記載された手順に沿って、クライアント ライブラリと単体テストを再構築します。
  6. 「C:\Program Files\Google\Google Data API SDK\Sources\Library\unittests\"」にある「unittests.dll.config」ファイルをデバッグ ビルド ディレクトリ「C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\"」にコピーします。ファイルを編集して、実行しているテストの適切な情報を含めます。たとえば、Base には API キー、カレンダーにはユーザー名とパスワードが必要です。単体テストによって情報が削除されないように、ライブデータのないテスト アカウントを使用することをおすすめします。
  7. スタート メニューから NUnit を開きます。
  8. [File] > [Open Project] に移動し、C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\" から「unittests.dll」ファイルを選択します。
  9. 目的の単体テストを実行します。一部のテストでは、unittests.dll.config にパラメータを設定する必要があります。特定のサービスのストレステストを実行すると、テスト アカウントでスパムの生成が報告され、CAPTCHA チャレンジなしではコンテンツを Google サーバーに送信できなくなります。

モノラル

Mono は、Linux、Solaris、Mac OS X、Windows、Unix 上で .NET クライアント アプリケーションとサーバー アプリケーションを実行するためのオープンソース プロジェクトです。これらのプラットフォームのいずれかを使用するデベロッパー向けの、クライアント ライブラリの ZIP ファイルがあります。

環境設定

  1. クライアント ライブラリの最新の ZIP ファイル リリースを http://code.google.com/p/google-uses/downloads/list からダウンロードします。
  2. ローカル ディレクトリに展開します(例: "/scratch/then.NET")
  3. ディストリビューションのパッケージ管理を使用して Mono をインストールします。または、http://www.mono-project.com からダウンロードできます。
  4. ディストリビューションによっては、nunit.framework.dll ファイルがモノラル ライブラリに正しくリンクされていることを確認する必要があります。mono が「/usr/lib/mono」にインストールされている場合は、nunit.framework.dll の「/usr/lib/mono/1.0」と「/usr/lib/mono/2.0」にシンボリック リンクがあることを確認します。

サンプルのコンパイルと実行

  1. クライアント ライブラリを「/scratch/then.NET」にインストールしている場合は、/scratch/then.NET/clients/cs ディレクトリに移動します。
  2. 使用する .NET のバージョンに応じて、Makefile を編集します。.NET 1.x の場合は CSC=mcs を使用し、.NET 2.x の場合は CSC=gmcs を使用します。
  3. make を実行して、ライブラリとサンプル アプリケーションをコンパイルします。
  4. クライアント ライブラリの DLL を Mono ライブラリにインストールする場合は、make install を実行します。

独自のアプリケーションの開発

クライアント ライブラリのコンパイル後に make install を実行した場合は、使用する特定のサービス拡張機能の DLL ファイルへの参照とともに、-r:Google.GData.Extensions.dll -r:Google.GData.Client.dll を Mono C# コンパイラに渡すことで、独自のコードにライブラリを含めることができるようにする必要があります。

NUnit テストの実行

  1. unittests.dll.config ファイルを「/scratch/then.NET/clients/cs/src/unittests」から「/scratch/then.NET/clients/cs/」にコピーします。
  2. 「/scratch/then.NET/clients/cs/unittests.dll.config」を編集して、実行しているテストの適切な情報を含めます。たとえば、Base には API キー、カレンダーにはユーザー名とパスワードが必要です。単体テストによって情報が削除されないように、ライブデータのないテスト アカウントを使用することをおすすめします。
  3. ライブラリのコンパイル後、"/scratch/then.NET/clients/cs" に unittests.dll ファイルが作成されます。この DLL は、任意の NUnit テスト マネージャー(nunit-console、gnunit など)とともに使用します。

まとめ

ライブラリをコンパイルしてサンプルコードを実行できるようになりました。ただし、これは始まりにすぎません。クライアント ライブラリの「.../clients/cs/docs」ディレクトリにあるドキュメントを確認することをおすすめします。 .NET クライアント ライブラリ デベロッパー ガイドプロジェクト ページリファレンス ガイドGoogle Data .NET クライアント ライブラリ フォーラムもご覧ください。

この記事で参照しているツール:

それでは .NET アプリケーションでご健闘をお祈りいたします。