Actualmente, este método solo admite acceso de administrador, por lo que solo se acepta true para este campo.
pageSize
integer
La cantidad máxima de espacios que se mostrarán. El servicio puede mostrar menos que este valor.
Si no se especifica, se muestran 100 espacios como máximo.
El valor máximo es 1,000. Si usas un valor superior a 1,000, este se cambia 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.
Cuando se realiza la paginación, todos los demás parámetros proporcionados deben coincidir con la llamada que proporcionó el token de página. Pasar valores diferentes a los otros parámetros puede generar resultados inesperados.
query
string
Obligatorio. Una búsqueda.
Puedes buscar con los siguientes parámetros:
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 (:). Primero, se asigna un token al texto que debe coincidir en tokens, y a cada token se le asigna un prefijo que no distingue entre mayúsculas y minúsculas, y es independiente como una subcadena en el 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 admite 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 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 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:
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:
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Falta la información que necesito","missingTheInformationINeed","thumb-down"],["Muy complicado o demasiados pasos","tooComplicatedTooManySteps","thumb-down"],["Desactualizado","outOfDate","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Problema con las muestras o los códigos","samplesCodeIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-02-27 (UTC)"],[[["Returns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType."],["Requires administrator privileges and the `useAdminAccess` parameter set to `true` in the request."],["Utilizes the `GET https://chat.googleapis.com/v1/spaces:search` HTTP request with query parameters for customization."],["Needs authorization with either the `chat.admin.spaces` or `chat.admin.spaces.readonly` OAuth scope."],["Response body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces."]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"]]
