Method: spaces.search

Retorna uma lista de espaços em uma organização do Google Workspace com base na pesquisa de um administrador.

Exige a autenticação do usuário com privilégios de administrador. 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 de gerenciar chats e conversas em espaços.

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

No momento, esse método só oferece suporte ao 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, serão retornados no máximo 100 espaços.

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será alterado automaticamente para 1.000.
pageToken

string

Um token recebido da chamada de espaços de pesquisa anterior. Forneça esse parâmetro para recuperar a página subsequente.

Na paginação, todos os outros parâmetros precisam corresponder à chamada que informou o token da página. Passar 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 aceitos são: =, <, >, <= e >=.

customer é obrigatório e é usado para indicar de qual cliente buscar os espaços. customers/my_customer é o único valor compatível.

displayName só aceita o operador HAS (:). O texto a ser correspondido é tokenizado primeiro, e cada token é correspondido por prefixo, sem distinção entre 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, somente 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".

No mesmo campo, spaceType não aceita operadores AND ou OR. displayName, "spaceHistoryState" e "externalUserAllowed" oferecem suporte apenas a 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 de ordenação aceitos 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 é adicionado a qualquer tema desse 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:

  • ASC para crescente. Valor padrão.

  • DESC para decrescente.

As sintaxes aceitas 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

Responda 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)

Uma página dos espaços solicitados.
nextPageToken

string

Um token que pode ser usado para recuperar a próxima página. Se esse 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 será 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.