Retorna uma lista de espaços em uma organização do Google Workspace com base na pesquisa de um administrador. Na solicitação, defina useAdminAccess como true. Por exemplo, consulte Pesquisar e gerenciar espaços.
Requer o escopo do OAuth 2.0chat.admin.spaces.readonly ou chat.admin.spaces.
No momento, esse método só aceita acesso de administrador. Portanto, apenas true é aceito para esse campo.
pageSize
integer
O número máximo de espaços a serem retornados. O serviço pode retornar menos que esse valor.
Se não for especificado, no máximo 100 espaços serão retornados.
O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será mudado automaticamente para 1.000.
pageToken
string
Um token recebido da chamada anterior de espaços de pesquisa. Forneça esse parâmetro para recuperar a página seguinte.
Na paginação, todos os outros parâmetros enviados precisam corresponder à chamada que proporcionou o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.
query
string
Obrigatório. Uma consulta de pesquisa.
É possível pesquisar usando os seguintes parâmetros:
createTime
customer
displayName
externalUserAllowed
lastActiveTime
spaceHistoryState
spaceType
createTime e lastActiveTime aceitam um carimbo de data/hora no formato RFC-3339. Os operadores de comparação compatíveis são: =, <, >, <=, >=.
customer é obrigatório e usado para indicar de qual cliente buscar espaços. customers/my_customer é o único valor compatível.
displayName aceita apenas o operador HAS (:). O texto a ser correspondido é primeiro tokenizado em tokens, e cada token é correspondido por prefixo sem sensibilidade a maiúsculas e minúsculas e de forma independente como uma substring em qualquer lugar no displayName do espaço. Por exemplo, Fun Eve corresponde a Fun event ou The
evening was fun, mas não a notFun event ou even.
externalUserAllowed aceita true ou false.
spaceHistoryState aceita apenas valores do campo historyState de um recurso space.
spaceType é obrigatório, e o único valor válido é SPACE.
Em campos diferentes, apenas os operadores AND são aceitos. Um exemplo válido é spaceType = "SPACE" AND displayName:"Hello" e um inválido é spaceType = "SPACE" OR displayName:"Hello".
No mesmo campo, spaceType não é compatível com os operadores AND ou OR. displayName, "spaceHistoryState" e "externalUserAllowed" só são compatíveis com operadores OR. lastActiveTime e createTime são compatíveis com os operadores AND e OR. AND só pode ser usado para representar um intervalo, como lastActiveTime
< "2022-01-01T00:00:00+00:00" AND lastActiveTime >
"2023-01-01T00:00:00+00:00".
As consultas de exemplo a seguir são 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. Como a lista de espaços é ordenada.
Os atributos aceitos para ordenação são:
membershipCount.joined_direct_human_user_count: indica o número de usuários humanos que entraram diretamente em um espaço.
lastActiveTime: indica o momento em que o último item qualificado é adicionado a qualquer tema deste espaço.
createTime: indica o momento da criação do espaço.
Os valores válidos para a operação de ordenação são:
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 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,[]]
