רשת מאורגנת להצגת אוסף של פריטים ברשת.
זמין לתוספים ל-Google Workspace ולאפליקציות ל-Google Chat.
const grid = CardService.newGrid().setTitle('My Grid').setNumColumns(2).addItem( CardService.newGridItem().setTitle('My item'));
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
add | Widget | הוספה של פעולת האירוע שאפשר לבצע בווידג'ט. |
add | Grid | הוספת פריט חדש לרשת. |
set | Grid | הגדרה של פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשלוחצים על האובייקט. |
set | Grid | מגדיר את סגנון הגבול שחל על כל פריט ברשת. |
set | Grid | הגדרת פעולה שיוצרת טיוטת אימייל כשלוחצים על האובייקט. |
set | Widget | מגדיר את המזהה הייחודי שהוקצה ומשמש לזיהוי הווידג'ט שצריך לשנות. |
set | Grid | מספר העמודות שיוצגו ברשת. |
set | Grid | הגדרת פעולה שמופעלת כשלוחצים על האובייקט. |
set | Grid | הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. |
set | Grid | הגדרה של כתובת URL שתיפתח כשלוחצים על האובייקט. |
set | Grid | מגדיר את טקסט הכותרת של הרשת. |
set | Widget | הגדרה של רמת החשיפה של הווידג'ט. |
תיעוד מפורט
add Event Action(eventAction)
הוספה של פעולת האירוע שאפשר לבצע בווידג'ט.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
event | Event | ה-Event שרוצים להוסיף. |
חזרה
Widget – האובייקט, לשרשור.
add Item(gridItem)
set Authorization Action(action)
הגדרה של פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשלוחצים על האובייקט. כתובת ה-URL תיפתח בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.
אפשר להגדיר לאובייקט בממשק המשתמש רק אחת מהאפשרויות הבאות: set, set, set, set או set.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
action | Authorization | האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על הרכיב הזה. |
חזרה
Grid – האובייקט הזה, לשרשור.
set Border Style(borderStyle)
מגדיר את סגנון הגבול שחל על כל פריט ברשת. ברירת המחדל היא NO_BORDER.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
border | Border | סגנון הגבול שרוצים להחיל. |
חזרה
Grid – האובייקט הזה, לשרשור.
set Compose Action(action, composedEmailType)
הגדרת פעולה שיוצרת טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק אחד מהערכים set, set, set, set או set.
הפרמטר Action צריך לציין פונקציית קריאה חוזרת שמחזירה אובייקט Compose שהוגדר באמצעות Compose.
// ... const action = CardService.newAction().setFunctionName('composeEmailCallback'); CardService.newTextButton() .setText('Compose Email') .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT); // ... function composeEmailCallback(e) { const thread = GmailApp.getThreadById(e.threadId); const draft = thread.createDraftReply('This is a reply'); return CardService.newComposeActionResponseBuilder() .setGmailDraft(draft) .build(); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
action | Action | האובייקט שמציין את פעולת ההודעה ליצירה שתתבצע כשלוחצים על הרכיב הזה. |
composed | Composed | ערך enum שמציין אם טיוטת ההודעה המורכבת היא טיוטה עצמאית או טיוטת תשובה. |
חזרה
Grid – האובייקט הזה, לשרשור.
set Id(id)
מגדיר את המזהה הייחודי שהוקצה ומשמש לזיהוי הווידג'ט שצריך לשנות. שינוי של ווידג'ט נתמך רק בתוספים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
id | String | המזהה של הווידג'ט, עם מגבלה של 64 תווים ובפורמט `[a-zA-Z0-9-]+`. |
חזרה
Widget – האובייקט הזה, לשרשור.
set Num Columns(numColumns)
מספר העמודות שיוצגו ברשת. אם האפשרות מוצגת בחלונית הצדדית, אפשר להציג 1-2 עמודות. ערך ברירת המחדל הוא 1. אם מוצגות בתיבת דו-שיח, אפשר להציג 2-3 עמודות וערך ברירת המחדל הוא 2.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
num | Integer | מספר העמודות. |
חזרה
Grid – האובייקט הזה, לשרשור.
set On Click Action(action)
הגדרת פעולה שמופעלת כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק אחת מהאפשרויות הבאות: set, set, set, set או set.
הפרמטר Action צריך לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action.
// ... const 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 – האובייקט הזה, לשרשור.
set On Click Open Link Action(action)
הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט Open. אפשר להגדיר לאובייקט בממשק המשתמש רק אחד מהערכים set, set, set, set או set.
הפרמטר Action צריך לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action שהוגדר באמצעות Action.
// ... const 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 – האובייקט הזה, לשרשור.
set Open Link(openLink)
הגדרה של כתובת URL שתיפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך רק לפתוח אותה. אפשר להגדיר לאובייקט בממשק המשתמש רק אחת מהאפשרויות הבאות: set, set, set, set או set.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
open | Open | אובייקט Open שמתאר את כתובת ה-URL לפתיחה. |
חזרה
Grid – האובייקט הזה, לשרשור.
set Title(title)
מגדיר את טקסט הכותרת של הרשת. הטקסט צריך להיות מחרוזת פשוטה ללא עיצוב.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
title | String | טקסט הכותרת. |
חזרה
Grid – האובייקט הזה, לשרשור.
set Visibility(visibility)
הגדרה של רמת החשיפה של הווידג'ט. ערך ברירת המחדל הוא `VISIBLE`.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
visibility | Visibility | הVisibility של הווידג'ט. |
חזרה
Widget – האובייקט, לשרשור.