Method: spaces.spaceEvents.list

Elenca gli eventi da uno spazio di Google Chat. Per ogni evento, il payload contiene la versione più recente della risorsa Chat. Ad esempio, se elenchi eventi relativi ai nuovi membri dello spazio, il server restituisce risorse Membership contenenti i dettagli più recenti sull'iscrizione. Se durante il periodo richiesto sono stati rimossi nuovi membri, il payload dell'evento contiene una risorsa Membership vuota.

Richiede l'autenticazione degli utenti. Per elencare gli eventi, l'utente autenticato deve essere membro dello spazio.

Per un esempio, vedi Elencare gli eventi da uno spazio di Google Chat.

Richiesta HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

obbligatorio. Nome della risorsa dello spazio di Google Chat in cui si sono verificati gli eventi.

Formato: spaces/{space}.

Parametri di ricerca

Parametri
pageSize

integer

Campo facoltativo. Il numero massimo di eventi dello spazio restituiti. Il servizio potrebbe restituire meno di questo valore.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
pageToken

string

Un token di pagina, ricevuto da una precedente chiamata di eventi dello spazio elenco. Specifica questo valore per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti per elencare gli eventi dello spazio devono corrispondere alla chiamata che ha fornito il token della pagina. Il trasferimento di valori diversi agli altri parametri potrebbe portare a risultati imprevisti.
filter

string

obbligatorio. Un filtro di query.

Devi specificare almeno un tipo di evento (eventType) utilizzando l'operatore :. Per filtrare in base a più tipi di eventi, utilizza l'operatore OR. Ometti tipi di eventi batch nel filtro. La richiesta restituisce automaticamente tutti gli eventi batch correlati. Ad esempio, se filtri in base a nuove reazioni (google.workspace.chat.reaction.v1.created), il server restituisce anche nuovi eventi di reazione in batch (google.workspace.chat.reaction.v1.batchCreated). Per un elenco dei tipi di eventi supportati, consulta la documentazione di riferimento di SpaceEvents.

Se vuoi, puoi anche filtrare per ora di inizio (startTime) e ora di fine (endTime):

  • startTime: timestamp esclusivo da cui iniziare a elencare gli eventi dello spazio. Puoi elencare gli eventi che si sono verificati fino a 28 giorni prima della data corrente. Se non specificati, vengono elencati gli eventi dello spazio degli ultimi 28 giorni.
  • endTime: timestamp inclusivo fino al quale sono elencati gli eventi dello spazio. Se non specificato, elenca gli eventi fino al momento della richiesta.

Per specificare un'ora di inizio o di fine, utilizza l'operatore = e il formato in RFC-3339. Per filtrare sia in base a startTime che in base a endTime, utilizza l'operatore AND.

Ad esempio, le seguenti query sono valide:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Le seguenti query non sono valide:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

Le query non valide vengono rifiutate dal server con un errore INVALID_ARGUMENT.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per l'elenco degli eventi dello spazio.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Campi
spaceEvents[]

object (SpaceEvent)

I risultati vengono restituiti in ordine cronologico (a partire dall'evento meno recente).
nextPageToken

string

Token di continuazione utilizzato per recuperare più eventi. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Per ulteriori informazioni, consulta la guida all'autorizzazione.