توضّح الأدلة الواردة في هذا القسم كيفية استدعاء تطبيق Google Chat لواجهة برمجة تطبيقات Chat، والتي تسمح لتطبيقات Chat بتنفيذ إجراءات مثل إنشاء مساحة وإضافة مستخدمين إليها ونشر رسالة بدون أن يُطلب منك ذلك من خلال حدث التفاعل مع تطبيق Chat.
المصادقة
يتطلب طلب البيانات من Chat API على نحو غير متزامن المصادقة. تتطلّب كل طريقة من طرق Chat API إمّا مصادقة المستخدم (لتنفيذ إجراءات أو الوصول إلى البيانات نيابةً عن المستخدم) أو مصادقة التطبيق (لتنفيذ إجراءات أو الوصول إلى البيانات كتطبيق Chat). تدعم بعض الطرق كلاً من مصادقة المستخدم ومصادقة التطبيق.
لمزيد من المعلومات حول المصادقة في Chat، يُرجى الاطّلاع على نظرة عامة على المصادقة.
موارد واجهة برمجة التطبيقات وطرقها
تمنح الموارد والطرق REST إمكانية وصول غير متزامن إلى مساحات Chat وأعضاء المساحات والرسائل وتفاعلات الرسائل ومرفقات الرسائل.
- المساحات
المساحات هي أماكن يمكن للمستخدمين والتطبيقات من خلالها التحدّث ومشاركة الملفات. هناك عدة أنواع من المساحات. الرسائل المباشرة هي محادثات فردية بين مستخدمَين أو مستخدم وتطبيق Chat. أما المحادثات الجماعية، فهي محادثات بين ثلاثة مستخدمين أو أكثر وتطبيقات Chat. المساحات المُعنوَنة هي أماكن دائمة يرسل فيها الأشخاص الرسائل ويشاركون الملفات ويتعاونون فيها.
يمثل المورد
Spaceمساحة.تتيح المساحات الطرق التالية:
- أنشئ مساحة، وهي مكان يمكن فيه للأشخاص والتطبيقات التحدث إلى الملفات ومشاركتها.
- عليك إعداد مساحة لإنشاء مساحة وإضافة أشخاص وتطبيقات Chat إلى تلك المساحة.
- يمكنك الحصول على مساحة للاطّلاع على تفاصيل عنها.
- إدراج المساحات لعرض قائمة مقسّمة على صفحات وقابلة للفلترة.
- تحديث مساحة لتغيير السمات حول مساحة، مثل الاسم المعروض والوصف والإرشادات التي تظهر للمستخدم.
- حذف مساحة عند عدم الحاجة إليها
- البحث عن رسالة مباشرة (DM) لعرض رسالة مباشرة بين مستخدمَين، أو رسالة مباشرة بين مستخدم وتطبيقات Chat المُتصِلة
- الأعضاء
الأعضاء هم المستخدمون وتطبيقات Chat التي انضموا إلى مساحة أو تمت دعوتهم إليها.
يمثل المورد
Memberعضوًا.ويتيح الأعضاء استخدام الطُرق التالية:
- يمكنك إنشاء اشتراك لإضافة مستخدم أو تطبيق إلى مساحة.
- يمكنك الحصول على اشتراك داعم للاطّلاع على تفاصيل حوله.
- إدراج الاشتراكات في القائمة للاطّلاع على قائمة اشتراكات قابلة للفلترة ومقسّمة على صفحات في مساحة
- حذف اشتراك لإزالة مستخدم أو تطبيق من مساحة.
- الرسائل
تتضمن الرسائل مراسلات النصوص والبطاقات التي يتم نشرها في المساحات. يمكن أن تحتوي الرسائل على ملفات مرفقة بها. يمكن للمستخدمين التفاعل مع الرسائل من خلال إلحاق رموز تعبيرية بها.
يمثل المورد
Messageرسالة.وتتيح الرسائل استخدام الطرق التالية:
- أنشئ رسالة لنشر رسالة نصية أو بطاقة. يمكنك أيضًا بدء سلسلة رسائل أو الردّ عليها.
- تلقّي رسالة للحصول على تفاصيل حول رسالة، مثل وقت إرسالها أو مضمونها
- إدراج الرسائل للاطّلاع على قائمة رسائل مقسّمة على صفحات وقابلة للفلترة في مساحة.
- تعديل رسالة لتغيير سمات الرسالة، مثل ما تنص عليه يمكنك أيضًا إلحاق نص برسالة بطاقة، أو بطاقة إلى رسالة نصية.
- احذف رسالة عند عدم الحاجة إليها.
- التفاعلات
تمثّل التفاعلات الرموز التعبيرية التي يستخدمها المستخدمون عند التفاعل مع رسالة، مثل 👍 و🚲 ورون معيّنة.
يمثِّل المورد
Reactionتفاعلاً.تتيح التفاعلات الطرق التالية:
- إنشاء تفاعل لإلحاق رمز تعبيري برسالة.
- يمكنك إدراج التفاعلات لعرض قائمة بالتفاعلات مع رسالة مقسّمة على صفحات وقابلة للفلترة.
- حذف تفاعل لإزالة رمز تعبيري من الرسالة.
- الوسائط والمرفقات
الوسائط هي ملف تم تحميله إلى Google Chat، مثل الصور والفيديوهات والمستندات.
يمثِّل المورد
Mediaالوسائط المرفقة بالرسائل.المرفقات هي نُسخ الوسائط (الملفات) المرفقة بالرسائل.
يمثل المورد
Attachmentمرفقًا. يتضمن المرفق الوسائط وبيانات التعريف المرتبطة بها المرفقة بالرسالة.تتيح الوسائط والمرفقات الطرق التالية:
- تحميل الوسائط كمرفق لتحميل الوسائط إلى Google Chat ثم إرفاقها برسالة
- تنزيل الوسائط كمرفق لتنزيل الوسائط من Google Chat كملف ثنائي
- الحصول على مرفق لاسترداد البيانات الوصفية حول مرفق رسالة.
تحديد موقع مستند "اقتراحات"
يتوفّر مستند الاكتشاف الخاص بواجهة برمجة التطبيقات هذه على عنوان URL التالي: