يوضّح هذا القسم كيف يمكن لتطبيق Google Chat استدعاء واجهة برمجة تطبيقات Chat، ما يسمح لتطبيقات Chat بتنفيذ إجراءات مثل إنشاء مساحة وإضافة مستخدمين إليها ونشر رسالة بدون أن يُطلب منك ذلك من خلال حدث تفاعل مع تطبيق Chat.
المصادقة
يتطلب الاتصال بواجهة برمجة تطبيقات Chat بشكل غير متزامن المصادقة. تتطلّب كل طريقة من طرق Chat API إما مصادقة المستخدم (لتنفيذ الإجراءات أو الوصول إلى البيانات نيابةً عن مستخدم) أو مصادقة التطبيق (لتنفيذ الإجراءات أو الوصول إلى البيانات كتطبيق Chat). تتوافق بعض الطرق مع مصادقة المستخدم ومصادقة التطبيقات.
لمزيد من المعلومات حول المصادقة في Chat، يُرجى الاطّلاع على نظرة عامة على المصادقة.
موارد واجهة برمجة التطبيقات وطرقها
تمنح موارد وطرق REST إمكانية الوصول غير المتزامن إلى مساحات Chat وأعضاء المساحة والرسائل والتفاعلات مع الرسائل ومرفقات الرسائل.
- المساحات
المساحات هي أماكن يمكن للمستخدمين والتطبيقات من خلالها إجراء محادثات ومشاركة الملفات. هناك عدة أنواع من المساحات. إنّ الرسائل المباشرة هي محادثات بين مستخدمَين أو مستخدم وتطبيق Chat. وتشمل المحادثات الجماعية محادثات بين ثلاثة مستخدمين أو أكثر وتطبيقات Chat. المساحات المُعنونة هي أماكن دائمة يرسل من خلالها المستخدمون الرسائل ويشاركون الملفات ويتعاونون في ما بينهم.
يمثل مورد
spacesمساحة.تتيح ميزة "مساحات" الطرق التالية:
- إنشاء مساحة، وهي مكان يمكن فيه للأشخاص والتطبيقات التحدّث عن الملفات ومشاركتها
- عليك إعداد مساحة لإنشاء المساحة وإضافة مستخدمين وتطبيقات Chat إليها.
- الحصول على مساحة للاطّلاع على تفاصيل حول مساحة معيّنة
- قائمة المساحات للاطّلاع على قائمة بمساحات مقسّمة إلى صفحات وقابلة للفلترة
- عدِّل المساحة لتغيير السمات المتعلقة بالمساحة، مثل الاسم المعروض المرئي للمستخدم والوصف والإرشادات.
- يمكنك حذف مساحة عند عدم الحاجة إليها.
- يمكنك البحث عن رسالة مباشرة (DM) لعرض رسالة مباشرة بين مستخدمَين، أو رسالة مباشرة بين مستخدم وبين تطبيقات Chat التي يتم الاتصال بها.
- الأعضاء
الأعضاء هم المستخدمون وتطبيقات Chat التي انضمت إلى مساحة أو تمت دعوتها.
يمثل مورد
spaces.membersعضوًا.يتيح الأعضاء استخدام الطرق التالية:
- أنشئ عضوية لإضافة مستخدم أو تطبيق إلى مساحة
- يمكنك الاشتراك للاطّلاع على تفاصيل الاشتراك.
- قائمة العضويات للاطّلاع على قائمة العضويات المقسَّمة والقابلة للفلترة في إحدى المساحات
- تعديل عضوية لتغيير السمات المتعلقة بعضوية، مثل تغيير عضو في المساحة إلى مدير مساحة أو تغيير مدير المساحة إلى عضو في المساحة
- حذف اشتراك لإزالة مستخدم أو تطبيق من مساحة
- الرسائل
تتضمن الرسائل الرسائل النصية والبطاقات المراسلات المنشورة في المساحات. يمكن أن تحتوي الرسائل على ملفات مرفقة بها. يمكن للمستخدمين التفاعل مع الرسائل من خلال إضافة رموز تعبيرية إليها.
يمثل مورد
spaces.messagesرسالة.يتيح تطبيق "الرسائل" الطرق التالية:
- أنشئ رسالة لنشر رسالة نص أو بطاقة. يمكنك أيضًا بدء سلسلة محادثات أو الرد عليها.
- تلقّي رسالة للحصول على تفاصيل حول رسالة معيّنة، مثل وقت إرسالها أو مضمونها
- يمكنك إدراج الرسائل للاطّلاع على قائمة الرسائل المقسّمة والقابلة للفلترة في إحدى المساحات.
- عدِّل رسالة لتغيير سماتها، مثل مضمونها. ويمكنك أيضًا إلحاق نص برسالة بطاقة أو بطاقة في رسالة نصية.
- يمكنك حذف رسالة عند عدم الحاجة إليها.
- التفاعلات
تمثّل التفاعلات الرموز التعبيرية التي يستخدمها الأشخاص للتفاعل مع رسالة، مثل 👍 و🚲 وأو التصفّح.
يمثل مورد
spaces.messages.reactionsتفاعلاً.تدعم التفاعلات الطرق التالية:
- يمكنك إنشاء تفاعل لإضافة رمز تعبيري إلى رسالة.
- إنشاء قائمة بالتفاعلات لعرض قائمة بالتفاعلات مع رسالة مقسَّمة إلى صفحات وقابلة للفلترة
- حذف تفاعل لإزالة رمز تعبيري من الرسالة
- الوسائط والمرفقات
الوسائط هي ملف يتم تحميله إلى Google Chat، مثل الصور والفيديوهات والمستندات.
يمثل مورد
mediaالوسائط المرفقة بالرسائل.المرفقات هي مثيلات للوسائط (الملفات) المرفقة بالرسائل.
يمثل مورد
spaces.messages.attachmentsمرفقًا. يتضمن المرفق الوسائط والبيانات الوصفية المرتبطة المرتبطة بالرسالة.تتيح الوسائط والمرفقات الطرق التالية:
- تحميل الوسائط كمرفق لتحميل الوسائط إلى Google Chat ثم إرفاقها برسالة
- يمكنك تنزيل الوسائط كمرفق لتنزيل الوسائط من Google Chat كملف ثنائي.
- الحصول على مرفق لاسترداد البيانات الوصفية حول مرفق رسالة
- أحداث المساحة
تمثل أحداث المساحة التغييرات التي تطرأ على المساحة أو على الموارد الفرعية التابعة لها، بما في ذلك أعضاؤها ورسائلها وتفاعلاتها.
يمثل مورد
spaces.spaceEventالحدث الفضائي.تتيح أحداث المساحة استخدام الطرق التالية:
- الحصول على حدث في الفضاء لعرض تفاصيل حدث في مساحة ما.
- يمكنك إدراج أحداث المساحة للحصول على قائمة بالأحداث التي حدثت في مساحة.
- حالات قراءة المستخدم
حالات قراءة المستخدم هي موارد مفردة تمثل تفاصيل حول آخر رسالة مقروءة لمستخدم محدد في مساحة Google Chat أو سلسلة محادثات.
يمثل مورد
users.spacesحالة القراءة للمستخدم في المساحة.يمثل مورد
users.spaces.threadsحالة القراءة للمستخدم في سلسلة محادثات.تتوافق حالات قراءة المستخدم مع الطرق التالية:
- الحصول على حالة قراءة المساحة لعرض تفاصيل حول حالة القراءة لدى المستخدم داخل مساحة
- تعديل حالة قراءة المساحة لتعديل حالة قراءة المستخدم داخل مساحة
- الحصول على حالة قراءة سلسلة المحادثات لعرض تفاصيل حول حالة قراءة المستخدم ضمن سلسلة محادثات