Java-Kurzanleitung

Erstellen Sie eine Java-Befehlszeilenanwendung, die Anfragen an die Google Chat API sendet.

In Kurzanleitungen wird beschrieben, wie Sie eine App einrichten und ausführen, die eine Google Workspace API aufruft. In dieser Kurzanleitung wird ein vereinfachtes Authentifizierungsverfahren verwendet, das für eine Testumgebung geeignet ist. Für eine Produktionsumgebung empfehlen wir, sich mit Authentifizierung und Autorisierung vertraut zu machen, bevor Sie die für Ihre App geeigneten Zugangsdaten auswählen.

In dieser Kurzanleitung werden die von Google Workspace empfohlenen API-Clientbibliotheken verwendet, um einige Details des Authentifizierungs- und Autorisierungsablaufs zu verarbeiten.

Lernziele

  • die Umgebung einrichten
  • Beispiel einrichten
  • Führen Sie das Beispiel aus.

Vorbereitung

Umgebung einrichten

Richten Sie Ihre Umgebung ein, um diese Kurzanleitung durchzuarbeiten.

API aktivieren

Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.

  • Aktivieren Sie in der Google Cloud Console die Google Chat API.

    API aktivieren

Wenn Sie für diese Kurzanleitung ein neues Google Cloud-Projekt verwenden, konfigurieren Sie den OAuth-Zustimmungsbildschirm. Wenn Sie diesen Schritt für Ihr Cloud-Projekt bereits ausgeführt haben, fahren Sie mit dem nächsten Abschnitt fort.

  1. Rufen Sie in der Google Cloud Console das Menü  > > Branding auf.

    Zu Branding

  2. Wenn Sie die bereits konfiguriert haben, können Sie die folgenden Einstellungen für den OAuth-Zustimmungsbildschirm unter Branding, Zielgruppe und Datenzugriff konfigurieren. Wenn Sie die Meldung noch nicht konfiguriert sehen, klicken Sie auf Jetzt starten:
    1. Geben Sie unter App-Informationen im Feld App-Name einen Namen für die App ein.
    2. Wählen Sie unter E-Mail-Adresse des Nutzersupports eine Support-E-Mail-Adresse aus, über die Nutzer Sie mit Fragen zu ihrer Einwilligung kontaktieren können.
    3. Klicken Sie auf Weiter.
    4. Wählen Sie unter Zielgruppe die Option Intern aus.
    5. Klicken Sie auf Weiter.
    6. Geben Sie unter Kontaktdaten eine E-Mail-Adresse ein, unter der Sie über Änderungen an Ihrem Projekt benachrichtigt werden können.
    7. Klicken Sie auf Weiter.
    8. Sehen Sie sich unter Fertigstellen die Nutzerdatenrichtlinie für Google API-Dienste an. Wenn Sie damit einverstanden sind, wählen Sie Ich stimme der Nutzerdatenrichtlinie für Google API-Dienste zu aus.
    9. Klicken Sie auf Weiter.
    10. Klicken Sie auf Erstellen.
  3. Sie können das Hinzufügen von Bereichen vorerst überspringen. Wenn Sie in Zukunft eine App für die Verwendung außerhalb Ihrer Google Workspace-Organisation erstellen, müssen Sie den Nutzertyp in Extern ändern. Fügen Sie dann die Autorisierungsbereiche hinzu, die für Ihre App erforderlich sind. Weitere Informationen finden Sie in der vollständigen Anleitung OAuth-Zustimmung konfigurieren.

Anmeldedaten für eine Desktopanwendung autorisieren

Für die Authentifizierung von Endnutzern und für den Zugriff auf Nutzerdaten in Ihrer Anwendung müssen Sie mindestens eine OAuth 2.0-Client-ID erstellen. Eine Client-ID wird zur Identifizierung einer einzelnen Anwendung bei Googles OAuth-Servern verwendet. Wenn Ihre App auf mehreren Plattformen ausgeführt wird, müssen Sie für jede Plattform eine separate Client-ID erstellen.
  1. Rufen Sie in der Google Cloud Console das Menü  > > Clients auf.

    Zu „Clients“

  2. Klicken Sie auf Create Client.
  3. Klicken Sie auf Anwendungstyp > Desktop-App.
  4. Geben Sie im Feld Name einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.
  5. Klicken Sie auf Erstellen.

    Die neu erstellten Anmeldedaten werden unter „OAuth 2.0-Client-IDs“ angezeigt.

  6. Speichern Sie die heruntergeladene JSON-Datei als credentials.json und verschieben Sie die Datei in Ihr Arbeitsverzeichnis.

Google Chat App konfigurieren

Wenn Sie die Google Chat API aufrufen möchten, müssen Sie eine Google Chat-App konfigurieren. Bei allen Schreibanfragen werden der Google Chat-App in der Benutzeroberfläche die folgenden Informationen zugewiesen.

  1. Rufen Sie in der Google Cloud Console die Seite Konfiguration der Chat API auf:

    Zur Seite „Chat API-Konfiguration“

  2. Geben Sie unter Application info (Anwendungsinformationen) Folgendes ein:

    1. Geben Sie im Feld App-Name Chat API quickstart app ein.
    2. Geben Sie im Feld Avatar-URL den Wert https://developers.google.com/chat/images/quickstart-app-avatar.png ein.
    3. Geben Sie im Feld Beschreibung den Text Quickstart for calling the Chat API ein.

  3. Klicken Sie unter Interaktive Funktionen auf die Ein/Aus-Schaltfläche Interaktive Funktionen aktivieren, um interaktive Funktionen für die Chat-App zu deaktivieren.

  4. Klicken Sie auf Speichern.

Arbeitsbereich vorbereiten

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine neue Projektstruktur:

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

  2. Kopieren Sie im Verzeichnis src/main/resources/ die Datei credentials.json, die Sie zuvor heruntergeladen haben.

  3. Öffnen Sie die Standarddatei build.gradle und ersetzen Sie ihren Inhalt durch den folgenden Code:

    chat/quickstart/build.gradle
    apply plugin: 'java'
apply plugin: 'application'

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

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.google.auth:google-auth-library-oauth2-http:1.23.0'
    implementation 'com.google.api-client:google-api-client:1.33.0'
    implementation 'com.google.api.grpc:proto-google-cloud-chat-v1:0.8.0'
    implementation 'com.google.api:gax:2.48.1'
    implementation 'com.google.cloud:google-cloud-chat:0.1.0'
    implementation 'com.google.oauth-client:google-oauth-client-jetty:1.34.1'
}

Beispielanwendung einrichten

  1. Erstellen Sie im Verzeichnis src/main/java/ eine neue Java-Datei mit einem Namen, der dem mainClassName-Wert in Ihrer build.gradle-Datei entspricht.

  2. Fügen Sie der neuen Java-Datei den folgenden Code hinzu:

    chat/quickstart/src/main/java/ChatQuickstart.java
    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.json.JsonFactory;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.client.util.store.FileDataStoreFactory;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.auth.Credentials;
import com.google.auth.oauth2.AccessToken;
import com.google.auth.oauth2.UserCredentials;
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ChatServiceSettings;
import com.google.chat.v1.ListSpacesRequest;
import com.google.chat.v1.Space;
import com.google.protobuf.util.JsonFormat;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Collections;
import java.util.Date;
import java.util.List;

/* class to demonstrate use of Google Chat API spaces list API */
public class ChatQuickstart {
  /** Directory to store authorization tokens for this application. */
  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 tokens/ folder.
   */
  private static final List<String> SCOPES =
      Collections.singletonList("https://www.googleapis.com/auth/chat.spaces.readonly");

  /** Global instance of the JSON factory. */
  private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();

  private static final String CREDENTIALS_FILE_PATH = "/credentials.json";

  /**
   * Run the OAuth2 flow for local/installed app.
   *
   * @return An authorized Credential object.
   * @throws IOException If the credentials.json file cannot be found.
   */
  private static Credentials getCredentials() throws Exception {
    // Load client secrets.
    InputStream credentialsFileInputStream =
        ChatQuickstart.class.getResourceAsStream(CREDENTIALS_FILE_PATH);
    if (credentialsFileInputStream == null) {
      throw new FileNotFoundException("Credentials file resource not found.");
    }
    GoogleClientSecrets clientSecrets =
        GoogleClientSecrets.load(JSON_FACTORY, new InputStreamReader(credentialsFileInputStream));

    // Set up authorization code flow.
    GoogleAuthorizationCodeFlow flow =
        new GoogleAuthorizationCodeFlow.Builder(
                GoogleNetHttpTransport.newTrustedTransport(), JSON_FACTORY, clientSecrets, SCOPES)
            // Set these two options to generate refresh token alongside access token.
            .setDataStoreFactory(new FileDataStoreFactory(new File(TOKENS_DIRECTORY_PATH)))
            .setAccessType("offline")
            .build();

    // Authorize.
    Credential credential =
        new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");

    // Build and return an authorized Credential object
    AccessToken accessToken =
        new AccessToken(
            credential.getAccessToken(),
            new Date(
                // put the actual expiry date of access token here
                System.currentTimeMillis()));
    return UserCredentials.newBuilder()
        .setAccessToken(accessToken)
        .setRefreshToken(credential.getRefreshToken())
        .setClientId(clientSecrets.getInstalled().getClientId())
        .setClientSecret(clientSecrets.getInstalled().getClientSecret())
        .build();
  }

  public static void main(String... args) throws Exception {
    // Override default service settings to supply user credentials.
    Credentials credentials = getCredentials();

    // Create the ChatServiceSettings with the credentials
    ChatServiceSettings chatServiceSettings =
        ChatServiceSettings.newBuilder()
            .setCredentialsProvider(FixedCredentialsProvider.create(credentials))
            .build();

    try (ChatServiceClient chatServiceClient = ChatServiceClient.create(chatServiceSettings)) {
      ListSpacesRequest request =
          ListSpacesRequest.newBuilder()
              // Filter spaces by space type (SPACE or GROUP_CHAT or
              // DIRECT_MESSAGE).
              .setFilter("spaceType = \"SPACE\"")
              .build();

      // Iterate over results and resolve additional pages automatically.
      for (Space response : chatServiceClient.listSpaces(request).iterateAll()) {
        System.out.println(JsonFormat.printer().print(response));
      }
    }
  }
}

Beispiel ausführen

  1. So führen Sie das Beispiel aus:

    gradle run
  1. Wenn Sie das Beispiel zum ersten Mal ausführen, werden Sie aufgefordert, den Zugriff zu autorisieren:
    1. Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, werden Sie dazu aufgefordert. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie ein Konto für die Autorisierung aus.
    2. Klicken Sie auf Akzeptieren.

    Ihre Java-Anwendung wird ausgeführt und ruft die Google Chat API auf.

    Autorisierungsinformationen werden im Dateisystem gespeichert. Wenn Sie den Beispielcode das nächste Mal ausführen, werden Sie daher nicht zur Autorisierung aufgefordert.

Nächste Schritte