Method: spaces.search

Retorna uma lista de espaços em uma organização do Google Workspace. Para conferir um exemplo, consulte Pesquisar e gerenciar espaços.

Quando useAdminAccess é definido como false, os resultados são limitados a espaços em que o usuário que faz a chamada é um membro participante. Para pesquisar com privilégios de administrador, defina useAdminAccess como true. A configuração de useAdminAccess como false está disponível na prévia para desenvolvedores.

Oferece suporte aos seguintes tipos de autenticação:

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 conversas do Chat e espaços.

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

A configuração de useAdminAccess como false está disponível na prévia para desenvolvedores.

pageSize

integer

O número máximo de espaços a serem retornados. O serviço pode retornar um valor inferior a este.

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á 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 seguinte.

Ao paginar, todos os outros parâmetros fornecidos precisam corresponder à chamada que forneceu o token da página. A transmissão de valores diferentes para os outros parâmetros pode levar a resultados inesperados.
query

string

Obrigatório. Uma consulta de pesquisa.

É possível pesquisar usando os seguintes parâmetros quando useAdminAccess está definido como true:

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

Quando useAdminAccess está definido como false:

  • displayName
  • externalUserAllowed
  • 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 quando useAdminAccess está definido como true e é usado para indicar de qual cliente buscar espaços. customers/my_customer é o único valor compatível.

displayName só aceita o operador HAS (:). O texto a ser correspondido é primeiro tokenizado em tokens, e cada token é correspondido por prefixo de maneira independente e sem distinção entre maiúsculas e minúsculas 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. Quando useAdminAccess está definido como false, displayName é obrigatório para recuperar resultados significativos. Caso contrário, o comportamento padrão é retornar uma resposta vazia.

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 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 oferece suporte a operadores AND ou OR. displayName, "spaceHistoryState" e "externalUserAllowed" só oferecem suporte a operadores OR. lastActiveTime e createTime oferecem suporte a 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 quando useAdminAccess está definido como true:

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

As consultas de exemplo a seguir são válidas quando useAdminAccess está definido como false:

displayName:"Hello World" AND spaceType = "SPACE"

(displayName:"Hello" OR displayName:"Fun") AND spaceType = "SPACE"

(externalUserAllowed = "true" AND spaceType = "SPACE") // Returns an
empty response.

(externalUserAllowed = "true" AND displayName:"Hello" AND spaceType =
"SPACE")
orderBy

string

Opcional. Como a lista de espaços é ordenada.

Os atributos compatíveis para ordenar 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 tópico desse espaço.
  • createTime: indica a hora da criação do espaço.

Quando useAdminAccess é false, apenas createTime e relevance são aceitos para ordenação. Apenas DESC é aceito para esses campos em pesquisas não administrativas.

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

  • ASC para crescente. Valor padrão.

  • DESC para decrescente.

A sintaxe aceita é quando useAdminAccess está definido como true:

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

Quando useAdminAccess está definido como false:

  • createTime DESC
  • relevance DESC

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,
  "results": [
    {
      object (SearchSpaceResult)
    }
  ]
}
Campos
spaces[]
(deprecated)

object (Space)

Descontinuado: use o novo campo results. Uma página dos espaços solicitados. Esse campo será preenchido apenas quando useAdminAccess estiver definido como true e será descontinuado em favor do novo campo results.
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 maior que 10.000 espaços, esse valor será uma estimativa.
results[]

object (SearchSpaceResult)

Apenas saída.

A lista de resultados da pesquisa que correspondem à consulta.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • 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.

SearchSpaceResult

Um único item de resultado de uma pesquisa de espaço.

Representação JSON 
{
  "space": {
    object (Space)
  }
}
Campos
space

object (Space)

Apenas saída. O espaço correspondente.