Method: spaces.members.list

Lista as assinaturas em um espaço. Para ver um exemplo, consulte Associações a listas. Com o recurso de autenticação de app, você lista as assinaturas nos espaços a que o app Chat tem acesso, mas exclui as do app Chat, inclusive a própria. A lista de associações com a autenticação do usuário lista os espaços em que o usuário autenticado tem acesso.

Requer autenticação. É totalmente compatível com a autenticação da conta de serviço e a autenticação do usuário. 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 que uma lista de associação será buscada.

Formato: space/{space}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. 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. Se você usar um valor acima de 1.000, ele 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 subsequente.

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

string

Opcional. Um filtro de consulta.

Você pode filtrar as associações por função (role) e tipo (member.type) de um participante.

Para filtrar por papel, 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 for definido, as assinaturas do Google Group que não corresponderem aos critérios do filtro não serão retornadas.

showInvited

boolean

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

Atualmente requer 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 de assinaturas na página solicitada (ou primeira).
nextPageToken

string

Um token que você pode enviar 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.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.