Method: spaces.list

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Lista os espaços de que o autor da chamada é participante e que ficam visíveis para ele ou para o usuário autenticado. Requer autenticação. É totalmente compatível com a autenticação da conta de serviço.

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. Valores maiores são convertidos para 1.000.

Os valores negativos retornam um erro INVALID_ARGUMENT.

pageToken

string

Opcional. Um token de página, recebido de uma chamada de espaços da lista anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Passar um valor diferente pode levar a resultados inesperados.

filter

string

Opcional. Um filtro de consulta.

Requer a autenticação do usuário.

A API é compatível com a filtragem por spaceType.

Por exemplo, as seguintes consultas 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.

Com a autenticação da conta de serviço, esse campo é ignorado, e a consulta sempre retorna todos os espaços. Ainda assim, a API Chat valida a sintaxe de consultas com contas de serviço, portanto, as consultas inválidas ainda são rejeitadas.

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 página solicitada (ou primeira).

nextPageToken

string

Um token que pode ser enviado como pageToken para recuperar a próxima página de resultados. Se estiver vazio, não há 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 a Visão geral do OAuth 2.0.