Class Grid

רשת

רשת מאורגנת להצגת אוסף של פריטים מרשת.

אפשר להשתמש בתוספים ל-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)

הוספה של פריט רשת חדש לרשת.

פרמטרים

שם	סוג	תיאור
gridItem	GridItem	פריט הרשת להוספה.

החזרות

Grid – האובייקט הזה, לשרשור.

---

setAuthorizationAction(action)

מגדירה פעולת הרשאה שפותחת כתובת 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).

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

// ...

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 עמודות, וערך ברירת המחדל הוא 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 – האובייקט הזה, לשרשור.