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) ได้เพียง 1 รายการเท่านั้น

// ...

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 ต้องระบุฟังก์ชัน Callback ที่ส่งคืนออบเจ็กต์ 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 ต้องระบุฟังก์ชัน Callback ที่ส่งคืนออบเจ็กต์ 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 ต้องระบุฟังก์ชัน Callback ที่ส่งคืนออบเจ็กต์ 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ออบเจ็กต์ที่ระบุการดำเนินการ Open Link ที่จะทำเมื่อองค์ประกอบนี้ คลิกแล้ว

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่


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

พารามิเตอร์

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

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่


setTitle(title)

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

พารามิเตอร์

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

รีเทิร์น

Grid — ออบเจ็กต์นี้สำหรับการทำห่วงโซ่