Method: spaces.messages.list

Elenca i messaggi in uno spazio di cui il chiamante è membro, inclusi i messaggi provenienti da membri e spazi bloccati. I messaggi di sistema, come quelli che annunciano i nuovi membri dello spazio, non sono inclusi. Se elenchi i messaggi di uno spazio senza messaggi, la risposta è un oggetto vuoto. Quando utilizzi un'interfaccia REST/HTTP, la risposta contiene un oggetto JSON vuoto, {}. Per un esempio, vedi Elenco dei messaggi.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con approvazione dell'amministratore nell'anteprima per gli sviluppatori con l'ambito di autorizzazione:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. Quando utilizzi questo ambito di autenticazione, questo metodo restituisce solo i messaggi pubblici in uno spazio. Non include i messaggi privati.

  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa dello spazio da cui elencare i messaggi.

Formato: spaces/{space}

Parametri di query

Parametri
pageSize

integer

Facoltativo. Il numero massimo di messaggi restituiti. Il servizio potrebbe restituire un numero di messaggi inferiore a questo valore.

Se non specificato, vengono restituiti al massimo 25 risultati.

Il valore massimo è 1000. Se utilizzi un valore superiore a 1000, questo viene automaticamente modificato in 1000.

I valori negativi restituiscono un errore INVALID_ARGUMENT.
pageToken

string

Facoltativo. Un token di pagina ricevuto da una precedente chiamata dell'elenco dei messaggi. Fornisci questo parametro per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti 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

Facoltativo. Un filtro query.

Puoi filtrare i messaggi per data (createTime) e thread (thread.name).

Per filtrare i messaggi in base alla data di creazione, specifica createTime con un timestamp nel formato RFC-3339 e virgolette doppie. Ad esempio: "2023-04-21T11:30:00-04:00". Puoi utilizzare l'operatore maggiore di > per elencare i messaggi creati dopo un timestamp o l'operatore minore di < per elencare i messaggi creati prima di un timestamp. Per filtrare i messaggi in un intervallo di tempo, utilizza l'operatore AND tra due timestamp.

Per filtrare per thread, specifica thread.name, formattato come spaces/{space}/threads/{thread}. Puoi specificare un solo thread.name per query.

Per filtrare per thread e data, utilizza l'operatore AND nella query.

Ad esempio, le seguenti query sono valide:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

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

string

Facoltativo. Come viene ordinato l'elenco dei messaggi. Specifica un valore per ordinare in base a un'operazione di ordinamento. I valori validi dell'operazione di ordinamento sono:

  • ASC per l'ordine crescente.

  • DESC per l'ordine decrescente.

L'ordinamento predefinito è createTime ASC.
showDeleted

boolean

Facoltativo. Se includere i messaggi eliminati. I messaggi eliminati includono l'ora di eliminazione e i metadati relativi all'eliminazione, ma i contenuti dei messaggi non sono disponibili.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per i messaggi della scheda.

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

Rappresentazione JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
Campi
messages[]

object (Message)

Elenco dei messaggi.
nextPageToken

string

Puoi inviare un token come pageToken per recuperare la pagina successiva dei risultati. Se è vuoto, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.