Method: spaces.list

Lista os espaços em que o autor da chamada é membro. As conversas em grupo e as mensagens diretas não são listadas até que a primeira mensagem seja enviada. Confira um exemplo em Listar espaços.

Oferece suporte aos seguintes tipos de autenticação:

  • Autenticação do app com o escopo de autorização:

    • https://www.googleapis.com/auth/chat.bot

  • Autenticação do usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces

Para listar todos os espaços nomeados por organização do Google Workspace, use o método spaces.search() com 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, 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á 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 lista de espaços anterior. Forneça esse parâmetro para recuperar a página seguinte.

Ao fazer a paginação, 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 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 Space para solicitações de lista.
nextPageToken

string

Você pode 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.