Neste guia, explicamos como usar o método list
no recurso membership
da API Google Chat para listar os participantes em um espaço como uma lista paginada e filtrável
de associações a um espaço. As associações da página de detalhes com a
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, incluindo
as próprias. A listagem das associações com a autenticação de usuários lista as associações em espaços a que o usuário autenticado tem acesso.
O
recurso Membership
representa se um usuário humano ou um app do Google Chat foi convidado,
participando ou ausente de um espaço.
Pré-requisitos
Python
- Python 3.6 ou superior
- A ferramenta de gerenciamento de pacotes pip
As bibliotecas de cliente mais recentes do Google para Python. Para instalá-los ou atualizá-los, execute o seguinte comando em sua interface de linha de comando:
pip3 install --upgrade google-api-python-client google-auth-oauthlib google-auth
- Um projeto do Google Cloud com a API Google Chat ativada e configurada. Para ver as etapas, consulte Criar um app do Google Chat.
Autorização configurada para o app do Chat. A listagem de assinaturas é compatível com os dois métodos de autenticação a seguir:
- Autenticação do usuário com o escopo de autorização
chat.memberships.readonly
ouchat.memberships
. - Autenticação de apps
com o escopo de autorização
chat.bot
.
- Autenticação do usuário com o escopo de autorização
Listar participantes em um espaço com autenticação de usuário
Para listar usuários, Grupos do Google e app do Chat em um espaço a que o usuário autenticado tem acesso, transmita o seguinte na sua solicitação:
- Com a autenticação do usuário, especifique o escopo de autorização
chat.memberships.readonly
ouchat.memberships
. - Chame o
método
list
no recursomembership
. - Para listar Grupos do Google, defina o parâmetro de consulta
showGroups
comotrue
.
O exemplo a seguir lista os membros do Grupo do Google, humanos e do aplicativo visíveis para o usuário autenticado.
Python
- No diretório de trabalho, crie um arquivo chamado
chat_member_list_user.py
. Inclua o seguinte código em
chat_member_list_user.py
:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then lists Google Group, human, and app members in a specified space. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().list( # The space for which to list memberships. parent = 'spaces/SPACE', # Set this parameter to list Google Groups. showGroups = 'true' ).execute() # Prints the list of memberships. print(result) if __name__ == '__main__': main()
No código, substitua
SPACE
por um nome de espaço, que pode ser encontrado no métodospaces.list
na API Chat ou no URL de um espaço.No diretório de trabalho, crie e execute o exemplo:
python3 chat_member_list_user.py
A API Google Chat retorna uma lista de membros do Grupo do Google, humanos e do app do espaço especificado.
Listar participantes em um espaço com autenticação de apps
Para listar os usuários e o app do Chat em um espaço a que o app autenticado tem acesso, transmita o seguinte na sua solicitação:
- Com a
autenticação de apps,
especifique o escopo de autorização
chat.bot
. - Chame o
método
list
no recursomember
. - Para listar Grupos do Google, defina o parâmetro de consulta
showGroups
comotrue
.
O exemplo abaixo lista os participantes do espaço humano (não os administradores) visíveis no app do Chat:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_member_list_app.py
. Inclua o seguinte código em
chat_member_list_app.py
:from google.oauth2 import service_account from apiclient.discovery import build # Specify required scopes. SCOPES = ['https://www.googleapis.com/auth/chat.bot'] # Specify service account details. CREDENTIALS = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build the URI and authenticate with the service account. chat = build('chat', 'v1', credentials=CREDENTIALS) # Use the service endpoint to call Chat API. result = chat.spaces().members().list( # The space for which to list memberships. parent = 'spaces/SPACE', # An optional filter that returns only human space members. filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"' ).execute() print(result)
No código, substitua
SPACE
por um nome de espaço, que pode ser encontrado no métodospaces.list
na API Chat ou no URL de um espaço.No diretório de trabalho, crie e execute o exemplo:
python3 chat_member_list_app.py
A API Google Chat retorna uma lista de membros do espaço humano (exceto os administradores) do espaço especificado.
Personalizar a paginação ou filtrar a lista
Para listar as associações, transmita os seguintes parâmetros de consulta para personalizar a paginação ou filtrar as associações listadas:
pageSize
: 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 retornados no máximo 100 espaços. O valor máximo é 1.000. Valores acima disso são alterados automaticamente para 1.000.pageToken
: um token de página recebido de uma chamada anterior de espaços de lista. Forneça esse token para recuperar a página subsequente. Na paginação, o valor do filtro precisa corresponder à chamada que forneceu o token da página. Transmitir um valor diferente pode levar a resultados inesperados.filter
: um filtro de consulta. Requer autenticação do usuário. Para detalhes de consulta compatíveis, consulte o métodospaces.members.list
.
Temas relacionados
- Veja detalhes sobre a assinatura de um usuário ou de um app do Chat.
- Convidar ou adicionar um usuário ou um app do Chat a um espaço
- Atualizar a associação de um usuário em um espaço do Google Chat
- Remover um usuário ou app do Chat de um espaço.