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

В этом руководстве объясняется, как использовать метод upload ресурса Media API Google Chat для загрузки медиафайлов в Google Chat и последующего прикрепления их к сообщению.

When the user sends a message to your app, Google Chat dispatches a MESSAGE interaction event . The interaction event received by your app includes a request body, which is the JSON payload representing the interaction event, including any attachments. The data in the attachment is different depending on whether the attachment is uploaded content (a local file) or is a file stored on Drive. The Media resource represents a file uploaded to Google Chat, like images, videos, and documents. The Attachment resource represents an instance of media—a file—attached to a message. The Attachment resource includes the metadata about the attachment, such as where it's saved.

Предварительные требования

Python

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

Для загрузки медиафайлов и прикрепления их к сообщению передайте в запросе следующее:

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

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

Python

  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(
                  'credentials.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 с подробной информацией о загруженном файле.

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

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