Method: spaces.spaceEvents.list

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

Supporta i seguenti tipi di autenticazione con un ambito di autorizzazione appropriato per la lettura dei dati richiesti:

  • Autenticazione dell'app con approvazione dell'amministratore con uno dei seguenti ambiti di autorizzazione:

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

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

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

Per elencare gli eventi, il chiamante autenticato deve essere membro dello spazio.

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

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 Chat di Google in cui si sono verificati gli eventi.

Formato: spaces/{space}.

Parametri di query

Parametri
pageSize

integer

Facoltativo. Il numero massimo di eventi dello spazio restituiti. Il servizio potrebbe restituire un valore inferiore.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
pageToken

string

Facoltativo. Un token di pagina, ricevuto da una precedente chiamata di eventi dello spazio di elenco. Forniscilo per recuperare la pagina successiva.

Quando esegui la paginazione, tutti gli altri parametri forniti per elencare gli eventi dello spazio devono corrispondere alla chiamata che ha fornito il token di pagina. Il passaggio 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 has :. Per filtrare in base a più tipi di eventi, utilizza l'operatore OR. Ometti i 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 eventi batch di nuove reazioni (google.workspace.chat.reaction.v1.batchCreated). Per un elenco dei tipi di eventi supportati, consulta la documentazione di riferimento di SpaceEvents.

In alternativa, puoi anche filtrare in base all'ora di inizio (startTime) e all'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 fa. Se non specificato, elenca gli eventi dello spazio degli ultimi 28 giorni.
  • endTime: timestamp inclusivo fino al quale vengono 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 uguale = e il formato in RFC-3339. Per filtrare in base a startTime e 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 (prima l'evento più vecchio). Nota: il campo permissionSettings non viene restituito nell'oggetto Space per le richieste di elenco.
nextPageToken

string

Token di continuazione utilizzato per recuperare altri 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.app.memberships
  • https://www.googleapis.com/auth/chat.app.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.app.spaces.readonly
  • 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.