Guide de démarrage rapide Java

Créez une application Java en ligne de commande qui envoie des requêtes à l'API Google Apps Script.

Les guides de démarrage rapide expliquent comment configurer et exécuter une application qui appelle une API Google Workspace. Ce guide de démarrage rapide utilise une approche d'authentification simplifiée, adaptée à un environnement de test. Pour un environnement de production, nous vous recommandons de vous familiariser avec l'authentification et l'autorisation avant de choisir les identifiants d'accès adaptés à votre application.

Ce guide de démarrage rapide utilise les bibliothèques clientes d'API recommandées par Google Workspace pour gérer certains détails du flux d'authentification et d'autorisation.

Objectifs

Configurez votre environnement.
Configurez l'exemple.
Exécutez l'exemple.

Prérequis

Un compte Google avec Google Drive activé

Configurez votre environnement

Pour suivre ce guide de démarrage rapide, configurez votre environnement.

Activer l'API

Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud. Vous pouvez activer une ou plusieurs API dans un même projet Google Cloud.

Dans la console Google Cloud, activez l'API Google Apps Script.

Activer l'API

Configurer l'écran de consentement OAuth

Si vous utilisez un nouveau projet Google Cloud pour effectuer ce démarrage rapide, configurez l'écran de consentement OAuth. Si vous avez déjà effectué cette étape pour votre projet Cloud, passez à la section suivante.

Dans la console API Google, accédez à Menu > Google Auth Platform > Branding.
Accéder à la page "Branding"
Si vous avez déjà configuré Google Auth Platform, vous pouvez configurer les paramètres de l'écran de consentement OAuth suivants dans Branding, Audience et Accès aux données. Si le message Google Auth Platform pas encore configuré s'affiche, cliquez sur Premiers pas :

Sous Informations sur l'application, dans Nom de l'application, saisissez un nom pour l'application.
Dans Adresse e-mail d'assistance utilisateur, choisissez une adresse e-mail d'assistance à laquelle les utilisateurs peuvent vous contacter s'ils ont des questions sur leur consentement.
Cliquez sur Suivant.
Sous Audience, sélectionnez Interne.
Cliquez sur Suivant.
Sous Coordonnées, saisissez une adresse e-mail à laquelle vous recevrez des notifications en cas de modification de votre projet.
Cliquez sur Suivant.
Sous Terminer, consultez le Règlement sur les données utilisateur dans les services d'API Google et, si vous l'acceptez, sélectionnez J'accepte le Règlement sur les données utilisateur dans les services d'API Google.
Cliquez sur Continuer.
Cliquez sur Créer.

Pour l'instant, vous pouvez ignorer l'ajout de niveaux d'accès. À l'avenir, lorsque vous créerez une application à utiliser en dehors de votre organisation Google Workspace, vous devrez définir le type d'utilisateur sur Externe. Ajoutez ensuite les niveaux d'autorisation dont votre application a besoin. Pour en savoir plus, consultez le guide complet Configurer l'écran de consentement OAuth.

Autoriser les identifiants pour une application de bureau

Pour authentifier les utilisateurs finaux et accéder aux données utilisateur dans votre application, vous devez créer un ou plusieurs ID client OAuth 2.0. Un ID client sert à identifier une application unique auprès des serveurs OAuth de Google. Si votre application s'exécute sur plusieurs plates-formes, vous devez créer un ID client distinct pour chacune d'elles.

Dans la console API Google, accédez à Menu > Google Auth Platform > Clients.
Accéder à "Clients"
Cliquez sur Créer un client.
Cliquez sur Type d'application > Application de bureau.
Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom ne s'affiche que dans la console API Google.
Cliquez sur Créer.
L'identifiant que vous venez de créer s'affiche sous "ID client OAuth 2.0".
Enregistrez le fichier JSON téléchargé sous le nom credentials.json, puis déplacez le fichier dans votre répertoire de travail.

Préparer l'espace de travail

Dans votre répertoire de travail, créez une structure de projet :

gradle init --type basic
mkdir -p src/main/java src/main/resources

Dans le répertoire src/main/resources/, copiez le fichier credentials.json que vous avez téléchargé précédemment.
Ouvrez le fichier build.gradle par défaut et remplacez son contenu par le code suivant :

appsScript/quickstart/build.gradle

Afficher sur GitHub
```
apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'AppsScriptQuickstart'
sourceCompatibility = 11
targetCompatibility = 11
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.google.api-client:google-api-client:2.0.0'
    implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
    implementation 'com.google.apis:google-api-services-script:v1-rev20220323-2.0.0'
}
```

Configurer l'exemple

Dans le répertoire src/main/java/, créez un fichier Java dont le nom correspond à la valeur mainClassName dans votre fichier build.gradle.

Incluez le code suivant dans votre nouveau fichier Java :

appsScript/quickstart/src/main/java/AppsScriptQuickstart.java

Afficher sur GitHub

import com.google.api.client.auth.oauth2.Credential;
import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.client.util.store.FileDataStoreFactory;
import com.google.api.services.script.Script;
import com.google.api.services.script.model.Content;
import com.google.api.services.script.model.CreateProjectRequest;
import com.google.api.services.script.model.File;
import com.google.api.services.script.model.Project;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.security.GeneralSecurityException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class AppsScriptQuickstart {
  private static final String APPLICATION_NAME = "Apps Script API Java Quickstart";
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
  private static final String TOKENS_DIRECTORY_PATH = "tokens";

  /**
   * Global instance of the scopes required by this quickstart.
   * If modifying these scopes, delete your previously saved credentials folder at /secret.
   */
  private static final List<String> SCOPES =
      Collections.singletonList("https://www.googleapis.com/auth/script.projects");
  private static final String CREDENTIALS_FILE_PATH = "/credentials.json";

  /**
   * Creates an authorized Credential object.
   *
   * @param HTTP_TRANSPORT The network HTTP Transport.
   * @return An authorized Credential object.
   * @throws IOException If the credentials.json file cannot be found.
   */
  private static Credential getCredentials(final NetHttpTransport HTTP_TRANSPORT)
      throws IOException {
    // Load client secrets.
    InputStream in = AppsScriptQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
    if (in == null) {
      throw new FileNotFoundException("Resource not found: " + CREDENTIALS_FILE_PATH);
    }
    GoogleClientSecrets clientSecrets =
        GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(in));

    // Build flow and trigger user authorization request.
    GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
        HTTP_TRANSPORT, JSON_FACTORY, clientSecrets, SCOPES)
        .setDataStoreFactory(new FileDataStoreFactory(new java.io.File(TOKENS_DIRECTORY_PATH)))
        .setAccessType("offline")
        .build();
    LocalServerReceiver receiver = new LocalServerReceiver.Builder().setPort(8888).build();
    return new AuthorizationCodeInstalledApp(flow, receiver).authorize("user");
  }

  public static void main(String... args) throws IOException, GeneralSecurityException {
    // Build a new authorized API client service.
    final NetHttpTransport HTTP_TRANSPORT = GoogleNetHttpTransport.newTrustedTransport();
    Script service =
        new Script.Builder(HTTP_TRANSPORT, JSON_FACTORY, getCredentials(HTTP_TRANSPORT))
            .setApplicationName(APPLICATION_NAME)
            .build();
    Script.Projects projects = service.projects();

    // Creates a new script project.
    Project createOp = projects.create(new CreateProjectRequest().setTitle("My Script")).execute();

    // Uploads two files to the project.
    File file1 = new File()
        .setName("hello")
        .setType("SERVER_JS")
        .setSource("function helloWorld() {\n  console.log(\"Hello, world!\");\n}");
    File file2 = new File()
        .setName("appsscript")
        .setType("JSON")
        .setSource("{\"timeZone\":\"America/New_York\",\"exceptionLogging\":\"CLOUD\"}");
    Content content = new Content().setFiles(Arrays.asList(file1, file2));
    Content updatedContent = projects.updateContent(createOp.getScriptId(), content).execute();

    // Logs the project URL.
    System.out.printf("https://script.google.com/d/%s/edit\n", updatedContent.getScriptId());
  }
}

Exécuter l'exemple

Exécutez l'exemple :
```
gradle run
```

La première fois que vous exécutez l'exemple, vous êtes invité à autoriser l'accès :
1. Si vous n'êtes pas déjà connecté à votre compte Google, connectez-vous lorsque vous y êtes invité. Si vous êtes connecté à plusieurs comptes, sélectionnez-en un à utiliser pour l'autorisation.
2. Cliquez sur Accepter.
Votre application Java s'exécute et appelle l'API Google Apps Script.

Les informations d'autorisation sont stockées dans le système de fichiers. Par conséquent, la prochaine fois que vous exécuterez l'exemple de code, vous ne serez pas invité à vous authentifier.

Guide de démarrage rapide Java Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.