Google Apps Script – Kurzanleitung

Erstellen Sie ein Google Apps Script , mit dem Anfragen an die Google Chat API gesendet werden.

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

In Apps Script verwenden Google Workspace Kurzanleitungen erweiterte Google-Dienste, um Google Workspace APIs aufzurufen und einige Details des Authentifizierungs - und Autorisierungsablaufs zu verarbeiten.

Ziele

  • Umgebung konfigurieren
  • Skript erstellen und konfigurieren
  • Skript ausführen

Vorbereitung

Cloud-Projekt konfigurieren

Wenn Sie für diese Kurzanleitung ein neues Google Cloud-Projekt verwenden, müssen Sie es konfigurieren und sich selbst als Testnutzer hinzufügen. Wenn Sie diese Schritte für Ihr Cloud-Projekt bereits ausgeführt haben, fahren Sie mit dem nächsten Abschnitt fort.

Cloud-Projekt in der Google Cloud Console öffnen

Öffnen Sie das Cloud-Projekt, das Sie für dieses Beispiel verwenden möchten, falls es noch nicht geöffnet ist:

  1. Rufen Sie in der Google Cloud Console die Seite Projekt auswählen auf.

    Cloud-Projekt auswählen

  2. Wählen Sie das Google Cloud-Projekt aus, das Sie verwenden möchten. Oder klicken Sie auf Projekt erstellen und folgen Sie der Anleitung auf dem Bildschirm. Wenn Sie ein Google Cloud-Projekt erstellen, müssen Sie möglicherweise die Abrechnung für das Projekt aktivieren.

Chat 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

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

    Zum Branding

  2. Wenn Sie die Google Auth Platform bereits konfiguriert haben, können Sie die folgenden Einstellungen für den OAuth-Zustimmungsbildschirm unter Branding, Zielgruppe und Datenzugriff konfigurieren. Wenn die Meldung Google Auth Platform noch nicht konfiguriert angezeigt wird, klicken Sie auf Jetzt starten:
    1. Geben Sie unter Anwendungsinformationen im Feld Anwendungsname einen Namen für die App ein.
    2. Wählen Sie unter E‑Mail-Adresse für Nutzersupport eine E‑Mail-Adresse für den Support aus, über die Nutzer Sie kontaktieren können, wenn sie Fragen zu ihrer Einwilligung haben.
    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, über die Sie über Änderungen an Ihrem Projekt informiert werden können.
    7. Klicken Sie auf Weiter.
    8. Lesen Sie unter Abschließen die Nutzerdatenrichtlinie für Google API-Dienste. Wenn Sie damit einverstanden sind, wählen Sie Ich akzeptiere die Richtlinie zu Nutzerdaten für Google API-Dienste aus.
    9. Klicken Sie auf Weiter.
    10. Klicken Sie auf Erstellen.
  3. Sie können das Hinzufügen von Bereichen vorerst überspringen. Wenn Sie später 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 Ihre App benötigt. Weitere Informationen finden Sie in der vollständigen Anleitung zum Konfigurieren des OAuth-Zustimmungsbildschirms.

Google Chat-App konfigurieren

Um die Google Chat API aufzurufen, müssen Sie eine Google Chat-App konfigurieren. Bei Schreibanfragen ordnet Google Chat die Google Chat-App in der Benutzeroberfläche mit den folgenden Informationen zu.

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

    Seite „Konfiguration der Chat API“ aufrufen

  2. Geben Sie unter Anwendungsinformationen die folgenden Informationen ein:

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

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

  4. Klicken Sie auf Speichern.

Skript erstellen

  1. Erstellen Sie im Apps Script-Editor ein neues Skript. Rufen Sie dazu script.google.com/create auf.
  2. Ersetzen Sie den Inhalt des Skript-Editors durch den folgenden Code:

chat/quickstart/Code.gs
/**
 * This quickstart sample shows how to list spaces with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listSpaces() {
  // Initialize request argument(s)
  // Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
  const filter = 'space_type = "SPACE"';

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.list({
      filter: filter,
      pageToken: pageToken,
    });
    // Handle response pages
    if (responsePage.spaces) {
      for (const space of responsePage.spaces) {
        console.log(space);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

  1. Klicken Sie auf „Speichern“ .
  2. Klicken Sie auf Unbenanntes Projekt, geben Sie Quickstart ein und klicken Sie auf Umbenennen.

Skript konfigurieren

Cloud-Projektnummer kopieren

  1. Rufen Sie in der Google Cloud Console das Menü > IAM & Verwaltung > Einstellungen auf.

    Weiter zur Seite "IAM &Verwaltung"

  2. Kopieren Sie den Wert im Feld Projektnummer.
  1. Öffnen Sie das Apps Script-Projekt.
  2. Klicken Sie auf die Projekteinstellungen .
  3. Klicken Sie unter Google Cloud Platform-Projekt (GCP) auf Projekt wechseln.
  4. Fügen Sie unter GCP-Projektnummer die Google Cloud-Projektnummer ein.
  5. Klicken Sie auf Projekt festlegen.

Google Chat API aktivieren

Öffnen Sie das Apps Script-Projekt.

  1. Klicken Sie auf die Projekteinstellungen .
  2. Aktivieren Sie unter Allgemeine Einstellungen die Option Manifestdatei „appsscript.json“ im Editor anzeigen.
  3. Klicken Sie auf Editor , wählen Sie die Datei appscript.json aus und ersetzen Sie den Inhalt durch den folgenden Code:

chat/quickstart/appsscript.json
{
  "timeZone": "America/New_York",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": ["https://www.googleapis.com/auth/chat.spaces.readonly"],
  "chat": {},
  "dependencies": {
    "enabledAdvancedServices": [
      {
        "userSymbol": "Chat",
        "version": "v1",
        "serviceId": "chat"
      }
    ]
  }
}

Beispiel ausführen

Klicken Sie im Apps Script-Editor auf Ausführen.

Wenn Sie das Beispiel zum ersten Mal ausführen, werden Sie aufgefordert, den Zugriff zu autorisieren:

  1. Klicken Sie auf Berechtigungen ansehen.
  2. Wählen Sie ein Konto aus.
  3. Klicken Sie auf Zulassen.

Das Ausführungsprotokoll des Skripts wird unten im Fenster angezeigt.

Nächste Schritte