Als Google Chat-App authentifizieren

In dieser Anleitung wird erläutert, wie Sie ein Dienstkonto einrichten und verwenden, um im Namen einer Chat-App auf die Google Chat API zuzugreifen. Zuerst wird erläutert, wie Sie ein Dienstkonto erstellen. Anschließend wird gezeigt, wie Sie ein Script schreiben, mit dem Sie sich über das Dienstkonto bei der Chat API authentifizieren und eine Nachricht in einem Chatbereich posten.

Wenn eine Chat-App mit einem Dienstkonto authentifiziert ist, muss sie Mitglied des Chatbereichs sein, um Daten zu einem Chatbereich abzurufen oder Aktionen darin auszuführen. Wenn Sie beispielsweise Mitglieder eines Gruppenbereichs auflisten oder eine Nachricht in einem Gruppenbereich erstellen möchten, muss die Chat-App selbst Mitglied des Gruppenbereichs sein. Die einzige Ausnahme ist, wenn eine Chat-App einen Gruppenbereich mit App-Authentifizierung erstellt. In diesem Fall erstellt die App den Gruppenbereich und wird dann automatisch Mitglied.

Google Chat API-Methoden, die die App-Autorisierung mit Autorisierungsbereichen unterstützen, deren Namen mit https://www.googleapis.com/auth/chat.app.* beginnen, erfordern eine einmalige Administratorgenehmigung. Für Google Chat API-Methoden, die die App-Autorisierung mit dem Autorisierungsbereich https://www.googleapis.com/auth/chat.bot unterstützen, ist keine zusätzliche Genehmigung erforderlich. Die https://www.googleapis.com/auth/chat.app.*-Autorisierungsbereiche sind in der Entwicklervorschau verfügbar.

Wenn Ihre Chat-App auf Nutzerdaten zugreifen oder Aktionen im Namen eines Nutzers ausführen muss, authentifizieren Sie sich stattdessen als Nutzer. Als Domainadministrator können Sie die domainweite Delegierung von Befugnissen gewähren, um das Dienstkonto einer Chat-App zu autorisieren, auf die Daten Ihrer Nutzer zuzugreifen, ohne dass diese einzeln ihre Einwilligung geben müssen. Weitere Informationen finden Sie unter Mit domainweiter Delegierung authentifizieren und autorisieren.

Weitere Informationen dazu, wann und welche Art der Authentifizierung für Chat-Apps erforderlich ist, finden Sie in der Übersicht zur Authentifizierung und Autorisierung der Chat API unter Erforderliche Authentifizierungstypen.

Vorbereitung

Java

• JDK 1.7 oder höher
• Das Paketverwaltungstool Maven
• Ein initialisiertes Maven-Projekt. Führen Sie den folgenden Befehl in der Befehlszeile aus, um ein neues Projekt zu initialisieren:

  mvn archetype:generate -DgroupId=com.google.chat.app.authsample -DartifactId=auth-sample-app -DarchetypeArtifactId=maven-archetype-quickstart -DarchetypeVersion=1.4 -DinteractiveMode=false

• Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App mit einem HTTP-Dienst erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Informationen zum Hinzufügen der Chat-App finden Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Python

• Python 3.6 oder höher
• Das Paketverwaltungstool pip
• Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App mit einem HTTP-Dienst erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Informationen zum Hinzufügen der Chat-App finden Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Node.js

• Node.js 14 oder höher
• Das npm
• Ein initialisiertes Node.js-Projekt. Wenn Sie ein neues Projekt initialisieren möchten, erstellen Sie einen neuen Ordner, wechseln Sie zu diesem und führen Sie dann den folgenden Befehl in der Befehlszeile aus:

  npm init

• Eine Google Chat App mit aktivierten interaktiven Funktionen. Wenn Sie eine interaktive Chat-App mit einem HTTP-Dienst erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Wie Sie die Chat-App hinzufügen, erfahren Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Apps Script

• Eine Google Chat-App, für die interaktive Funktionen aktiviert sind. Wenn Sie eine interaktive Chat-App in Apps Script erstellen möchten, folgen Sie dieser Kurzanleitung.
• Fügen Sie der Chat-App einen Gruppenbereich hinzu. Wie Sie die Chat-App hinzufügen, erfahren Sie unter Interaktive Funktionen für Google Chat-Apps testen.

Schritt 1: Dienstkonto in der Google Cloud Console erstellen

Erstelle ein Dienstkonto, mit dem deine Chat-App auf Google APIs zugreifen kann.

Dienstkonto erstellen

So erstellen Sie ein Dienstkonto:

Google Cloud Console

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  und dann auf IAM und Verwaltung > Dienstkonten.

   Zur Seite „Dienstkonten“

2. Klicken Sie auf Dienstkonto erstellen.
3. Geben Sie die Details zum Dienstkonto ein und klicken Sie dann auf Erstellen und fortfahren.
   Hinweis: Google erstellt standardmäßig eine eindeutige Dienstkonto-ID. Wenn Sie die ID ändern möchten, ändern Sie sie im Feld „Dienstkonto-ID“.
4. Optional: Weisen Sie Ihrem Dienstkonto Rollen zu, um Zugriff auf die Ressourcen Ihres Google Cloud-Projekts zu gewähren. Weitere Informationen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.
5. Klicken Sie auf Weiter.
6. Optional: Geben Sie Nutzer oder Gruppen ein, die Aktionen mit diesem Dienstkonto verwalten und ausführen können. Weitere Informationen finden Sie unter Identitätswechsel für Dienstkonten verwalten.
7. Klicken Sie auf Fertig. Notieren Sie sich die E-Mail-Adresse für das Dienstkonto.

gcloud-CLI

1. Erstellen Sie das Dienstkonto:

   gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
     --display-name="SERVICE_ACCOUNT_NAME"

2. Optional: Weisen Sie Ihrem Dienstkonto Rollen zu, um Zugriff auf die Ressourcen Ihres Google Cloud-Projekts zu gewähren. Weitere Informationen finden Sie unter Zugriff auf Ressourcen erteilen, ändern und entziehen.

Das Dienstkonto wird auf der Seite „Dienstkonto“ angezeigt. Erstellen Sie als Nächstes einen privaten Schlüssel für das Dienstkonto.

Privaten Schlüssel erstellen

Warnung : In diesem Beispiel wird der Einfachheit halber ein exportierter Dienstkontoschlüssel verwendet. Der Export eines privaten Schlüssels wird in der Produktion nicht empfohlen, da er nicht an einem unsicheren Speicherort wie der Quellcodeverwaltung abgelegt werden sollte.

Weitere Informationen zu sicheren Dienstkontoimplementierungen und Best Practices finden Sie unter Entscheiden, wann Dienstkonten verwendet werden sollen.

So erstellen Sie einen privaten Schlüssel für das Dienstkonto und laden ihn herunter:

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  und dann auf IAM und Verwaltung > Dienstkonten.

   Zur Seite „Dienstkonten“

2. Wählen Sie Ihr Dienstkonto aus.
3. Klicken Sie auf Schlüssel > Schlüssel hinzufügen > Neuen Schlüssel erstellen.
4. Wählen Sie JSON aus und klicken Sie auf Erstellen.

   Ihr neues öffentliches/privates Schlüsselpaar wird generiert und als neue Datei auf Ihren Computer heruntergeladen. Speichern Sie die heruntergeladene JSON-Datei als credentials.json in Ihrem Arbeitsverzeichnis. Diese Datei ist die einzige Kopie dieses Schlüssels. Informationen zum sicheren Speichern deines Schlüssels findest du unter Dienstkontoschlüssel verwalten.

5. Klicken Sie auf Schließen.

Weitere Informationen zu Dienstkonten finden Sie in der Google Cloud IAM-Dokumentation unter Dienstkonten.

Erstellen Sie als Nächstes einen mit Google Workspace Marketplace kompatiblen OAuth-Client für dieses Dienstkonto.

Administratorgenehmigung erhalten

Entwicklervorschau:Diese ist im Rahmen des Google Workspace-Entwicklervorschauprogramms verfügbar, mit dem Vorabzugriff auf bestimmte Funktionen gewährt wird.

Wenn Sie einen Autorisierungsbereich verwenden möchten, der mit https://www.googleapis.com/auth/chat.app.* beginnt und im Rahmen einer Entwicklervorschau verfügbar ist, benötigt Ihre Chat-App eine einmalige Administratorgenehmigung.

Für die Verwendung des Autorisierungsbereichs https://www.googleapis.com/auth/chat.bot ist keine Administratorgenehmigung erforderlich.

Damit Sie die Administratorgenehmigung erhalten, müssen Sie das Dienstkonto Ihrer Chat-App mit den folgenden Informationen vorbereiten:

• Einen mit Google Workspace Marketplace kompatiblen OAuth-Client.
• App-Konfiguration im Google Workspace Marketplace SDK.

Mit Google Workspace Marketplace kompatiblen OAuth-Client erstellen

So erstellen Sie einen mit Google Workspace Marketplace kompatiblen OAuth-Client:

1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  und dann auf IAM und Verwaltung > Dienstkonten.

   Zur Seite „Dienstkonten“

2. Klicken Sie auf das Dienstkonto, das Sie für Ihre Chat-App erstellt haben.

3. Klicke auf Erweiterte Einstellungen.

4. Klicken Sie auf Google Workspace Marketplace-kompatiblen OAuth-Client erstellen.

5. Klicken Sie auf Weiter.

Es wird eine Bestätigungsmeldung angezeigt, dass ein mit Google Workspace Marketplace kompatibler OAuth-Client erstellt wurde.

Chat-App im Google Workspace Marketplace SDK konfigurieren

So konfigurieren Sie die Chat-App im Google Workspace Marketplace SDK:

1. Aktivieren Sie in der Google Cloud Console das Google Workspace Marketplace SDK.

   Google Workspace Marketplace SDK aktivieren

2. Gehen Sie in der Google Cloud Console auf das Menü > APIs und Dienste > Aktivierte APIs und Dienste > Google Workspace Marketplace SDK > App-Konfiguration.

   App-Konfiguration aufrufen

3. Schließen Sie die Seite für die App-Konfiguration ab. Wie Sie Ihre Chat-App konfigurieren, hängt von Ihrer beabsichtigten Zielgruppe und weiteren Faktoren ab. Wie Sie die Seite „App-Konfiguration“ ausfüllen, erfahren Sie unter App im Google Workspace Marketplace SDK konfigurieren. Geben Sie für diesen Leitfaden die folgenden Informationen ein:

   1. Wählen Sie unter Sichtbarkeit der App die Option Privat aus.
   2. Wählen Sie unter Installationseinstellungen die Option Individuelle und Administratorinstallation aus.
   3. Wählen Sie unter App-Integrationen die Option Chat-App aus.

   4. Geben Sie unter OAuth-Bereiche alle Authentifizierungsbereiche ein, die Ihre Chat-App verwendet.

      Warnung: Geben Sie nicht den Autorisierungsbereich https://www.googleapis.com/auth/chat.bot ein, da dieser auf dieser Seite nicht konfiguriert werden muss. Da in diesem Leitfaden der Autorisierungsbereich https://www.googleapis.com/auth/chat.bot verwendet wird, müssen Sie hier nichts eingeben, um das Beispiel auszuführen.

   5. Geben Sie unter Entwicklerinformationen den Namen des Entwicklers, die URL der Website des Entwicklers und die E-Mail-Adresse des Entwicklers ein.

   6. Klicken Sie auf Entwurf speichern.

Administratorgenehmigung einholen

Ihr Dienstkonto ist jetzt so konfiguriert, dass es eine Administratorgenehmigung erhält. Wenden Sie sich an einen Google Workspace-Administrator, der die Genehmigung erteilen kann. Folgen Sie dazu der Anleitung unter Autorisierung für Chat-Apps einrichten.

Schritt 2: Google-Clientbibliothek und andere Abhängigkeiten installieren

Installieren Sie die Google-Clientbibliothek und andere für das Projekt erforderliche Abhängigkeiten.

Java

Wenn Sie Ihrem Maven-Projekt die Google-Clientbibliotheken und andere erforderliche Abhängigkeiten hinzufügen möchten, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie die folgenden Abhängigkeiten hinzu:

<dependencies>
  <!-- ... existing dependencies ... -->
  <dependency>
    <groupId>com.google.apis</groupId>
    <artifactId>google-api-services-chat</artifactId>
    <version>v1-rev20230905-2.0.0</version>
  </dependency>
  <dependency>
    <groupId>com.google.auth</groupId>
    <artifactId>google-auth-library-oauth2-http</artifactId>
    <version>1.19.0</version>
  </dependency>
  <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.10.1</version>
  </dependency>
</dependencies>

Python

Wenn Sie die Google-Clientbibliotheken für Python noch nicht installiert haben, führen Sie den folgenden Befehl in der Befehlszeile aus:

pip3 install --upgrade google-api-python-client google-auth

Node.js

Um Ihrem Node.js-Projekt die Google-Clientbibliotheken hinzuzufügen, wechseln Sie in das Verzeichnis Ihres Projekts und führen Sie in der Befehlszeile den folgenden Befehl aus:

npm install "@googleapis/chat"

Apps Script

In diesem Beispiel wird die OAuth2-Bibliothek für Apps Script verwendet, um ein JWT-Token für die Dienstkontoauthentifizierung zu generieren. So fügen Sie die Bibliothek Ihrem Apps Script-Projekt hinzu:

1. Klicken Sie links auf Editor .
2. Klicken Sie links neben Bibliotheken auf Bibliothek hinzufügen .
3. Geben Sie die Script-ID 1B7FSrk5Zi6L1rSxxTDgDEUsPzlukDsi4KGuTMorsTQHhGBzBkMun4iDF ein.
4. Klicken Sie auf Suchen und dann auf Hinzufügen.

In diesem Beispiel wird der erweiterte Chatdienst verwendet, um die Google Chat API aufzurufen. So aktivieren Sie den Dienst für Ihr Apps Script-Projekt:

1. Klicken Sie links auf Editor .
2. Klicken Sie links neben Dienste auf Dienst hinzufügen .
3. Wählen Sie Google Chat API aus.
4. Wählen Sie unter Version die Option v1 aus.
5. Klicken Sie auf Hinzufügen.

Sie können jede Sprache verwenden, die von unseren Clientbibliotheken unterstützt wird.

Schritt 3: Script schreiben, das die Authentifizierung bei der Chat API über das Dienstkonto vornimmt

Im folgenden Code wird mit einem Dienstkonto bei der Chat API authentifiziert und dann eine Nachricht in einem Chatbereich gepostet:

Hinweis: Weitere Informationen zum Testen eines Beispiels, das sich mit einem https://www.googleapis.com/auth/chat.app.*-Autorisierungsbereich authentifiziert, der im Rahmen einer Entwicklervorschau verfügbar ist, finden Sie unter Gruppenbereich als Chat-App erstellen.

Java

1. Öffnen Sie im Verzeichnis Ihres Projekts die Datei src/main/java/com/google/chat/app/authsample/App.java.

2. Ersetzen Sie den Inhalt von App.java durch den folgenden Code:

   package com.google.chat.app.authsample;
   
   import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
   import com.google.api.client.http.HttpRequestInitializer;
   import com.google.api.client.json.gson.GsonFactory;
   import com.google.api.services.chat.v1.HangoutsChat;
   import com.google.api.services.chat.v1.model.Message;
   import com.google.auth.http.HttpCredentialsAdapter;
   import com.google.auth.oauth2.GoogleCredentials;
   
   /**
    * Authenticates with Chat API using service account credentials,
    * then creates a Chat message.
    */
   public class App {
       // Specify required scopes.
       private static final String CHAT_SCOPE = "https://www.googleapis.com/auth/chat.bot";
   
       // Specify service account details.
       private static final String PRIVATE_KEY_RESOURCE_URI = "/credentials.json";
   
       public static void main( String[] args ) {
           try {
               // Run app.
               Message response = App.createChatMessage();
               // Print details about the created message.
               System.out.println(response);
           } catch (Exception e) {
               e.printStackTrace();
           }
       }
   
       private static Message createChatMessage() throws Exception {
           // Build the Chat API client and authenticate with the service account.
           GoogleCredentials credentials = GoogleCredentials.fromStream(
               App.class.getResourceAsStream(PRIVATE_KEY_RESOURCE_URI))
               .createScoped(CHAT_SCOPE);
           HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(credentials);
           HangoutsChat chatService = new HangoutsChat.Builder(
               GoogleNetHttpTransport.newTrustedTransport(),
               GsonFactory.getDefaultInstance(),
               requestInitializer)
               .setApplicationName("auth-sample-app")
               .build();
   
           // The space to create the message in.
           //
           // Replace SPACE_NAME with a space name.
           // Obtain the space name from the spaces resource of Chat API,
           // or from a space's URL.
           String spaceName = "spaces/SPACE_NAME";
   
           // Create a Chat message.
           Message message = new Message().setText("Hello, world!");
           return chatService.spaces().messages().create(spaceName, message).execute();
       }
   }
   

3. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen.

4. Erstellen Sie im Verzeichnis Ihres Projekts ein neues Unterverzeichnis mit dem Namen resources.

5. Achten Sie darauf, dass die Datei mit dem privaten Schlüssel für Ihr Dienstkonto den Namen credentials.json hat, und kopieren Sie sie in das Unterverzeichnis resources.

6. Wenn Sie Maven so konfigurieren möchten, dass die Datei mit dem privaten Schlüssel in das Projektpaket aufgenommen wird, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie dem Abschnitt <build> die folgende Konfiguration hinzu:

   <build>
     <!-- ... existing configurations ... -->
     <resources>
       <resource>
         <directory>resources</directory>
       </resource>
     </resources>
   </build>
   

7. Um Maven so zu konfigurieren, dass die Abhängigkeiten in das Projektpaket aufgenommen und die Hauptklasse der Anwendung ausgeführt wird, bearbeiten Sie die Datei pom.xml im Verzeichnis Ihres Projekts und fügen Sie dem Abschnitt <plugins> die folgende Konfiguration hinzu:

   <plugins>
     <!-- ... existing configurations ... -->
     <plugin>
       <artifactId>maven-assembly-plugin</artifactId>
       <configuration>
         <archive>
           <manifest>
             <mainClass>com.google.chat.app.authsample.App</mainClass>
           </manifest>
         </archive>
         <descriptorRefs>
           <descriptorRef>jar-with-dependencies</descriptorRef>
         </descriptorRefs>
       </configuration>
     </plugin>
   </plugins>
   

Python

1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_app_auth.py.

2. Fügen Sie den folgenden Code in chat_app_auth.py ein:

   from apiclient.discovery import build
   from google.oauth2 import service_account
   
   # Specify required scopes.
   SCOPES = ['https://www.googleapis.com/auth/chat.bot']
   
   # Specify service account details.
   creds = service_account.Credentials.from_service_account_file(
       'credentials.json', scopes=SCOPES)
   
   # Build the URI and authenticate with the service account.
   chat = build('chat', 'v1', credentials=creds)
   
   # Create a Chat message.
   result = chat.spaces().messages().create(
   
       # The space to create the message in.
       #
       # Replace SPACE_NAME with a space name.
       # Obtain the space name from the spaces resource of Chat API,
       # or from a space's URL.
       parent='spaces/SPACE_NAME',
   
       # The message to create.
       body={'text': 'Hello, world!'}
   
   ).execute()
   
   # Prints details about the created message.
   print(result)
   

3. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen. Die Datei mit dem privaten Schlüssel für Ihr Dienstkonto muss den Namen credentials.json haben.

Node.js

1. Erstellen Sie im Verzeichnis Ihres Projekts eine Datei mit dem Namen chat_app_auth.js.

2. Fügen Sie in chat_app_auth.js den folgenden Code ein:

   const chat = require('@googleapis/chat');
   
   async function createMessage() {
     const auth = new chat.auth.GoogleAuth({
   
       // Specify service account details.
       keyFilename: 'credentials.json',
   
       // Specify required scopes.
       scopes: ['https://www.googleapis.com/auth/chat.bot']
   
     });
     const authClient = await auth.getClient();
   
     // Create the Chat API client and authenticate with the service account.
     const chatClient = await chat.chat({
       version: 'v1',
       auth: authClient
     });
   
     // Create a Chat message.
     const result = await chatClient.spaces.messages.create({
   
       // The space to create the message in.
       //
       // Replace SPACE_NAME with a space name.
       // Obtain the space name from the spaces resource of Chat API,
       // or from a space's URL.
       parent: 'spaces/SPACE_NAME',
   
       // The message to create.
       requestBody: { 'text': 'Hello, world!' }
   
     });
     return result;
   }
   
   // Execute function then print details about the created message.
   createMessage().then(console.log);
   

3. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen. Die Datei mit dem privaten Schlüssel für Ihr Dienstkonto muss den Namen credentials.json haben.

Apps Script

1. Bearbeiten Sie im Apps Script-Editor die Datei appsscript.json und fügen Sie den OAuth-Bereich hinzu, der für externe Anfragen zum Abrufen des OAuth-Tokens des Dienstkontos erforderlich ist:

     "oauthScopes": [
       "https://www.googleapis.com/auth/script.external_request"
     ]
   

2. Speichern Sie den folgenden Code in einer Datei mit dem Namen ChatAppAuth.gs in Ihrem Apps Script-Projekt:

   // Specify the contents of the file credentials.json.
   const CREDENTIALS = CREDENTIALS;
   
   const SCOPE = 'https://www.googleapis.com/auth/chat.bot';
   
   // The space to create the message in.
   //
   // Replace SPACE_NAME with a space name.
   // Obtain the space name from the spaces resource of Chat API,
   // or from a space's URL.
   const PARENT = 'spaces/SPACE_NAME'
   
   /**
    * Authenticates with Chat API using app credentials, then posts a message.
    */
   function createMessageWithAppCredentials() {
     try {
       const service = getService_();
       if (!service.hasAccess()) {
         console.error(service.getLastError());
         return;
       }
   
       // Specify the message to create.
       const message = {'text': 'Hello world!'};
   
       // Call Chat API with a service account to create a message.
       const result = Chat.Spaces.Messages.create(
           message,
           PARENT,
           {},
           // Authenticate with the service account token.
           {'Authorization': 'Bearer ' + service.getAccessToken()});
   
       // Log details about the created message.
       console.log(result);
   
     } catch (err) {
       // TODO (developer) - Handle exception.
       console.log('Failed to create message with error %s', err.message);
     }
   }
   
   /**
    * Configures the OAuth library to authenticate with the service account.
    */
   function getService_() {
     return OAuth2.createService(CREDENTIALS.client_email)
         .setTokenUrl('https://oauth2.googleapis.com/token')
         .setPrivateKey(CREDENTIALS.private_key)
         .setIssuer(CREDENTIALS.client_email)
         .setSubject(CREDENTIALS.client_email)
         .setScope(SCOPE)
         .setPropertyStore(PropertiesService.getScriptProperties());
   }
   

3. Ersetzen Sie im Code CREDENTIALS durch den Inhalt der Datei credentials.json.

4. Ersetzen Sie im Code SPACE_NAME durch den Namen eines Gruppenbereichs. Sie können ihn über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs abrufen.

Schritt 4: Vollständiges Beispiel ausführen

Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

Java

mvn compile assembly:single
java -jar target/auth-sample-app-1.0-SNAPSHOT-jar-with-dependencies.jar

Python

python3 chat_app_auth.py

Node.js

node chat_app_auth.js

Apps Script

Öffnen Sie die Datei ChatAppAuth.gs im Apps Script Editor und klicken Sie auf Ausführen.

Ihr Script sendet eine authentifizierte Anfrage an die Chat API, die als Antwort eine Nachricht in einem Chatbereich als Chat-App postet.

Beispiel beheben

In diesem Abschnitt werden häufige Probleme beschrieben, die beim Ausführen dieses Beispiels auftreten können.

Sie sind nicht berechtigt, diese App zu verwenden

Beim Ausführen des Scripts wird möglicherweise folgende Fehlermeldung angezeigt:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}/messages?alt=json returned "You are not permitted to use this app". Details: "You are not permitted to use this app">

Diese Fehlermeldung bedeutet, dass die Chat-App nicht berechtigt ist, Chatnachrichten im angegebenen Chatbereich zu erstellen.

Zum Beheben des Fehlers fügen Sie die Chat-App dem im Skript angegebenen Chatbereich hinzu.

Der Administrator muss der Anwendung den erforderlichen OAuth-Autorisierungsbereich für diese Aktion gewähren

Beim Ausführen des Scripts wird möglicherweise folgende Fehlermeldung angezeigt:

<HttpError 403 when requesting https://chat.googleapis.com/v1/spaces/{space}?alt=json returned "The administrator must grant the app the required OAuth authorization scope for this action.". Details: "The administrator must grant the app the required OAuth authorization scope for this action.">

Diese Fehlermeldung bedeutet, dass ein Google Workspace-Administrator der Chat-App noch keine einmalige Genehmigung erteilt hat, Autorisierungsbereiche zu verwenden, die mit dem Namen https://www.googleapis.com/auth/chat.app.* beginnen.

So beheben Sie den Fehler:

• Bitten Sie den Google Workspace-Administrator, Ihrer Chat-App die Genehmigung zu erteilen. Wenn Sie diesen Fehler in der Logik Ihrer Chat-App behandeln, können Sie eine Nachricht senden, in der Sie angeben, dass die Chat-App die Administratorgenehmigung benötigt, um die angeforderte Aktion auszuführen. Beispiel: To perform this action, I need approval. <https://support.google.com/a?p=chat-app-auth|Learn more>.
• Wenn die Google Chat API-Methode den Autorisierungsbereich https://www.googleapis.com/auth/chat.bot unterstützt, für den keine Administratorgenehmigung erforderlich ist, können Sie ihn stattdessen verwenden. Informationen dazu, welche Autorisierungsbereiche eine Methode unterstützt, finden Sie in der Referenzdokumentation zur Google Chat API.

Weitere Informationen

• Weitere Informationen zu den Funktionen der Chat API finden Sie in der Referenzdokumentation.
• Wenn Sie OAuth-Autorisierungsbereiche verwenden, die mit https://www.googleapis.com/auth/chat.app.* beginnen, erfahren Sie, wie Administratoren eine einmalige Genehmigung erteilen.