Devuelve una lista de espacios en una organización de Google Workspace según la búsqueda de un administrador. En la solicitud, configura useAdminAccess como true. Para ver un ejemplo, consulta Cómo buscar y administrar espacios.
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 devolverán. El servicio puede mostrar menos que este valor.
Si no se especifica, se devolverá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
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 coincidir con la llamada que proporcionó el token de página. Si pasas valores diferentes a los otros parámetros, es posible que obtengas resultados inesperados.
query
string
Es obligatorio. Es una búsqueda.
Puedes realizar búsquedas 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, el texto que se debe hacer coincidir se tokeniza en unidades, y cada unidad se compara con el prefijo de forma independiente y sin distinguir mayúsculas de minúsculas como una subcadena en cualquier parte 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. 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 fecha y hora en que se agregó el último elemento apto a cualquier tema de este espacio.
createTime: Indica la fecha y hora de creación del espacio.
Los valores válidos de la operación de ordenamiento son los siguientes:
Es un token que se puede usar para recuperar la página siguiente. Si este campo está vacío, no hay páginas siguientes.
totalSize
integer
Es la cantidad total de espacios que coinciden con la búsqueda en todas las páginas. Si el resultado supera los 10,000 espacios, este valor es una estimación.
Permisos 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-08-20 (UTC)"],[[["\u003cp\u003eReturns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType.\u003c/p\u003e\n"],["\u003cp\u003eRequires administrator privileges and the \u003ccode\u003euseAdminAccess\u003c/code\u003e parameter set to \u003ccode\u003etrue\u003c/code\u003e in the request.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eGET https://chat.googleapis.com/v1/spaces:search\u003c/code\u003e HTTP request with query parameters for customization.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with either the \u003ccode\u003echat.admin.spaces\u003c/code\u003e or \u003ccode\u003echat.admin.spaces.readonly\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces.\u003c/p\u003e\n"]]],["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"],null,[]]
