Action

פעולה שמתארת את ההתנהגות כששולחים את הטופס. לדוגמה, אפשר להפעיל סקריפט של Apps Script כדי לטפל בטופס. אם הפעולה מופעלת, ערכי הטופס נשלחים לשרת.

זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.

ייצוג ב-JSON 
{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}
שדות
function

string

פונקציה בהתאמה אישית שמופעלת כשלוחצים על הרכיב שמכיל אותה או מפעילים אותו בדרך אחרת.

דוגמה לשימוש מופיעה בקטע קריאת נתוני טופס.
parameters[]

object (ActionParameter)

רשימה של פרמטרים של פעולות.
loadIndicator

enum (LoadIndicator)

מציין את אינדיקטור הטעינה שהפעולה מציגה בזמן שהיא מתבצעת.
persistValues

boolean

מציין אם ערכי הטופס נשמרים אחרי הפעולה. ערך ברירת המחדל הוא false.

אם הערך הוא true, ערכי הטופס נשארים אחרי שהפעולה מופעלת. כדי לאפשר למשתמש לבצע שינויים בזמן שהפעולה מעובדת, מגדירים את LoadIndicator לערך NONE. בהודעות כרטיס באפליקציות ל-Chat, צריך גם להגדיר את ResponseType של הפעולה כ-UPDATE_MESSAGE ולהשתמש באותו cardId מהכרטיס שכלל את הפעולה.

אם הערך הוא false, ערכי הטופס נמחקים כשהפעולה מופעלת. כדי למנוע מהמשתמש לבצע שינויים בזמן שהפעולה מעובדת, מגדירים את LoadIndicator לערך SPINNER.
interaction

enum (Interaction)

זה שינוי אופציונלי. נדרש כשפותחים תיבת דו-שיח.

מה לעשות בתגובה לאינטראקציה עם משתמש, כמו לחיצה על כפתור בהודעה עם כרטיס.

אם לא מציינים את זה, האפליקציה מגיבה על ידי ביצוע action – כמו פתיחת קישור או הפעלת פונקציה – כרגיל.

אם מציינים interaction, האפליקציה יכולה להגיב בדרכים אינטראקטיביות מיוחדות. לדוגמה, אם מגדירים את interaction לערך OPEN_DIALOG, האפליקציה יכולה לפתוח תיבת דו-שיח. אם מציינים את המאפיין הזה, לא מוצג אינדיקטור לטעינה. אם צוין עבור תוסף, כל הכרטיס מוסר ולא מוצג דבר בלקוח.

זמינה לאפליקציות ל-Google Chat ולא זמינה לתוספים ל-Google Workspace.
requiredWidgets[]

string

זה שינוי אופציונלי. מלאו את הרשימה הזו בשמות של הווידג'טים שהפעולה הזו צריכה כדי שהשליחה תהיה תקינה.

אם לווידג'טים שמופיעים כאן אין ערך כשהפעולה הזו מופעלת, שליחת הטופס מבוטלת.

זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.
allWidgetsAreRequired

boolean

זה שינוי אופציונלי. אם הערך הוא True, כל הווידג'טים נחשבים כנדרשים לפעולה הזו.

זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.

ActionParameter

רשימה של פרמטרים מסוג מחרוזת שצריך לספק כשמפעילים את שיטת הפעולה. לדוגמה, נניח שיש שלושה לחצני השהיה: השהיה עכשיו, השהיה ליום אחד או השהיה לשבוע הבא. אפשר להשתמש ב-action method = snooze(), ולהעביר את סוג ההשהיה וזמן ההשהיה ברשימה של פרמטרים מסוג מחרוזת.

מידע נוסף זמין במאמר CommonEventObject.

זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.

ייצוג ב-JSON 
{
  "key": string,
  "value": string
}
שדות
key

string

שם הפרמטר של סקריפט הפעולה.
value

string

ערך הפרמטר.

LoadIndicator

מציין את אינדיקטור הטעינה שהפעולה מציגה בזמן שהיא מתבצעת.

זמין לאפליקציות ל-Google Chat ולתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
SPINNER מוצג סמל של גלגל מסתובב כדי לציין שהתוכן נטען.
NONE לא מוצג שום דבר.

אינטראקציה

זה שינוי אופציונלי. נדרש כשפותחים תיבת דו-שיח.

מה לעשות בתגובה לאינטראקציה עם משתמש, כמו לחיצה על כפתור בהודעה עם כרטיס.

אם לא מציינים את זה, האפליקציה מגיבה על ידי ביצוע action – כמו פתיחת קישור או הפעלת פונקציה – כרגיל.

אם מציינים interaction, האפליקציה יכולה להגיב בדרכים אינטראקטיביות מיוחדות. לדוגמה, אם מגדירים את interaction לערך OPEN_DIALOG, האפליקציה יכולה לפתוח תיבת דו-שיח.

אם מציינים את המאפיין הזה, לא מוצג אינדיקטור לטעינה. אם צוין עבור תוסף, כל הכרטיס מוסר ולא מוצג דבר בלקוח.

זמינה לאפליקציות ל-Google Chat ולא זמינה לתוספים ל-Google Workspace.

טיפוסים בני מנייה (enum)
INTERACTION_UNSPECIFIED ערך ברירת המחדל. ‫action פועל כרגיל.
OPEN_DIALOG

פותחת תיבת דו-שיח, ממשק מבוסס-כרטיסים בחלון שבו אפליקציות ל-Chat משתמשות כדי לקיים אינטראקציה עם המשתמשים.

האפשרות הזו נתמכת רק באפליקציות ל-Chat, בתגובה ללחיצה על כפתורים בהודעות עם כרטיסים. אם צוין עבור תוסף, כל הכרטיס מוסר ולא מוצג דבר בלקוח.

זמינה לאפליקציות ל-Google Chat ולא זמינה לתוספים ל-Google Workspace.