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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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