Google Workspace-Abo erstellen

Apps Script

• So verwenden Sie die Google Cloud CLI-Befehle in dieser Anleitung:
  1. Installieren Sie die Google Cloud CLI.
  2. Bis <ph type="x-smartling-placeholder"></ph> Initialisieren Sie die gcloud-Befehlszeile und führen Sie den folgenden Code aus:

    gcloud init
    

• Ein Google Cloud-Projekt mit aktivierter Abrechnung. Für Abos von Google Chat müssen Sie Aktivieren Sie auch die Chat API in Ihrem Cloud-Projekt und Konfigurieren Sie App-Name, Avatar-URL und Beschreibung. . Weitere Informationen finden Sie unter Erstellen Sie eine Google Chat App.
• Erfordert eine Nutzerauthentifizierung mit konfiguriertem OAuth-Zustimmungsbildschirm für in der App. Beim Konfigurieren des Zustimmungsbildschirms müssen Sie einen Bereich für unterstützen alle Ereignistypen für das Abo. Einwilligung konfigurieren und die erforderlichen Bereiche zu identifizieren, Bereiche auswählen

• Ein Apps Script-Projekt:
  • Verwenden Sie Ihr Google Cloud-Projekt anstelle des Standardprojekts, das automatisch von Apps Script.
  • Für alle Bereiche, die Sie zur Konfiguration des OAuth-Zustimmungsbildschirms hinzugefügt haben, müssen Sie auch den Bereiche auf die Datei appsscript.json in Ihrem Apps Script-Projekt. Beispiel:

  "oauthScopes": [
    "https://www.googleapis.com/auth/chat.messages.readonly"
  ]
      

  • Aktivieren den erweiterten Google Workspace Events-Dienst.

Python

• Python 3.6 oder höher
• Paketverwaltungstool pip
• Die neuesten Google-Clientbibliotheken für Python. Führen Sie den folgenden Befehl aus, um sie zu installieren oder zu aktualisieren: in Ihrer Befehlszeile:

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

• So verwenden Sie die Google Cloud CLI-Befehle in dieser Anleitung:
  1. Installieren Sie die Google Cloud CLI.
  2. Bis <ph type="x-smartling-placeholder"></ph> Initialisieren Sie die gcloud-Befehlszeile und führen Sie den folgenden Code aus:

    gcloud init
    

• Ein Google Cloud-Projekt mit aktivierter Abrechnung. Für Abos von Google Chat müssen Sie die Chat API in Ihrem Cloud-Projekt aktivieren und Konfigurieren Sie App-Name, Avatar-URL und Beschreibung. . Weitere Informationen finden Sie unter Erstellen Sie eine Google Chat App.
• Erfordert eine Nutzerauthentifizierung mit konfiguriertem OAuth-Zustimmungsbildschirm für in der App. Beim Konfigurieren des Zustimmungsbildschirms müssen Sie einen Bereich für unterstützen alle Ereignistypen für das Abo. Einwilligung konfigurieren und die erforderlichen Zugriffsbereiche identifizieren, Bereiche auswählen

Google Cloud Console

Öffnen Sie in der Google Cloud Console das Google Cloud-Projekt für Ihre Anwendung und aktivieren Sie die Google Workspace Events API und Pub/Sub API:

APIs aktivieren

gcloud

1. Melden Sie sich in Ihrem Arbeitsverzeichnis in Ihrem Google-Konto an:

   gcloud auth login
   

2. Legen Sie Ihr Projekt auf das Cloud-Projekt für Ihre Anwendung fest:

   gcloud config set project PROJECT_ID
   

   Ersetzen Sie PROJECT_ID durch den Projekt-ID des Cloud-Projekts für Ihre Anwendung.

3. Google Workspace Events API und Google Cloud Pub/Sub aktivieren API:

   gcloud services enable pubsub.googleapis.com workspaceevents.googleapis.com
   

Google Cloud Console

1. Rufen Sie in der Google Cloud Console die Pub/Sub-Seite auf:

   Zu Google Cloud Pub/Sub

   Achten Sie darauf, dass das Cloud-Projekt für Ihre Anwendung ausgewählt ist.

2. Klicken Sie auf add_box Thema erstellen und Gehen Sie so vor:

   1. Geben Sie einen Namen für das Thema ein, z. B. workspace-events-topic.
   2. Lassen Sie Standardabo hinzufügen ausgewählt. Pub/Sub benennt diesen Standardabo, das dem Namen Ihres Themas ähnelt, z. B. workspace-events-topic-sub
   3. Optional: Aktualisieren oder konfigurieren Sie zusätzliche Properties. zu Ihrem Thema.

3. Klicken Sie auf Erstellen. Ihr vollständiger Themenname hat folgendes Format: projects/PROJECT_ID/topics/TOPIC_ID Sie verwenden diesen vollständigen Namen in einem späteren Schritt.

4. Gewähren Sie Zugriff zum Veröffentlichen von Pub/Sub-Nachrichten zu Ihrem Thema:

   1. Öffnen Sie auf der Themenseite in der Seitenleiste das Berechtigungen.
   2. Klicken Sie auf Hauptkonto hinzufügen.
   3. Fügen Sie im Feld Hauptkonten hinzufügen das Dienstkonto für das Google Workspace-Anwendung, die Ereignisse an Ihre Abo:
      1. Bei Chat-Ereignissen: chat-api-push@system.gserviceaccount.com
      2. Bei Meet-Terminen: meet-api-event-push@system.gserviceaccount.com
   4. Wählen Sie im Menü Rollen zuweisen die Option Pub/Sub Publisher aus.
   5. Klicken Sie auf Speichern. Es kann einige Minuten dauern, bis die Berechtigungen aktualisiert sind zu Ihrem Thema.

gcloud

1. Erstellen Sie in Ihrem Cloud-Projekt ein Thema, indem Sie Folgendes ausführen: Befehl:

   gcloud pubsub topics create TOPIC_ID
   

   Ersetzen Sie TOPIC_ID durch eine eindeutige ID für Ihr Thema, z. B. als workspace-events-topic.

   Die Ausgabe zeigt den vollständigen Themennamen im Format projects/PROJECT_ID/topics/TOPIC_ID Notieren Sie sich den Namen und stellen Sie sicher, dass der Wert für PROJECT_ID ist die ID des Cloud-Projekts. für Ihre App. Sie verwenden den Themennamen im nächsten Schritt und um das Google Workspace-Abo abschließen.

2. Gewähren Sie Zugriff, um Nachrichten zu Ihrem Thema zu veröffentlichen:

   gcloud pubsub topics add-iam-policy-binding TOPIC_NAME --member='serviceAccount:GOOGLE_WORKSPACE_APPLICATION' --role='roles/pubsub.publisher'
   

   Ersetzen Sie Folgendes:

   • TOPIC_NAME: Der vollständige Name des Themas, also der aus dem vorherigen Schritt. Formatiert als projects/PROJECT_ID/topics/TOPIC_ID

   • GOOGLE_WORKSPACE_APPLICATION: Die Google Workspace-Anwendung, die Ereignisse an Nutzer senden muss Ihr Abo:

     • Um Ereignisse aus Google Chat zu erhalten, verwenden Sie chat-api-push@system.gserviceaccount.com
     • Wenn Sie Termine aus Meet erhalten möchten, verwenden Sie meet-api-event-push@system.gserviceaccount.com

   Es kann einige Minuten dauern, bis die Berechtigungen für Ihr Thema aktualisiert sind.

3. Erstellen Sie ein Pub/Sub-Abo für das Thema:

    gcloud pubsub subscriptions create SUBSCRIPTION_NAME --topic=TOPIC_NAME
   

   Ersetzen Sie Folgendes:

   • SUBSCRIPTION_NAME: Ein Name für Ihr Abo. z. B. workspace-events-subscription.
   • TOPIC_NAME: Der Name des Themas, das Sie erstellt haben. aus dem vorherigen Schritt.

Apps Script

1. Erstellen Sie in Ihrem Apps Script-Projekt eine neue Skriptdatei. namens createSubscription und fügen Sie den folgenden Code hinzu:

   function createSubscription() {
     // The Google Workspace resource to monitor for events.
     const targetResource = 'TARGET_RESOURCE';
   
     // The types of events to receive.
     const eventTypes = [EVENT_TYPES];
   
     // The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
     const pubsubTopic = 'TOPIC_NAME';
   
     // Whether to include resource data or not.
     const resourceData = RESOURCE_DATA;
   
     // Call the Workspace Events API using the advanced service.
     const response = WorkspaceEvents.Subscriptions.create({
       targetResource: targetResource,
       eventTypes: eventTypes,
       notificationEndpoint: {
         pubsubTopic: pubsubTopic,
       },
       payloadOptions: {
         includeResource: resourceData
       }
     });
     console.log(response);
   }
   

   Ersetzen Sie Folgendes:

   • TARGET_RESOURCE: Die Google Workspace-Ressource die Sie abonnieren, formatiert als der vollständige Ressourcenname. Für Beispiel: Sie können einen Google Chat-Bereich mit der ID des Gruppenbereichs abonnieren, AAAABBBB, //chat.googleapis.com/spaces/AAAABBBB verwenden.
   • EVENT_TYPES: mindestens ein Ereignistyp die Sie in der Zielressource abonnieren möchten. Formatieren als Array von Strings wie 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Der vollständige Name des Pub/Sub-Themas, das die Sie in Ihrem Cloud-Projekt erstellt haben. Formatiert als projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: Ein boolescher Wert, der angibt, enthält Ressourcendaten in die Nutzlast:

     • True: Enthält alle Ressourcendaten. Um einzuschränken, welche Felder enthalten, fügen Sie den fieldMask und geben Sie mindestens ein Feld für die geänderte Ressource an. Nur Abos von Chat-Ressourcen, Support einschließlich Ressourcendaten.
     • False: Schließt Ressourcendaten aus.

2. Führen Sie die Funktion aus, um das Google Workspace-Abo zu erstellen createSubscription in Ihrem Apps Script-Projekt

Python

1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen create_subscription.py. und fügen Sie den folgenden Code hinzu:

   """Create subscription."""
   
   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   
   # Specify required scopes.
   SCOPES = [SCOPES]
   
   # Authenticate with Google Workspace and get user authentication.
   flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
   CREDENTIALS = flow.run_local_server()
   
   # The Google Workspace resource to monitor for events.
   TARGET_RESOURCE = 'TARGET_RESOURCE'
   
   # The types of events to receive.
   EVENT_TYPES = [EVENT_TYPES]
   
   # The endpoint to deliver events to, such as a Google Cloud Pub/Sub topic.
   TOPIC = 'TOPIC_NAME'
   
   # Call the Workspace Events API using the service endpoint.
   service = build(
       'workspaceevents',
       'v1',
       credentials=CREDENTIALS,
   )
   
   BODY = {
       'target_resource': TARGET_RESOURCE,
       'event_types': EVENT_TYPES,
       'notification_endpoint': {'pubsub_topic': TOPIC},
       'payload_options': {'include_resource': RESOURCE_DATA},
   }
   response = service.subscriptions().create(body=BODY).execute()
   print(response)
   

   Ersetzen Sie Folgendes:

   • SCOPES: Ein oder mehrere OAuth-Bereiche, die jeden Ereignistyp unterstützen für das Abo. Formatiert als String-Array. Wenn Sie mehrere Bereiche auflisten möchten, trennen Sie sie durch Kommas. Beispiel: 'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
   • TARGET_RESOURCE: Die Google Workspace-Ressource die Sie abonnieren, formatiert als der vollständige Ressourcenname. Für Beispiel: Sie können einen Google Chat-Bereich mit der ID des Gruppenbereichs abonnieren, AAAABBBB, //chat.googleapis.com/spaces/AAAABBBB verwenden.
   • EVENT_TYPES: mindestens ein Ereignistyp die Sie in der Zielressource abonnieren möchten. Formatieren als Array von Strings wie z. B. 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Der vollständige Name des Pub/Sub-Themas, das die Sie in Ihrem Cloud-Projekt erstellt haben. Formatiert als projects/PROJECT_ID/topics/TOPIC_ID

   • RESOURCE_DATA: Ein boolescher Wert, der angibt, enthält Ressourcendaten in die Nutzlast:

     • True: Enthält alle Ressourcendaten. Um einzuschränken, welche Felder enthalten, fügen Sie den fieldMask und geben Sie mindestens ein Feld für die geänderte Ressource an. Nur Abos von Chat-Ressourcen, Support einschließlich Ressourcendaten.
     • False: Schließt Ressourcendaten aus.

2. Führen Sie folgenden Befehl aus, um das Google Workspace-Abo zu erstellen: Ihrem Terminal:

   python3 create_subscription.py
   

Google Cloud Console

1. Lösen Sie einen oder mehrere Ereignistypen in der Zielressource Ihrer Google Workspace-Abo. Wenn Sie beispielsweise neue Nachrichten in einem Chatbereich haben, posten Sie eine Nachricht im Gruppenbereich.

2. Rufen Sie in der Google Cloud Console die Pub/Sub-Seite auf:

   Zu Pub/Sub

   Achten Sie darauf, dass das Cloud-Projekt für Ihre Anwendung ausgewählt ist.

3. Klicken Sie im Menü Pub/Sub auf Subscriptions (Abos).

4. Suchen Sie in der Tabelle nach dem Pub/Sub-Abo für Ihr Thema und klicken Sie auf den Namen des Abos.

5. Klicken Sie auf den Tab Nachrichten.

6. Klicken Sie auf Pull. Es kann einige Minuten dauern, bis ein Ereignis Pub/Sub-Nachricht.

gcloud

1. Lösen Sie einen oder mehrere Ereignistypen in der Zielressource Ihrer Google Workspace-Abo. Wenn Sie beispielsweise neue Nachrichten in einem Chatbereich haben, posten Sie eine Nachricht im Gruppenbereich.

2. Führen Sie dazu diesen Befehl aus:

   gcloud pubsub subscriptions pull PUBSUB_SUBSCRIPTION_NAME --format=json --limit=MESSAGE_COUNT --auto-ack
   

   Ersetzen Sie Folgendes:

   • PUBSUB_SUBSCRIPTION_NAME: Der vollständige Name Ihres Pub/Sub-Abo, formatiert als projects/SUBSCRIPTION_ID/subscriptions/SUBSCRIPTION_ID.
   • MESSAGE_COUNT: Die maximale Anzahl von Pub/Sub-Nachrichten, die Sie abrufen möchten.

   Es kann einige Minuten dauern, bis ein Ereignis ein Pub/Sub generiert. angezeigt.