این راهنما توضیح میدهد که چگونه از روش
update
در منبع Message در Google Chat API برای بهروزرسانی پیام نوشتاری یا کارتی در فضا استفاده کنید. پیامی را بهروز کنید تا مشخصههای پیام، مثل آنچه میگوید یا محتوای کارت، تغییر کند. همچنین میتوانید پیام نوشتاری را به ابتدای پیام کارتی اضافه کنید، یا کارت را به انتهای پیام نوشتاری اضافه کنید.
در Chat API، پیام Chat با
منبع Message نشان داده میشود.
درحالیکه کاربران Chat فقط میتوانند پیامهای حاوی نوشتار ارسال کنند،
برنامههای Chat میتوانند از بسیاری از ویژگیهای پیامرسانی دیگر استفاده کنند، ازجمله
نمایش میاناهای کاربر تعاملی یا ایستا، جمعآوری اطلاعات از
کاربران، و ارسال خصوصی پیامها. برای کسب اطلاعات بیشتر درباره ویژگیهای پیامرسانی
موجود برای Chat API، به
نمای کلی پیامهای Google Chat مراجعه کنید.
پیشنیازها
Node.js
- حساب «کسبوکار» یا «سازمان» Google Workspace با دسترسی به Google Chat.
- محیط خود را راهاندازی کنید:
- پروژه Google Cloud ایجاد کنید.
- صفحه کسب رضایت OAuth را پیکربندی کنید.
- Google Chat API را با نام، نماد، و شرحی برای برنامه Chat خود فعال و پیکربندی کنید.
- نصب Node.js Cloud Client Library.
- اعتبارنامه دسترسی را براساس نحوه اصالتسنجی در درخواست Google Chat API خود ایجاد کنید:
- برای اصالتسنجی بهعنوان کاربر Chat،
اعتبارنامه شناسه کارخواه OAuth ایجاد کنید
و اعتبارنامه را بهعنوان فایل JSON با نام
credentials.jsonدر دایرکتوری محلیتان ذخیره کنید. - برای اصالتسنجی بهعنوان برنامه Chat،
اعتبارنامههای حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.jsonذخیره کنید.
- برای اصالتسنجی بهعنوان کاربر Chat،
اعتبارنامه شناسه کارخواه OAuth ایجاد کنید
و اعتبارنامه را بهعنوان فایل JSON با نام
- براساس اینکه میخواهید بهعنوان کاربر یا برنامه Chat اصالتسنجی کنید، یک دامنه مجوز انتخاب کنید.
Python
- حساب «کسبوکار» یا «سازمان» Google Workspace با دسترسی به Google Chat.
- محیط خود را راهاندازی کنید:
- پروژه Google Cloud ایجاد کنید.
- صفحه کسب رضایت OAuth را پیکربندی کنید.
- Google Chat API را با نام، نماد، و شرحی برای برنامه Chat خود فعال و پیکربندی کنید.
- کتابخانه کارخواه ابری Python را نصب کنید.
- اعتبارنامه دسترسی را براساس نحوه اصالتسنجی در درخواست Google Chat API خود ایجاد کنید:
- برای اصالتسنجی بهعنوان کاربر Chat،
اعتبارنامه شناسه کارخواه OAuth ایجاد کنید
و اعتبارنامه را بهعنوان فایل JSON با نام
credentials.jsonدر دایرکتوری محلیتان ذخیره کنید. - برای اصالتسنجی بهعنوان برنامه Chat،
اعتبارنامههای حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.jsonذخیره کنید.
- برای اصالتسنجی بهعنوان کاربر Chat،
اعتبارنامه شناسه کارخواه OAuth ایجاد کنید
و اعتبارنامه را بهعنوان فایل JSON با نام
- براساس اینکه میخواهید بهعنوان کاربر یا برنامه Chat اصالتسنجی کنید، یک دامنه مجوز انتخاب کنید.
جاوا
- حساب «کسبوکار» یا «سازمان» Google Workspace با دسترسی به Google Chat.
- محیط خود را راهاندازی کنید:
- پروژه Google Cloud ایجاد کنید.
- صفحه کسب رضایت OAuth را پیکربندی کنید.
- Google Chat API را با نام، نماد، و شرحی برای برنامه Chat خود فعال و پیکربندی کنید.
- کتابخانه کارخواه ابری جاوا را نصب کنید.
- اعتبارنامه دسترسی را براساس نحوه اصالتسنجی در درخواست Google Chat API خود ایجاد کنید:
- برای اصالتسنجی بهعنوان کاربر Chat،
اعتبارنامه شناسه کارخواه OAuth ایجاد کنید
و اعتبارنامه را بهعنوان فایل JSON با نام
credentials.jsonدر دایرکتوری محلیتان ذخیره کنید. - برای اصالتسنجی بهعنوان برنامه Chat،
اعتبارنامههای حساب سرویس ایجاد کنید و اعتبارنامهها را بهعنوان فایل JSON با نام
credentials.jsonذخیره کنید.
- برای اصالتسنجی بهعنوان کاربر Chat،
اعتبارنامه شناسه کارخواه OAuth ایجاد کنید
و اعتبارنامه را بهعنوان فایل JSON با نام
- براساس اینکه میخواهید بهعنوان کاربر یا برنامه Chat اصالتسنجی کنید، یک دامنه مجوز انتخاب کنید.
Apps Script
- حساب «کسبوکار» یا «سازمان» Google Workspace با دسترسی به 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
جاوا
Apps Script
برای اجرای این نمونه، موارد زیر را جایگزین کنید:
-
SPACE_NAME: شناسه ازnameفضا. میتوانید شناسه را با فراخوانی روشListSpacesیا از نشانی وب فضا دریافت کنید. MESSAGE_NAME: شناسه ازnameپیام. میتوانید شناسه را از بدنه پاسخ برگرداندهشده پساز ایجاد پیام بهصورت ناهمگام با Chat API، یا با نام سفارشی اختصاصدادهشده به پیام در زمان ایجاد دریافت کنید.
Chat API نمونهای از
Message
را برمیگرداند که جزئیات پیام بهروزشده را نشان میدهد.
بهروزرسانی پیام بهعنوان برنامه Chat
با اصالتسنجی برنامه، هم نوشتار و هم کارتهای پیام را میتوان بهروز کرد.
برای بهروزرسانی پیام با اصالتسنجی برنامه، موارد زیر را در درخواستتان ارسال کنید:
- محدوده مجوز
chat.botرا مشخص کنید. - روش
UpdateMessageرا فراخوانی کنید. messageرا بهعنوان نمونهای ازMessageبا موارد زیر ارسال کنید:- فیلد
nameروی پیامی که باید بهروز شود تنظیم شده است، که شامل شناسه فضا و شناسه پیام است. - اگر فیلد
textنیاز به بهروزرسانی داشته باشد، با نوشتار جدید تنظیم میشود. - اگر کارتهای جدید نیاز به بهروزرسانی داشته باشند، فیلد
cardsV2با آنها تنظیم میشود.
- فیلد
-
updateMaskرا با فهرست فیلدها برای بهروزرسانیهایی مثلtextوcardsV2ارسال کنید.
اگر پیام بهروزشده پیام کارتی باشد و نوشتار بهروز شده باشد، نوشتار بهروزشده به کارتها (که همچنان نمایش داده میشوند) اضافه میشود. اگر پیام بهروزشده پیام نوشتاری باشد و کارتها بهروز شوند، کارتهای بهروزشده به نوشتار (که همچنان نمایش داده میشود) اضافه میشوند.
در اینجا نحوه بهروزرسانی نوشتار و کارتهای پیام با اصالتسنجی برنامه آورده شده است:
Node.js
Python
جاوا
Apps Script
برای اجرای این نمونه، موارد زیر را جایگزین کنید:
-
SPACE_NAME: شناسه ازnameفضا. میتوانید شناسه را با فراخوانی روشListSpacesیا از نشانی وب فضا دریافت کنید. MESSAGE_NAME: شناسه ازnameپیام. میتوانید شناسه را از بدنه پاسخ برگرداندهشده پساز ایجاد پیام بهصورت ناهمگام با Chat API، یا با نام سفارشی اختصاصدادهشده به پیام در زمان ایجاد دریافت کنید.
Chat API نمونهای از
Message
را برمیگرداند که جزئیات پیام بهروزشده را نشان میدهد.
بهروزرسانی کارتها بهصورت ناهمگام
میتوانید کارتهای موجود در پیام را بااستفاده از روش
replaceCards
بهصورت ناهمگام بهروز کنید. این برای بهروزرسانی محتوای کارت بدون تعامل کاربر مفید است، مانند بازآوری پیشنمایش پیوند یا بهروزرسانی وضعیت تکلیف.
این روش برای پیامهای ایجادشده توسط برنامه، ازجمله پیامهای ایجادشده ازطرف کاربر، کار میکند.
برای جزئیات، ایجاد و بهروزرسانی کارتهای تعاملی را ببینید.