يوضّح هذا القسم الطريقة التي يمكن بها لتطبيق Google Chat طلب واجهة برمجة تطبيقات Chat، التي تتيح لتطبيقات Chat تنفيذ إجراءات مثل إنشاء مساحة وإضافة مستخدمين إليها ونشر رسالة بدون أن يُطلب منك ذلك من خلال حدث تفاعل مع تطبيق Chat.
المصادقة
يتطلب طلب البيانات من Chat API بشكل غير متزامن المصادقة. تتطلّب كل طريقة في Chat API إمّا مصادقة المستخدم (لتنفيذ إجراءات أو الوصول إلى البيانات نيابةً عن مستخدم) أو مصادقة التطبيق (لتنفيذ الإجراءات أو الوصول إلى البيانات كتطبيق Chat). توفّر بعض الطرق كلاً من مصادقة المستخدم ومصادقة التطبيقات.
لمزيد من المعلومات حول المصادقة في Chat، يُرجى الاطّلاع على مقالة نظرة عامة على المصادقة.
موارد واجهات برمجة التطبيقات وطرقها
تمنح موارد REST وطرقه إمكانية الوصول غير المتزامن إلى مساحات Chat وأعضاء المساحة والرسائل وتفاعلات الرسائل ومرفقات الرسائل.
- المساحات
المساحات هي أماكن يمكن للمستخدمين والتطبيقات من خلالها إجراء محادثات ومشاركة الملفات. هناك عدة أنواع من المساحات. الرسائل المباشرة هي محادثات فردية بين مستخدمَين أو مستخدم وتطبيق في Chat. أما المحادثات الجماعية، فهي محادثات بين ثلاثة مستخدمين أو أكثر وتطبيقات Chat. المساحات المُسمّاة هي أماكن دائمة يرسل من خلالها المستخدمون الرسائل ويشاركون الملفات ويتعاونون مع بعضهم البعض.
يمثّل المورد
spacesمساحة.تتيح المساحات الطرق التالية:
- أنشئ مساحة، وهي مكان يمكن فيه للمستخدمين والتطبيقات إجراء محادثات ومشاركة الملفات.
- يمكنك إعداد مساحة لإنشاء المساحة وإضافة أشخاص وتطبيقات في Chat إلى تلك المساحة.
- الحصول على مساحة للاطّلاع على تفاصيل حول المساحة
- أدرج المسافات لعرض قائمة مقسّمة إلى صفحات قابلة للفلترة.
- عدِّل مساحة لتغيير سمات المساحة، مثل الاسم المعروض والوصف والإرشادات التي يمكن للمستخدم رؤيتها.
- حذف مساحة عند عدم الحاجة إليها
- البحث عن رسالة مباشرة لعرض رسالة مباشرة بين مستخدمَين أو رسالة مباشرة بين مستخدم وتطبيقات 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حالة القراءة للمستخدم في سلسلة محادثات.تتيح حالات القراءة للمستخدم استخدام الطرق التالية:
- الحصول على حالة قراءة المساحة لعرض تفاصيل حول حالة القراءة للمستخدم داخل المساحة
- تعديل حالة قراءة المساحة لتعديل حالة القراءة للمستخدم داخل مساحة
- الحصول على حالة قراءة سلسلة المحادثات لعرض تفاصيل حول حالة القراءة للمستخدم ضمن سلسلة محادثات