Method: spaces.members.list

Lista as associações em um espaço. Por exemplo, consulte Listar usuários e apps do Google Chat em um espaço. As associações da página de detalhes com autenticação de app listam as associações em espaços a que o app do Chat tem acesso, mas exclui as associações a apps do Chat, inclusive as que pertencem a ele. A listagem das associações com a autenticação de usuário lista as associações em espaços a que o usuário autenticado tem acesso.

Requer autenticação. Dá 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 em que uma lista de participantes será buscada.

Formato: espaços/{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 do que esse valor.

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

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será alterado automaticamente 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 outros parâmetros pode levar a resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

É possível filtrar as associações pela função (role) e tipo (member.type) de um membro.

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

Para filtrar por tipo, defina member.type como HUMAN ou BOT. Prévia para desenvolvedores: também é possível filtrar por member.type usando o operador !=.

Para filtrar por função e tipo, use o operador AND. Para filtrar por função ou tipo, use o operador OR.

É necessário usar member.type = "HUMAN" ou member.type != "BOT" quando useAdminAccess é definido como verdadeiro. Outros filtros de tipo de membro serão rejeitados.

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

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

member.type != "BOT"

As seguintes consultas são inválidas:

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

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

boolean

Opcional. Quando true, também retorna assinaturas associadas a uma Google Group, além de outros tipos de assinaturas. Se um filter for definido, as associações 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 invited participantes, além de outros tipos de assinaturas. Se um filtro for definido, as associações do invited que não corresponderem aos critérios do filtro não serão retornadas.

Requer a autenticação do usuário no momento.
useAdminAccess

boolean

Quando true, o método é executado usando os privilégios de administrador do Google Workspace do usuário.

O usuário que faz a chamada precisa ser um administrador do Google Workspace com o privilégio "Gerenciar conversas de chats e espaços".

Requer o escopo OAuth 2.0 chat.admin.memberships.readonly ou chat.admin.memberships.

Não é possível listar as associações a apps em um espaço quando você usa o acesso de administrador.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta para listar as associações do espaço.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

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 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 haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • 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.