Class KeyValue

คีย์ค่า

เลิกใช้งานแล้ว เลิกใช้งานคลาสนี้แล้วและไม่ควรใช้ในสคริปต์ใหม่

คลาสนี้เลิกใช้งานแล้ว แต่ให้ใช้ DecoratedText แทน

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addEventAction(eventAction)Widgetเพิ่มการดำเนินการของเหตุการณ์ที่ทำได้ในวิดเจ็ต
setAuthorizationAction(action)KeyValueตั้งค่าการดำเนินการให้สิทธิ์ที่จะเปิด URL ไปยังโฟลว์การให้สิทธิ์เมื่อมีการคลิกออบเจ็กต์
setComposeAction(action, composedEmailType)KeyValueตั้งค่าการทำงานที่เขียนอีเมลฉบับร่างเมื่อมีการคลิกออบเจ็กต์
setId(id)Widgetกำหนดรหัสที่ไม่ซ้ำกันที่กำหนดให้ซึ่งใช้ระบุวิดเจ็ตที่จะเปลี่ยน
setOnClickAction(action)KeyValueตั้งค่าการดำเนินการที่จะเรียกใช้เมื่อมีการคลิกออบเจ็กต์
setOnClickOpenLinkAction(action)KeyValueตั้งค่าการดำเนินการที่จะเปิด URL ในแท็บเมื่อมีการคลิกออบเจ็กต์
setOpenLink(openLink)KeyValueตั้งค่า URL ที่จะเปิดเมื่อคลิกออบเจ็กต์
setVisibility(visibility)Widgetตั้งค่าระดับการมองเห็นของวิดเจ็ต

เอกสารโดยละเอียด

addEventAction(eventAction)

เพิ่มการดำเนินการของเหตุการณ์ที่ทำได้ในวิดเจ็ต

พารามิเตอร์

ชื่อประเภทคำอธิบาย
eventActionEventActionEventAction ที่จะเพิ่ม

รีเทิร์น

Widget — ออบเจ็กต์สำหรับการเชื่อมโยง


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);

พารามิเตอร์

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

รีเทิร์น

KeyValue - ออบเจ็กต์นี้สำหรับการเชื่อมโยง


setComposeAction(action, composedEmailType)

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

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

// ...

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();
}

พารามิเตอร์

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

รีเทิร์น

KeyValue - ออบเจ็กต์นี้สำหรับการเชื่อมโยง


setId(id)

กำหนดรหัสที่ไม่ซ้ำกันที่กำหนดให้ซึ่งใช้ระบุวิดเจ็ตที่จะเปลี่ยน การเปลี่ยนแปลงวิดเจ็ต รองรับเฉพาะในส่วนเสริม

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของวิดเจ็ต โดยมีความยาวได้ไม่เกิน 64 อักขระและอยู่ในรูปแบบ `[a-zA-Z0-9-]+`

รีเทิร์น

Widget - ออบเจ็กต์นี้สำหรับการเชื่อมโยง


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();
}

พารามิเตอร์

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

รีเทิร์น

KeyValue - ออบเจ็กต์นี้สำหรับการเชื่อมโยง


setOnClickOpenLinkAction(action)

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

พารามิเตอร์

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

รีเทิร์น

KeyValue - ออบเจ็กต์นี้สำหรับการเชื่อมโยง


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

พารามิเตอร์

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

รีเทิร์น

KeyValue - ออบเจ็กต์นี้สำหรับการเชื่อมโยง


setVisibility(visibility)

ตั้งค่าระดับการมองเห็นของวิดเจ็ต ค่าเริ่มต้นคือ `VISIBLE`

พารามิเตอร์

ชื่อประเภทคำอธิบาย
visibilityVisibilityVisibility ของวิดเจ็ต

รีเทิร์น

Widget — ออบเจ็กต์สำหรับการเชื่อมโยง

วิธีการที่เลิกใช้งานแล้ว