Method: spaces.search

boolean

Cuando es true, el método se ejecuta con los privilegios de administrador de Google Workspace del usuario.

El usuario que llama debe ser un administrador de Google Workspace con el privilegio para administrar el chat y las conversaciones de los espacios.

Requiere el permiso de OAuth 2.0 chat.admin.spaces.readonly o chat.admin.spaces.

La configuración de useAdminAccess en false está disponible en la Versión preliminar para desarrolladores.

integer

Es la cantidad máxima de espacios que se mostrarán. El servicio puede mostrar menos que este valor.

Si no se especifica, se muestran como máximo 100 espacios.

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

string

Es un token que se recibió de la llamada anterior a los espacios 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 se pasan valores diferentes a los otros parámetros, es posible que se obtengan resultados inesperados.

string

Obligatorio. Es una consulta de búsqueda.

Puedes buscar con los siguientes parámetros cuando useAdminAccess se establece en true:

• createTime
• customer
• displayName
• externalUserAllowed
• lastActiveTime
• spaceHistoryState
• spaceType

Cuando useAdminAccess se establece en false:

• displayName
• externalUserAllowed

createTime y lastActiveTime aceptan una marca de tiempo en formato RFC-3339, y los operadores de comparación admitidos son: =, <, >, <=, >=.

customer es obligatorio cuando useAdminAccess se establece en true y se usa para indicar de qué cliente se deben recuperar los espacios. customers/my_customer es el único valor admitido.

displayName solo acepta el operador HAS (:) . El texto que debe coincidir primero se tokeniza en tokens, y cada token se compara con el prefijo sin distinción entre mayúsculas y minúsculas y de forma independiente como una substring en cualquier lugar del displayName del espacio. Por ejemplo, Fun Eve coincide con Fun event o The evening was fun, pero no con notFun event ni even. Cuando useAdminAccess se establece en false, displayName es obligatorio para recuperar resultados significativos. De lo contrario, el comportamiento predeterminado es mostrar una respuesta vacía.

externalUserAllowed acepta true o false.

spaceHistoryState solo acepta valores del campo historyState de un recurso space.

spaceType es obligatorio cuando useAdminAccess se establece en true, y el único valor válido es SPACE.

En diferentes campos, solo se admiten operadores AND. Un ejemplo válido es spaceType = "SPACE" AND displayName:"Hello" y un ejemplo no válido es spaceType = "SPACE" OR displayName:"Hello".

En el mismo campo, spaceType no admite operadores AND ni OR. displayName, 'spaceHistoryState' y 'externalUserAllowed' solo admiten operadores OR. lastActiveTime y createTime admiten operadores AND y OR. AND solo se puede usar para representar un intervalo, como lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Las siguientes consultas de ejemplo son válidas cuando useAdminAccess se establece en true:

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")

Las siguientes consultas de ejemplo son válidas cuando useAdminAccess se establece en false:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")

string

Es opcional. Es el orden en que se muestra la lista de espacios.

Los atributos admitidos para ordenar son los siguientes:

• membershipCount.joined_direct_human_user_count: Indica la cantidad de usuarios humanos que se unieron directamente a un espacio.
• lastActiveTime: Indica la hora en que se agregó el último elemento apto a cualquier tema de este espacio.
• createTime: Indica la hora de creación del espacio.

Cuando useAdminAccess es false, solo se admiten createTime y relevance para ordenar. Solo se admite DESC para estos campos en búsquedas que no son de administrador.

Los valores válidos de la operación de ordenamiento son los siguientes:

• ASC para el orden ascendente Valor predeterminado

• DESC para el orden descendente

La sintaxis admitida es cuando useAdminAccess se establece en true:

• membershipCount.joined_direct_human_user_count DESC
• membershipCount.joined_direct_human_user_count ASC
• lastActiveTime DESC
• lastActiveTime ASC
• createTime DESC
• createTime ASC

Cuando useAdminAccess se establece en false:

• createTime DESC
• relevance DESC

object (Space)

Solo salida. Es el espacio coincidente.