Google Apps Script – Kurzanleitung

In den Kurzanleitungen wird erläutert, wie Sie eine App einrichten und ausführen, die eine Google Workspace API aufruft.

In den Google Workspace-Schnellstarts werden die API-Clientbibliotheken verwendet, um einige Details des Authentifizierungs- und Autorisierungsablaufs zu verarbeiten. Wir empfehlen die Verwendung der Clientbibliotheken für Ihre eigenen Apps. In dieser Kurzanleitung wird ein vereinfachter Authentifizierungsansatz verwendet, der für eine Testumgebung geeignet ist. Für eine Produktionsumgebung empfehlen wir, sich mit Authentifizierung und Autorisierung vertraut zu machen, bevor Sie die Zugriffsdaten auswählen, die für Ihre App geeignet sind.

Erstellen Sie ein Google Apps Script, das Anfragen an die Google Chat API sendet.

Lernziele

  • Konfigurieren Sie die Umgebung.
  • Erstellen und konfigurieren Sie das Script.
  • Führen Sie das Skript aus.

Vorbereitung

Cloud-Projekt konfigurieren

Wenn Sie für diese Kurzanleitung ein neues Google Cloud-Projekt verwenden, müssen Sie es konfigurieren und sich 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 noch nicht geschehen:

  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. Sie können auch auf Projekt erstellen klicken und der Anleitung auf dem Bildschirm folgen. 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. Klicken Sie in der Google Cloud Console auf das Dreistrich-Menü  > > Branding.

    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 Kontaktinformationen eine E-Mail-Adresse ein, unter der Sie über Änderungen an Ihrem Projekt informiert werden können.
    7. Klicken Sie auf Weiter.
    8. Lesen Sie unter Fertigstellen die Nutzerdatenrichtlinie für Google API-Dienste und wählen Sie dann Ich akzeptiere die Richtlinie zu Nutzerdaten für Google API-Dienste aus, wenn Sie zustimmen.
    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.

Google Chat App konfigurieren

Wenn Sie die Google Chat API aufrufen möchten, müssen Sie eine Google Chat-App konfigurieren. Bei Schreibanfragen weist Google Chat der Google Chat-App in der Benutzeroberfläche anhand der folgenden Informationen eine Identität zu.

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

    Seite „Chat API-Konfiguration“ aufrufen

  2. Geben Sie unter App-Informationen die folgenden Informationen ein:

    1. Geben Sie im Feld App-Name den Namen Chat API quickstart app ein.
    2. Geben Sie im Feld Avatar-URL die URL 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.

Script erstellen

  1. Rufen Sie script.google.com/create auf, um ein neues Script zu erstellen.
  2. Ersetzen Sie den Inhalt des Script-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) {
      responsePage.spaces.forEach((space) => 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 Schnellstart ein und klicken Sie auf Umbenennen.

Script konfigurieren

Cloud-Projektnummer kopieren

  1. Klicken Sie in der Google Cloud Console auf das Dreipunkt-Menü  > IAM und Verwaltung > Einstellungen.

    Weiter zur Seite „IAM & Verwaltung“

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

Google Chat API aktivieren

  1. Öffnen Sie das Apps Script-Projekt.
  1. Klicken Sie auf 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 Scripts wird unten im Fenster angezeigt.

Nächste Schritte