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