Class 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 ในหน้าต่างใหม่ เมื่อผู้ใช้ทำตามขั้นตอนการให้สิทธิ์จนเสร็จสิ้นและกลับไปที่แอปพลิเคชันแล้ว ส่วนเสริมจะโหลดซ้ำ

ออบเจ็กต์ UI หนึ่งๆ มีการกําหนดค่าได้เพียง 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)

ตั้งค่าการดําเนินการที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกวัตถุ ออบเจ็กต์ UI หนึ่งๆ ตั้งค่าได้เพียง setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) เท่านั้น

พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ ComposeActionResponse ที่กําหนดค่าโดยใช้ ComposeActionResponseBuilder.setGmailDraft(draft)

หมายเหตุ: วิธีนี้ไม่ได้ตั้งค่าการดำเนินการเขียนที่ใช้เพื่อขยาย UI ของเครื่องมือเขียน แต่วิธีนี้จะเชื่อมต่อองค์ประกอบ UI นี้กับ Action ที่เขียนข้อความร่างใน Apps Script ซึ่งจะเปิดใน Gmail เมื่อการดำเนินการเสร็จสมบูรณ์

// ...

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	ออบเจ็กต์ที่ระบุการดำเนินการเขียนที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้
composedEmailType	ComposedEmailType	ค่า Enum ที่ระบุว่าข้อความร่างที่เขียนขึ้นเป็นข้อความร่างแบบสแตนด์อโลนหรือแบบตอบ

รีเทิร์น

Grid — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setNumColumns(numColumns)

จำนวนคอลัมน์ที่จะแสดงในตารางกริด หากแสดงในแผงด้านขวา คุณจะแสดงได้ 1-2 คอลัมน์ โดยค่าเริ่มต้นคือ 1 หากแสดงในกล่องโต้ตอบ คุณสามารถแสดง 2-3 คอลัมน์ได้ โดยค่าเริ่มต้นคือ 2

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
numColumns	Integer	จํานวนคอลัมน์

รีเทิร์น

Grid — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setOnClickAction(action)

ตั้งค่าการดำเนินการที่จะทำงานเมื่อมีการคลิกวัตถุ ออบเจ็กต์ UI หนึ่งๆ มีการกําหนดค่าได้เพียงค่าเดียวจาก setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType)

พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ 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 ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType)

พารามิเตอร์ Action ต้องระบุฟังก์ชัน Callback ที่แสดงผลออบเจ็กต์ 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 อยู่แล้วและต้องการเปิดเท่านั้น ออบเจ็กต์ UI สามารถตั้งค่าได้เพียง 1 รายการจาก setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือsetComposeAction(action, composedEmailType)

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
openLink	OpenLink	ออบเจ็กต์ OpenLink ที่อธิบาย URL ที่จะเปิด

รีเทิร์น

Grid — ออบเจ็กต์นี้สําหรับการต่อเชื่อม

---

setTitle(title)

ตั้งค่าข้อความชื่อของตารางกริด ข้อความต้องเป็นสตริงธรรมดาที่ไม่มีการจัดรูปแบบ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
title	String	ข้อความชื่อ

รีเทิร์น

Grid — ออบเจ็กต์นี้สําหรับการต่อเชื่อม