Method: spaces.search

Muestra una lista de espacios en una organización de Google Workspace. Para ver un ejemplo, consulta Cómo buscar y administrar espacios.

Cuando useAdminAccess se establece en false, los resultados se limitan a los espacios en los que el usuario que llama es miembro. Para buscar con privilegios de administrador, establece useAdminAccess en true.

Admite los siguientes tipos de autenticación:

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

El valor máximo es 1,000 cuando useAdminAccess se establece en true. De lo contrario, el valor máximo es 100. Si usas un valor superior al máximo, se cambia automáticamente al valor máximo.
pageToken

string

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

Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con los de 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.
query

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
  • 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 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 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 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 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" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

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

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

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.
orderBy

string

Es opcional. Indica cómo se ordena 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 la 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 el ordenamiento. 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:

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta con una lista de espacios que corresponden a la solicitud de búsqueda de espacios.

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,
  "results": [
    {
      object (SearchSpaceResult)
    }
  ]
}
Campos
spaces[]
(deprecated)

object (Space)

Obsoleto: Usa el nuevo campo results en su lugar. Es una página de los espacios solicitados. Este campo solo se propagará cuando useAdminAccess se establezca en true y se dé de baja en favor del nuevo campo results.
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.

Solo se propaga cuando useAdminAccess se establece en true.
totalSize

integer

Es la cantidad total de espacios que coinciden con la consulta en todas las páginas. Si el resultado es de más de 10,000 espacios, este valor es una estimación.

Solo se propaga cuando useAdminAccess se establece en true.
results[]

object (SearchSpaceResult)

Solo salida. Es la lista de resultados de la búsqueda que coincidieron con la consulta.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • 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.

SearchSpaceResult

Es un solo elemento de resultado de una búsqueda de espacio.

Representación JSON 
{
  "space": {
    object (Space)
  }
}
Campos
space

object (Space)

Solo salida. Es el espacio coincidente.