Method: spaces.search

Retorna uma lista de espaços com base na pesquisa de um usuário. Requer a autenticação do usuário. O usuário precisa ser um administrador da organização do Google Workspace. Na solicitação, defina useAdminAccess como true.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
useAdminAccess

boolean

Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio "Gerenciar conversas de chats e espaços".

Requer o escopo do OAuth 2.0 chat.admin.spaces.readonly ou chat.admin.spaces.

No momento, este método só é compatível com acesso de administrador. Portanto, apenas true é aceito para este 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 vai ser automaticamente alterado 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.

Ao fazer a paginação, todos os outros parâmetros informados precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para outros parâmetros pode levar a 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, e 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 é correspondente ao prefixo sem diferenciar maiúsculas de minúsculas e de modo independente como uma substring em qualquer lugar do 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 só aceita 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 exemplo inválido é spaceType = "SPACE" OR displayName:"Hello".

Entre o mesmo campo, spaceType não oferece suporte aos operadores AND ou OR. displayName, "spaceHistoryState" e "externalUserAllowed" são compatíveis apenas com os 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 a contagem de usuários humanos que entraram diretamente em um espaço.
  • lastActiveTime: indica a hora em que o último item qualificado foi adicionado a qualquer tema do espaço.
  • createTime: indica a hora de criação do espaço.

Os valores válidos de operação de ordenação são:

  • ASC para crescente. Valor padrão.

  • DESC para decrescente.

As sintaxes compatíveis são:

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

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta com uma lista de espaços correspondentes à solicitação de espaços de pesquisa.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Campos
spaces[]

object (Space)

Página dos espaços solicitados.
nextPageToken

string

Um token que pode ser usado para recuperar a próxima página. Se o campo estiver vazio, não haverá páginas subsequentes.
totalSize

integer

O número total de espaços que correspondem à consulta em todas as páginas. Se o resultado for mais de 10.000 espaços, esse valor é uma estimativa.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o Guia de autorização.