Questa guida spiega come utilizzare il metodo download
nella risorsa Media
dell'API Google Chat per scaricare contenuti multimediali (un file) da un messaggio in Google Chat.
Quando l'utente invia un messaggio alla tua app, Google Chat invia un
MESSAGE
evento di interazione.
L'evento di interazione ricevuto dalla tua app include un corpo della richiesta, ovvero il payload JSON che rappresenta l'evento di interazione, inclusi eventuali allegati. I
dati nell'allegato sono diversi a seconda che si tratti di contenuti caricati (un file locale) o di un file archiviato su Drive. La
risorsa Media
rappresenta un file caricato su Google Chat, come immagini, video e documenti.
La
risorsa Attachment
rappresenta un'istanza di contenuti multimediali, un file, allegato a un messaggio. La risorsa Attachment
include i metadati dell'allegato, ad esempio la posizione in cui è salvato.
Prerequisiti
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 API di Google per Python.
- Crea le credenziali di accesso in base alla modalità di autenticazione nella richiesta dell'API Google Chat:
- Per autenticarti come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON nominato
client_secrets.json
nella tua directory locale. - Per autenticarti come app Chat,
crea le credenziali dell'account di servizio e salvale come file JSON denominato
credentials.json
.
- Per autenticarti come utente di Chat,
crea le credenziali dell'ID client OAuth e salvale come file JSON nominato
- Scegli un ambito di autorizzazione in base a se vuoi autenticarti come utente o come app Chat.
Scaricare da un file allegato
Per scaricare contenuti multimediali da un allegato file, nella richiesta specifica quanto segue:
- Con l'autenticazione utente, specifica l'ambito di autorizzazione
chat.messages.readonly
ochat.messages
. Con l'autenticazione delle app, specifica l'ambito di autorizzazionechat.bot
. - Chiama i seguenti metodi di Google Chat:
- Ottieni
attachmentDataRef
chiamando uno dei seguenti metodi:- Il metodo
get
nella risorsaAttachment
. - Il metodo
get
o il metodolist
nella risorsaMessage
.
- Il metodo
- Chiama il metodo
download
nella risorsaMedia
e specificaattachmentDataRef.resourceName
recuperato in precedenza comemedia.download.resourceName
.
- Ottieni
L'esempio seguente scarica un file allegato a un messaggio:
Python
- Nella directory di lavoro, crea un file denominato
chat_media_and_attachment_download.py
. Includi il seguente codice in
chat_media_and_attachment_download.py
:import io from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build from googleapiclient.http import MediaIoBaseDownload # 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"] def main(): ''' Authenticates with Chat API via user credentials, then downloads a file attached to 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) # Download media resource. request = chat.media().download_media( resourceName=RESOURCE_NAME, ) file = io.BytesIO() downloader = MediaIoBaseDownload(file, request) done = False while done is False: status, done = downloader.next_chunk() if status.total_size: print(f'Total size: {status.total_size}') print(f'Download {int(status.progress() * 100)}') if __name__ == '__main__': main()
Nel codice, sostituisci
RESOURCE_NAME
conattachmentDataRef.resourceName
, che puoi recuperare in uno dei seguenti modi:- Il metodo
get
nella risorsaAttachment
. - Il metodo
get
nella risorsaMessage
. - Il metodo
list
nella risorsaMessage
.
- Il metodo
Nella directory di lavoro, compila ed esegui l'esempio:
python3 chat_media_and_attachment_download.py
In caso di esito positivo, questo metodo restituisce i contenuti del file sotto forma di byte.
Per scaricare i contenuti del file, scegli uno dei seguenti approcci:
Ti consigliamo di utilizzare la classe
MediaIoBaseDownload
in Python, che contiene metodi per scaricare il file in sezioni e salvare i contenuti in uno stream di output.Se devi effettuare la richiesta HTTP manualmente, chiama il metodo
download
e specifica la parte del file che vuoi scaricare utilizzando un intervallo di byte con l'intestazioneRange
, ad esempio:Range: bytes=500-999
.
Argomenti correlati
- Se il messaggio è un file di Drive, utilizza l'API Drive per accedere al file.
- Caricare contenuti multimediali come allegato file
- Scaricare contenuti multimediali come allegato file
- Ottenere i metadati di un allegato di un messaggio