- Solicitação HTTP
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Lista os espaços de que o autor da chamada é participante. Os chats em grupo e as mensagens diretas só são listados depois que a primeira mensagem é enviada. Para ver um exemplo, consulte Listar espaços.
Requer autenticação. Dá suporte à autenticação de apps e à autenticação de usuários.
Lista os espaços visíveis para o autor da chamada ou o usuário autenticado. Os chats em grupo e as mensagens diretas só são listados depois que a primeira mensagem é enviada.
Para listar todos os espaços nomeados da organização do Google Workspace, use o método spaces.search()
com os privilégios de administrador do Workspace.
Solicitação HTTP
GET https://chat.googleapis.com/v1/spaces
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de consulta
Parâmetros | |
---|---|
pageSize |
Opcional. O número máximo de espaços a serem retornados. O serviço pode retornar menos do 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. Valores negativos retornam um erro |
pageToken |
Opcional. Um token de página, recebido de uma chamada de espaços de lista anterior. Forneça esse parâmetro para recuperar a página subsequente. Ao paginar, o valor do filtro deve corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados. |
filter |
Opcional. Um filtro de consulta. É possível filtrar os espaços pelo tipo ( Para filtrar por tipo de espaço, especifique um valor de tipo enumerado válido, como Por exemplo, as seguintes consultas são válidas:
As consultas inválidas são rejeitadas pelo servidor com um erro |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
A resposta para uma solicitação de listagem de espaços.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"spaces": [
{
object ( |
Campos | |
---|---|
spaces[] |
Lista de espaços na página solicitada (ou na primeira). |
nextPageToken |
É possível enviar um token como |
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.bot
Para mais informações, consulte o Guia de autorização.