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. Führen Sie den folgenden Code aus, um die gcloud-Befehlszeile zu initialisieren:

    gcloud init
    

• Ein Apps Script-Projekt:
  • Verwenden Sie Ihr Google Cloud-Projekt anstelle des Standardprojekts, das automatisch von Apps Script erstellt wird.
  • Für alle Bereiche, die Sie zum Konfigurieren des OAuth-Zustimmungsbildschirms hinzugefügt haben, müssen Sie die Bereiche auch der Datei appsscript.json in Ihrem Apps Script-Projekt hinzufügen. Wenn Sie beispielsweise den Bereich chat.messages angegeben haben, fügen Sie Folgendes hinzu:

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

  • Aktivieren Sie den erweiterten Dienst Google Workspace Events.

• Ein Google Cloud-Projekt mit aktivierter Abrechnung. Für Abos für Google Chat müssen Sie auch die Chat API in Ihrem Cloud-Projekt aktivieren und die Felder App-Name, Avatar-URL und Beschreibung konfigurieren. Weitere Informationen finden Sie unter Google Chat-App erstellen.
• Erfordert die Authentifizierung und einen geeigneten Autorisierungsbereich für jeden Ereignistyp im Abo:
  • Erfordert in der Regel die Nutzerauthentifizierung mit dem für die App konfigurierten OAuth-Zustimmungsbildschirm. Wenn Sie den Zustimmungsbildschirm konfigurieren, müssen Sie einen Bereich für jeden Ereignistyp für das Abo angeben. Informationen zum Konfigurieren des Zustimmungsbildschirms und zum Ermitteln der erforderlichen Zugriffsbereiche finden Sie unter Bereiche auswählen.
  • Wenn Sie als Chat-App ein Chat-Ereignis abonnieren möchten, ist eine App-Authentifizierung mit einmaliger Administratorgenehmigung erforderlich.

Python

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

    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. Führen Sie den folgenden Code aus, um die gcloud-Befehlszeile zu initialisieren:

    gcloud init
    

• Ein Google Cloud-Projekt mit aktivierter Abrechnung. Für Abos für Google Chat müssen Sie auch die Chat API in Ihrem Cloud-Projekt aktivieren und die Felder App-Name, Avatar-URL und Beschreibung konfigurieren. Weitere Informationen finden Sie unter Google Chat-App erstellen.
• Erfordert die Authentifizierung und einen geeigneten Autorisierungsbereich für jeden Ereignistyp im Abo:
  • Erfordert in der Regel die Nutzerauthentifizierung mit dem für die App konfigurierten OAuth-Zustimmungsbildschirm. Wenn Sie den Zustimmungsbildschirm konfigurieren, müssen Sie einen Bereich für jeden Ereignistyp für das Abo angeben. Informationen zum Konfigurieren des Zustimmungsbildschirms und zum Ermitteln der erforderlichen Zugriffsbereiche finden Sie unter Bereiche auswählen.
  • Wenn Sie als Chat-App ein Chat-Ereignis abonnieren möchten, ist eine App-Authentifizierung mit einmaliger Administratorgenehmigung erforderlich.

Google Cloud Console

Öffnen Sie in der Google Cloud Console das Google Cloud-Projekt für Ihre App und aktivieren Sie die Google Workspace Events API und die 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 App fest:

   gcloud config set project PROJECT_ID

   Ersetzen Sie PROJECT_ID durch die Projekt-ID des Cloud-Projekts für Ihre App.

3. Aktivieren Sie die Google Workspace Events API und die Google Cloud Pub/Sub API:

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

Google API-Konsole

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

   Zu Google Cloud Pub/Sub

   Achten Sie darauf, dass das Cloud-Projekt für Ihre App 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 gibt diesem Standardabo einen Namen, der dem Namen Ihres Themas ähnelt, z. B. workspace-events-topic-sub.
   3. Optional: Aktualisieren oder konfigurieren Sie zusätzliche Attribute für Ihr Thema.

3. Klicken Sie auf Erstellen. Der vollständige Themenname hat das Format projects/PROJECT_ID/topics/TOPIC_ID. Verwenden Sie diesen vollständigen Namen in einem späteren Schritt.

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

   1. Rufen Sie auf der Seite Ihres Themas die Seitenleiste auf und öffnen Sie den Tab Berechtigungen.
   2. Klicken Sie auf Hauptkonto hinzufügen.
   3. Fügen Sie im Feld Hauptkonten hinzufügen das Dienstkonto für die Google Workspace-Anwendung hinzu, die Ereignisse an Ihr Abo sendet:
      1. Für Chat-Ereignisse:
         • Bei Chat-Apps, die als Google Workspace-Add‑ons zur Erweiterung von Chat erstellt wurden, verwenden Sie die E‑Mail-Adresse des Dienstkontos auf der Seite für die Chat API-Konfiguration. Weitere Informationen finden Sie unter Google Chat-App erstellen, die Pub/Sub verwendet.
         • Verwenden Sie für Chat-Apps, die keine Google Workspace-Add‑ons sind, chat-api-push@system.gserviceaccount.com. Weitere Informationen finden Sie unter Google Chat-App erstellen, die Pub/Sub verwendet.
      2. Bei Drive-Ereignissen: drive-api-event-push@system.gserviceaccount.com.
      3. 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 für Ihr Thema aktualisiert werden.

gcloud

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

   gcloud pubsub topics create TOPIC_ID

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

   In der Ausgabe wird der vollständige Themenname im Format projects/PROJECT_ID/topics/TOPIC_ID angezeigt. Notieren Sie sich den Namen und achten Sie darauf, dass der Wert für PROJECT_ID die Cloud-Projekt-ID für Ihre App ist. Verwenden Sie den Themennamen im nächsten Schritt und später zum Erstellen des Google Workspace-Abos.

2. Zugriff zum Veröffentlichen von Nachrichten zu Ihrem Thema gewähren:

   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 Themenname, der die Ausgabe des vorherigen Schritts ist. Formatiert als projects/PROJECT_ID/topics/TOPIC_ID.

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

     • Wenn Sie Ereignisse von Chat erhalten möchten, verwenden Sie eines der folgenden Dienstkonten:
       • Bei Chat-Apps, die als Google Workspace-Add‑ons zur Erweiterung von Chat erstellt wurden, verwenden Sie die E‑Mail-Adresse des Dienstkontos auf der Seite für die Chat API-Konfiguration. Weitere Informationen finden Sie unter Google Chat-App erstellen, die Pub/Sub verwendet.
       • Verwenden Sie für Chat-Apps, die keine Add-ons sind, chat-api-push@system.gserviceaccount.com. Weitere Informationen finden Sie unter Google Chat-App erstellen, die Pub/Sub verwendet.
     • Wenn Sie Ereignisse von Drive empfangen möchten, verwenden Sie drive-api-event-push@system.gserviceaccount.com.
     • Wenn Sie Ereignisse von Meet empfangen 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 im vorherigen Schritt erstellt haben.

Apps Script

1. Erstellen Sie in Ihrem Apps Script-Projekt eine neue Skriptdatei mit dem Namen createSubscription und fügen Sie den folgenden Code ein:

   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 vollständiger Ressourcenname. Wenn Sie beispielsweise einen Chat-Bereich mit der Bereichs-ID AAAABBBB abonnieren möchten, verwenden Sie //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Ein oder mehrere Ereignistypen, die Sie in der Zielressource abonnieren möchten. Formatieren Sie die Antwort als Array von Strings, z. B. 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Der vollständige Name des Pub/Sub-Themas, das Sie in Ihrem Cloud-Projekt erstellt haben. Formatiert als projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Ein boolescher Wert, der angibt, ob das Abo Ressourcendaten in der Nutzlast enthält:

     • True: Enthält alle Ressourcendaten. Wenn Sie einschränken möchten, welche Felder einbezogen werden, fügen Sie das Feld fieldMask hinzu und geben Sie mindestens ein Feld für die geänderte Ressource an. Nur Abos für Chat-Ressourcen unterstützen die Einbeziehung von Ressourcendaten.
     • False: Schließt Ressourcendaten aus.

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

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('credentials.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 für das Abo unterstützen. Als Stringarray formatiert. Wenn Sie mehrere Bereiche angeben möchten, trennen Sie diese 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 vollständiger Ressourcenname. Wenn Sie beispielsweise einen Chat-Bereich mit der Bereichs-ID AAAABBBB abonnieren möchten, verwenden Sie //chat.googleapis.com/spaces/AAAABBBB.
   • EVENT_TYPES: Ein oder mehrere Ereignistypen, die Sie in der Zielressource abonnieren möchten. Formatieren Sie die Antwort als Array von Strings, z. B. 'google.workspace.chat.message.v1.created'.
   • TOPIC_NAME: Der vollständige Name des Pub/Sub-Themas, das Sie in Ihrem Cloud-Projekt erstellt haben. Formatiert als projects/PROJECT_ID/topics/TOPIC_ID.

   • RESOURCE_DATA: Ein boolescher Wert, der angibt, ob das Abo Ressourcendaten in der Nutzlast enthält:

     • True: Enthält alle Ressourcendaten. Wenn Sie einschränken möchten, welche Felder enthalten sind, fügen Sie das Feld fieldMask hinzu und geben Sie mindestens ein Feld für die geänderte Ressource an. Nur Abos für Chat-Ressourcen unterstützen die Einbeziehung von Ressourcendaten.
     • False: Schließt Ressourcendaten aus.

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

   python3 create_subscription.py

Google API-Konsole

1. Lösen Sie ein oder mehrere Arten von Ereignissen in der Zielressource Ihres Google Workspace-Abos aus. Wenn Sie beispielsweise neue Nachrichten in einem Chatbereich abonniert haben, posten Sie eine Nachricht im Bereich.

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

   Zu Pub/Sub

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

3. Klicken Sie im Menü Pub/Sub auf 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 eine Pub/Sub-Nachricht generiert.

gcloud

1. Lösen Sie ein oder mehrere Arten von Ereignissen in der Zielressource Ihres Google Workspace-Abos aus. Wenn Sie beispielsweise neue Nachrichten in einem Chatbereich abonniert haben, posten Sie eine Nachricht im Bereich.

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-Abos im Format projects/PROJECT_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 eine Pub/Sub-Nachricht generiert.

Python

  """Create subscription."""

  from google.oauth2 import service_account
  from apiclient.discovery import build

  # Specify required scopes.
  SCOPES = ['https://www.googleapis.com/auth/chat.app.messages.readonly']

  # Specify service account details.
  CREDENTIALS = (
      service_account.Credentials.from_service_account_file('credentials.json')
      .with_scopes(SCOPES)
  )

  # The Google Workspace resource to monitor for events.
  TARGET_RESOURCE = '//chat.googleapis.com/spaces/SPACE_ID'

  # The types of events to receive.
  EVENT_TYPES = [
                  'google.workspace.chat.message.v1.created',
                  'google.workspace.chat.message.v1.updated',
                  'google.workspace.chat.message.v1.deleted',
                ]

  # 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)

Python

"""Create a customer subscription."""

from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
# Replace with the scopes needed for the event types you want to receive.
SCOPES = ['https://www.googleapis.com/auth/chat.app.all.messages.readonly']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Monitor all events for the Google Workspace organization.
TARGET_RESOURCE = '//admin.googleapis.com/customers/CUSTOMER_ID'

# The types of events to receive.
EVENT_TYPES = [
    'google.workspace.chat.message.v1.created',
    'google.workspace.chat.message.v1.updated',
    'google.workspace.chat.message.v1.deleted',
]

# The endpoint to deliver events to.
TOPIC = 'TOPIC_NAME'

# Call the Workspace Events API.
# Note: Use the v1beta endpoint for Developer Preview features.
service = build(
    'workspaceevents',
    'v1beta',
    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)