.NET クライアント ライブラリ スタートガイド
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
Google Data APIs チーム、Jeff Fisher
2007 年 8 月
はじめに
図 1: Google Data API ソリューション
多くのデベロッパーにとって、新しいプロジェクトの最も難しい部分は、新しいソフトウェア パッケージのインストール、開発環境の構成、新しいライブラリの学習など、プロジェクトを始めることです。この記事では、Windows 用 Visual Studio 2005 または Linux やその他の Unix オペレーティング システム用の Mono を使用して .NET クライアント ライブラリの使用を開始する方法について、手順を追って説明します。このガイドが、皆様のスタートアップにかかる時間を短縮し、コードをすぐに使い始めるための一助となれば幸いです。
Visual Studio 2008
Visual Studio 2008 がまだインストールされていない場合は、.NET クライアント ライブラリを使用できる Visual Studio の無料版である Visual C# 2008 Express Edition の使用を検討してください。
環境設定
- http://code.google.com/p/google-gdata/downloads/list からクライアント ライブラリの最新の MSI リリースをダウンロードします。
- ダウンロードした MSI ファイルを実行して、パッケージをインストールします。デフォルトでは、「C:\Program Files\Google\Google Data API SDK\」にインストールされます。この記事の以降の例では、クライアント ライブラリがこの場所にインストールされていることを前提としています。
- [スタート] メニューの [Google Data API SDK] フォルダにある「Google Data API SDK」というソリューション ファイルを開きます。
サンプルのコンパイルと実行
- [Build] > [Build Solution] の実行がエラーなしで完了することを確認します。
- デバッグ ビルドを作成するには、[ビルド] > [構成マネージャー] に移動し、アクティブ ソリューション構成として [デバッグ] を選択します。[ビルド] > [ソリューションのビルド] を選択します。
- コンパイルしたバイナリ ファイルと 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 ファイルを参照パスとして追加する必要があります。
- Google API SDK ソリューションの外部でプロジェクトを作成または開きます。
- [プロジェクト] メニューから [参照を追加] を選択します。
- [ブラウジング] タブをクリックします。
- SDK の Redist ディレクトリ(C:\Program Files\Google\Google Data API SDK\Redist)に移動します。
- コードで使用される 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 テストが合格することを確認することが重要です。クライアント ライブラリを変更せずに使用する場合は、通常、実行する必要はありません。
- http://www.nunit.org/index.php?p=download から NUnit の .NET 2.0 MSI ファイル リリースをダウンロードします。
- MSI ファイルを実行して NUnit をインストールします。デフォルトのインストール場所は、「C:\Program Files\NUnit 2.4.8」のようになります。このパスを「C:\Program Files\NUnit」などに変更すると、将来 Visual Studio プロジェクトのパスを変更することなく NUnit をアップグレードできます。
- 「C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005」ディレクトリに移動し、「Google Data APIs」というソリューション ファイルを開きます。これは Visual Studio 2005 プロジェクト ファイルであるため、変換ウィザードが表示されます。画面上の手順に沿って操作するか、[完了] ボタンをクリックします。変換ログが表示されますが、無視してかまいません。
- 次に、NUnit を参照パスとして追加する必要があります。右側のソリューション エクスプローラーで「unittests」プロジェクトを右クリックし、[プロパティ] を選択します。次に、表示されたウィンドウの [参照パス] タブをクリックします。NUnit インストールの bin サブディレクトリの場所を参照パスとして入力し、[フォルダーを追加] をクリックします。たとえば、NUnit が「C:\Program Files\NUnit\」にインストールされている場合は、「C:\Program Files\NUnit\bin」と入力します。続行する前に、この変更を必ず保存してください。
- サンプルをコンパイルして実行するに記載されている手順に沿って、クライアント ライブラリと単体テストを再ビルドします。
- 「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 キーが必要で、Calendar にはユーザー名とパスワードが必要です。単体テストで情報が削除されないように、ライブデータのないテスト アカウントを使用することをおすすめします。
- スタート メニューから NUnit を開きます。
- [File] > [Open Project] に移動し、[C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\"] から unittests.dll ファイルを選択します。
- 関心のある単体テストを実行します。一部のテストでは、unittests.dll.config でパラメータを設定する必要があります。特定のサービスのストレステストを実行すると、テスト アカウントがスパムを生成しているとフラグが設定され、CAPTCHA のチャレンジに遭遇することなく、Google サーバーにコンテンツをプログラムで送信できなくなることがあります。
モノラル
Mono は、Linux、Solaris、Mac OS X、Windows、Unix で .NET クライアント アプリケーションとサーバー アプリケーションを実行できるオープンソース プロジェクトです。これらのプラットフォームのいずれかで作業したいデベロッパー向けに、クライアント ライブラリの個別の ZIP ファイルを提供しています。
環境設定
- http://code.google.com/p/google-gdata/downloads/list からクライアント ライブラリの最新の ZIP ファイル リリースをダウンロードします。
- ローカル ディレクトリ(/scratch/gdata.NET など)に抽出します。
- ディストリビューションのパッケージ管理を使用して Mono をインストールします。または、http://www.mono-project.com からダウンロードすることもできます。
- 一部のディストリビューションでは、nunit.framework.dll ファイルが mono ライブラリに適切にリンクされていることを確認する必要があります。mono が「/usr/lib/mono」にインストールされている場合は、「/usr/lib/mono/1.0」と「/usr/lib/mono/2.0」に nunit.framework.dll のシンボリック リンクがあることを確認します(nunit.framework.dll は「/usr/lib/mono/gac/nunit.framework/<someversionstring>/nunit.framework.dll」にインストールされているはずです)。
サンプルのコンパイルと実行
- クライアント ライブラリを「/scratch/gdata.NET」にインストールしたと仮定して、「/scratch/gdata.NET/clients/cs」ディレクトリに移動します。
- 使用する .NET のバージョンに応じて Makefile を編集します。.NET 1.x の場合は
CSC=mcs
を、.NET 2.x の場合は CSC=gmcs
を使用します。
make
を実行して、ライブラリとサンプル アプリケーションをコンパイルします。
- クライアント ライブラリ DLL を Mono ライブラリにインストールする場合は、
make install
を実行します。
独自のアプリケーションを開発する
クライアント ライブラリのコンパイル後に make install
を実行した場合は、使用する特定のサービス拡張機能の DLL ファイルへの参照とともに -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll
を Mono C# コンパイラに渡すことで、独自のコードにライブラリを含めることができます。
NUnit テストの実行
- unittests.dll.config ファイルを「/scratch/gdata.NET/clients/cs/src/unittests」から「/scratch/gdata.NET/clients/cs/」にコピーします。
- 「/scratch/gdata.NET/clients/cs/unittests.dll.config」を編集して、実行するテストに適した情報を含めます。たとえば、Base には API キーが必要で、Calendar にはユーザー名とパスワードが必要です。単体テストで情報が削除されないように、ライブデータのないテスト アカウントを使用することをおすすめします。
- ライブラリをコンパイルすると、/scratch/gdata.NET/clients/cs に unittests.dll ファイルが作成されます。この DLL は、選択した NUnit テスト マネージャー(nunit-console、gnunit など)で使用します。
まとめ
これで、ライブラリをコンパイルしてサンプルコードを実行できるようになります。ただし、これはほんの始まりにすぎません。クライアント ライブラリの「.../clients/cs/docs」ディレクトリにあるドキュメントをお読みになることをおすすめします。.NET クライアント ライブラリのデベロッパー ガイド、プロジェクト ページとリファレンス ガイド、Google Data .NET クライアント ライブラリ フォーラムもご覧ください。
この記事で言及しているツール:
次の .NET アプリケーションの開発がうまくいくことを願っています。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2025-07-27 UTC。
[null,null,["最終更新日 2025-07-27 UTC。"],[[["\u003cp\u003eThis guide provides step-by-step instructions for setting up and using the Google Data .NET client library with either Visual Studio 2008 or Mono.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this library to interact with various Google services like Calendar by compiling and running provided sample applications or by developing their own applications.\u003c/p\u003e\n"],["\u003cp\u003eThe guide includes details on compiling the library, running provided unit tests for verifying functionality, and configuring the development environment for both Windows and Unix-based systems.\u003c/p\u003e\n"],["\u003cp\u003eAdditional resources such as the .NET Client Library Developer's Guide and project forums are available for further assistance.\u003c/p\u003e\n"]]],[],null,["# Getting Started with the .NET Client Library\n\n*Jeff Fisher, Google Data APIs team\nAugust 2007*\n\n- [Introduction](#introduction)\n- [Visual Studio 2008](#vs2005)\n - [Setting up your environment](#vssetup)\n - [Compiling and running samples](#vscompile)\n - [Developing your own application](#vsdevelop)\n - [Running the NUnit tests](#vsnunit)\n- [Mono](#mono)\n - [Setting up your environment](#monosetup)\n - [Compiling and running samples](#monocompile)\n - [Developing your own application](#monodevelop)\n - [Running the NUnit tests](#mononunit)\n- [Conclusion](#conclusion)\n\n### Introduction\n\n\u003cbr /\u003e\n\n**Figure 1: The Google Data API solution**\n\nFor many developers, the most difficult part of a new project is getting the ball rolling-installing new software packages, configuring a development environment, and learning new libraries. In this article, I have pulled together some step-by-step instructions for how to begin with the .NET client library using either Visual Studio 2005 for Windows or Mono for Linux and other Unix operating systems. It is my hope that this will save you some time in getting started and let you quickly start working with some code.\n\nVisual Studio 2008\n------------------\n\nIf you do not already have Visual Studio 2008 installed, you may want to consider using [Visual C# 2008 Express Edition](http://msdn.microsoft.com/en-us/library/orm-9780596521066-01-02.aspx), a free version of Visual Studio that will allow you to work with the .NET client library.\n\n### Setting up your environment\n\n1. Download the latest MSI release of the client library from [http://code.google.com/p/google-gdata/downloads/list](//code.google.com/p/google-gdata/downloads/list).\n2. Run the downloaded MSI file to install the package. It will install to \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\\" by default. Further examples in this article will assume you installed the client library to this location.\n3. Open the solution file called \"Google Data API SDK\" in the \"Google Data API SDK\" folder in the Start Menu.\n\n### Compiling and running samples\n\n1. Verify that running \"Build \\\u003e Build Solution\" completes without any errors.\n2. To create a Debug build go to \"Build \\\u003e Configuration Manager\" and select \"Debug\" as the active solution configuration. Then select \"Build \\\u003e Build Solution\".\n3. The binaries and DLL files you have just compiled can be found in \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Sources\\\\Samples\\\\\" For example, you can run the sample application for Calendar by executing \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Sources\\\\Samples\\\\calendar\\\\bin\\\\Debug\\\\Calendar.exe\". There are also some Start Menu shortcuts to these samples.\n\n### Developing your own application\n\nIf you want to develop in a project outside of the solution file provided by the MSI file, you need to add the client library DLL files as a reference path.\n\n1. Create or open a project outside of the Google API SDK solution.\n2. Select \"Add Reference\" from the Project menu.\n3. Click on the Browse tab.\n4. Navigate to the Redist directory in the SDK: \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Redist\".\n5. Select the DLL files that will be used by your code. Google.GData.Extensions.dll and Google.GData.Client.dll will be needed for most projects, along with the DLL file specific to the Google service(s) you are using in your application.\n\n**Note:** There is also a solution file for client libraries on Mobile devices. It is found in \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Sources\\\\Library\\\\VS2005.mobile\" by default. This solution will only compile the DLL files for the client libraries.\n\n### Running the NUnit tests\n\nMaking sure the appropriate NUnit tests pass is an important step if you make any changes to the client libraries or plan to contribute to them. If you plan to use the client libraries without modifications then there is normally no need to run them.\n\n1. Download the .NET 2.0 MSI file release of NUnit from \u003chttp://www.nunit.org/index.php?p=download\u003e.\n2. Install NUnit by running the MSI file. The default install location is similar to \"C:\\\\Program Files\\\\NUnit 2.4.8\". You may wish to change this to something like \"C:\\\\Program Files\\\\NUnit\" so you can upgrade NUnit in the future without having to change the path in your Visual Studio project.\n3. Go to the \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Sources\\\\Library\\\\VS2005\" directory and open the solution file named \"Google Data APIs\". You will see the Conversion Wizard since this is a Visual Studio 2005 project file. Either click through the prompts or simply click on the \"Finish\" button. It should display the conversion log, which can be ignored.\n4. Now NUnit must be added as a reference path. Right click on the \"unittests\" project in the Solution Explorer on the right and select \"Properties\". Now click on the \"Reference Paths\" tab within the window that opens. Enter in the location of the \"bin\" subdirectory of the NUnit installation as a reference path and click \"Add Folder\". For example, if NUnit is installed to \"C:\\\\Program Files\\\\NUnit\\\\\", one would enter \"C:\\\\Program Files\\\\NUnit\\\\bin\". Be sure to save this change before continuing.\n5. Follow the steps listed in [Compiling and running samples](#vscompile) to rebuild the client library and the unit tests.\n6. Copy the \"unittests.dll.config\" file in \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Sources\\\\Library\\\\unittests\\\\\" to your debug build directory \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Source\\\\Library\\\\VS2005\\\\unittests\\\\bin\\\\Debug\\\\\". Remember to edit the file to include the appropriate information for the tests you are running. For example, Base requires an API key and Calendar requires a username and password. It is recommended to use a test account without any live data to avoid having information deleted by the unit tests.\n7. Open NUnit from the Start Menu.\n8. Go to \"File \\\u003e Open Project\" and select the \"unittests.dll\" file from \"C:\\\\Program Files\\\\Google\\\\Google Data API SDK\\\\Source\\\\Library\\\\VS2005\\\\unittests\\\\bin\\\\Debug\\\\\".\n9. Run the unit tests you are interested in. Remember that certain tests require parameters be set in unittests.dll.config to work. If you run the stress tests for certain services you may have your test account flagged as generating spam and be unable to programmatically submit content to Google servers without encountering CAPTCHA challenges.\n\nMono\n----\n\nMono is an open source project that allows you to run .NET client and server applications on Linux, Solaris, Mac OS X, Windows, and Unix. We offer a separate ZIP file of our client library for developers who want to work on one of these platforms.\n\n### Setting up your environment\n\n1. Download the latest ZIP file release of the client library from [http://code.google.com/p/google-gdata/downloads/list](//code.google.com/p/google-gdata/downloads/list)\n2. Extract to a local directory (e.g. \"/scratch/gdata.NET\")\n3. Use your distribution's package management to install Mono. Alternatively, you can download it from \u003chttp://www.mono-project.com\u003e.\n4. In some distributions you have to make sure that the nunit.framework.dll file is properly linked into the mono library. If mono was installed to \"/usr/lib/mono\", then ensure that there are symbolic links in \"/usr/lib/mono/1.0\" and \"/usr/lib/mono/2.0\" for nunit.framework.dll (which should be installed in \"/usr/lib/mono/gac/nunit.framework/\\\u003csomeversionstring\\\u003e/nunit.framework.dll\").\n\n### Compiling and running samples\n\n1. Assuming you installed the client library to \"/scratch/gdata.NET\", change to the \"/scratch/gdata.NET/clients/cs\" directory.\n2. Edit the Makefile depending on what version of .NET you wish to use. For .NET 1.x, use `CSC=mcs` and for .NET 2.x, use `CSC=gmcs`.\n3. Run `make` to compile the libraries and sample applications.\n4. Execute `make install` if you want to install the client library DLLs into the Mono library.\n\n### Developing your own application\n\nIf you executed a `make install` after compiling the client library, you should be able to include the libraries in your own code by passing `-r:Google.GData.Extensions.dll -r:Google.GData.Client.dll` to the Mono C# compiler along with references to the DLL files of any specific service extensions you wish to use.\n\n### Running the NUnit tests\n\n1. Copy the unittests.dll.config file from \"/scratch/gdata.NET/clients/cs/src/unittests\" to \"/scratch/gdata.NET/clients/cs/\".\n2. Edit \"/scratch/gdata.NET/clients/cs/unittests.dll.config\" to include the appropriate information for the tests you are running. For example, Base requires an API key and Calendar requires a username and password. I recommend using a test account without any live data to avoid having information deleted by the unit tests.\n3. After compiling the library there will be a unittests.dll file in \"/scratch/gdata.NET/clients/cs\". Use this DLL with your NUnit test manager of choice (nunit-console, gnunit, etc.).\n\n### Conclusion\n\nNow you should be able to compile the libraries and run the sample code. This is only the beginning, however. I encourage you to read through the documentation found in the \".../clients/cs/docs\" directory of the client library.\nYou might also want to check out the [.NET Client Library Developer's Guide](/gdata/client-cs), the [project page](http://code.google.com/p/google-gdata/) and [reference guide](http://google-gdata.googlecode.com/svn/docs/Index.html), and the [Google Data .NET client library forum](http://groups.google.com/group/gdata-dotnet-client-library).\n\nTools referenced in this article:\n\n- [Mono Project](http://www.mono-project.com/Main_Page)\n- [Visual Studio](http://msdn2.microsoft.com/en-us/vstudio/default.aspx)\n- [Visual C# 2008 Express Edition](http://msdn.microsoft.com/en-us/library/orm-9780596521066-01-02.aspx)\n- [NUnit](http://www.nunit.org/)\n\nGood luck on your next .NET application!"]]