Google Chat API konfigurieren

Für jede von Ihnen erstellte Google Chat-App ist ein eigenes Google Cloud-Projekt erforderlich, in dem die Chat API aktiviert und konfiguriert ist. Auf dieser Seite erfahren Sie, wie Sie die Chat API konfigurieren.

Vorbereitung

Anzeigenamen, Avatar und Beschreibung für die Chat App auswählen

Wenn Sie die Chat API aufrufen möchten, müssen Sie eine Google Chat App mit den folgenden Informationen einrichten:

Feld Beschreibung Format
App-Name Der Anzeigename für die Google Chat App. Bis zu 25 alphanumerische Zeichen
Avatar-URL Das Bild, das als Avatar der Chat-App angezeigt wird. Eine HTTPS-URL, die auf ein quadratisches Grafikbild (PNG oder JPEG) verweist. Die empfohlene Größe ist mindestens 256 × 256 Pixel.
Beschreibung Eine kurze Beschreibung des Zwecks der Chat-App. Bis zu 40 alphanumerische Zeichen

Der Name, der Avatar und die Beschreibung der Chat-App werden Nutzern in der Chat-Benutzeroberfläche angezeigt. Bei einigen Schreibanfragen der Chat API werden diese Informationen in Google Chat verwendet, um die Aktionen einer Chat-App in Google Chat zuzuordnen.

Wenn Sie beispielsweise die Methode spaces.create() aufrufen, enthält Google Chat den Namen der Chat-App in der Beschreibung des Erstellers des Gruppenbereichs, wie im folgenden Bild zu sehen:

In der Google Chat App wird ein Gruppenbereich für einen Nutzer erstellt.
Abbildung 1: Die Attributionsnachricht, die in Google Chat angezeigt wird, wenn mit der Methode spaces.create() ein Gruppenbereich im Namen eines Nutzers erstellt wird.

Nutzer können diese Informationen auch auf folgende Weise sehen oder verwenden, um mit Chat-Apps zu interagieren:

  • Rufen Sie die Chat-App auf, indem Sie den Namen @erwähnen.
  • Suchen Sie nach der Chat-App und starten Sie eine Direktnachricht. Im Menü Apps werden in Direktnachrichten der Name und der Avatar der Chat-App angezeigt.
  • Über die Eingabeleiste können Nutzer Chat-Apps durchsuchen und ihren Namen, Avatar und ihre Beschreibung sehen.

Chat-App in der Google Cloud Console konfigurieren

Wenn Sie die Details Ihrer Chat-App haben, öffnen Sie Ihr Cloud-Projekt und konfigurieren Sie die Chat API:

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

    Seite „Chat API-Konfiguration“ aufrufen

  2. Füllen Sie unter App-Informationen die Felder App-Name, Avatar-URL und Beschreibung aus.

  3. Stellen Sie die Ein/Aus-Schaltfläche unter Interaktive Features aktivieren auf „Aus“, um die interaktiven Funktionen für die Chat-App zu deaktivieren. Sie können dies später einrichten. Informationen zum Konfigurieren und Erstellen interaktiver Funktionen finden Sie unter Nutzerinteraktionen empfangen und darauf reagieren.

  4. Optional: Klicken Sie unter Logs das Kästchen Fehler in Logging protokollieren an, um Google Cloud Logging zu verwenden. Weitere Informationen finden Sie unter Abfragefehlerlogs für Chat-Apps.

  5. Klicken Sie auf Speichern.

Anderen Personen die Berechtigung zum Konfigurieren der Chat API gewähren

Sie können bestimmten Nutzern Zugriff auf die Konfigurationsseite der Chat-App gewähren, indem Sie ihnen die Google Cloud Identity Access Management (IAM)-Rolle Inhaber von Chat-Apps oder Betrachter von Chat-Apps zuweisen. Nutzer mit diesen Rollen können die Konfigurationsseite der Chat-App nicht über das Dashboard APIs und Dienste aufrufen. Sie können sie aber aufrufen, indem sie die Google Cloud Console für das Cloud-Projekt des Chat-App-Hosts aufrufen. Gehen Sie dazu so vor:

https://console.developers.google.com/apis/api/chat.googleapis.com/hangouts-chat?project=PROJECT_ID

Dabei ist PROJECT_ID die Projekt-ID des Google Cloud-Projekts, in dem die Chat-App gehostet wird.