การขยาย UI ของข้อความ

โดยส่วนเสริม Google Workspace ที่ขยาย Gmail จะให้อินเทอร์เฟซผู้ใช้เมื่อผู้ใช้อ่านข้อความ ซึ่งจะช่วยให้ส่วนเสริมของ Google Workspace ทํางานที่ตอบสนองต่อเนื้อหาข้อความได้โดยอัตโนมัติ เช่น การแสดง การดึงข้อมูล หรือการส่งข้อมูลเพิ่มเติมที่เกี่ยวข้องกับข้อความ

การเข้าถึง UI ของข้อความส่วนเสริม

ดู UI ข้อความของส่วนเสริมได้ 2 วิธี วิธีแรกคือการเปิดข้อความขณะที่ส่วนเสริมเปิดอยู่แล้ว (เช่น เมื่อดูหน้าแรกของส่วนเสริมในหน้าต่างกล่องจดหมาย Gmail) วิธีที่ 2 คือ เริ่มส่วนเสริมขณะดูข้อความ

ทั้ง 2 กรณีจะทําให้ส่วนเสริมเรียกใช้ฟังก์ชันทริกเกอร์บริบทที่เกี่ยวข้อง ซึ่งกําหนดไว้ในไฟล์ Manifest ส่วนเสริม ทริกเกอร์ยังทํางานหากผู้ใช้เปลี่ยนไปใช้ข้อความอื่นขณะที่ส่วนเสริมยังเปิดอยู่ ฟังก์ชันทริกเกอร์ตามบริบทจะสร้าง UI ของข้อความสําหรับข้อความนั้น ซึ่ง Gmail จะแสดงต่อผู้ใช้

การสร้างส่วนเสริมข้อความ

คุณสามารถเพิ่มฟังก์ชันการทํางานของข้อความลงในส่วนเสริมได้โดยทําตามขั้นตอนทั่วไปเหล่านี้

1. เพิ่มช่องที่เหมาะสมในไฟล์ Manifest ของสคริปต์ส่วนเสริม รวมถึงขอบเขตที่จําเป็นสําหรับฟังก์ชันการทํางานของข้อความ อย่าลืมเพิ่มช่องทริกเกอร์เงื่อนไขลงในไฟล์ Manifest ด้วยค่า unconditional เป็น {}
2. ใช้ฟังก์ชันทริกเกอร์ตามบริบทที่สร้าง UI ข้อความเมื่อผู้ใช้เลือกส่วนเสริมในข้อความ
3. ใช้ฟังก์ชันที่เกี่ยวข้องซึ่งจําเป็นต่อการโต้ตอบใน UI ของผู้ใช้

ทริกเกอร์ตามบริบท

ส่วนเสริม Google Workspace จะกําหนดทริกเกอร์ตามบริบทในไฟล์ Manifest เพื่อมอบความช่วยเหลือแก่ผู้ใช้เมื่ออ่านข้อความ เมื่อผู้ใช้เปิดข้อความ Gmail (โดยเปิดส่วนเสริม) ที่เป็นไปตามเกณฑ์ * ทริกเกอร์จะเริ่มทํางาน ทริกเกอร์ที่เริ่มทํางานจะทํางานฟังก์ชันทริกเกอร์บริบทที่สร้างอินเทอร์เฟซผู้ใช้ของส่วนเสริม แล้วแสดงผลใน Gmail เมื่อถึงจุดนี้ ผู้ใช้จะเริ่มโต้ตอบได้

ระบบจะทริกเกอร์ทริกเกอร์ตามบริบทในโปรเจ็กต์ไฟล์ Manifest ของส่วนเสริม คําจํากัดความของทริกเกอร์จะบอกให้ Gmail ทราบว่าฟังก์ชันทริกเกอร์ใดเริ่มทํางานภายใต้เงื่อนไขใด เช่น ข้อมูลโค้ดไฟล์ Manifest นี้จะตั้งค่าทริกเกอร์ที่ไม่มีเงื่อนไขซึ่งเรียกฟังก์ชันทริกเกอร์ onGmailMessageOpen() เมื่อเปิดข้อความ

{
  ...
  "addOns": {

    "common": {
      ...
    },
    "gmail": {
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "onGmailMessageOpen"
        }
      ],
      ...
    },
    ...
  }
  ...
}

ฟังก์ชันทริกเกอร์ตามบริบท

ทริกเกอร์ตามบริบททั้งหมดต้องมีฟังก์ชันทริกเกอร์ที่เกี่ยวข้อง ซึ่งจะสร้างอินเทอร์เฟซผู้ใช้ของส่วนเสริม คุณระบุฟังก์ชันนี้ในช่อง onTriggerFunction ของไฟล์ Manifest ให้ใช้ฟังก์ชันนี้เพื่อยอมรับอาร์กิวเมนต์ออบเจ็กต์เหตุการณ์การดําเนินการ และแสดงผลออบเจ็กต์ Card รายการเดียวหรืออาร์เรย์ของออบเจ็กต์ Card

เมื่อทริกเกอร์บริบทเริ่มทํางานสําหรับข้อความ Gmail ที่ระบุ จะเป็นการทริกเกอร์ฟังก์ชันนี้และส่งผ่านออบเจ็กต์เหตุการณ์การดําเนินการ ฟังก์ชันทริกเกอร์มักจะใช้รหัสข้อความที่ให้ไว้โดยออบเจ็กต์เหตุการณ์นี้เพื่อรับข้อความและรายละเอียดอื่นๆ โดยใช้บริการ Gmail ของ Apps Script เช่น ฟังก์ชันทริกเกอร์อาจดึงเนื้อหาของข้อความโดยใช้ฟังก์ชันต่อไปนี้

  // Activate temporary Gmail scopes, in this case to allow
  // the add-on to read message metadata and content.
  var accessToken = e.gmail.accessToken;
  GmailApp.setCurrentMessageAccessToken(accessToken);

  // Read message metadata and content. This requires the Gmail scope
  // https://www.googleapis.com/auth/gmail.addons.current.message.readonly.
  var messageId = e.gmail.messageId;
  var message = GmailApp.getMessageById(messageId);
  var subject = message.getSubject();
  var sender = message.getFrom();
  var body = message.getPlainBody();
  var messageDate = message.getDate();

  // Setting the access token with a gmail.addons.current.message.readonly
  // scope also allows read access to the other messages in the thread.
  var thread = message.getThread();
  var threadMessages = thread.getMessages();

  // Using this link can avoid the need to copy message or thread content
  var threadLink = thread.getPermalink();

จากนั้นฟังก์ชันทริกเกอร์จะดําเนินการกับข้อมูลนี้ โดยดึงข้อมูลที่อินเทอร์เฟซต้องการ เช่น ส่วนเสริมที่สรุปตัวเลขยอดขายจะสามารถรวบรวมยอดขายจากเนื้อหาข้อความและจัดระเบียบเป็นการแสดงการ์ดได้

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

  function onGmailMessageOpen(e) {
    // Activate temporary Gmail scopes, in this case to allow
    // message metadata to be read.
    var accessToken = e.gmail.accessToken;
    GmailApp.setCurrentMessageAccessToken(accessToken);

    var messageId = e.gmail.messageId;
    var message = GmailApp.getMessageById(messageId);
    var subject = message.getSubject();
    var sender = message.getFrom();

    // Create a card with a single card section and two widgets.
    // Be sure to execute build() to finalize the card construction.
    var exampleCard = CardService.newCardBuilder()
        .setHeader(CardService.newCardHeader()
            .setTitle('Example card'))
        .addSection(CardService.newCardSection()
            .addWidget(CardService.newKeyValue()
                .setTopLabel('Subject')
                .setContent(subject))
            .addWidget(CardService.newKeyValue()
                .setTopLabel('From')
                .setContent(sender)))
        .build();   // Don't forget to build the Card!
    return [exampleCard];
  }