Method: spaces.messages.search

string

Obligatorio. Es una consulta de búsqueda.

La consulta puede especificar una o más palabras clave de búsqueda, que se usan para filtrar los resultados.

También puedes filtrar los resultados con los siguientes campos de mensaje:

• createTime: Acepta una marca de tiempo en formato RFC-3339 y los operadores de comparación admitidos son: < y >=.
• sender.name: Es el nombre del recurso del remitente (users/{user}). Solo admite =. Puedes usar el correo electrónico como alias de {user}. Por ejemplo, users/example@gmail.com, donde example@gmail.com es el correo electrónico del usuario de Google Chat.
• space.name: Es el nombre del recurso del espacio en el que se publicó el mensaje (spaces/{space}). Solo admite =. Si no se establece este filtro, la búsqueda se realiza en todos los mensajes directos y espacios a los que el usuario tiene acceso como miembro del espacio.
• space.display_name: Admite el operador : (tiene) y filtra los espacios según una coincidencia parcial de su nombre visible. Los resultados se limitan a las cinco coincidencias principales de espacios. Por ejemplo, space.display_name:Project busca mensajes en los cinco espacios principales que contienen la palabra "Project" en sus nombres visibles.
• attachment: Admite el operador :* (tiene cualquiera) para verificar la presencia de archivos adjuntos. Si se especifica attachment:*, solo se muestran los mensajes que tienen al menos un archivo adjunto.
• annotations.user_mentions.user.name: Es el nombre del recurso del usuario mencionado (users/{user}). Solo admite : (tiene). Por ejemplo: annotations.user_mentions.user.name:"users/1234567890" solo muestra los mensajes que contienen una mención al usuario especificado. Como alternativa, se puede usar el alias me para filtrar los mensajes que mencionan al usuario que realiza la llamada, por ejemplo: annotations.user_mentions.user.name:users/me. También puedes usar el correo electrónico como alias de {user}, por ejemplo, users/example@gmail.com.

Para el filtrado avanzado, también están disponibles las siguientes funciones:

• has_link(): Muestra solo los mensajes que tienen al menos un hipervínculo en el texto del mensaje.
• is_unread(): Filtra los mensajes que leyó el usuario que realiza la llamada.

Para usar el filtro space.display_name, las credenciales de llamada deben incluir uno de los siguientes permisos de autorización:

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

Para usar el filtro is_unread(), las credenciales de llamada deben incluir uno de los siguientes permisos de autorización:

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

En diferentes campos, solo se admiten operadores AND. Un ejemplo válido es sender.name = "users/1234567890" AND is_unread(). La palabra AND es opcional y está implícita si se omite. Por ejemplo, sender.name = "users/1234567890" is_unread() es válido y equivale al ejemplo anterior. Un ejemplo no válido es sender.name = "users/1234567890" OR is_unread() porque OR no es compatible entre diferentes campos.

Entre el mismo campo:

• createTime solo admite AND y solo se puede usar para representar un intervalo, como createTime >= "2022-01-01T00:00:00+00:00" AND createTime < "2023-01-01T00:00:00+00:00".
• sender.name solo admite el operador OR, por ejemplo: sender.name = "users/1234567890" OR sender.name = "users/0987654321".
• space.name solo admite el operador OR, por ejemplo: space.name = "spaces/ABCDEFGH" OR space.name = "spaces/QWERTYUI".
• space.display_name admite los operadores AND y OR, pero no una combinación de ambos. Por ejemplo: space.display_name:Project AND space.display_name:Tasks muestra mensajes que están en espacios con nombres visibles que contienen Project y Tasks, mientras que space.display_name:Project OR space.display_name:Tasks muestra mensajes que están en espacios con nombres visibles que contienen Project o Tasks o ambos.
• annotations.user_mentions.user.name admite los operadores AND y OR, pero no una combinación de ambos. Por ejemplo: annotations.user_mentions.user.name:"users/1234567890" AND annotations.user_mentions.user.name:"users/0987654321" solo muestra los mensajes que mencionan a ambos usuarios, mientras que annotations.user_mentions.user.name:"users/1234567890" OR annotations.user_mentions.user.name:"users/0987654321" muestra los mensajes que mencionan a cualquiera de los usuarios o a ambos.

Los paréntesis son necesarios para desambiguar la precedencia del operador cuando se combinan operadores AND y OR en la misma consulta. Por ejemplo: (sender.name="users/me" OR sender.name="users/123456") AND is_unread(). De lo contrario, los paréntesis son opcionales.

Las siguientes consultas de ejemplo son válidas:

"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 longitud máxima de la consulta es de 1,000 caracteres.

El servidor rechaza las consultas no válidas con un error INVALID_ARGUMENT.

integer

Opcional. La cantidad máxima de resultados que se mostrarán. El servicio puede mostrar menos que este valor.

Si no se especifica, se muestran, como máximo, 25.

El valor máximo es 100. Si usas un valor superior a 100, se cambia automáticamente a 100.

string

Opcional. Es un token que se recibió de la llamada anterior a los mensajes de búsqueda. Proporciona este parámetro para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben guardar correspondencia con la llamada que proporcionó el token de la página. Si pasas valores diferentes a los otros parámetros, es posible que obtengas resultados inesperados.

string

Opcional. Es la forma en que se ordena la lista de resultados.

Los atributos admitidos para ordenar son los siguientes:

• createTime: Ordena los resultados por la hora de creación del mensaje. Valor predeterminado
• relevance: Ordena los resultados por relevancia (versión preliminar para desarrolladores de science)

El orden predeterminado es createTime desc. Solo se admite un orden por consulta (createTime o relevance). Solo se admite el orden descendente (desc), y debe especificarse después del atributo de orden.

enum (SearchMessagesView)

Opcional. Especifica qué tipo de vista de resultados de búsqueda se mostrará. El valor predeterminado es SEARCH_MESSAGES_VIEW_BASIC.