يشرح هذا الدليل كيفية استخدام طريقة upload في مورد Media ضِمن Google Chat API لتحميل وسائط (ملف) إلى Google Chat ثم إرفاقها برسالة.
عندما يرسل المستخدم رسالة إلى تطبيقك، يرسل Google Chat حدث تفاعل
MESSAGE.
يتضمّن حدث التفاعل الذي يتلقّاه تطبيقك نص طلب، وهو حمولة JSON التي تمثّل حدث التفاعل، بما في ذلك أي مرفقات. تختلف البيانات في المرفق حسب ما إذا كان المرفق محتوًى تم تحميله (ملف محلي) أو ملفًا مخزّنًا على Drive. يمثّل مورد
Media
ملفًا تم تحميله إلى Google Chat، مثل الصور والفيديوهات والمستندات.
يمثّل مورد
Attachment
مثيلاً للوسائط، أي ملفًا مرفقًا برسالة. يتضمّن مورد Attachment البيانات الوصفية حول المرفق، مثل مكان حفظه.
المتطلبات الأساسية
Python
- حساب Business أو Enterprise على Google Workspace يتيح الوصول إلى Google Chat
- إعداد البيئة:
- إنشاء مشروع على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
- تفعيل Google Chat API وإعداده باسم و رمز ووصف لتطبيق Chat.
- تثبيت مكتبة عميل واجهة Google API للغة Python.
-
إنشاء بيانات اعتماد معرّف عميل OAuth لتطبيق على الكمبيوتر المكتبي. لتشغيل النموذج في هذا
الدليل، احفظ بيانات الاعتماد كملف JSON باسم
credentials.jsonفي دليلك المحلي.
- اختيار نطاق تفويض يتيح مصادقة المستخدم
التحميل كمرفق ملف
لتحميل وسائط وإرفاقها برسالة، مرِّر ما يلي في طلبك:
- حدِّد نطاق التفويض
chat.messages.createأوchat.messages. - استدعِ طريقتَي Google Chat التاليتَين:
- لتحميل الملف، استدعِ الـ
uploadطريقة في الـMediaمورد.- اضبط
parentعلى اسم مساحة العمل التي تستضيف الملف. - في
body(نص الطلب)، اضبطfilenameعلى اسم المرفق الذي تم تحميله. - اضبط
media_bodyكمثيل للملف الذي سيتم تحميله.
- اضبط
- لإنشاء رسالة مرفق بها الملف الذي تم تحميله، استدعِ الـ
createطريقة على الـMessagesمورد.
- لتحميل الملف، استدعِ الـ
يحمّل المثال التالي ملف صورة بتنسيق PNG ويرفقه برسالة.
Python
- في دليل العمل، أنشئ ملفًا باسم
chat_media_and_attachment_upload.py. أدرِج الرمز التالي في
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()في الرمز، استبدِل
SPACEباسم مساحة العمل التي تريد تحميل المرفق فيها، ويمكنك الحصول عليه منspaces.listطريقة في Chat API أو من عنوان URL لمساحة عمل.في دليل العمل، أنشئ النموذج وشغِّله:
python3 chat_media_and_attachment_upload.py
تعرض Chat API نص ردّ يحتوي على attachmentDataRef مع تفاصيل حول الملف الذي تم تحميله.
الحدود والاعتبارات
أثناء التحضير لتحميل الملفات وإرفاقها بالرسائل، يُرجى مراعاة هذه الحدود والاعتبارات:
- يمكنك تحميل ملفات يصل حجمها إلى 200 ميغابايت.
- بعض أنواع الملفات غير متوافقة ولا يمكن تحميلها. لمعرفة التفاصيل، يُرجى الاطّلاع على أنواع الملفات المحظورة في Google Chat.
- يجب ألا تتضمّن رسالتك تطبيقات مصغّرة إضافية.