Termine aus einem Google Chat-Bereich auflisten

In diesem Leitfaden wird beschrieben, wie Sie mit der Methode list() für die Ressource SpaceEvent der Google Chat API Änderungen an Ressourcen in einem Space auflisten.

Die SpaceEvent-Ressource stellt eine Änderung am Zielbereich dar, einschließlich untergeordneter Ressourcen des Bereichs wie Nachrichten, Reaktionen und Mitgliedschaften. Weitere Informationen zur Liste der unterstützten Ereignistypen und Ereignisnutzlasten finden Sie in der Referenzdokumentation zur SpaceEvent-Ressource in den Feldern eventType und payload.

Sie können Ereignisse bis zu 28 Tage vor dem Zeitpunkt der Anfrage auflisten. Der Server gibt Ereignisse zurück, die die aktuelle Version der betroffenen Ressource enthalten. Wenn Sie beispielsweise Ereignisse zu neuen Projektbereichsmitgliedern auflisten, gibt der Server Membership-Ressourcen mit den neuesten Mitgliedschaftsdetails zurück. Wenn neue Mitglieder während des angeforderten Zeitraums entfernt wurden, enthält die Ereignisnutzlast eine leere Membership-Ressource.

Für den Aufruf dieser Methode ist eine Nutzerauthentifizierung erforderlich. Um Ereignisse aus einem Gruppenbereich aufzulisten, muss der authentifizierte Nutzer Mitglied des Gruppenbereichs sein.

Vorbereitung

Node.js

Space-Ereignisse auflisten

Wenn Sie Gruppenbereichsereignisse aus einem Chatbereich auflisten möchten, übergeben Sie Folgendes in Ihrer Anfrage:

  • Geben Sie mindestens einen Autorisierungsbereich an, um jeden Ereignistyp in Ihrer Anfrage zu unterstützen. Es empfiehlt sich, den restriktivsten Bereich auszuwählen, der die Funktion Ihrer App weiterhin ermöglicht. Informationen zum Auswählen eines Bereichs finden Sie unter Übersicht über Authentifizierung und Autorisierung.

  • Rufen Sie die Methode ListSpaceEvents() auf und übergeben Sie die filter der aufzulistenden Ereignistypen. Sie müssen mindestens einen Ereignistyp angeben. Außerdem können Sie nach Datum filtern. Eine Liste der unterstützten Ereignistypen finden Sie in der Referenzdokumentation zum Feld eventType der Ressource SpaceEvent.

Im folgenden Beispiel werden Ereignisse zu neuen Mitgliedschaften und Nachrichten in einem Bereich aufgeführt:

Node.js

chat/client-libraries/cloud/list-space-events-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly',
];

// This sample shows how to list space events with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages
    filter: 'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"',
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

main().catch(console.error);

Ersetzen Sie SPACE_NAME durch die ID aus der name des Bereichs, um dieses Beispiel auszuführen. Sie können die ID abrufen, indem Sie die Methode ListSpaces() aufrufen oder die URL des Bereichs verwenden.

Die Chat API gibt eine paginierte Liste von Bereichsereignissen zu neuen Mitgliedschaften und Nachrichten zurück.