Instructions de configuration

Si vous n'utilisez pas de bibliothèque générée, vous pouvez télécharger la bibliothèque cliente des API Google pour Java et ses dépendances dans un fichier ZIP, ou vous pouvez utiliser Maven.

Consultez également les instructions de configuration de ProGuard qui font partie de la documentation sur la bibliothèque cliente HTTP Google pour Java.

Télécharger la bibliothèque avec les dépendances

Téléchargez le fichier ZIP le plus récent, disponible sur la page des téléchargements, puis extrayez-le sur votre ordinateur. Ce fichier ZIP contient les fichiers JAR de la classe de la bibliothèque cliente et les fichiers JAR sources associés à chaque artefact et à ses dépendances. Vous trouverez des graphiques de dépendances et des licences pour les différentes bibliothèques dans le dossier des dépendances. Pour en savoir plus sur le contenu du téléchargement, consultez le fichier readme.html.

Android

Si vous développez pour Android et que l'API Google que vous souhaitez utiliser est incluse dans la bibliothèque des services Google Play, utilisez-la pour bénéficier de performances et d'une expérience optimales.

Si vous utilisez la bibliothèque cliente des API Google pour Java avec Android, il est important de savoir quelles dépendances sont compatibles avec Android, et plus précisément le niveau du SDK Android. Les applications Android requièrent les fichiers JAR suivants, ou des versions compatibles plus récentes, dans le dossier "libs" :

  • 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 App Engine

Les applications Google App Engine requièrent les fichiers JAR suivants, ou des versions compatibles plus récentes, dans le dossier "libs" :

  • 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

Servlet

Les applications de servlet nécessitent les fichiers JAR suivants, ou des versions compatibles plus récentes, à partir du dossier libs:

  • 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 générique

Les applications Java à usage général nécessitent les fichiers JAR suivants, ou des versions compatibles plus récentes, dans le dossier "libs" :

  • 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

Bibliothèques générées pour les API Google

Le dépôt des bibliothèques générées explique comment utiliser chaque version des API.

Maven

La bibliothèque cliente des API Google pour Java se trouve dans le dépôt Maven central. Le fichier Maven groupId pour tous les artefacts de cette bibliothèque est com.google.api-client. Des instructions Maven spécifiques sont fournies pour chaque module (ci-dessous).

Modules

Cette bibliothèque se compose de neuf modules:

google-api-client

La bibliothèque cliente des API Google pour Java (google-api-client) est conçue pour être compatible avec toutes les plates-formes Java compatibles, y compris Android.

Utilisation de Maven:

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

Sur Android, vous devez exclure explicitement les dépendances inutilisées:

<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

Les extensions de la bibliothèque cliente des API Google pour Java (google-api-client-android) sont compatibles avec Java Google Android (uniquement pour les applications SDK 2.1 ou supérieures). Ce module dépend de google-api-client et de google-http-client-android.

Utilisation de Maven:

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

google-api-client-servlet

Les extensions de servlet et Jenkins ajoutées à la bibliothèque cliente des API Google pour Java (google-api-client-servlet) prennent en charge les applications Web de servlet Java. Ce module dépend de google-api-client et de google-oauth-client-servlet.

Utilisation de Maven:

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

google-api-client-appengine

Les extensions Google App Engine de la bibliothèque cliente des API Google pour Java (google-api-client-appengine) prennent en charge les applications Java Google App Engine. Ce module dépend de google-api-client, google-api-client-servlet, google-oauth-client-appengine et google-http-client-appengine.

Utilisation de Maven:

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

google-api-client-gson

Extensions GSON de la bibliothèque cliente des API Google pour Java (google-api-client-gson). Ce module dépend de google-api-client et de google-http-client-gson.

Utilisation de Maven:

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

google-api-client-jackson2

Extensions Jackson2 de la bibliothèque cliente des API Google pour Java (google-api-client-jackson2). Ce module dépend de google-api-client et de google-http-client-jackson2.

Utilisation de Maven:

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

google-api-client-protobuf

Extensions de Protocol Buffer à la bibliothèque cliente des API Google pour Java (google-api-client-protobuf). Ce module dépend de google-http-client-protobuf et google-api-client.

Utilisation de Maven:

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

google-api-client-xml

Extensions XML vers la bibliothèque cliente des API Google pour Java (google-api-client-xml). Ce module dépend de google-api-client et de google-http-client-xml.

Utilisation de Maven:

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