Elencare gli eventi da uno spazio di Google Chat

Questa guida spiega come utilizzare il metodo list() nella risorsa SpaceEvent dell'API Google Chat per elencare le modifiche alle risorse in uno spazio.

La risorsa SpaceEvent rappresenta una modifica allo spazio di destinazione, incluse le risorse figlio dello spazio come messaggi, reazioni e abbonamenti. Per ulteriori informazioni sull'elenco dei tipi di eventi e dei payload degli eventi supportati, consulta i campi eventType e payload della documentazione di riferimento della risorsa SpaceEvent.

Puoi elencare gli eventi fino a 28 giorni prima dell'ora della richiesta. Il server restituisce gli eventi che contengono la versione più recente della risorsa interessata. Ad esempio, se elenchi eventi relativi a nuovi membri dello spazio, il server restituisce risorse Membership che contengono i dettagli di appartenenza più recenti. Se nuovi membri sono stati rimossi durante il periodo richiesto, il payload dell'evento contiene una risorsa Membership vuota.

Per chiamare questo metodo, devi utilizzare l'autenticazione utente. Per elencare gli eventi di uno spazio, l'utente autenticato deve essere un membro dello spazio.

Prerequisiti

Node.js

Elencare gli eventi dello spazio

Per elencare gli eventi dello spazio di uno spazio di Chat, passa quanto segue nella richiesta:

  • Specifica uno o più ambiti di autorizzazione per supportare ogni tipo di evento nella tua richiesta. Come best practice, scegli l'ambito più restrittivo che consenta comunque il funzionamento della tua app. Per scegliere un ambito, vedi la Panoramica di autenticazione e autorizzazione.

  • Chiama il metodo ListSpaceEvents() passando filter dei tipi di eventi da elencare. Devi specificare almeno un tipo di evento e puoi anche filtrare per data. Per un elenco dei tipi di eventi supportati, consulta il campo eventType della risorsa SpaceEvent nella documentazione di riferimento.

L'esempio seguente elenca gli eventi relativi a nuovi abbonamenti e messaggi in uno spazio:

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

Per eseguire questo esempio, sostituisci SPACE_NAME con l'ID dello spazio name. Puoi ottenere l'ID chiamando il metodo ListSpaces() o dall'URL dello spazio.

L'API Chat restituisce un elenco impaginato di eventi dello spazio relativi a nuove iscrizioni e nuovi messaggi.