Erweiterter Google Workspace-Ereignisdienst

Mit dem erweiterten Google Workspace Events-Dienst können Sie die Google Workspace Events API in Apps Script verwenden. Mit dieser API können Sie Google Workspace-Ressourcen abonnieren, um über für Sie relevante Ereignisse informiert zu werden. Ereignisse beschreiben Änderungen an Ressourcen, z. B. wenn Ressourcen erstellt, aktualisiert oder gelöscht werden.

Vorbereitung

  • Ein Apps Script-Projekt, das ein Standard-Google Cloud-Projekt anstelle des Standardprojekts verwendet, das automatisch von Apps Script erstellt wird.
  • Ein Pub/Sub-Thema, das im selben Google Cloud-Projekt erstellt wurde, um Abo-Ereignisse zu empfangen. Informationen zum Erstellen eines Pub/Sub-Themas finden Sie unter Pub/Sub-Thema erstellen und abonnieren.
  • Wenn Sie Chat-Ereignisse abonnieren möchten, muss eine Google Chat-App auf der Seite zur Chat API-Konfiguration in der Google Cloud Console konfiguriert sein. Informationen zum Erstellen einer Google Chat-App finden Sie unter Google Chat-App mit Apps Script erstellen.

  • Die erforderlichen Autorisierungsbereiche wurden der Datei appsscript.json des Apps Script-Projekts hinzugefügt. Die erforderlichen Bereiche hängen von den Typen der Zielressourcen und Ereignisse der Abonnements ab. Weitere Informationen finden Sie unter Bereiche für die Google Workspace Events API auswählen. Beispiel:

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

Referenz

Weitere Informationen zu diesem Dienst finden Sie in der Referenzdokumentation zur Google Workspace Events API. Wie alle erweiterten Dienste in Apps Script verwendet der Google Workspace Events-Dienst dieselben Objekte, Methoden und Parameter wie die öffentliche API.

Beispielcode

In diesen Beispielen wird gezeigt, wie Sie mit dem erweiterten Dienst häufige Aktionen der Google Workspace Events API ausführen.

Abo erstellen

Wenn Sie ein Abo für eine Google Workspace-Ressource erstellen möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:

advanced/events.gs
/**
 * Creates a subscription to receive events about a Google Workspace resource.
 * For a list of supported resources and event types, see the
 * [Google Workspace Events API Overview](https://developers.google.com/workspace/events#supported-events).
 * For additional information, see the
 * [subscriptions.create](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/create)
 * method reference.
 * @param {!string} targetResource The full resource name of the Google Workspace resource to subscribe to.
 * @param {!string|!Array<string>} eventTypes The types of events to receive about the resource.
 * @param {!string} pubsubTopic The resource name of the Pub/Sub topic that receives events from the subscription.
 */
function createSubscription(targetResource, eventTypes, pubsubTopic) {
  try {
    const operation = WorkspaceEvents.Subscriptions.create({
      targetResource: targetResource,
      eventTypes: eventTypes,
      notificationEndpoint: {
        pubsubTopic: pubsubTopic,
      },
    });
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to create subscription with error %s', err.message);
  }
}

Abos auflisten

Wenn Sie Abos filtern möchten, die nach Ereignistypen und Zielressource aufgelistet werden, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:

advanced/events.gs
/**
 * Lists subscriptions created by the calling app filtered by one or more event types and optionally by a target resource.
 * For additional information, see the
 * [subscriptions.list](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/list)
 * method reference.
 * @param {!string} filter The query filter.
 */
function listSubscriptions(filter) {
  try {
    const response = WorkspaceEvents.Subscriptions.list({ filter });
    console.log(response);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to list subscriptions with error %s', err.message);
  }
}

Abo abrufen

Wenn Sie Informationen zu einem Abo abrufen möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:

advanced/events.gs
/**
 * Gets details about a subscription.
 * For additional information, see the
 * [subscriptions.get](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/get)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function getSubscription(name) {
  try {
    const subscription = WorkspaceEvents.Subscriptions.get(name);
    console.log(subscription);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get subscription with error %s', err.message);
  }
}

Abo aktualisieren

Wenn Sie ein Abo aktualisieren oder verlängern möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:

advanced/events.gs
/**
 * Updates an existing subscription.
 * This can be used to renew a subscription that is about to expire.
 * For additional information, see the
 * [subscriptions.patch](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/patch)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function patchSubscription(name) {
  try {
    const operation = WorkspaceEvents.Subscriptions.patch({
      // Setting the TTL to 0 seconds extends the subscription to its maximum expiration time.
      ttl: '0s',
    }, name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to update subscription with error %s', err.message);
  }
}

Abo reaktivieren

Wenn Sie ein Abo reaktivieren möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:

advanced/events.gs
/**
 * Reactivates a suspended subscription.
 * Before reactivating, you must resolve any errors with the subscription.
 * For additional information, see the
 * [subscriptions.reactivate](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/reactivate)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function reactivateSubscription(name) {
  try {
    const operation = WorkspaceEvents.Subscriptions.reactivate({}, name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to reactivate subscription with error %s', err.message);
  }
}

Abo löschen

Fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu, um ein Abo zu löschen:

advanced/events.gs
/**
 * Deletes a subscription.
 * For additional information, see the
 * [subscriptions.delete](https://developers.google.com/workspace/events/reference/rest/v1/subscriptions/delete)
 * method reference.
 * @param {!string} name The resource name of the subscription.
 */
function deleteSubscription(name) {
  try {
    const operation = WorkspaceEvents.Subscriptions.remove(name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to delete subscription with error %s', err.message);
  }
}

Vorgang abrufen

Die meisten Methoden der Google Workspace Events API geben einen Vorgang mit langer Ausführungszeit zurück. Mit der Methode operations.get() können Sie den Status des Vorgangs ermitteln.

Wenn Sie Informationen zu einem Vorgang abrufen möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:

advanced/events.gs
/**
 * Gets details about an operation returned by one of the methods on the subscription
 * resource of the Google Workspace Events API.
 * For additional information, see the
 * [operations.get](https://developers.google.com/workspace/events/reference/rest/v1/operations/get)
 * method reference.
 * @param {!string} name The resource name of the operation.
 */
function getOperation(name) {
  try {
    const operation = WorkspaceEvents.Operations.get(name);
    console.log(operation);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get operation with error %s', err.message);
  }
}

Um den Namen eines Vorgangs abzurufen, verwenden Sie den Wert aus dem Feld name, der von einer der Google Workspace Events API-Methoden wie subscriptions.create() oder subscriptions.patch() zurückgegeben wird.