В этом руководстве объясняется, как использовать метод download ресурса Media API Google Chat для загрузки медиафайлов из сообщений в Google Chat.
Когда пользователь отправляет сообщение в ваше приложение, Google Chat отправляет событие взаимодействия MESSAGE . Событие взаимодействия, полученное вашим приложением, включает тело запроса, которое представляет собой полезную нагрузку JSON, отражающую событие взаимодействия, включая любые вложения. Данные во вложении различаются в зависимости от того, является ли вложение загруженным контентом (локальным файлом) или файлом, хранящимся на Google Диске. Ресурс Media представляет собой файл, загруженный в Google Chat, например, изображения, видео или документы. Ресурс Attachment представляет собой экземпляр медиафайла, прикрепленного к сообщению. Ресурс Attachment включает метаданные о вложении, например, место его сохранения.
Предварительные требования
Python
- Корпоративный аккаунт Google Workspace с доступом к Google Chat .
- Настройте свою среду:
- Создайте проект в Google Cloud .
- Настройте экран согласия OAuth .
- Включите и настройте API Google Chat, указав имя, значок и описание для вашего приложения чата.
- Установите клиентскую библиотеку Google API для Python.
- Создайте учетные данные доступа в зависимости от того, как вы хотите аутентифицироваться в запросе к Google Chat API:
- Для аутентификации в качестве пользователя чата создайте учетные данные OAuth-клиента и сохраните их в виде JSON-файла с именем
credentials.jsonв локальной директории. - Для аутентификации в приложении «Чат» создайте учетные данные сервисной учетной записи и сохраните их в JSON-файле с именем
credentials.json.
- Для аутентификации в качестве пользователя чата создайте учетные данные OAuth-клиента и сохраните их в виде JSON-файла с именем
- Выберите область авторизации в зависимости от того, хотите ли вы аутентифицироваться как пользователь или как приложение чата.
Скачать из прикрепленного файла
Для загрузки медиафайлов из вложенного файла передайте в запросе следующее:
- При аутентификации пользователя укажите область авторизации
chat.messages.readonlyилиchat.messages. При аутентификации приложения укажите область авторизацииchat.bot. - Воспользуйтесь следующими способами связи с Google Chat:
- Получите
attachmentDataRef, вызвав один из следующих методов:- Метод
getресурсаAttachment. - Метод
getили `listресурсаMessage.
- Метод
- Вызовите метод
downloadдля ресурсаMediaи укажите ранее полученное значениеattachmentDataRef.resourceNameкакmedia.download.resourceName.
- Получите
В следующем примере загружается файл, прикрепленный к сообщению:
Python
- В рабочей директории создайте файл с именем
chat_media_and_attachment_download.py. Включите следующий код в
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( 'credentials.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()В коде замените
RESOURCE_NAMEнаattachmentDataRef.resourceName, который можно получить одним из следующих способов:В рабочей директории соберите и запустите пример:
python3 chat_media_and_attachment_download.py
В случае успеха этот метод возвращает содержимое файла в виде байтов.
Для загрузки содержимого файла выберите один из следующих способов:
Мы рекомендуем использовать класс
MediaIoBaseDownloadв Python, который содержит методы для загрузки файла по частям и сохранения его содержимого в выходной поток.Если вам необходимо выполнить HTTP-запрос вручную, вызовите метод
downloadи укажите часть файла, которую вы хотите загрузить, используя диапазон байтов в заголовкеRange— например:Range: bytes=500-999.
Связанные темы
- Если сообщение представляет собой файл Google Диска, используйте API Google Диска для получения доступа к файлу .
- Загрузите медиафайл в качестве вложения.
- Скачать медиафайл в виде вложения.
- Получить метаданные о вложенном сообщении