Method: spaces.members.list

Lista as associações em um espaço. Veja um exemplo em Listar usuários e apps do Google Chat em um espaço. A lista de assinaturas com autenticação de apps lista as associações em espaços a que o app do Chat tem acesso, mas exclui as associações ao app do Chat, incluindo as próprias. A lista de associações com autenticação de usuário lista as associações em espaços a que o usuário autenticado tem acesso.

Requer autenticação. Oferece suporte à autenticação de apps e autenticação de usuários.

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 para buscar uma lista de participantes.

Formato: workspaces/{space}

Parâmetros de consulta

Parâmetros
pageSize

integer

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

Se não for especificado, no máximo 100 associações serão retornadas.

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele vai ser automaticamente alterado para 1.000.

Valores negativos retornam um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Um token de página, recebido de uma chamada anterior para listar associações. Forneça esse parâmetro para recuperar a página seguinte.

Ao fazer a paginação, todos os outros parâmetros informados precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para outros parâmetros pode levar a resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

Você pode filtrar as assinaturas pela função (role) e tipo (member.type) de um participante.

Para filtrar por função, defina role como ROLE_MEMBER ou ROLE_MANAGER.

Para filtrar por tipo, defina member.type como HUMAN ou BOT.

Para filtrar por papel e tipo, use o operador AND. Para filtrar por papel ou tipo, use o operador OR.

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

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

As seguintes consultas são inválidas:

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

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

boolean

Opcional. Quando true, também retorna assinaturas associadas a um Google Group, além de outros tipos de assinatura. Se um filter estiver definido, as associações de Google Group que não corresponderem aos critérios do filtro não serão retornadas.
showInvited

boolean

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

Atualmente, exige a autenticação do usuário.

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 não ordenada. Lista de associações 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 haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/chat.import
  • 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 o Guia de autorização.