يشرح هذا الدليل كيفية استخدام طريقة
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 الخاصة بنظام Node.js.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.json
في الدليل المحلي. - لإجراء المصادقة بصفتك تطبيق Chat،
أنشئ بيانات اعتماد
لحساب الخدمة واحفظها كملف JSON باسم
credentials.json
.
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
- اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
Python
- حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة برامج Cloud للغة Python.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.json
في الدليل المحلي. - لإجراء المصادقة بصفتك تطبيق Chat،
أنشئ بيانات اعتماد
لحساب الخدمة واحفظها كملف JSON باسم
credentials.json
.
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
- اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
Java
- حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها باستخدام اسم ورمز ووصف لتطبيق Chat.
- ثبِّت مكتبة برامج Cloud للغة Java.
- أنشئ بيانات اعتماد الوصول استنادًا إلى الطريقة التي تريد استخدامها للمصادقة في طلب Google Chat API:
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
credentials.json
في الدليل المحلي. - لإجراء المصادقة بصفتك تطبيق Chat،
أنشئ بيانات اعتماد
لحساب الخدمة واحفظها كملف JSON باسم
credentials.json
.
- لإجراء المصادقة كمستخدم في Chat،
أنشئ بيانات اعتماد معرّف عميل OAuthواحفظها كملف JSON باسم
- اختَر نطاق تفويض استنادًا إلى ما إذا كنت تريد المصادقة كمستخدم أو كتطبيق Chat.
برمجة تطبيقات
- حساب Google Workspace من إصدار Business أو Enterprise مع إذن الوصول إلى Google Chat
- إعداد البيئة:
- أنشئ مشروعًا على Google Cloud.
- ضبط شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth
- فعِّل واجهة Google Chat API وأعِدّها باستخدام اسم ورمز ووصف لتطبيق Chat.
- أنشئ مشروعًا مستقلاً في "برمجة تطبيقات Google"، وفعِّل خدمة 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
يوضّح تفاصيل الرسالة التي تم تعديلها.