يشرح هذا الدليل كيفية استخدام الأسلوب
get()
في مورد Message
لواجهة برمجة التطبيقات Google Chat API لعرض تفاصيل حول
رسالة نصية أو رسالة بطاقة.
في Chat API، يتم تمثيل رسالة Chat باستخدام موارد
Message
.
في حين أنّ مستخدمي Chat يمكنهم إرسال رسائل تتضمّن نصًا فقط،
يمكن لتطبيقات Chat استخدام العديد من ميزات المراسلة الأخرى، بما في ذلك
عرض واجهات مستخدم ثابتة أو تفاعلية، وجمع المعلومات من
المستخدمين، وتسليم الرسائل بشكل خاص. لمزيد من المعلومات حول ميزات المراسلة
المتوفّرة لواجهة برمجة تطبيقات Chat، يُرجى الاطّلاع على مقالة
نظرة عامة على رسائل Google Chat.
المتطلبات الأساسية
Node.js
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة برامج Cloud Client Library لنظام التشغيل Node.js.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
- مساحة Google Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق Chat إلى المساحة.
Python
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة Cloud Client Library لبرنامج Python.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
- مساحة Google Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق Chat إلى المساحة.
Java
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة Cloud Client Library لبرنامج Java.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد المصادقة بها في طلب Google Chat API:
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
client_secrets.json
في الدليل المحلي. - لمصادقة تطبيق Chat،
أنشئ بيانات اعتماد
حساب الخدمة واحفظ بيانات الاعتماد كملف JSON باسم
credentials.json
.
- لمصادقة مستخدم Chat،
أنشئ بيانات اعتماد معرّف العميل لبروتوكول OAuth واحفظ بيانات الاعتماد كملف JSON باسم
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
- مساحة Google Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق Chat إلى المساحة.
برمجة تطبيقات
- حساب على Google Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم ورمز ووصف لتطبيق Chat.
- أنشئ مشروعًا مستقلاً في Apps Script، وفعِّل خدمة Chat المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو مصادقة التطبيق. للمصادقة بصفتك تطبيق Chat، أنشئ بيانات اعتماد حساب الخدمة. لمعرفة الخطوات، يُرجى الاطّلاع على مقالة المصادقة والتفويض بصفتك تطبيق Google Chat.
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
- مساحة Google Chat يكون فيها المستخدم الذي تمّت المصادقة عليه أو تطبيق Chat الذي يجري المكالمة عضوًا لتسجيل الدخول بصفتك تطبيق Chat، أضِف تطبيق Chat إلى المساحة.
تلقّي رسالة تتضمّن مصادقة المستخدم
للحصول على تفاصيل عن رسالة تتضمّن مصادقة المستخدم، يجب إدخال ما يلي في طلبك:
- حدِّد نطاق التفويض
chat.messages.readonly
أوchat.messages
. - استخدِم الطريقة
GetMessage()
. - اضبط
name
على اسم المورد للرسالة المطلوب الحصول عليها.
يتلقّى المثال التالي رسالة تتضمّن مصادقة المستخدم:
Node.js
Python
Java
برمجة تطبيقات
لتنفيذ هذا المثال، استبدِل ما يلي:
-
SPACE_NAME
: رقم التعريف منname
المساحة يمكنك الحصول على المعرّف من خلال استدعاء الأسلوبListSpaces()
أو من عنوان URL للمساحة. MESSAGE_NAME
: المعرّف منname
الرسالة يمكنك الحصول على المعرّف من نص الاستجابة الذي يتم إرجاعه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API، أو باستخدام الاسم المخصّص الذي تمّ تعيينه للرسالة عند إنشائها.
تعرض Chat API مثيلًا من
Message
الذي يوضّح تفاصيل الرسالة المحدّدة.
تلقّي رسالة تتضمّن مصادقة التطبيق
للحصول على تفاصيل عن رسالة تتضمّن مصادقة التطبيق، يجب إدخال ما يلي في طلبك:
- حدِّد نطاق تفويض
chat.bot
. - استخدِم الطريقة
GetMessage()
. - اضبط
name
على اسم المورد للرسالة المطلوب الحصول عليها.
يتلقّى المثال التالي رسالة تتضمّن مصادقة التطبيق:
Node.js
Python
Java
برمجة تطبيقات
لتنفيذ هذا المثال، استبدِل ما يلي:
-
SPACE_NAME
: رقم التعريف منname
المساحة يمكنك الحصول على المعرّف من خلال استدعاء الأسلوبListSpaces()
أو من عنوان URL للمساحة. MESSAGE_NAME
: المعرّف منname
الرسالة يمكنك الحصول على المعرّف من نص الاستجابة الذي يتم إرجاعه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API، أو باستخدام الاسم المخصّص الذي تمّ تعيينه للرسالة عند إنشائها.
تعرض Chat API مثيلًا من
Message
الذي يوضّح تفاصيل الرسالة المحدّدة.