Questa guida spiega come utilizzare il
get()
metodo sulla risorsa Message dell'API Google Chat per restituire i dettagli di un
messaggio di testo o di una scheda.
Nell'API Chat, un messaggio di Chat è rappresentato dalla
Message risorsa.
Sebbene gli utenti di Chat possano inviare solo messaggi contenenti testo, le app di Chat possono utilizzare molte altre funzionalità di messaggistica, tra cui la visualizzazione di interfacce utente statiche o interattive, la raccolta di informazioni dagli utenti e la consegna di messaggi privati. Per scoprire di più sulle funzionalità di messaggistica
disponibili per l'API Chat, consulta la
panoramica dei messaggi di Google Chat.
Prerequisiti
Node.js
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di Chat.
- Installa la libreria client di Node.js Cloud.
- Crea le credenziali di accesso in base alla modalità di autenticazione nella richiesta dell'API Google Chat:
- Per eseguire l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
credentials.jsonnella directory locale. - Per eseguire l'autenticazione come app di Chat,
crea le credenziali dell'account di servizio e salvale come file JSON denominato
credentials.json.
- Per eseguire l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app di Chat.
- Uno spazio di Chat di cui l'utente autenticato o l'app di Chat chiamante è membro. Per eseguire l'autenticazione come app di Chat, aggiungi l'app di Chat allo spazio.
Python
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di Chat.
- Installa la libreria client di Python Cloud.
- Crea le credenziali di accesso in base alla modalità di autenticazione nella richiesta dell'API Google Chat:
- Per eseguire l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
credentials.jsonnella directory locale. - Per eseguire l'autenticazione come app di Chat,
crea le credenziali dell'account di servizio e salvale come file JSON denominato
credentials.json.
- Per eseguire l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app di Chat.
- Uno spazio di Chat di cui l'utente autenticato o l'app di Chat chiamante è membro. Per eseguire l'autenticazione come app di Chat, aggiungi l'app di Chat allo spazio.
Java
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di Chat.
- Installa la libreria client di Java Cloud.
- Crea le credenziali di accesso in base alla modalità di autenticazione nella richiesta dell'API Google Chat:
- Per eseguire l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
credentials.jsonnella directory locale. - Per eseguire l'autenticazione come app di Chat,
crea le credenziali dell'account di servizio e salvale come file JSON denominato
credentials.json.
- Per eseguire l'autenticazione come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON denominato
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app di Chat.
- Uno spazio di Chat di cui l'utente autenticato o l'app di Chat chiamante è membro. Per eseguire l'autenticazione come app di Chat, aggiungi l'app di Chat allo spazio.
Apps Script
- Un account Google Workspace Business o Enterprise con accesso a Google Chat.
- Configura l'ambiente:
- Crea un progetto Google Cloud.
- Configura la schermata per il consenso OAuth.
- Attiva e configura l'API Google Chat con un nome, un'icona e una descrizione per la tua app di Chat.
- Crea un progetto Apps Script autonomo, e attiva il servizio Chat avanzato.
- In questa guida devi utilizzare l'autenticazione utente o dell'app. Per eseguire l'autenticazione come app di Chat, crea le credenziali dell'account di servizio. Per i passaggi, vedi Eseguire l'autenticazione e l'autorizzazione come app di Google Chat.
- Scegli un ambito di autorizzazione in base al fatto che tu voglia eseguire l'autenticazione come utente o come app di Chat.
- Uno spazio di Chat di cui l'utente autenticato o l'app di Chat chiamante è membro. Per eseguire l'autenticazione come app di Chat, aggiungi l'app di Chat allo spazio.
Recuperare un messaggio con l'autenticazione utente
Per recuperare i dettagli di un messaggio con l'autenticazione utente, trasmetti quanto segue nella richiesta:
- Specifica l'ambito di autorizzazione
chat.messages.readonlyochat.messages. - Chiama il
GetMessage()metodo. - Imposta
namesul nome della risorsa del messaggio da recuperare.
L'esempio seguente recupera un messaggio con l'autenticazione utente:
Node.js
Python
Java
Apps Script
Per eseguire questo esempio, sostituisci quanto segue:
SPACE_NAME: l'ID delnamedello spazio. Puoi ottenere l'ID chiamando ilListSpaces()metodo o dall'URL dello spazio.MESSAGE_NAME: l'ID delnamedel messaggio. Puoi ottenere l'ID dal corpo della risposta restituito dopo aver creato un messaggio in modo asincrono con l'API Chat o con il nome personalizzato assegnato al messaggio al momento della creazione.
L'API Chat restituisce un'istanza di
Message
che descrive in dettaglio il messaggio specificato.
Recuperare un messaggio con l'autenticazione dell'app
Per recuperare i dettagli di un messaggio con l'autenticazione dell'app, trasmetti quanto segue nella richiesta:
- Specifica un ambito di autorizzazione. Gli esempi in questa sezione utilizzano l'ambito
chat.bot, che è in disponibilità generale e non richiede l'approvazione dell'amministratore. In alternativa, puoi autorizzare l'app di Chat con l'approvazione dell'amministratore. - Chiama il
GetMessage()metodo. - Imposta
namesul nome della risorsa del messaggio da recuperare.
L'esempio seguente recupera un messaggio con l'autenticazione dell'app:
Node.js
Python
Java
Apps Script
Per eseguire questo esempio, sostituisci quanto segue:
SPACE_NAME: l'ID delnamedello spazio. Puoi ottenere l'ID chiamando ilListSpaces()metodo o dall'URL dello spazio.MESSAGE_NAME: l'ID delnamedel messaggio. Puoi ottenere l'ID dal corpo della risposta restituito dopo aver creato un messaggio in modo asincrono con l'API Chat o con il nome personalizzato assegnato al messaggio al momento della creazione.
L'API Chat restituisce un'istanza di
Message
che descrive in dettaglio il messaggio specificato.
Recuperare un messaggio come app di Chat con l'approvazione dell'amministratore
L'autenticazione dell'app con un ambito di autorizzazione chat.app.* richiede l'approvazione una tantum
dell'amministratore.
Per recuperare i dettagli di un messaggio con l'autenticazione dell'app utilizzando l'API REST di Chat, trasmetti quanto segue nella richiesta:
- Chiama il
GetMessage()metodo. - Specifica l'ambito di autorizzazione
chat.app.messages.readonly. - Imposta
namesul nome della risorsa del messaggio da recuperare.
Scrivere uno script che chiama l'API Chat
Ecco come recuperare i dettagli di un messaggio con l'autenticazione dell'app e l'approvazione dell'amministratore e l'API REST di Chat:
Python
- Nella directory di lavoro, crea un file denominato
chat_messages_get_admin_app.py. Includi il seguente codice in
chat_messages_get_admin_app.py:from google.oauth2 import service_account from apiclient.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.app.messages.readonly"] def main(): ''' Authenticates with Chat API using app authentication, then gets details about a message. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # 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 details about. # # Replace SPACE_NAME with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE_NAME/messages/MESSAGE_NAME', ).execute() # Print Chat API's response in your command line interface. print(result) if __name__ == '__main__': main()Nel codice, sostituisci quanto segue:
SPACE_NAME: l'ID dello spazioname. Puoi ottenere l'ID chiamando ilListSpaces()metodo o dall'URL dello spazio.MESSAGE_NAME: l'ID del messaggioname. Puoi ottenere l'ID dal corpo della risposta restituito dopo aver creato un messaggio in modo asincrono con l'API Chat o con il nome personalizzato assegnato al messaggio al momento della creazione.
Nella directory di lavoro, crea ed esegui l'esempio:
python3 chat_messages_get_admin_app.py
L'API Chat restituisce un'istanza di
Message
che descrive in dettaglio il messaggio specificato.
Argomenti correlati
- Formattare un messaggio.
- Eliminare un messaggio.
- Elencare i messaggi in uno spazio.
- Aggiornare un messaggio.
- Inviare un messaggio.