Este guia explica como usar o método get
no recurso Message
da
a API Google Chat para retornar detalhes sobre uma mensagem de texto ou de card.
Na API Chat, uma mensagem do Chat é representada por
Recurso Message
.
Os usuários do Chat só podem enviar mensagens com texto,
Os apps de chat podem usar muitos outros recursos de mensagens, incluindo
exibir interfaces do usuário estáticas ou interativas, coletar informações de
usuários e na entrega de mensagens com privacidade. Para saber mais sobre mensagens
recursos disponíveis para a API Chat, consulte o
Visão geral das mensagens do Google Chat.
Pré-requisitos
Python
- Uma empresa Conta do Google Workspace com acesso a Google Chat.
- Configure o ambiente:
- Crie um projeto do Google Cloud.
- Configure a tela de permissão OAuth.
- Ative e configure a API Google Chat com um nome. o ícone e a descrição do app do Chat.
- Instale o Python biblioteca de cliente das APIs do Google.
- Crie credenciais de acesso com base em como você quer autenticar sua API Google Chat
solicitação:
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credenciais e salvá-las como um arquivo JSON chamado
client_secrets.json
ao diretório local. - Para autenticar como o app do Chat, faça o seguinte:
criar conta de serviço
credenciais e salvá-las como um arquivo JSON chamado
credentials.json
- Para autenticar como um usuário do Chat, faça o seguinte:
criar ID do cliente OAuth
credenciais e salvá-las como um arquivo JSON chamado
- Escolha um escopo de autorização para autenticar como usuário ou como App Chat.
Receber uma mensagem com a autenticação do usuário
Para mais detalhes sobre uma mensagem com autenticação do usuário transmita o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.messages.readonly
ouchat.messages
. - Chame o método
Método
get
no(a) RecursoMessage
. - Defina
name
como o nome do recurso da mensagem a ser recebida.
O exemplo a seguir recebe uma mensagem autenticação do usuário:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_message_get_user.py
. Inclua o seguinte código em
chat_message_get_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.messages.readonly"] def main(): ''' Authenticates with Chat API via user credentials, then gets a message. ''' # 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().messages().get( # The message to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name = 'spaces/SPACE/messages/MESSAGE' ).execute() # Prints details about the message. print(result) if __name__ == '__main__': main()
No código, substitua o seguinte:
SPACE
: um nome de espaço, que você pode conferir em as Métodospaces.list
na API Chat ou pelo URL de um espaço.MESSAGE
: um nome de mensagem, que você pode acessar do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_message_get_user.py
A API Chat retorna uma instância do
Message
que detalha a mensagem especificada.
Receber uma mensagem com a autenticação do app
Para mais detalhes sobre uma mensagem com autenticação de apps transmita o seguinte na sua solicitação:
- Especifique o escopo de autorização
chat.bot
. - Chame o método
Método
get
no(a) RecursoMessage
. - Defina
name
como o nome do recurso da mensagem a ser recebida.
O exemplo a seguir recebe uma mensagem autenticação de apps:
Python
- No diretório de trabalho, crie um arquivo chamado
chat_get_message_app.py
. Inclua o seguinte código em
chat_get_message_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) # Get a Chat message. result = chat.spaces().messages().get( # The message to get. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MESSAGE with a message name. # Obtain the message name from the response body returned # after creating a message asynchronously with Chat REST API. name='spaces/SPACE/messages/MESSAGE' ).execute() # Print Chat API's response in your command line interface. print(result)
No código, substitua o seguinte:
SPACE
: aname
do espaço em que o a mensagem é postada, e você pode acessá-la Métodospaces.list
na API Chat ou pelo URL de um espaço.MESSAGE
: o nome da mensagem, que você pode conferir do corpo da resposta retornado após a criação de uma mensagem de forma assíncrona com a API Chat ou com a nome personalizado atribuído à mensagem na criação.
No diretório de trabalho, crie e execute o exemplo:
python3 chat_get_message_app.py
A API Chat retorna uma instância do
Message
que detalha a mensagem especificada.
Temas relacionados
- Formatar uma mensagem.
- Excluir uma mensagem.
- Listar mensagens em um espaço
- Atualizar uma mensagem.
- Enviar uma mensagem.