בדף הזה מוסבר איך להגדיר פקודות מהירות באפליקציית Google Chat ולהגיב להן.
פקודה מהירה היא דרך שבה משתמשים יכולים להפעיל אפליקציה ב-Chat ולנהל איתה אינטראקציה. כדי להשתמש בפקודה מהירה, פותחים את תפריט השילוב בלחיצה על 'כלים של Google Workspace' במרחב משותף או בשיחה ב-Chat, ובוחרים פקודה לאפליקציה עם שם שלא מתחיל בקו נטוי (/). בחירת פקודה מהירה מפעילה את אפליקציית Chat ישירות בלי צורך בהזנות נוספות מהמשתמש, ומאפשרת אינטראקציות מהירות עם המשתמשים.
המשתמשים יכולים גם להפעיל אפליקציית צ'אט באמצעות פקודת קו נטוי. בהשוואה לפקודות קו נטוי, הפקודות המהירות מוצגות בממשק המשתמש של Chat עם שם ידידותי יותר למשתמש, הן מופעלות מיד אחרי הבחירה שלהן והמשתמשים לא צריכים לזכור או להקליד את השם של הפקודה עם קו נטוי.
הגדרת פקודת קיצור ב-Google Chat API
כדי ליצור פקודה מהירה או לעדכן פקודות קיימות של קו נטוי לפקודות מהירות, צריך לציין מידע על הפקודה בהגדרות של אפליקציית Chat ל-Google Chat API.
כדי להגדיר פקודה מהירה ב-Google Chat API, מבצעים את השלבים הבאים:
במסוף Google Cloud, לוחצים על סמל התפריט > APIs & Services > Enabled APIs & Services > Google Chat API.
לוחצים על Configuration.
בקטע Advanced settings, עוברים אל Triggers ובודקים שהשדה App command מכיל טריגר, כמו נקודת קצה מסוג HTTP או פונקציית Apps Script. צריך להשתמש בטריגר הזה בקטע הבא כדי להגיב לפקודה המהירה.
בקטע פקודות, לוחצים על הוספת פקודה.
מזינים את מזהה הפקודה, השם, התיאור וסוג הפקודה:
- מזהה הפקודה: מספר מ-1 עד 1,000 שמשמש את אפליקציית Chat לזיהוי הפקודה ולהחזרת תשובה.
- שם: השם המוצג של הפקודה. השמות יכולים להכיל עד 50 תווים, כולל תווים מיוחדים.
- כדאי להשתמש במילים או בביטויים קצרים, תיאוריים וברורים, כדי שהפקודות יהיו ברורות למשתמש. לדוגמה, אפשר להשתמש ב-Update contact לפקודה שמשנה את רשומת איש הקשר.
- Description: הטקסט שמתאר את הפעולה של הפקודה.
התיאורים יכולים להכיל עד 50 תווים ויכולים לכלול תווים מיוחדים.
- חשוב שהתיאור יהיה קצר וברור, כדי שהמשתמשים ידעו למה לצפות כשהם מריצים את הפקודה.
- אפשר להגדיר אם התשובה של אפליקציית Chat תישלח לכל המשתתפים במרחב המשותף או באופן פרטי למשתמש שהפעיל את הפקודה. לדוגמה, לפקודה המהירה מידע אפשר לתת את התיאור מידע על האפליקציה הזו (גלוי רק לך).
- סוג הפקודה: בוחרים באפשרות פקודה מהירה.
אם רוצים שתגובה לפקודה תופיע בתיבת דו-שיח באפליקציית Chat, מסמנים את התיבה פתיחת תיבת דו-שיח.
לוחצים על שמירה.
הפקודה המהירה מוגדרת עכשיו לאפליקציית Chat.
מענה לפקודה מהירה
כשמשתמשים מפעילים פקודה מהירה, אפליקציית Chat מקבלת אובייקט אירוע שמכיל מידע על הפקודה המהירה.
אובייקט האירוע מכיל מטען נתונים של AppCommand עם פרטים על הפקודה שהופעל (כולל מזהה הפקודה), כדי שתוכלו להחזיר תשובה מתאימה.
כדי להגיב לפקודה מהירה, צריך להטמיע את הטריגר של פקודת האפליקציה כדי שאפליקציית Chat תוכל לטפל בכל אובייקטי האירועים שמכילים מטא-נתונים של פקודת האפליקציה.
הקוד הבא מציג דוגמה לאפליקציית Chat שמגיבה לפקודה Help. כדי להגיב לפקודות מהירות, אפליקציית Chat מטפלת באובייקטים של אירועים מטריגר של פקודה מאפליקציה. כשמטען הייעודי של אובייקט אירוע מכיל מזהה של פקודה מהירה, אפליקציית Chat מחזירה את הפעולה DataActions עם אובייקט createMessageAction:
Apps Script
// 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.
כדי לבדוק פקודה מהירה ב-Chat, פותחים את תפריט השילוב בלחיצה על סמל הכלים של Google Workspace ובוחרים את הפקודה המהירה.