Method: spaces.search

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 no Chat e nos espaços.

Requer o escopo do 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.

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á mudado automaticamente para 1.000.

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 fornecidos precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.

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 é definido como false:

• displayName
• externalUserAllowed

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 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 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. Quando useAdminAccess é 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 aceita apenas valores do campo historyState de um recurso space.

spaceType é obrigatório quando useAdminAccess está definido como true, 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 quando useAdminAccess é 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 é definido como false:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

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

(externalUserAllowed = "true" AND displayName:"Hello")

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 foi adicionado a qualquer tema deste espaço.
• createTime: indica o momento da criação do espaço.

Quando useAdminAccess é false, apenas createTime e relevance são compatíveis com a ordenação. Somente DESC é compatível com esses campos em pesquisas que não são de administrador.

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

• ASC para crescente. Valor padrão.

• DESC para ordem decrescente.

A sintaxe compatível é 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 é definido como false:

• createTime DESC
• relevance DESC

object (Space)

Apenas saída. O espaço correspondente.