Method: spaces.members.list

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

Lista as associações em um espaço.

Requer autenticação. Compatibilidade total com a autenticação de conta de serviço.

Solicitação HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do espaço em que uma lista de participantes será buscada.

Formato: espaços/{espaço}

Parâmetros de consulta

Parâmetros
pageSize

integer

O número máximo de assinaturas a serem retornadas. O serviço pode retornar menos que esse valor.

Se não for especificado, serão retornadas no máximo 100 assinaturas.

O valor máximo é 1.000. Valores maiores são convertidos para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.

pageToken

string

Um token de página, recebido de uma chamada de associação da lista anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos devem corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode levar a resultados inesperados.

filter

string

Opcional. Um filtro de consulta.

A API oferece suporte à filtragem por role e type.

role aceita apenas valores ROLE_MEMBER e ROLE_MANAGER.

member.type aceita apenas valores HUMAN e BOT.

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

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

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

showInvited

boolean

Opcional. Quando true, também retorna assinaturas associadas a membros invited, além de outros tipos de assinaturas. Se um filtro for definido, não serão retornadas as assinaturas de invited que não corresponderem aos critérios do filtro.

No momento, a autenticação do usuário é necessária.

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
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Campos
memberships[]

object (Membership)

Lista de assinaturas na página solicitada, ou na 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.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Para mais informações, consulte a Visão geral do OAuth 2.0.