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