نظرة عامة على Google Chat API

تقدّم هذه الصفحة نظرة عامة على كيفية استخدام Google Chat API ومستندات مرجعي ة.

تتضمّن Google Chat API واجهات gRPC و REST، و مكتبات عملاء متوافقة مع كليهما. يمكنك اختياريًا كتابة مكتبات عملاء خاصة بك تستخدم واجهة gRPC أو REST إذا كانت مكتبات العملاء المقدَّمة لا تلبي احتياجاتك.

مكتبات العملاء

إنّ الطريقة المُقترَحة لمعظم المطوّرين للاتّصال بواجهة برمجة التطبيقات Google Chat API هي باستخدام مكتبات عملاء Cloud المتوافقة رسميًا بلغتك المفضّلة، مثل Python أو Java أو Node.js.

إذا كنت تُنشئ الرموز البرمجية باستخدام "برمجة تطبيقات Google"، استخدِم خدمة Chat المتقدّمة بدلاً من تثبيت مكتبة عملاء.

أسماء النوع والطريقة والحقول

استنادًا إلى ما إذا كنت تستخدم مكتبات العملاء أو gRPC أو REST، يختلف نوع واجهة برمجة التطبيقات Google Chat API وطريقة استخدامها وأسماء الحقول إلى حدٍ ما:

  • يتم ترتيب مكتبات برامج Cloud Client حسب خدمات gRPC وطرقها. يتم ترتيب مكتبات عملاء Google API كخدمات تحتوي على عناصر أو فئات تتوافق مع موارد REST التي تحتوي أيضًا على طُرق مقابلة.
  • يتم ترتيب gRPC حسب الخدمات وطُرقها.
  • يتم ترتيب بروتوكول REST حسب التسلسلات الهرميّة للموارد وطُرقها.
  • تستخدم أسماء حقول gRPC أسلوب الكتابة بالتنسيق snake case.
  • تستخدم أسماء حقول REST أسلوب CamelCase، على الرغم من أنّ خدمة واجهة برمجة التطبيقات ستقبل إما أسلوب CamelCase أو أسلوب SnakeCase.
  • تستخدم أسماء حقول مكتبة العميل إما حالة أحرف العنوان أو حالة أحرف الجمل أو حالة الثعبان، استنادًا إلى الاسم الشائع في اللغة.

آليات سَلسلة البيانات المنظّمة

سواء كنت تستخدم مكتبات العملاء أو REST أو gRPC، يتم تحديد الخدمة الأساسية باستخدام بروتوكول Buffers. على وجه التحديد، تستخدم الخدمة proto3.

عند استدعاء واجهة برمجة التطبيقات، قد تتطلّب بعض حقول الطلبات أو الردود معرفة أساسية بأنواع ذاكرة التخزين المؤقت للبروتوكول المعروفة.

بالإضافة إلى ذلك، عند طلب البيانات من واجهة برمجة التطبيقات REST API، قد يؤدي سلوك القيمة التلقائية لمخازن ملفّات البروتوكول إلى عدم توفّر حقول في استجابة JSON. يتم ضبط هذه الحقول على القيمة التلقائية، لذا لا يتم تضمينها في الاستجابة.

إصدارات واجهة برمجة التطبيقات

تتوفّر إصدارات واجهة برمجة التطبيقات التالية:

  • v1: إصدار ثابت.

معاينة المطور

في المستندات، قد تظهر لك طرق أو حقول واجهة برمجة التطبيقات التي لا تتوفّر إلا من خلال "برنامج معاينة المطوّرين". لاختبار أحدث ميزات المعاينة ومعاينتها وتقديم ملاحظات بشأنها، يمكنك الانضمام إلى برنامج معاينة المطوّرين.