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)

เพิ่มรายการในตารางกริดใหม่

พารามิเตอร์

ชื่อประเภทคำอธิบาย
gridItemGridItemรายการในตารางกริดที่จะเพิ่ม

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


setAuthorizationAction(action)

ตั้งค่าการดำเนินการการให้สิทธิ์ซึ่งจะเปิด URL ไปยังขั้นตอนการให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์ การดำเนินการนี้จะเปิด URL ในหน้าต่างใหม่ เมื่อผู้ใช้ทำตามขั้นตอนการให้สิทธิ์เสร็จสิ้นและกลับไปที่แอปพลิเคชันแล้ว ส่วนเสริมจะโหลดซ้ำ

ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น

// ...

var action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionAuthorizationActionออบเจ็กต์ที่ระบุการดำเนินการการให้สิทธิ์ที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


setBorderStyle(borderStyle)

ตั้งค่ารูปแบบเส้นขอบที่ใช้กับรายการตารางกริดแต่ละรายการ ค่าเริ่มต้นคือ NO_BORDER

พารามิเตอร์

ชื่อประเภทคำอธิบาย
borderStyleBorderStyleรูปแบบเส้นขอบที่จะใช้

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


setComposeAction(action, composedEmailType)

ตั้งค่าการทำงานที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI มีการตั้งค่า 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();
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionActionออบเจ็กต์ที่ระบุการดำเนินการเขียนที่จะดำเนินการเมื่อมีการคลิกองค์ประกอบนี้
composedEmailTypeComposedEmailTypeค่า enum ที่ระบุว่าฉบับร่างที่เขียนเป็นฉบับร่างแบบสแตนด์อโลนหรือฉบับร่างของการตอบกลับ

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


setNumColumns(numColumns)

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

พารามิเตอร์

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

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


setOnClickAction(action)

ตั้งค่าการทำงานที่จะดำเนินการเมื่อมีการคลิกออบเจ็กต์ ออบเจ็กต์ UI มีการตั้งค่า 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();
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionActionการดำเนินการที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


setOnClickOpenLinkAction(action)

ตั้งค่าการทำงานที่จะเปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อจำเป็นต้องสร้าง URL หรือเมื่อคุณต้องดำเนินการอื่นๆ ในโปรแกรมเพิ่มเติมเพื่อสร้างออบเจ็กต์ OpenLink ออบเจ็กต์ UI มีการตั้งค่า 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();
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
actionActionออบเจ็กต์ที่ระบุการทำงานของลิงก์แบบเปิดที่จะทำเมื่อมีการคลิกองค์ประกอบนี้

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


ตั้งค่า URL ที่จะเปิดเมื่อมีการคลิกออบเจ็กต์ ใช้ฟังก์ชันนี้เมื่อทราบ URL อยู่แล้ว และจำเป็นต้องเปิดเท่านั้น ออบเจ็กต์ UI มีการตั้งค่า setOpenLink(openLink), setOnClickAction(action), setOnClickOpenLinkAction(action), setAuthorizationAction(action) หรือ setComposeAction(action, composedEmailType) ได้เพียงอย่างใดอย่างหนึ่งเท่านั้น

พารามิเตอร์

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

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน


setTitle(title)

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

พารามิเตอร์

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

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำเชน