רשת מאורגנת להצגת אוסף של פריטים ברשת.
ההגדרה זמינה לתוספים ל-Google Workspace ולאפליקציות של Google Chat.
var grid = CardService.newGrid() .setTitle("My Grid") .setNumColumns(2) .addItem(CardService.newGridItem() .setTitle("My item"));
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
addItem(gridItem) | Grid | הוספת פריט חדש לרשת. |
setAuthorizationAction(action) | Grid | הגדרה של פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשהאובייקט בוצעה לחיצה. |
setBorderStyle(borderStyle) | Grid | הגדרת סגנון הגבול שהוחל על כל פריט ברשת. |
setComposeAction(action, composedEmailType) | Grid | מגדיר פעולה שכותבת טיוטת אימייל כשמשתמש לוחץ על האובייקט. |
setNumColumns(numColumns) | Grid | מספר העמודות שיוצגו ברשת. |
setOnClickAction(action) | Grid | מגדיר פעולה שמופעלת כשמשתמש לוחץ על האובייקט. |
setOnClickOpenLinkAction(action) | Grid | מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. |
setOpenLink(openLink) | Grid | הגדרת כתובת URL שתיפתח כשלוחצים על האובייקט. |
setTitle(title) | Grid | מגדיר את טקסט הכותרת של הרשת. |
מסמכי תיעוד מפורטים
addItem(gridItem)
setAuthorizationAction(action)
הגדרה של פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשהאובייקט בוצעה לחיצה. פעולה זו תפתח את כתובת ה-URL בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה חוזר לאפליקציה, והתוסף נטען מחדש.
אובייקט של ממשק משתמש יכול לכלול רק אחת מהאפשרויות הבאות: setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
.
// ... var action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | AuthorizationAction | האובייקט שמציין את פעולת ההרשאה לבצע כאשר הרכיב הזה בוצעה לחיצה. |
חזרה
Grid
– האובייקט הזה, לשרשור.
setBorderStyle(borderStyle)
הגדרת סגנון הגבול שהוחל על כל פריט ברשת. ברירת המחדל היא NO_BORDER.
פרמטרים
שם | סוג | תיאור |
---|---|---|
borderStyle | BorderStyle | סגנון הגבול שצריך להחיל. |
חזרה
Grid
– האובייקט הזה, לשרשור.
setComposeAction(action, composedEmailType)
מגדיר פעולה שכותבת טיוטת אימייל כשמשתמש לוחץ על האובייקט. אובייקט של ממשק משתמש יכול רק
הם אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
,
setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
הוגדרו.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse
שהוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft)
.
// ... var action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback() { var thread = GmailApp.getThreadById(e.threadId); var draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את פעולת ההרכבה שצריך לבצע כאשר הרכיב הזה בוצעה לחיצה. |
composedEmailType | ComposedEmailType | ערך enum שמציין אם הטיוטה שהורכבה היא בנפרד או כטיוטה של תשובה. |
חזרה
Grid
– האובייקט הזה, לשרשור.
setNumColumns(numColumns)
מספר העמודות שיוצגו ברשת. אם האפשרות הזו מופיעה בחלונית הצדדית השמאלית, תוכלו להציג עמודה אחת או שתיים וערך ברירת המחדל הוא 1. אם מוצג בתיבת דו-שיח, ניתן להציג 2-3 עמודות ערך ברירת המחדל הוא 2.
פרמטרים
שם | סוג | תיאור |
---|---|---|
numColumns | Integer | מספר העמודות. |
חזרה
Grid
– האובייקט הזה, לשרשור.
setOnClickAction(action)
מגדיר פעולה שמופעלת כשמשתמש לוחץ על האובייקט. אובייקט בממשק המשתמש יכול לכלול רק
setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
הוגדרו.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse
.
// ... var action = CardService.newAction().setFunctionName('notificationCallback'); CardService.newTextButton().setText('Create notification').setOnClickAction(action); // ... function notificationCallback() { return CardService.newActionResponseBuilder() .setNotification(CardService.newNotification() .setText("Some info to display to user")) .build(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | הפעולה לביצוע כשלוחצים על הרכיב הזה. |
חזרה
Grid
– האובייקט הזה, לשרשור.
setOnClickOpenLinkAction(action)
מגדירה פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. צריך להשתמש בפונקציה הזו כאשר
צריך ליצור כתובת URL או לבצע פעולות אחרות בנוסף ליצירת האובייקט OpenLink
. אובייקט של ממשק משתמש יכול להכיל רק אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או
setComposeAction(action, composedEmailType)
הוגדר.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse
שהוגדר באמצעות ActionResponseBuilder.setOpenLink(openLink)
.
// ... var action = CardService.newAction().setFunctionName('openLinkCallback'); CardService.newTextButton().setText('Open Link').setOnClickOpenLinkAction(action); // ... function openLinkCallback() { return CardService.newActionResponseBuilder() .setOpenLink(CardService.newOpenLink() .setUrl('https://www.google.com')) .build(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את פעולת הקישור הפתוח שיש לבצע כשהרכיב הזה בוצעה לחיצה. |
חזרה
Grid
– האובייקט הזה, לשרשור.
setOpenLink(openLink)
הגדרת כתובת URL שתיפתח כשלוחצים על האובייקט. יש להשתמש בפונקציה הזו כאשר כתובת ה-URL כבר
ידוע ורק צריך לפתוח אותו. אובייקט בממשק המשתמש יכול להכיל רק אחד מהערכים setOpenLink(openLink)
,
setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
,
או setComposeAction(action, composedEmailType)
מוגדרות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
openLink | OpenLink | אובייקט OpenLink שמתאר את כתובת ה-URL שצריך לפתוח. |
חזרה
Grid
– האובייקט הזה, לשרשור.
setTitle(title)
מגדיר את טקסט הכותרת של הרשת. הטקסט חייב להיות מחרוזת פשוטה ללא תוספות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
title | String | טקסט הכותרת |
חזרה
Grid
– האובייקט הזה, לשרשור.