Method: spaces.members.list

Lista as assinaturas em um espaço. Por exemplo, consulte Listar usuários e apps do Google Chat em um espaço. A listagem de assinaturas com autenticação de app mostra as assinaturas em espaços a que o app Chat tem acesso, mas exclui as assinaturas do app Chat, incluindo a dele mesmo. A listagem de assinaturas com Autenticação de usuário mostra as assinaturas em espaços a que o usuário autenticado tem acesso.

Aceita os seguintes tipos de autenticação:

  • Autenticação do app com um dos seguintes escopos de autorização:

  • Autenticação de usuário com um dos seguintes escopos de autorização:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (somente espaços do modo de importação)
    • A autenticação de usuário concede privilégios de administrador quando uma conta de administrador é autenticada, useAdminAccess é true e um dos seguintes escopos de autorização é usado:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

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 o qual uma lista de assinaturas será buscada.

Formato: spaces/{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, no máximo 100 assinaturas serão retornadas.

O valor máximo é 1.000. Se você usar um valor maior que 1.000, ele será mudado 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 assinaturas. Forneça esse parâmetro para recuperar a página seguinte.

Na paginação, todos os outros parâmetros fornecidos precisam corresponder à chamada que forneceu o token da página. Transmitir valores diferentes para os outros parâmetros pode gerar resultados inesperados.
filter

string

Opcional. Um filtro de consulta.

É possível filtrar as associações pelo papel (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. Também é possível filtrar 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 member.type = "HUMAN" ou member.type != "BOT" quando useAdminAccess está definido como verdadeiro. Outros filtros de tipo de membro serão rejeitados.

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

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

member.type != "BOT"

As consultas a seguir 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 as assinaturas associadas a um Google Group, além de outros tipos de assinaturas. Se um filter for definido, as associações Google Group que não corresponderem aos critérios de filtro não serão retornadas.
showInvited

boolean

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

No momento, exige autenticação do usuário.
useAdminAccess

boolean

Opcional. 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 de gerenciar conversas no Chat e nos espaços.

Requer o escopo do 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 usando 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 assinaturas 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 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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • 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.