Загрузить медиафайл в виде вложения

В этом руководстве объясняется, как использовать метод upload 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 .
  • Создайте учетные данные идентификатора клиента OAuth для настольного приложения. Чтобы запустить пример из этого руководства, сохраните учетные данные в виде файла JSON с именем client_secrets.json в локальном каталоге.
• Выберите область авторизации , которая поддерживает аутентификацию пользователей.

Загрузить как вложенный файл

Чтобы загрузить медиафайл и прикрепить его к сообщению, передайте в запросе следующее:

• Укажите область авторизации chat.messages.create или chat.messages .
• Вызовите следующие методы Google Chat:
  1. Чтобы загрузить файл, вызовите метод upload Media ресурса.
     • Установите parent имя пространства, в котором размещен файл.
     • В body (тело запроса) укажите filename , равное имени загруженного вложения файла.
     • Установите media_body как экземпляр загружаемого файла.
  2. Чтобы создать сообщение с прикрепленным загруженным файлом, вызовите метод create ресурса Messages .
     • Установите attachment в качестве ответа на вызов метода upload Media ресурса . Поле attachment принимает список.

В следующем примере файл изображения PNG загружается и прикрепляется к сообщению.

Питон

1. В своем рабочем каталоге создайте файл с chat_media_and_attachment_upload.py .

2. Включите следующий код в chat_media_and_attachment_upload.py :

   from google_auth_oauthlib.flow import InstalledAppFlow
   from googleapiclient.discovery import build
   from googleapiclient.http import MediaFileUpload
   
   # 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.create"]
   
   def main():
       '''
       Authenticates with Chat API via user credentials,
       then uploads a file as media, creates a message, and
       attaches the file to the 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.
       service = build('chat', 'v1', credentials=creds)
   
       # Upload a file to Google Chat.
       media = MediaFileUpload('test_image.png', mimetype='image/png')
   
       # Create a message and attach the uploaded file to it.
       attachment_uploaded = service.media().upload(
   
           # The space to upload the attachment in.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           parent='spaces/SPACE',
   
           # The filename of the attachment, including the file extension.
           body={'filename': 'test_image.png'},
   
           # Media resource of the attachment.
           media_body=media
   
       ).execute()
   
       print(attachment_uploaded)
   
       # Create a Chat message with attachment.
       result = service.spaces().messages().create(
   
           # The space to create the message in.
           #
           # Replace SPACE with a space name.
           # Obtain the space name from the spaces resource of Chat API,
           # or from a space's URL.
           #
           # Must match the space name that the attachment is uploaded to.
           parent='spaces/SPACE',
   
           # The message to create.
           body={
               'text': 'Hello, world!',
               'attachment': [attachment_uploaded]
           }
   
       ).execute()
   
       print(result)
   
   if __name__ == '__main__':
       main()
   

3. В коде замените SPACE именем пространства для загрузки вложения, которое можно получить с помощью метода spaces.list в Chat API или из URL-адреса пространства.

4. В своем рабочем каталоге соберите и запустите пример:

   python3 chat_media_and_attachment_upload.py

API чата возвращает тело ответа, содержащее attachmentDataRef с подробной информацией о загруженном файле.

Ограничения и соображения

Готовясь загружать файлы и прикреплять их к сообщениям, обратите внимание на следующие ограничения и рекомендации:

• Вы можете загружать файлы размером до 200 МБ.
• Некоторые типы файлов не поддерживаются и не могут быть загружены. Подробную информацию см. в разделе Типы файлов, заблокированные в Google Chat .
• В вашем сообщении не должно быть дополнительных виджетов .

Связанные темы

• Загрузить медиафайл в виде вложения
• Получить метаданные о вложении сообщения