Method: spaces.list

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. Confira um exemplo em Listar espaços.

Oferece suporte aos seguintes tipos de autenticação:

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

integer

Opcional. 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, 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 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 deve corresponder à chamada que forneceu o token da página. A transmissão de um valor diferente pode levar a resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

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

Para filtrar por tipo de espaço, especifique um valor de tipo enumerado 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

A resposta para uma solicitação de lista de espaços.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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

object (Space)

Lista de espaços na página solicitada (ou primeira). Observação: o campo permissionSettings não é retornado no objeto de espaço para solicitações de lista.
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 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.