تحميل الوسائط كمرفق ملف

يوضّح هذا الدليل كيفية استخدام طريقة upload في مورد Media من Google Chat API لتحميل ملف وسائط إلى Google Chat ثم إرفاقه بأحد الرسائل.

عندما يرسل المستخدم رسالة إلى تطبيقك، تُرسِل Google Chat MESSAGE حدث تفاعل. يتضمّن حدث التفاعل الذي يتلقّاه تطبيقك نص الطلب، وهو ملف حمولة JSON يمثّل حدث التفاعل، بما في ذلك أي مرفقات. تختلف data في المرفق حسب ما إذا كان المرفق هو محتوى تم تحميله (ملف محلي) أو ملف مخزّن على Drive. يمثّل مورد Media ملفًا تم تحميله إلى Google Chat، مثل الصور والفيديوهات والمستندات. يمثّل مورد Attachment مثيلًا للوسائط، وهو ملف مرفق برسالة. يتضمّن Attachment المورد البيانات الوصفية عن المرفق، مثل مكان حفظه.

المتطلبات الأساسية

Python

التحميل كمرفق ملف

لتحميل الوسائط وإرفاقها برسالة، يجب إدخال ما يلي في الطلب::

  • حدِّد نطاق التفويض chat.messages.create أو chat.messages.
  • استخدِم طرق Google Chat التالية:
    1. لتحميل الملف، استخدِم طريقة upload في المورد Media.
      • اضبط parent على اسم المساحة التي تستضيف الملف.
      • في body (نص الطلب)، اضبط filename على اسم مرفق الملف الذي تم تحميله.
      • اضبط media_body كمثيل للملف الذي سيتم تحميله.
    2. لإنشاء رسالة مع إرفاق الملف الذي تم تحميله، استخدِم طريقة create في مورد Messages.
      • اضبط attachment على أنّه الردّ من استدعاء upload على مورد Media. يقبل الحقل attachment قائمة.

في المثال التالي، يتم تحميل ملف صورة بتنسيق 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(
                      '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 method في Chat API أو من عنوان URL للمساحة.

  4. في دليل العمل، أنشئ العيّنة وشغِّلها:

    python3 chat_media_and_attachment_upload.py

تعرض Chat API نص استجابة يحتوي على attachmentDataRef مع تفاصيل عن الملف الذي تم تحميله.

الحدود والاعتبارات

أثناء التحضير لتحميل الملفات وإرفاقها بالرسائل، يُرجى مراعاة قيود وملاحظات التحميل التالية: