設定の手順

生成されたライブラリを使用しない場合は、 Java 用 Google API クライアント ライブラリとその依存関係を Maven を使用できます。

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

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

ダウンロード ページから最新の zip ファイルをダウンロードし、パソコンに展開します。この zip ファイルには、クライアント ライブラリのクラス jar ファイルと、各アーティファクトとその依存関係に関連するソース jar ファイルが含まれています。依存関係フォルダには、さまざまなライブラリの依存関係グラフとライセンスがあります。ダウンロードの内容について詳しくは、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

Google API Client Library for Java（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

Google API Client Library for Java（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

Google API Client Library for Java（google-api-client-Servlet）の 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

Google API Client Library for Java（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

Google API Client Library for Java（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

Google API Client Library for Java（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

プロトコル バッファ Google API Client Library for Java（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

Google API Client Library for Java（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>