Method: spaces.list

Lista os espaços de que o autor da chamada participa. As mensagens diretas e os chats em grupo só são listados depois que a primeira mensagem é enviada. Veja um exemplo em Listar espaços.

Requer autenticação. Oferece suporte à autenticação de aplicativos e autenticação de usuário.

Lista os espaços visíveis para o autor da chamada ou o usuário autenticado. As mensagens diretas e os chats em grupo só são listados depois que a primeira mensagem é enviada.

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

integer

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 superior a 1.000, ele será alterado automaticamente para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.
pageToken

string

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 precisa corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

Você pode filtrar os espaços por tipo (spaceType).

Para filtrar por tipo de espaço, especifique um valor de enumeração válido, como SPACE ou GROUP_CHAT (o spaceType não pode ser SPACE_TYPE_UNSPECIFIED). Para consultar vários tipos de espaço, use o operador OR.

Por exemplo, as consultas a seguir são válidas:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Consultas inválidas são rejeitadas pelo servidor com um erro INVALID_ARGUMENT.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Campos
spaces[]

object (Space)

Lista de espaços na primeira página solicitada (ou na primeira).
nextPageToken

string

É possível enviar um token como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos de 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.