Als Google Chat-Nutzer authentifizieren und autorisieren

In diesem Leitfaden wird erläutert, wie Sie OAuth 2.0 mit den Google-Anmeldedaten von Nutzern verwenden, um auf die Chat API zuzugreifen. Durch die Authentifizierung und Autorisierung mit Nutzeranmeldedaten können Chat-Apps auf Nutzerdaten zugreifen und im Namen des authentifizierten Nutzers Aktionen ausführen. Durch die Authentifizierung im Namen eines Nutzers hat die App dieselben Berechtigungen wie dieser Nutzer und kann Aktionen ausführen, als wären sie von diesem Nutzer ausgeführt worden.

Nach der Authentifizierung und Autorisierung eines API-Aufrufs mit Nutzeranmeldedaten können Chat-Apps Folgendes tun:

Wenn eine App eine Aktion mit Nutzerauthentifizierung ausführt (z. B. das Erstellen eines Gruppenbereichs), wird in Google Chat eine Attributionsmeldung angezeigt, in der der Name der App angezeigt wird, die die Aktion für den Nutzer ausgeführt hat, der sie autorisiert hat.

In der Google Chat App wird ein Gruppenbereich für einen Nutzer erstellt.
Abbildung 1: Die Attributionsnachricht, die in Google Chat angezeigt wird, wenn eine Chat-App im Namen eines Nutzers einen Gruppenbereich erstellt.

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.

Als Google Workspace-Administrator authentifizieren und autorisieren

In diesem Abschnitt wird erläutert, wie Google Workspace-Administratoren Google Chat-Apps und ‑Gruppenbereiche in ihrer Organisation mithilfe der Nutzerauthentifizierung verwalten können.

Authentifizierung und Autorisierung mit der domainweiten Delegierung

Wenn Sie Domainadministrator sind, können Sie eine domainweite Delegierung von Befugnissen gewähren, um das Dienstkonto einer Anwendung für den Zugriff auf die Daten Ihrer Nutzer zu autorisieren, ohne dass jeder Nutzer seine Einwilligung geben muss. Nachdem Sie die domainweite Delegierung konfiguriert haben, kann das Dienstkonto die Identität eines Nutzerkontos übernehmen. Auch wenn ein Dienstkonto für die Authentifizierung verwendet wird, wird bei der domainweiten Delegierung die Identität eines Nutzers übernommen. Sie gilt daher als Nutzerauthentifizierung. Sie können die domainweite Delegierung für alle Funktionen verwenden, für die eine Nutzerauthentifizierung erforderlich ist.

Authentifizierung und Autorisierung mit Administratorberechtigungen

Wenn Sie ein Domainadministrator oder ein delegierter Administrator mit Administratorberechtigungen sind, können Sie Ihre Aufrufe an die Google Chat API mit Administratorberechtigungen authentifizieren und autorisieren, indem Sie in den Anfragen der entsprechenden Methoden das Feld useAdminAccess festlegen. Weitere Informationen finden Sie in der API-Referenzdokumentation.

Wenn eine Google Chat-App eine Aktion mit Administratorberechtigungen ausführt, wird Nutzern in Google Chat nicht der Name der Chat-App angezeigt, die die Aktion ausgeführt hat, und auch nicht der Name des Administrators, der sie autorisiert hat. Stattdessen wird nur angezeigt, dass die Aktion vom Administrator der Organisation ausgeführt wird.

Vorbereitung

Java

  • Ein Google Workspace-Konto für Unternehmen oder Organisationen mit Zugriff auf Google Chat.
  • Google Cloud-Projekt erstellen
  • Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, Symbol und einer Beschreibung für Ihre Chat-App.
  • 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

Python

Node.js

Apps Script

Schritt 1: OAuth-Zustimmungsbildschirm konfigurieren, Bereiche angeben und App registrieren

Wenn Sie OAuth 2.0 für die Autorisierung verwenden, zeigt Google Nutzern einen Zustimmungsbildschirm an, der eine Übersicht Ihres Projekts und dessen Richtlinien sowie die angeforderten Autorisierungsbereiche enthält. Wenn Sie den OAuth-Zustimmungsbildschirm Ihrer App konfigurieren, legen Sie fest, was Google Nutzern und App-Rezensenten anzeigt. Außerdem wird Ihre App registriert, damit Sie sie später veröffentlichen können.

Für alle Apps, die OAuth 2.0 verwenden, ist eine Konfiguration des Einwilligungsbildschirms erforderlich. Sie müssen jedoch nur Bereiche für Apps auflisten, die von Personen außerhalb Ihrer Google Workspace-Organisation verwendet werden.

  1. Gehen Sie in der Google Cloud Console zu „Menü“  > APIs und Dienste > OAuth-Zustimmungsbildschirm.

    Zum OAuth-Zustimmungsbildschirm

  2. Wählen Sie den Nutzertyp für Ihre App aus und klicken Sie auf Erstellen.

  3. Füllen Sie das Formular zur App-Registrierung aus und klicken Sie dann auf Speichern und fortfahren.

  4. Klicken Sie auf Bereiche hinzufügen oder entfernen. Fügen Sie die für Ihre App erforderlichen Autorisierungsbereiche hinzu und bestätigen Sie sie. Klicken Sie dann auf Aktualisieren und dann auf Speichern und fortfahren.

  5. Sehen Sie sich die Zusammenfassung der App-Registrierung an. Klicken Sie auf Bearbeiten, um Änderungen vorzunehmen, oder auf Zurück zum Dashboard.

Schritt 2: OAuth-Client-ID-Anmeldedaten in der Google Cloud Console erstellen

Für die Authentifizierung als Endnutzer 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, z. B. Android, iOS und Web, müssen Sie für jede Plattform eine separate Client-ID erstellen.

OAuth-Client-ID-Anmeldedaten erstellen

Wählen Sie den Anwendungstyp aus, um eine detaillierte Anleitung zum Erstellen einer OAuth-Client-ID aufzurufen:

Webanwendung

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
  3. Klicken Sie auf Anwendungstyp > Webanwendung.
  4. Geben Sie im Feld Name einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.
  5. Fügen Sie autorisierte URIs zu Ihrer App hinzu:
    • Clientseitige Apps (JavaScript): Klicken Sie unter Autorisierte JavaScript-Quellen auf URI hinzufügen. Geben Sie dann einen URI für Browseranfragen ein. Damit werden die Domains angegeben, von denen aus Ihre Anwendung API-Anfragen an den OAuth 2.0-Server senden kann.
    • Serverseitige Apps (Java, Python usw.): Klicken Sie unter Autorisierte Weiterleitungs-URIs auf URI hinzufügen. Geben Sie dann einen Endpunkt-URI ein, an den der OAuth 2.0-Server Antworten senden kann.
  6. Klicken Sie auf Erstellen. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf sind Ihre neue Client-ID und Ihr Clientschlüssel zu sehen.

    Notieren Sie sich die Client-ID. Clientschlüssel werden nicht für Webanwendungen verwendet.

  7. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter OAuth 2.0-Client-IDs angezeigt.

Android

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
  3. Klicken Sie auf Anwendungstyp > Android.
  4. Geben Sie im Feld „Name“ einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.
  5. Geben Sie im Feld „Paketname“ den Paketnamen aus Ihrer AndroidManifest.xml-Datei ein.
  6. Geben Sie in das Feld „SHA-1-Zertifikatfingerabdruck“ den generierten SHA-1-Zertifikatfingerabdruck ein.
  7. Klicken Sie auf Erstellen. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf ist Ihre neue Client-ID zu sehen.
  8. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter „OAuth 2.0-Client-IDs“ angezeigt.

iOS

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
  3. Klicken Sie auf Anwendungstyp > iOS.
  4. Geben Sie im Feld „Name“ einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.
  5. Geben Sie im Feld „Bundle-ID“ die Bundle-ID ein, die in der Info.plist-Datei der App aufgeführt ist.
  6. Optional: Wenn Ihre App im Apple App Store angezeigt wird, geben Sie die App-Store-ID ein.
  7. Optional: Geben Sie im Feld „Team-ID“ den eindeutigen 10-stelligen String ein, der von Apple generiert und Ihrem Team zugewiesen wurde.
  8. Klicken Sie auf Erstellen. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf sind Ihre neue Client-ID und Ihr Clientschlüssel zu sehen.
  9. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter „OAuth 2.0-Client-IDs“ angezeigt.

Chrome App

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
  3. Klicken Sie auf Anwendungstyp > Chrome-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. Geben Sie im Feld „App-ID“ den eindeutigen 32-stelligen ID-String Ihrer App ein. Sie finden diesen ID-Wert in der Chrome Web Store-URL Ihrer App und im Chrome Web Store-Entwickler-Dashboard.
  6. Klicken Sie auf Erstellen. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf sind Ihre neue Client-ID und Ihr Clientschlüssel zu sehen.
  7. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter „OAuth 2.0-Client-IDs“ angezeigt.

Desktopanwendung

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
  3. Klicken Sie auf Anwendungstyp > Desktopanwendung.
  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. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf sind Ihre neue Client-ID und Ihr Clientschlüssel zu sehen.
  6. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter OAuth 2.0-Client-IDs angezeigt.

Fernsehgeräte und Geräte mit begrenzter Eingabe

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
  3. Klicken Sie auf App-Typ > Fernseher und Geräte mit eingeschränkter Eingabe.
  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. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf sind Ihre neue Client-ID und Ihr Clientschlüssel zu sehen.
  6. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter „OAuth 2.0-Client-IDs“ angezeigt.

Universal Windows Platform (UWP)

  1. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
  3. Klicken Sie auf Anwendungstyp > Universal Windows Platform (UWP).
  4. Geben Sie im Feld „Name“ einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.
  5. Geben Sie im Feld „Store-ID“ die eindeutige 12-stellige Microsoft Store-ID Ihrer App ein. Sie finden diese ID in der Microsoft Store-URL Ihrer App und im Partner Center.
  6. Klicken Sie auf Erstellen. Der Bildschirm „OAuth-Client erstellt“ wird angezeigt. Darauf sind Ihre neue Client-ID und Ihr Clientschlüssel zu sehen.
  7. Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter „OAuth 2.0-Client-IDs“ angezeigt.

JSON-Datei mit dem Clientschlüssel herunterladen

Die Clientschlüsseldatei ist eine JSON-Darstellung der OAuth-Client-ID-Anmeldedaten, auf die Ihre Chat-App beim Bereitstellen von Anmeldedaten verweisen kann.

  1. Gehen Sie in der Google Cloud Console zu „Menü“  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie unter OAuth 2.0-Client-IDs auf die von Ihnen erstellte Client-ID.

  3. Klicken Sie auf JSON herunterladen.

  4. Speichern Sie die Datei als client_secrets.json.

Schritt 3: 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.oauth-client</groupId>
    <artifactId>google-oauth-client-jetty</artifactId>
    <version>1.34.1</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-oauthlib

Node.js

Wenn Sie Ihrem Node.js-Projekt die Google-Clientbibliotheken und andere erforderliche Abhängigkeiten hinzufügen möchten, wechseln Sie zum Verzeichnis Ihres Projekts und führen Sie den folgenden Befehl in der Befehlszeile aus:

npm install "@googleapis/chat" open server-destroy

Apps Script

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 4: Script schreiben, das die Chat API aufruft

Der Aufruf einer API mit OAuth-Autorisierung ist ein mehrstufiger Vorgang. In Web- oder Desktopanwendungen sieht der Prozess in der Regel so aus:

  1. Die App leitet den Nutzer auf eine Autorisierungsseite weiter, auf der der Zugriff auf Nutzerdaten angefordert wird, die durch Autorisierungsbereiche angegeben sind. Die App identifiziert sich mit Anmeldedaten für die Client-ID.
  2. Der Nutzer überprüft die von der App angeforderten Berechtigungen und genehmigt die Anfrage.
  3. Der Authentifizierungsserver von Google leitet den Browser zusammen mit einem Autorisierungscode an den HTTP-Endpunkt der App weiter.
  4. Die Anwendung sendet eine weitere Anfrage an den Autorisierungsserver von Google, um den Autorisierungscode gegen ein Zugriffstoken einzutauschen.
  5. Die Anwendung verwendet das Zugriffstoken, um die API im Namen des Nutzers aufzurufen.

Weitere Informationen zum OAuth-Autorisierungsprozess finden Sie im Leitfaden zum Zugriff auf Google APIs über OAuth 2.0.

In den folgenden Codebeispielen in Java, Python und Node.js wird eine Clientbibliothek verwendet, um den OAuth-Autorisierungsablauf auszuführen. Es öffnet einen lokalen HTTP-Server, um den Autorisierungscode vom Autorisierungsserver zurückzugeben, den es dann gegen ein Zugriffstoken austauscht. Im Apps Script-Codebeispiel wird dieser Autorisierungsablauf von Apps Script verwaltet.

Nach Abschluss des Authentifizierungsvorgangs authentifiziert sich das Script mit dem Zugriffstoken des Nutzers bei der Chat API und erstellt dann einen Gruppenbereich.

Java

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

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

    package com.google.chat.app.authsample;

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.HttpTransport;
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.chat.v1.HangoutsChat;
import com.google.api.services.chat.v1.model.Space;

import java.io.InputStreamReader;
import java.util.Collection;
import java.util.Collections;

/**
 * Authenticates with Chat API via user credentials, then creates a Chat space.
 */
public class App {
    // Application OAuth credentials.
    private static final String KEYS_RESOURCE_URI = "/client_secrets.json";

    // Define your app's authorization scopes.
    private static final Collection<String> SCOPES =
        Collections.singleton("https://www.googleapis.com/auth/chat.spaces.create");

    // Directory to store user credentials.
    private static final java.io.File DATA_STORE_DIR =
        new java.io.File(System.getProperty("user.home"), ".store/auth-sample-app");

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

    // Global instance of the HTTP transport.
    private static HttpTransport httpTransport;

    // Global instance of the DataStoreFactory. The best practice is to make it a single
    // globally shared instance across your application.
    private static FileDataStoreFactory dataStoreFactory;

    public static void main( String[] args ) {
        try {
            // Run app.
            httpTransport = GoogleNetHttpTransport.newTrustedTransport();
            dataStoreFactory = new FileDataStoreFactory(DATA_STORE_DIR);
            Credential userCredential = authorize();
            Space response = App.createChatSpace(userCredential);
            // Print details about the created space.
            System.out.println(response);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    /**
     * Authorizes the installed application to access user's protected data.
     */
    private static Credential authorize() throws Exception {
        // Load client secrets.
        GoogleClientSecrets clientSecrets = GoogleClientSecrets.load(JSON_FACTORY,
            new InputStreamReader(App.class.getResourceAsStream("/client_secrets.json")));
        // Set up authorization code flow.
        GoogleAuthorizationCodeFlow flow = new GoogleAuthorizationCodeFlow.Builder(
            httpTransport, JSON_FACTORY, clientSecrets, SCOPES)
            .setDataStoreFactory(dataStoreFactory)
            .build();
        // Authorize.
        return new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
    }

    /**
     * Creates a Chat space.
     */
    private static Space createChatSpace(Credential userCredential) throws Exception {
        // Build the Chat API client and authenticate with the user account.
        HangoutsChat chatService = new HangoutsChat.Builder(
            httpTransport, JSON_FACTORY, userCredential)
            .setApplicationName("auth-sample-app")
            .build();

        // Create a Chat space.
        Space space = new Space()
            // To create a named space, set spaceType to SPACE.
            .setSpaceType("SPACE")
            // The user-visible name of the space.
            .setDisplayName("API-made");
        return chatService.spaces().create(space).execute();
    }
}

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

  4. Kopieren Sie die Datei client_secrets.json in das Unterverzeichnis resources.

  5. Wenn Sie Maven so konfigurieren möchten, dass die Datei mit den Clientschlüsseln 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>

  6. 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. Speichern Sie den folgenden Code in einer Datei mit dem Namen chat_space_create_named.py im selben Verzeichnis wie client_secrets.json:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.spaces.create"]

def main():
  '''
  Authenticates with Chat API via user credentials,
  then creates a Chat space.
  '''

  flow = InstalledAppFlow.from_client_secrets_file(
                    'client_secrets.json', SCOPES)
  creds = flow.run_local_server()

  # Build a service endpoint for Chat API.
  service = build('chat', 'v1', credentials=creds)

  # Use the service endpoint to call Chat API.
  result = service.spaces().create(

    # Details about the space to create.
    body = {

      # To create a named space, set spaceType to SPACE.
      'spaceType': 'SPACE',

      # The user-visible name of the space.
      'displayName': 'API-made'

    }

  ).execute()

  # Prints details about the created space.
  print(result)

if __name__ == '__main__':
  main()

Node.js

  1. Speichern Sie den folgenden Code in einer Datei namens chat_space_create_named.js im selben Verzeichnis, in dem sich das Node.js-Projekt und client_secrets.json befinden:

    const fs = require('fs');
const path = require('path');
const http = require('http');
const url = require('url');
const destroyer = require('server-destroy');

const chat = require('@googleapis/chat');

// Application OAuth credentials.
const keys = require('./client_secrets.json').installed;

// Define your app's authorization scopes.
// When modifying these scopes, delete the file token.json, if it exists.
const scopes = ["https://www.googleapis.com/auth/chat.spaces.create"];

// Create a new OAuth2 client with the configured keys.
const oauth2Client = new chat.auth.OAuth2(
  keys.client_id,
  keys.client_secret,
  'http://localhost:3000'
);

/**
 * Opens an HTTP server to accept the OAuth callback.
 * In this simple example, the only request to our webserver is to /?code=<code>.
 */
async function authenticate(scopes) {
  const opn = (await import('open')).default;

  return new Promise((resolve, reject) => {
    // Generate the URL for authorization.
    const authorizeUrl = oauth2Client.generateAuthUrl({
      access_type: 'offline',
      scope: scopes.join(' '),
    });
    // Start the HTTP server to listen for the callback.
    const server = http
      .createServer(async (req, res) => {
        try {
          const qs = new url.URL(req.url, 'http://localhost:3000').searchParams;
          res.end('Authentication successful! Please return to the console.');
          server.destroy();
          const { tokens } = await oauth2Client.getToken(qs.get('code'));
          oauth2Client.credentials = tokens;
          resolve(oauth2Client);
        } catch (e) {
          reject(e);
        }
      })
      .listen(3000, () => {
        // Open the browser to the authorize URL to start the workflow.
        opn(authorizeUrl, { wait: false }).then(cp => cp.unref());
      });
    destroyer(server);
  });
}

/**
 * Authenticates with Chat API via user credentials, then creates a Chat space.
 */
async function createSpace() {
  // Create the Chat API client and authenticate with the authorized user.
  const chatClient = await chat.chat({
    version: 'v1',
    auth: oauth2Client
  });

  // Call the Chat API to create a space.
  const result = await chatClient.spaces.create({

    // Details about the space to create.
    requestBody: {

      // To create a named space, set spaceType to SPACE.
      'spaceType': 'SPACE',

      // The user-visible name of the space.
      'displayName': 'API-made'

    }

  });
  return result;
}

// Authenticate the user, execute the function,
// then print details about the created space.
authenticate(scopes)
  .then(createSpace)
  .then(console.log);

Apps Script

  1. Bearbeiten Sie im Apps Script-Editor die Datei appsscript.json und fügen Sie den OAuth-Bereich hinzu, der zum Aufrufen der API erforderlich ist:

      "oauthScopes": [
    "https://www.googleapis.com/auth/chat.spaces.create"
  ]

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

    /**
 * Authenticates with Chat API via user credentials, then creates a
 * Chat space.
 */
function createSpace() {
  try {
    // Details about the space to create.
    // To create a named space, set spaceType to SPACE.
    // The user-visible name of the space is displayName.
    const space = {'displayName': 'API-made', 'spaceType': 'SPACE'};

    // Call Chat API with user credentials to create the space.
    const result = Chat.Spaces.create(space);

    // Log details about the created space.
    console.log(result);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create space with error %s', err.message);
  }
}

Schritt 5: Beispielskript ausführen

Rufen Sie dazu in der Befehlszeile das Verzeichnis auf, in dem sich Ihre Projektdateien befinden, und führen Sie den folgenden Befehl aus:

Java

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

Python

python3 chat_space_create_named.py

Node.js

node chat_space_create_named.js

Apps Script

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

Ein Browser wird geöffnet und Sie werden aufgefordert, sich in Ihrem Google-Konto anzumelden:

Melden Sie sich an, um eine Chat-App zu autorisieren.

Abbildung 2. OAuth-Zustimmungsbildschirm, auf dem Sie auswählen, mit welchem Konto die App authentifiziert werden soll.

Nach der Anmeldung wird der OAuth-Zustimmungsbildschirm angezeigt, auf dem Sie der App die Berechtigung erteilen müssen.

Nachdem Sie die Berechtigung erteilt haben, ruft das Script die Chat API auf, die daraufhin den Chatbereich mit dem Anzeigenamen API-made erstellt. In der Konsole werden Details zum API-Aufruf ausgegeben. Sie finden den Gruppenbereich im Bereich Gruppenbereiche in Google Chat.

Beispiel beheben

Wenn Sie chat_space_create_named.py ausführen, wird möglicherweise folgende Fehlermeldung angezeigt:

Expected a JSON object with a single property for a "web" or "installed" application

Diese Fehlermeldung bedeutet, dass die client_secrets.json-Datei, die Sie aus der Google Cloud Console heruntergeladen haben, nicht mit der Property "web" oder "installed" beginnt. Wenn dein Code nach der Authentifizierung mit der heruntergeladenen Datei das Zugriffstoken nicht in einer neuen Datei wie token.json speichert, wird es in client_secrets.json geschrieben. Dies kann bei nachfolgenden Autorisierungsversuchen zu diesem Fehler führen.

Laden Sie die Datei mit dem Client-Secret noch einmal aus der Google Cloud Console herunter und speichern Sie die neue Datei anstelle der aktuellen Datei.

  • Wenn Ihre Anwendung die Nutzertokens außerhalb des Umfangs eines einzelnen Ablaufs weiterverwenden muss, können die Tokens gespeichert werden, um sie später wiederzuverwenden. In diesem Fall muss Ihre Anwendung Nutzertokens sicher verarbeiten und den Widerruf und Ablauf von Aktualisierungstokens verwalten. Weitere Informationen finden Sie im Leitfaden Best Practices für die Verwendung von OAuth 2.0.

  • Weitere Informationen zu den Funktionen der Chat API finden Sie in der Referenzdokumentation zur Chat API.