Method: spaces.messages.list

Elenca i messaggi in uno spazio di cui il chiamante è membro, inclusi i messaggi provenienti da spazi e membri bloccati. Per un esempio, vedi Elenca messaggi. Richiede l'autenticazione degli utenti.

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 ricerca

Parametri
pageSize

integer

Il numero massimo di messaggi restituiti. Il servizio potrebbe restituire meno messaggi di questo valore.

Se non specificati, vengono restituiti al massimo 25 valori.

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, in caso di ripresa da una query precedente.

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

Durante l'impaginazione, tutti gli altri parametri forniti 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

Un filtro di 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 in 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 oppure 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 in base al thread, specifica thread.name nel formato spaces/{space}/threads/{thread}. Puoi specificare un solo thread.name per query.

Per filtrare sia per thread sia per 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, in caso di ripresa da una query precedente.

Come viene ordinato l'elenco dei messaggi. Specifica un valore per ordinare tramite un'operazione di ordinamento. I valori validi per le operazioni di ordinamento sono i seguenti:

  • ASC per l'ordine crescente.

  • DESC per ordine decrescente.

L'ordinamento predefinito è createTime ASC.

showDeleted

boolean

Se includere i messaggi eliminati. I messaggi eliminati includono data e ora dell'eliminazione e metadati relativi alla loro eliminazione, ma i contenuti non sono disponibili.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

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 dei risultati successiva. Se è vuoto, non ci saranno pagine successive.

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

Per ulteriori informazioni, consulta la guida all'autorizzazione.