Este guia explica como usar o método findDirectMessage
no recurso Space
da API Google Chat para ver detalhes sobre um espaço de mensagem direta (DM).
O
recurso Space
representa um lugar onde as pessoas e os apps de chat podem enviar mensagens,
compartilhar arquivos e colaborar. Existem vários tipos de espaços:
- As mensagens diretas são conversas entre dois usuários ou um usuário e um app do Chat.
- Chats em grupo são conversas entre três ou mais usuários e apps do Chat.
- Os espaços nomeados são lugares persistentes onde as pessoas enviam mensagens, compartilham arquivos e colaboram.
A autenticação com a autenticação de apps permite que um app do Chat receba mensagens diretas que ele pode acessar no Google Chat (por exemplo, as mensagens diretas de que ele participa). Autenticar com a autenticação do usuário retorna as mensagens diretas às quais o usuário autenticado tem acesso.
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 instalar ou atualizar, execute o seguinte na 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. Veja as etapas em Criar um app do Google Chat.
Autorização configurada para o app do Chat. Encontrar uma mensagem direta aceita os seguintes procedimentos:
- Autenticação do usuário com o escopo de autorização
chat.spaces.readonly
ouchat.spaces
. - Autenticação de app
com o escopo de autorização
chat.bot
.
- Autenticação do usuário com o escopo de autorização
Node.js
- Node.js e npm
As bibliotecas de cliente mais recentes do Google para Node.js. Para instalá-los, execute o seguinte comando na interface de linha de comando:
npm install @google-cloud/local-auth @googleapis/chat
- Um projeto do Google Cloud com a API Google Chat ativada e configurada. Veja as etapas em Criar um app do Google Chat.
Autorização configurada para o app do Chat. Encontrar uma mensagem direta aceita os seguintes procedimentos:
- Autenticação do usuário com o escopo de autorização
chat.spaces.readonly
ouchat.spaces
. - Autenticação de app
com o escopo de autorização
chat.bot
.
- Autenticação do usuário com o escopo de autorização
Encontrar uma mensagem direta
Para encontrar uma mensagem direta no Google Chat, transmita o seguinte na solicitação:
- Com a autenticação do app, especifique o
escopo de autorização
chat.bot
. Com a autenticação do usuário, especifique o escopo de autorizaçãochat.spaces.readonly
ouchat.spaces
. - Chame o método
findDirectMessage
no recursoUser
, transmitindo oname
do outro usuário na mensagem direta a ser retornada. Com a autenticação do usuário, esse método retorna uma mensagem direta entre o usuário que fez a chamada e o especificado. Com a autenticação do app, esse método retorna uma mensagem direta entre o app de chamada e o usuário especificado. - Para adicionar um usuário humano como participante do espaço, especifique
users/{user}
, em que{user}
é o{person_id}
doperson
da API People ou o ID de umuser
na API Directory. Por exemplo, se a pessoaresourceName
da API People forpeople/123456789
, adicione o usuário ao espaço incluindo uma assinatura comusers/123456789
comomember.name
.
Encontrar uma mensagem direta com a autenticação do usuário
Veja como encontrar uma mensagem direta com a autenticação do usuário:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_find_dm_user.py
. Inclua o seguinte código em
chat_space_find_dm_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.spaces.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then returns details about a specified DM. ''' # 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().findDirectMessage( # The other user in the direct message (DM) to return. # # Replace USER with a user name. name='users/USER' ).execute() # Prints details about the direct message. print(result) if __name__ == '__main__': main()
No código, substitua
USER
peloname
de umaUser
no Google Chat.No diretório de trabalho, crie e execute a amostra:
python3 chat_space_find_dm_user.py
Node.js
No diretório de trabalho, crie um arquivo chamado
find-direct-message-space.js
.Inclua o seguinte código em
find-direct-message-space.js
:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Find a direct message Chat space for a user. * @return {!Promise<!Object>} */ async function findDirectMessageSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces.readonly', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.findDirectMessage( {name: 'users/USER'}); } findDirectMessageSpace().then(console.log);
No código, substitua
USER
peloname
de umaUser
no Google Chat.No diretório de trabalho, execute o exemplo:
node find-direct-message-space.js
A API Chat retorna uma instância de
Space
que detalha a mensagem direta especificada.
Encontrar uma mensagem direta com a autenticação de apps
Confira como encontrar uma mensagem direta com autenticação de app:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_space_find_dm_app.py
. Inclua o seguinte código em
chat_space_find_dm_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().findDirectMessage( # The other user in the direct message (DM) to return. # # Replace USER with a user name. name='users/USER' ).execute() print(result)
No código, substitua
USER
peloname
de umaUser
no Google Chat.No diretório de trabalho, crie e execute a amostra:
python3 chat_space_find_dm_app.py
Node.js
No diretório de trabalho, crie um arquivo chamado
app-find-direct-message-space.js
.Inclua o seguinte código em
app-find-direct-message-space.js
:const chat = require('@googleapis/chat'); /** * Find a direct message Chat space for a user. * @return {!Promise<!Object>} */ async function findDirectMessageSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.bot', ]; const auth = new chat.auth.GoogleAuth({ scopes, keyFilename: 'credentials.json', }); const authClient = await auth.getClient(); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.findDirectMessage( {name: 'users/USER'}); } findDirectMessageSpace().then(console.log);
No código, substitua
USER
peloname
de umaUser
no Google Chat.No diretório de trabalho, execute o exemplo:
node app-find-direct-message-space.js
A API Chat retorna uma instância de
Space
que detalha o DM especificado.
Temas relacionados
- Crie um espaço.
- Configurar um espaço.
- Ver detalhes sobre um espaço.
- Listar espaços.
- Atualizar um espaço.
- Excluir um espaço.