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