Method: spaces.search

Devuelve una lista de espacios en una organización de Google Workspace según la búsqueda de un administrador.

Requiere autenticación del usuario con privilegios de administrador. En la solicitud, configura useAdminAccess como true.

Solicitud HTTP

GET https://chat.googleapis.com/v1/spaces:search

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
useAdminAccess

boolean

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

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

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

Actualmente, este método solo admite acceso de administrador, por lo que solo se acepta true para este campo.
pageSize

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 mostrarán como máximo 100 espacios.

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

string

Un token, recibido de la llamada a los espacios de búsqueda anterior. Proporciona este parámetro para recuperar la página siguiente.

Durante la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de la página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
query

string

Obligatorio. Una búsqueda.

Puedes usar los siguientes parámetros para realizar búsquedas:

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

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

customer es obligatorio 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 divide en tokens, y cada token se compara con un prefijo de forma independiente y sin distinción de mayúsculas o minúsculas como una subcadena 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 o even.

externalUserAllowed acepta true o false.

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

spaceType es obligatorio 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".

Entre el mismo campo, spaceType no admite los operadores AND ni OR. displayName, "spaceHistoryState" y "externalUserAllowed" solo admiten operadores OR. lastActiveTime y createTime admiten los 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:

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")
orderBy

string

Opcional. Indica cómo se ordena la lista de espacios.

Los atributos compatibles 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 el momento en que se agregó el último elemento apto a cualquier tema de este espacio.
  • createTime: Indica la hora de creación del espacio.

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

  • ASC para ascendente. Valor predeterminado

  • DESC para el orden descendente.

Las sintaxis admitidas son las siguientes:

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

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta con una lista de espacios correspondientes a la solicitud de espacios de búsqueda.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campos
spaces[]

object (Space)

Una página de los espacios solicitados.
nextPageToken

string

Es un token que se puede usar para recuperar la página siguiente. Si este campo está vacío, no hay páginas posteriores.
totalSize

integer

Es la cantidad total de espacios que coinciden con la búsqueda en todas las páginas. Si el resultado es superior a 10,000 espacios, este valor es una estimación.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.