Method: spaces.messages.search

string

Obbligatorio. Una query di ricerca.

La query può specificare una o più parole chiave di ricerca, che vengono utilizzate per filtrare i risultati.

Puoi anche filtrare i risultati utilizzando i seguenti campi del messaggio:

• createTime: accetta un timestamp nel formato RFC-3339 e gli operatori di confronto supportati sono: < e >=.
• sender.name: il nome della risorsa del mittente (users/{user}). Supporta solo =. Puoi utilizzare l'email come alias per {user}. Ad esempio, users/example@gmail.com, dove example@gmail.com è l'email dell'utente di Google Chat.
• space.name: Il nome della risorsa dello spazio in cui viene pubblicato il messaggio. (spaces/{space}). Supporta solo =. Se questo filtro non è impostato, la ricerca viene eseguita in tutti i messaggi diretti e gli spazi a cui l'utente ha accesso in qualità di membro dello spazio.
• space.display_name: supporta l'operatore : (contiene) e filtra gli spazi in base a una corrispondenza parziale del nome visualizzato. I risultati sono limitati alle prime cinque corrispondenze di spazi. Ad esempio, space.display_name:Project cerca i messaggi nei primi cinque spazi che contengono la parola "Progetto" nei nomi visualizzati.
• attachment: supporta l'operatore :* (contiene) per verificare la presenza di allegati. Se viene specificato attachment:*, vengono restituiti solo i messaggi con almeno un allegato.
• annotations.user_mentions.user.name: Il nome della risorsa dell'utente menzionato (users/{user}). Supporta solo : (ha). Ad esempio: annotations.user_mentions.user.name:"users/1234567890" restituisce solo i messaggi che contengono una menzione dell'utente specificato. In alternativa, l'alias me può essere utilizzato per filtrare i messaggi che menzionano l'utente chiamante, ad esempio: annotations.user_mentions.user.name:users/me. Puoi anche utilizzare l'email come alias per {user}, ad esempio users/example@gmail.com.

Per il filtro avanzato, sono disponibili anche le seguenti funzioni:

• has_link(): restituisce solo i messaggi che contengono almeno un link ipertestuale nel testo del messaggio.
• is_unread(): Filtra i messaggi che sono stati letti dall'utente chiamante.

L'utilizzo del filtro space.display_name richiede che le credenziali di chiamata includano uno dei seguenti ambiti di autorizzazione:

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

L'utilizzo del filtro is_unread() richiede che le credenziali di chiamata includano uno dei seguenti ambiti di autorizzazione:

• https://www.googleapis.com/auth/chat.users.readstate.readonly
• https://www.googleapis.com/auth/chat.users.readstate

Nei diversi campi sono supportati solo gli operatori AND. Un esempio valido è sender.name = "users/1234567890" AND is_unread(). La parola AND è facoltativa e viene sottintesa se omessa. Ad esempio, sender.name = "users/1234567890" is_unread() è valido ed equivale all'esempio precedente. Un esempio non valido è sender.name = "users/1234567890" OR is_unread() perché OR non è supportato tra campi diversi.

All'interno dello stesso campo:

• createTime supporta solo AND e può essere utilizzato solo per rappresentare un intervallo, ad esempio createTime >= "2022-01-01T00:00:00+00:00" AND createTime < "2023-01-01T00:00:00+00:00".
• sender.name supporta solo l'operatore OR, ad esempio: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
• space.name supporta solo l'operatore OR, ad esempio: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
• space.display_name supporta gli operatori AND e OR, ma non una combinazione di entrambi. Ad esempio: space.display_name:Project AND space.display_name:Tasks restituisce i messaggi che si trovano in spazi con nomi visualizzati contenenti sia Project sia Tasks, mentre space.display_name:Project OR space.display_name:Tasks restituisce i messaggi che si trovano in spazi con nomi visualizzati contenenti Project o Tasks o entrambi.
• annotations.user_mentions.user.name supporta gli operatori AND e OR, ma non una combinazione di entrambi. Ad esempio: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" restituisce solo i messaggi che menzionano entrambi gli utenti, mentre annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" restituisce i messaggi che menzionano uno o entrambi gli utenti.

Le parentesi sono necessarie per disambiguare la precedenza degli operatori quando si combinano gli operatori AND e OR nella stessa query. Ad esempio (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). In caso contrario, le parentesi sono facoltative.

Le seguenti query di esempio sono valide:

"Pending reports" AND createTime >= "2023-01-01T00:00:00Z"

sender.name = "users/example@gmail.com"

annotations.user_mentions.user.name:"users/0987654321"

attachment:* AND space.name = "spaces/ABCDEFGH"

tasks AND is_unread() AND sender.name = "users/1234567890"

"things to do" "urgent"

(sender.name = "users/1234567890")
AND (createTime < "2023-05-01T00:00:00Z")

tasks AND space.name = "spaces/ABCDEFGH" AND has_link()

"project one" is_unread()

space.display_name:Project tasks

La lunghezza massima della query è di 1000 caratteri.

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

integer

Facoltativo. Il numero massimo di risultati da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore.

Se non specificato, vengono restituiti al massimo 25 risultati.

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

string

Facoltativo. Un token ricevuto dalla precedente chiamata di ricerca 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.

string

Facoltativo. Come viene ordinato l'elenco dei risultati.

Gli attributi supportati per l'ordinamento sono:

• createTime: ordina i risultati in base all'ora di creazione del messaggio. Valore predefinito.
• relevance: ordina i risultati per pertinenza.

L'ordinamento predefinito è createTime desc. È supportato un solo ordine per query (createTime o relevance). È supportato solo l'ordine decrescente (desc), che deve essere specificato dopo l'attributo di ordinamento.

enum (SearchMessagesView)

Facoltativo. Specifica il tipo di visualizzazione dei risultati di ricerca da restituire. Il valore predefinito è SEARCH_MESSAGES_VIEW_BASIC.