Method: spaces.list

Lista os espaços de que o autor da chamada faz parte. Requer autenticação. Compatibilidade total com a autenticação de conta de serviço.

Oferece suporte à autenticação de usuários como parte do Programa de prévia para desenvolvedores do Google Workspace, que concede acesso antecipado a determinados recursos. A autenticação do usuário requer o escopo de autorização chat.spaces ou chat.spaces.readonly.

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.

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.

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 isso 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.

Requer a autenticação do usuário.

Você pode filtrar por tipo (spaceType).

Para filtrar por tipo de espaço, especifique um valor de enum 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 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. Como a API Chat ainda valida a sintaxe de consulta com contas de serviço, 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 o Guia de autorização.