設定の手順

生成されたライブラリを使用しない場合は、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.4.0.jar
  • google-api-client-android-2.4.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

Google Apps Engine

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

  • google-api-client-2.4.0.jar
  • google-api-client-appengine-2.4.0.jar
  • google-api-client-servlet-2.4.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.4.0.jar
  • google-api-client-servlet-2.4.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
  • httpcore-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.4.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
  • httpcore-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 の手順を以下に示します。

モジュール

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

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.4.0</version>
</dependency>

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

<dependency>
  <groupId>com.google.api-client</groupId>
  <artifactId>google-api-client</artifactId>
  <version>2.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.0</version>
</dependency>