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

يشرح هذا الدليل كيفية استخدام طريقة upload على مورد Media الخاص بـ Google Chat API لتحميل الوسائط (ملف) إلى Google Chat وإرفاقها رسالة.

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

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

Python

  • Python 3.6 أو أعلى
  • أداة إدارة حزم pip
  • أحدث مكتبات عملاء Google. لتثبيت التطبيقات أو تحديثها، قم بتشغيل الأمر التالي في واجهة سطر الأوامر:
    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    

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

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

  • حدِّد نطاق التفويض chat.messages.create أو chat.messages.
  • يمكنك استدعاء طرق Google Chat التالية:
    1. لتحميل الملف، اطلب طريقة upload في المرجع Media.
      • اضبط parent على اسم المساحة للمساحة التي تستضيف الملف.
      • في 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(
                      '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
    

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

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

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