- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
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 |
Quando 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 No momento, este método só é compatível com acesso de administrador. Portanto, apenas |
pageSize |
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 |
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 |
Obrigatório. Uma consulta de pesquisa. É possível pesquisar usando os seguintes parâmetros: -
Em campos diferentes, apenas os operadores Entre o mesmo campo, As consultas de exemplo a seguir são válidas:
|
orderBy |
Opcional. Como a lista de espaços é ordenada. Os atributos aceitos para ordenação são:
Os valores válidos de operação de ordenação são:
As sintaxes compatíveis são:
|
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 ( |
Campos | |
---|---|
spaces[] |
Página dos espaços solicitados. |
nextPageToken |
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 |
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.