برای جلوگیری از تغییر بافت زمانی که کاربران پیوندی را در چت Google به اشتراک میگذارند، برنامه چت شما میتواند با پیوست کردن کارتی به پیام آنها پیوند را پیشنمایش کند که اطلاعات بیشتری را ارائه میدهد و به افراد امکان میدهد مستقیماً از چت Google اقدام کنند.
به عنوان مثال، یک فضای چت Google را تصور کنید که شامل تمام نمایندگان خدمات مشتری یک شرکت به علاوه یک برنامه چت به نام Case-y است. نمایندگان اغلب پیوندهایی را به پرونده های خدمات مشتری در فضای چت به اشتراک می گذارند، و هر بار که این کار را انجام می دهند، همکارانشان باید پیوند پرونده را باز کنند تا جزئیاتی مانند گیرنده، وضعیت و موضوع را ببینند. به همین ترتیب، اگر کسی بخواهد مالکیت یک پرونده را در اختیار بگیرد یا وضعیت را تغییر دهد، باید پیوند را باز کند.
پیشنمایش پیوند، برنامه چت ساکن در فضا، Case-y، را قادر میسازد تا هر زمان که شخصی پیوند موردی را به اشتراک میگذارد، کارتی را که مأمور، وضعیت و موضوع را نشان میدهد، ضمیمه کند. دکمه های روی کارت به نمایندگان اجازه می دهد تا مالکیت پرونده را در دست بگیرند و وضعیت را مستقیماً از جریان چت تغییر دهند.
پیش نمایش لینک چگونه کار می کند
هنگامی که شخصی پیوندی را به پیام خود اضافه میکند، تراشهای ظاهر میشود که به او اطلاع میدهد که برنامه چت ممکن است پیوند را پیشنمایش کند.
پس از ارسال پیام، لینک به برنامه چت ارسال می شود که سپس کارت را تولید کرده و به پیام کاربر متصل می کند.
در کنار پیوند، کارت اطلاعات اضافی درباره پیوند، از جمله عناصر تعاملی مانند دکمهها، ارائه میکند. برنامه گپ شما می تواند کارت پیوست شده را در پاسخ به تعاملات کاربر، مانند کلیک روی دکمه، به روز کند.
اگر کسی نمیخواهد برنامه چت پیوند او را با پیوست کردن کارتی به پیامش پیشنمایش کند، میتواند با کلیک روی
روی تراشه پیشنمایش، از پیشنمایش جلوگیری کند. کاربران می توانند کارت پیوست شده را در هر زمان با کلیک بر روی حذف پیش نمایش حذف کنند.پیش نیازها
Node.js
یک برنامه Google Chat که برای ویژگیهای تعاملی فعال است. برای ایجاد یک برنامه چت تعاملی با استفاده از سرویس HTTP، این شروع سریع را کامل کنید.اسکریپت برنامه ها
یک برنامه Google Chat که برای ویژگیهای تعاملی فعال است. برای ایجاد یک برنامه چت تعاملی در Apps Script، این شروع سریع را کامل کنید.پیش نمایش پیوندها را پیکربندی کنید
پیوندهای خاص - مانند example.com
، support.example.com
و support.example.com/cases/
- را به عنوان الگوهای URL در صفحه پیکربندی برنامه Chat خود در کنسول Google Cloud ثبت کنید تا برنامه Chat شما بتواند آنها را پیش نمایش کند.
- کنسول Google Cloud را باز کنید.
- در کنار «Google Cloud»، روی پیکان رو به پایین کلیک کنید و پروژه برنامه چت خود را باز کنید.
- در قسمت جستجو،
Google Chat API
را تایپ کنید و Google Chat API را کلیک کنید. - روی Manage > Configuration کلیک کنید.
- در بخش پیشنمایشهای پیوند، یک الگوی URL را اضافه یا ویرایش کنید.
- برای پیکربندی پیشنمایش پیوندها برای الگوی URL جدید، روی افزودن الگوی URL کلیک کنید.
- برای ویرایش پیکربندی الگوی URL موجود، روی پیکان رو به پایین کلیک کنید.
در قسمت Host pattern ، دامنه الگوی URL را وارد کنید. برنامه چت پیوندهای این دامنه را پیشنمایش خواهد کرد.
برای داشتن پیوندهای پیشنمایش برنامه گپ برای یک زیر دامنه خاص، مانند
subdomain.example.com
، زیردامنه را نیز اضافه کنید.برای داشتن پیوندهای پیشنمایش برنامه چت برای کل دامنه، یک کاراکتر عام با ستاره (*) را به عنوان زیر دامنه مشخص کنید. برای مثال،
*.example.com
باsubdomain.example.com
وany.number.of.subdomains.example.com
مطابقت دارد.در قسمت پیشوند مسیر ، مسیری را وارد کنید تا به دامنه الگوی میزبان اضافه شود.
برای مطابقت با همه URL ها در دامنه الگوی میزبان، پیشوند مسیر را خالی بگذارید.
به عنوان مثال، اگر الگوی میزبان
support.example.com
باشد، برای مطابقت با نشانیهای وب برای موارد میزبانی شده درsupport.example.com/cases/
،cases/
وارد کنید.روی Done کلیک کنید.
روی ذخیره کلیک کنید.
اکنون، هر زمان که فردی پیوندی را وارد کند که با الگوی URL پیشنمایش پیوند با پیامی در فضای چت که شامل برنامه چت شما است مطابقت دارد، برنامه شما پیوند را پیشنمایش میکند.
پیش نمایش یک پیوند
پس از پیکربندی پیشنمایش پیوند برای یک پیوند معین، برنامه چت شما میتواند پیوند را با پیوست کردن اطلاعات بیشتر به آن شناسایی و پیشنمایش کند.
در داخل فضاهای چت که شامل برنامه چت شما میشود، وقتی پیام شخصی حاوی پیوندی است که با الگوی URL پیشنمایش پیوند مطابقت دارد، برنامه گپ شما یک رویداد تعاملی MESSAGE
را دریافت میکند. بار JSON برای رویداد تعامل حاوی فیلد matchedUrl
است:
JSON
"message": {
. . . // other message attributes redacted
"matchedUrl": {
"url": "https://support.example.com/cases/case123"
},
. . . // other message attributes redacted
}
با بررسی وجود فیلد matchedUrl
در محموله رویداد MESSAGE
، برنامه چت شما میتواند اطلاعاتی را با پیوند پیشنمایششده به پیام اضافه کند. برنامه چت شما می تواند با یک پیام متنی ساده پاسخ دهد یا کارتی را پیوست کند.
با پیامک پاسخ دهید
برای پاسخهای ساده، برنامه چت شما میتواند با پاسخ دادن با یک پیام متنی ساده به یک پیوند، پیشنمایش پیوند را مشاهده کند. این مثال پیامی را ضمیمه میکند که URL پیوند را تکرار میکند که با الگوی URL پیشنمایش پیوند مطابقت دارد.
Node.js
اسکریپت برنامه ها
یک کارت ضمیمه کنید
برای پیوست کردن کارت به پیوند پیشنمایششده، یک ActionResponse
از نوع UPDATE_USER_MESSAGE_CARDS
برگردانید. این مثال یک کارت ساده را پیوست می کند.
Node.js
اسکریپت برنامه ها
این مثال با برگرداندن کارت JSON یک پیام کارت ارسال می کند. همچنین میتوانید از سرویس کارت برنامههای اسکریپت استفاده کنید.
یک کارت را به روز کنید
برای بهروزرسانی کارت پیوست شده به پیوند پیشنمایششده، یک ActionResponse
از نوع UPDATE_USER_MESSAGE_CARDS
برگردانید. برنامههای گپ فقط میتوانند کارتهایی را بهروزرسانی کنند که پیوندها را به عنوان پاسخی به رویداد تعامل برنامههای گپ پیشنمایش میکنند. برنامههای گپ نمیتوانند این کارتها را با تماس غیرهمزمان Chat API بهروزرسانی کنند.
پیش نمایش پیوند از بازگرداندن ActionResponse
از نوع UPDATE_MESSAGE
پشتیبانی نمی کند. از آنجایی که UPDATE_MESSAGE
به جای کارت، کل پیام را بهروزرسانی میکند، فقط در صورتی کار میکند که برنامه چت پیام اصلی را ایجاد کند. پیشنمایش پیوند، کارتی را به پیام ایجاد شده توسط کاربر متصل میکند، بنابراین برنامه چت اجازه بهروزرسانی آن را ندارد.
برای اطمینان از اینکه یک تابع هم کارت های ایجاد شده توسط کاربر و هم کارت های ایجاد شده توسط کاربر را در جریان گپ به روز می کند، ActionResponse
به صورت پویا بر اساس اینکه برنامه چت یا کاربر پیام را ایجاد کرده است تنظیم کنید.
- اگر کاربری پیام را ایجاد کرد،
ActionResponse
رویUPDATE_USER_MESSAGE_CARDS
تنظیم کنید. - اگر یک برنامه چت پیام را ایجاد کرد،
ActionResponse
رویUPDATE_MESSAGE
تنظیم کنید.
دو راه برای انجام این کار وجود دارد: تعیین و بررسی یک actionMethodName
سفارشی به عنوان بخشی از ویژگی onclick
کارت پیوست شده (که پیام را به عنوان ایجاد شده توسط کاربر شناسایی می کند) یا بررسی اینکه آیا پیام توسط کاربر ایجاد شده است.
گزینه 1: actionMethodName
را بررسی کنید
برای استفاده از actionMethodName
برای مدیریت مناسب رویدادهای تعاملی CARD_CLICKED
در کارتهای پیشنمایششده، یک actionMethodName
سفارشی را به عنوان بخشی از ویژگی onclick
کارت پیوست شده تنظیم کنید:
JSON
. . . // Preview card details
{
"textButton": {
"text": "ASSIGN TO ME",
"onClick": {
// actionMethodName identifies the button to help determine the
// appropriate ActionResponse.
"action": {
"actionMethodName": "assign",
}
}
}
}
. . . // Preview card details
با "actionMethodName": "assign"
که دکمه را به عنوان بخشی از یک پیشنمایش پیوند شناسایی میکند، میتوانید به صورت پویا ActionResponse
صحیح را با بررسی یک actionMethodName
منطبق برگردانید:
Node.js
اسکریپت برنامه ها
این مثال با برگرداندن کارت JSON یک پیام کارت ارسال می کند. همچنین میتوانید از سرویس کارت برنامههای اسکریپت استفاده کنید.
گزینه 2: نوع فرستنده را بررسی کنید
بررسی کنید که آیا message.sender.type
HUMAN
است یا BOT
. اگر HUMAN
, ActionResponse
را روی UPDATE_USER_MESSAGE_CARDS
و در غیر این صورت ActionResponse
روی UPDATE_MESSAGE
تنظیم کنید . در اینجا به این صورت است:
Node.js
اسکریپت برنامه ها
این مثال با برگرداندن کارت JSON یک پیام کارت ارسال می کند. همچنین میتوانید از سرویس کارت برنامههای اسکریپت استفاده کنید.
یک دلیل معمولی برای به روز رسانی کارت در پاسخ به کلیک یک دکمه است. دکمه Assign to Me را از بخش قبلی، Attach a card را به یاد بیاورید. مثال کامل زیر کارت را بهروزرسانی میکند به طوری که میگوید پس از کلیک کاربر روی Assign to Me به «You» اختصاص داده میشود. مثال به صورت پویا ActionResponse
را با بررسی نوع فرستنده تنظیم می کند.
مثال کامل: Case-y برنامه چت خدمات مشتری
در اینجا کد کامل Case-y، یک برنامه چت است که پیوندهای موارد به اشتراک گذاشته شده در فضای چت را که نمایندگان خدمات مشتری در آن همکاری می کنند، پیش نمایش می دهد.
Node.js
اسکریپت برنامه ها
این مثال با برگرداندن کارت JSON یک پیام کارت ارسال می کند. همچنین میتوانید از سرویس کارت برنامههای اسکریپت استفاده کنید.
محدودیت ها و ملاحظات
همانطور که پیش نمایش پیوندها را برای برنامه چت خود پیکربندی می کنید، به این محدودیت ها و ملاحظات توجه کنید:
- هر برنامه چت از پیش نمایش پیوند برای حداکثر 5 الگوی URL پشتیبانی می کند.
- برنامههای چت یک پیوند را در هر پیام پیشنمایش میکنند. اگر چندین پیوند قابل پیشنمایش در یک پیام وجود داشته باشد، تنها اولین پیوند قابل پیشنمایش پیشنمایش میشود.
- برنامههای چت فقط پیوندهایی را پیشنمایش میکنند که با
https://
شروع میشوند، بنابراینhttps://support.example.com/cases/
پیشنمایش میکند، اماsupport.example.com/cases/
این کار را نمیکند. - مگر اینکه پیام حاوی اطلاعات دیگری باشد که به برنامه چت ارسال میشود، مانند دستور اسلش ، فقط URL پیوند با پیشنمایش پیوند به برنامه چت ارسال میشود.
- کارتهای متصل به پیوندهای پیشنمایششده فقط از
ActionResponse
از نوعUPDATE_USER_MESSAGE_CARDS
پشتیبانی میکنند و فقط در پاسخ به رویداد تعامل برنامههای گپ . پیشنمایشهای پیوندUPDATE_MESSAGE
یا درخواستهای ناهمزمان برای بهروزرسانی کارتهای متصل به پیوند پیشنمایششده از طریق Chat API پشتیبانی نمیکنند. برای کسب اطلاعات بیشتر، به بهروزرسانی کارت مراجعه کنید.
پیش نمایش لینک اشکال زدایی
همانطور که پیشنمایش پیوندها را پیادهسازی میکنید، ممکن است لازم باشد برنامه چت خود را با خواندن گزارشهای برنامه اشکالزدایی کنید. برای خواندن گزارشها، از Logs Explorer در کنسول Google Cloud دیدن کنید.