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

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

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

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

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

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

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

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

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

2. روی پیکربندی کلیک کنید.

3. در قسمت تنظیمات پیشرفته ، به Triggers بروید و بررسی کنید که فیلد دستور App حاوی یک ماشه باشد، مانند یک نقطه پایانی HTTP یا عملکرد Apps Script. برای پاسخ دادن به فرمان سریع باید از این ماشه در قسمت زیر استفاده کنید.

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

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

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

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

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

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

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

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

برای پاسخ دادن به یک فرمان سریع، باید راه‌انداز دستور App را اجرا کنید تا برنامه Chat شما بتواند هر شی رویدادی را که حاوی فراداده فرمان برنامه است کنترل کند.

کد زیر نمونه ای از یک برنامه چت را نشان می دهد که به فرمان Help پاسخ می دهد. برای پاسخ به دستورات سریع، برنامه Chat اشیاء رویداد را از یک راه‌انداز فرمان برنامه کنترل می‌کند. هنگامی که بارگذاری یک شی رویداد حاوی شناسه فرمان سریع است، برنامه Chat عمل DataActions را با یک شی createMessageAction برمی‌گرداند:

// The ID of the slash command "/about".
// It's not enabled by default, set to the actual ID to enable it. You must
// use the same ID as set in the Google Chat API configuration.
const HELP_COMMAND_ID = 0;

/**
 * Responds to an APP_COMMAND event in Google Chat.
 *
 * @param {Object} event the event object from Google Chat
 */
function onAppCommand(event) {

    // Stores the Google Chat app command metadata as a variable.
    const appCommandMetadata = event.chat.appCommandPayload.appCommandMetadata;

    if (appCommandMetadata.appCommandType == "QUICK_COMMAND") {

        // Executes the quick command logic based on its ID.
        // Quick command IDs are set in the Google Chat API configuration.
        switch (appCommandMetadata.appCommandId) {
            case HELP_COMMAND_ID:
                return { hostAppDataAction: { chatDataAction: { createMessageAction: { message: {
                    text: 'The Avatar app replies to Google Chat messages.'
                }}}}};
        }
    }
}

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