يشرح هذا الدليل كيفية استخدام الأسلوب
update()
في مورد 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.
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.
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 Workspace من فئة Business أو Enterprise يتيح الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل Google Chat API وضبطها باستخدام اسم ورمز ووصف لتطبيق Chat.
- أنشئ مشروعًا مستقلاً في Apps Script، وفعِّل خدمة Chat المتقدّمة.
- في هذا الدليل، يجب استخدام مصادقة المستخدم أو مصادقة التطبيق. للمصادقة بصفتك تطبيق Chat، أنشئ بيانات اعتماد حساب الخدمة. لمعرفة الخطوات، يُرجى الاطّلاع على مقالة المصادقة والتفويض بصفتك تطبيق Google Chat.
- اختَر نطاق التفويض استنادًا إلى ما إذا كنت تريد المصادقة بصفتك مستخدمًا أو تطبيق Chat.
تعديل رسالة بالنيابة عن مستخدم
من خلال مصادقة المستخدم، يمكن تعديل نص الرسالة فقط.
لتعديل رسالة باستخدام مصادقة المستخدم، عليك ضبط ما يلي في طلبك:
- حدِّد نطاق تفويض
chat.messages
. - استخدِم الطريقة
UpdateMessage()
. - نقْل
message
كمثيل منMessage
مع ما يلي:- الحقل
name
الذي تم ضبطه على الرسالة المطلوب تعديلها، والتي تتضمّن معرّف مساحة ومعرّف رسالة - تم ضبط الحقل
text
باستخدام النص الجديد.
- الحقل
- نقْل
updateMask
بالقيمةtext
.
إذا كانت الرسالة المعدَّلة هي رسالة بطاقة، يتمّ وضع النص في بداية البطاقات (التي تستمر في العرض).
في ما يلي كيفية تعديل رسالة أو إضافة رسالة نصية إلى رسالة البطاقة مع مصادقة المستخدم:
Node.js
Python
Java
برمجة تطبيقات
لتنفيذ هذا المثال، استبدِل ما يلي:
SPACE_NAME
: رقم التعريف منname
المساحة يمكنك الحصول على المعرّف من خلال استدعاء الوسيطةListSpaces()
أو من عنوان URL للمساحة.MESSAGE_NAME
: المعرّف منname
الرسالة يمكنك الحصول على رقم التعريف من نص الاستجابة الذي يتم إرجاعه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API، أو باستخدام الاسم المخصّص الذي تمّ تعيينه للرسالة عند إنشائها.
تعرض Chat API مثيلًا من
Message
الذي يوضّح تفاصيل الرسالة التي تم تعديلها.
تعديل رسالة كتطبيق Chat
باستخدام مصادقة التطبيق، يمكن تعديل النص والبطاقات في الرسالة.
لتعديل رسالة باستخدام مصادقة التطبيق، أرسِل ما يلي في طلبك:
- حدِّد نطاق تفويض
chat.bot
. - استخدِم الطريقة
UpdateMessage()
. - نقْل
message
كمثيل منMessage
مع ما يلي:- الحقل
name
الذي تم ضبطه على الرسالة المطلوب تعديلها، والتي تتضمّن معرّف مساحة ومعرّف رسالة - حقل
text
الذي تم ضبطه بالنص الجديد إذا كان يحتاج إلى تعديل - تم ضبط الحقل
cardsV2
باستخدام البطاقات الجديدة إذا كانت بحاجة إلى تعديل.
- الحقل
- مرِّر
updateMask
مع قائمة الحقول إلى التعديلات، مثلtext
وcardsV2
.
إذا كانت الرسالة المعدَّلة هي رسالة بطاقة وتم تعديل النص، يتمّ وضع النص المعدَّل في بداية البطاقات (التي تستمر في الظهور). إذا كانت الرسالة المعدَّلة هي رسالة نصية وتم تعديل البطاقات، تتم إضافة البطاقات المعدَّلة إلى النص (الذي يستمر في العرض).
في ما يلي كيفية تعديل نص رسالة وبطاقاتها باستخدام مصادقة التطبيق:
Node.js
Python
Java
برمجة تطبيقات
لتنفيذ هذا المثال، استبدِل ما يلي:
SPACE_NAME
: رقم التعريف منname
المساحة يمكنك الحصول على المعرّف من خلال استدعاء الوسيطةListSpaces()
أو من عنوان URL للمساحة.MESSAGE_NAME
: المعرّف منname
الرسالة يمكنك الحصول على رقم التعريف من نص الاستجابة الذي يتم إرجاعه بعد إنشاء رسالة بشكل غير متزامن باستخدام Chat API، أو باستخدام الاسم المخصّص الذي تمّ تعيينه للرسالة عند إنشائها.
تعرض Chat API مثيلًا من
Message
الذي يوضّح تفاصيل الرسالة التي تم تعديلها.