Class Grid

Grid

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

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

const 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 לתהליך ההרשאה כשלוחצים על האובייקט. כתובת ה-URL תיפתח בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.

אובייקט של ממשק משתמש יכול לכלול רק אחת מהאפשרויות הבאות: setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

// ...

const 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 כשהפעולה מסתיימת.

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback() {
  const thread = GmailApp.getThreadById(e.threadId);
  const 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.

// ...

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 – האובייקט הזה, לצורך קישור.

---

setOnClickOpenLinkAction(action)

הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט OpenLink. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse שהוגדר באמצעות ActionResponseBuilder.setOpenLink(openLink).

// ...

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 – האובייקט הזה, לצורך קישור.

---

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 – האובייקט הזה, לשרשור.