به عنوان یک برنامه Google Chat به دستورات سریع پاسخ دهید

این صفحه نحوه راه‌اندازی و پاسخ به دستورات سریع برنامه Google Chat را توضیح می‌دهد.

دستور سریع راهی است که کاربران می توانند برنامه چت را فراخوانی کرده و با آن تعامل داشته باشند. برای استفاده از یک فرمان سریع، منوی ادغام را با کلیک کردن بر روی Google Workspace Tools در فضای چت یا مکالمه باز کنید و سپس یک دستور برنامه را با نامی انتخاب کنید که با اسلش ( / ) شروع نمی شود. با انتخاب یک فرمان سریع، برنامه Chat مستقیماً بدون ورودی های بیشتر از کاربر فراخوانی می شود و امکان تعامل سریع با کاربر را فراهم می کند.

کاربران همچنین می توانند یک برنامه چت را از طریق دستور اسلش فراخوانی کنند. برای مراحل، پاسخ به دستورات اسلش را ببینید. در مقایسه با دستورات اسلش، دستورات سریع با نام کاربرپسندتری در رابط کاربری چت فرمت می‌شوند، بلافاصله پس از انتخاب فراخوانی می‌شوند و نیازی به یادآوری یا تایپ نام دستور اسلش توسط کاربر ندارند.

منوی ادغام با دستورات سریع
شکل 1 : منوی ادغام حاوی دستورات سریع برای یک برنامه چت.

یک فرمان سریع در Google Chat API تنظیم کنید

برای ایجاد یک فرمان سریع یا به‌روزرسانی هر دستور اسلش موجود به دستورات سریع، باید اطلاعات مربوط به فرمان را در پیکربندی برنامه چت خود برای Google Chat API مشخص کنید.

برای پیکربندی یک فرمان سریع در Google Chat API، مراحل زیر را انجام دهید:

  1. در کنسول Google Cloud، روی > APIs & Services > Enabled APIs & Services > Google Chat API کلیک کنید.

    به صفحه Google Chat API بروید

  2. روی Configuration کلیک کنید.

  3. در بخش Commands ، روی Add a command کلیک کنید.

  4. شناسه فرمان، نام، توضیحات و نوع فرمان را برای دستور وارد کنید:

    • شناسه فرمان: عددی از 1 تا 1000 که برنامه چت شما از آن برای تشخیص فرمان و برگرداندن پاسخ استفاده می‌کند.
    • Name: نام نمایشی دستور. نام ها می توانند حداکثر 50 کاراکتر باشند و می توانند شامل کاراکترهای خاص باشند.
      • از کلمات یا عبارات کوتاه، توصیفی و کاربردی استفاده کنید تا دستورات را برای کاربر واضح کنید. به عنوان مثال، از Update contact برای دستوری که رکورد مخاطب را تغییر می دهد، استفاده کنید.
    • توضیحات: متنی که آنچه دستور انجام می دهد را توصیف می کند. توضیحات می تواند حداکثر 50 کاراکتر باشد و می تواند شامل کاراکترهای خاص باشد.
      • توضیحات را کوتاه و واضح نگه دارید تا کاربران بدانند هنگام فراخوانی دستور چه انتظاری داشته باشند.
      • به کاربران اطلاع دهید که آیا برنامه Chat به همه افراد موجود در فضا پاسخ می دهد یا به صورت خصوصی به کاربری که این فرمان را فراخوانی می کند. برای مثال، برای دستور سریع درباره ، می‌توانید آن را با عنوان Learn about this app (فقط برای شما قابل مشاهده است) توصیف کنید.
    • نوع فرمان: دستور Quick را انتخاب کنید.

  5. اختیاری: اگر می‌خواهید برنامه چت شما به فرمان با یک گفتگو پاسخ دهد، کادر باز کردن یک گفتگو را انتخاب کنید.

  6. روی ذخیره کلیک کنید.

دستور سریع اکنون برای برنامه چت پیکربندی شده است.

به یک دستور سریع پاسخ دهید

وقتی کاربران دستور سریعی را فراخوانی می‌کنند، برنامه چت شما یک رویداد تعاملی APP_COMMAND دریافت می‌کند. بارگذاری رویداد حاوی شی appCommandMetadata با جزئیات مربوط به فرمان فراخوانی شده است (شامل شناسه فرمان و نوع فرمان)، به طوری که می توانید پاسخ مناسبی را برگردانید.

کد زیر نمونه‌ای از برنامه Chat را نشان می‌دهد که با مدیریت رویدادهای تعامل APP_COMMAND و تشخیص اینکه آیا بار رویداد حاوی شناسه فرمان منطبق است یا خیر، به فرمان Help پاسخ می‌دهد. اگر محموله رویداد حاوی شناسه فرمان باشد، برنامه Chat یک پیام خصوصی برمی‌گرداند:

اسکریپت برنامه ها 

// Handle the APP_COMMAND event type.
function onAppCommand(event) {
  // Executes the command logic based on its ID.
  // Command IDs are set in the Google Chat API configuration.
  switch (event.appCommandMetadata.appCommandId) {
    case HELP_COMMAND_ID:
      return {
        privateMessageViewer: event.user,
        text: 'The Avatar app replies to Google Chat messages.'
      };
  }
}

HELP_COMMAND_ID با شناسه فرمانی که هنگام پیکربندی فرمان سریع در Chat API مشخص کردید، تنظیم کنید. برای آزمایش این کد، به تست ویژگی‌های تعاملی برای برنامه‌های گپ Google مراجعه کنید. برای آزمایش یک فرمان سریع در چت، منوی ادغام را با کلیک کردن بر روی Google Workspace Tools و سپس انتخاب دستور سریع خود باز کنید.

دستورات اسلش موجود را به دستورات سریع تبدیل کنید

برای تغییر یک دستور اسلش موجود به یک دستور سریع، دستور اسلش را در Google Chat API با تغییر نوع Command از دستور Slash به دستور Quick ویرایش کنید.

وقتی کاربران یک فرمان سریع را فراخوانی می‌کنند، برنامه چت شما به جای یک رویداد تعاملی MESSAGE که برای دستورات اسلش ارسال می‌شود، یک رویداد تعاملی APP_COMMAND دریافت می‌کند. برنامه Chat خود را برای مدیریت این نوع رویداد تعامل با خواندن بار رویداد حاوی شی appCommandMetadata با جزئیات مربوط به فرمان سریعی که فراخوانی شده است، به روز کنید. به پاسخ به دستور سریع مراجعه کنید.