セットアップ手順

生成されたライブラリを使用していない場合は、Java 用の Google API クライアント ライブラリとその依存関係を ZIP ファイルにダウンロードするか、Maven を使用できます。

Java 用 Google HTTP クライアント ライブラリのドキュメントに含まれている ProGuard の設定手順もご覧ください。

依存関係のあるライブラリをダウンロードする

最新の zip ファイルをダウンロードし、ダウンロード ページからパソコンに展開します。この zip ファイルには、クライアント ライブラリ クラスの jar ファイルと、各アーティファクトとその依存関係に関連付けられたソース jar ファイルが含まれています。さまざまなライブラリの依存関係のグラフとライセンスは、dependencies フォルダにあります。ダウンロード内容の詳細については、readme.html ファイルをご覧ください。

Android

Android 向けの開発で、使用する Google API が Google Play 開発者サービス ライブラリに含まれている場合は、最適なパフォーマンスとエクスペリエンスを実現するために Google Play 開発者サービス ライブラリを使用できます。

Android で Java 用の Google API クライアント ライブラリを使用する場合は、どの依存関係が Android と互換性があるか、特にどの Android SDK レベルかを把握しておくことが重要です。Android アプリケーションには、libs フォルダにある次の jar ファイル、または互換性のある最新のバージョンが必要です。

• google-api-client-2.0.0.jar
• google-api-client-android-2.0.0.jar
• google-oauth-client-1.34.1.jar
• google-http-client-1.42.2.jar
• google-http-client-android-1.42.2.jar
• gson-2.9.0.jar
• Jackson-core-2.13.3.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar

警告: Android の場合、.jar ファイルを「libs"」というディレクトリに配置して、APK パッケージャーがそれらを見つけられるようにする必要があります。そうしないと、実行時に NoClassDefFoundError エラーが発生します。

Google Apps Engine

Google App Engine アプリケーションには、libs フォルダの次の jar ファイルまたは新しい互換性のあるバージョンが必要です。

• google-api-client-2.0.0.jar
• google-api-client-appengine-2.0.0.jar
• google-api-client-servlet-2.0.0.jar
• google-oauth-client-1.34.1.jar
• google-oauth-client-appengine-1.34.1.jar
• google-oauth-client-servlet-1.34.1.jar
• google-http-client-1.42.2.jar
• google-http-client-appengine-1.39.2.jar
• gson-2.9.0.jar
• Jackson-core-2.13.3.jar
• jdo2-api-2.3-eb.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar
• transaction-api-1.1.jar
• xpp3-1.1.4c.jar

サーブレット

サーブレット アプリケーションには、libs フォルダの以下の jar ファイルまたは新しい互換バージョンが必要です。

• google-api-client-2.0.0.jar
• google-api-client-servlet-2.0.0.jar
• google-oauth-client-1.34.1.jar
• google-oauth-client-servlet-1.34.1.jar
• google-http-client-1.42.2.jar
• commons-logging-1.2.jar
• gson-2.9.0.jar
• httpclient-4.5.13.jar
• http://4.4.12.jar
• Jackson-core-2.13.3.jar
• jdo2-api-2.3-eb.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar
• transaction-api-1.1.jar
• xpp3-1.1.4c.jar

汎用 Java

汎用 Java アプリケーションには、libs フォルダにある次の jar ファイルまたは互換性のある新しいバージョンが必要です。

• google-api-client-2.0.0.jar
• google-oauth-client-1.34.1.jar
• google-http-client-1.42.2.jar
• google-http-client-Jackson2-1.39.2.jar
• commons-logging-1.2.jar
• gson-2.9.0.jar
• httpclient-4.5.13.jar
• http://4.4.12.jar
• Jackson-core-2.13.3.jar
• jsr305-3.0.2.jar
• protobuf-java-3.21.4.jar
• xpp3-1.1.4c.jar

生成された Google API のライブラリ

生成されたライブラリのリポジトリには、各バージョンの API の使用手順が記載されています。

Maven

Java 用の Google API クライアント ライブラリは、中央の Maven リポジトリにあります。このライブラリのすべてのアーティファクトの Maven groupId は com.google.api-client です。各 Maven に固有の Maven の手順を以下に示します（下記）。

モジュール

このライブラリは、9 つのモジュールで構成されています。

• google-api-client
• google-api-client-android
• google-api-client-appengine
• google-api-client-servlet
• google-api-client-gson
• google-api-client-Jackson2
• google-api-client-java6
• google-api-client-protobuf
• google-api-client-xml

google-api-client

Java 用 Google API クライアント ライブラリ（google-api-client）は、Android を含むすべてのサポート対象 Java プラットフォームに対応するように設計されています。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client</artifactId>
  <version>2.0.0</version>
</dependency>

Android では、未使用の依存関係を明示的に除外する必要があります。

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client</artifactId>
  <version>2.0.0</version>
  <exclusions>
    <exclusion>
      <artifactId>xpp3</artifactId>
      <groupId>xpp3</groupId>
    </exclusion>
    <exclusion>
      <artifactId>httpclient</artifactId>
      <groupId>org.apache.httpcomponents</groupId>
    </exclusion>
    <exclusion>
      <artifactId>junit</artifactId>
      <groupId>junit</groupId>
    </exclusion>
    <exclusion>
      <artifactId>android</artifactId>
      <groupId>com.google.android</groupId>
    </exclusion>
  </exclusions>
</dependency>

google-api-client-android

Java 用 Google API クライアント ライブラリ（google-api-client-android）の拡張機能は、Java Google Android（SDK >= 2.1 専用）アプリをサポートしています。このモジュールは、google-api-client と google-http-client-android に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-android</artifactId>
  <version>2.0.0</version>
</dependency>

google-api-client-servlet

Java 用 Google API クライアント ライブラリ（google-api-client-servlet）のサーブレットと JDO 拡張機能は Java サーブレット ウェブ アプリケーションをサポートしています。このモジュールは、google-api-client と google-oauth-client-servlet に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-servlet</artifactId>
  <version>2.0.0</version>
</dependency>

google-api-client-appengine

Java 用 Google API クライアント ライブラリ（google-api-client-appengine）への Google App Engine 拡張機能では、Java の Google App Engine アプリケーションがサポートされています。このモジュールは、google-api-client、google-api-client-servlet、google-oauth-client-appengine、google-http-client-appengine に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-appengine</artifactId>
  <version>2.0.0</version>
</dependency>

google-api-client-gson

Java 用 Google API クライアント ライブラリ（google-api-client-gson）の GSON 拡張機能。このモジュールは、google-api-client と google-http-client-gson に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-gson</artifactId>
  <version>2.0.0</version>
</dependency>

google-api-client-jackson2

Java 用 Google API クライアント ライブラリ（google-api-client-Jackson2）に対する Jackson2 拡張機能。このモジュールは、google-api-client と google-http-client-Jackson2 に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-jackson2</artifactId>
  <version>2.0.0</version>
</dependency>

google-api-client-java6

Java 用 Google API クライアント ライブラリ（google-api-client-java6）に対する Java 6 以降の拡張機能。このモジュールは、google-api-client と google-oauth-client-java6 に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-java6</artifactId>
  <version>2.0.0</version>
</dependency>

google-api-client-protobuf をご覧ください。

プロトコル バッファは、Java 用 Google API クライアント ライブラリ（google-api-client-protobuf）に拡張されています。このモジュールは、google-http-client-protobuf と google-api-client に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-protobuf</artifactId>
  <version>2.0.0</version>
</dependency>

google-api-client-xml

Java 用 Google API クライアント ライブラリ（google-api-client-xml）の XML 拡張機能。このモジュールは、google-api-client と google-http-client-xml に依存します。

Maven の使用:

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client-xml</artifactId>
  <version>2.0.0</version>
</dependency>