การดําเนินการในปฏิทิน

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

การดำเนินการจะแนบไปกับวิดเจ็ตหนึ่งๆ โดยใช้ฟังก์ชันตัวแฮนเดิลวิดเจ็ต ซึ่งจะกำหนดเงื่อนไขที่จะทริกเกอร์การดำเนินการด้วย เมื่อทริกเกอร์ การดำเนินการจะเรียกใช้ฟังก์ชัน Callback ที่กําหนด ฟังก์ชันการเรียกกลับจะได้รับการส่งผ่านออบเจ็กต์เหตุการณ์ซึ่งมีข้อมูลเกี่ยวกับการโต้ตอบฝั่งไคลเอ็นต์ของผู้ใช้ คุณต้องติดตั้งใช้งานฟังก์ชัน callback และให้แสดงผลออบเจ็กต์คำตอบที่เฉพาะเจาะจง

ตัวอย่างเช่น สมมติว่าคุณต้องการปุ่มที่สร้างและแสดงการ์ดใหม่เมื่อมีการคลิก โดยคุณต้องสร้างวิดเจ็ตปุ่มใหม่และใช้ฟังก์ชันตัวแฮนเดิลของวิดเจ็ตปุ่ม setOnClickAction(action) เพื่อตั้งค่าการสร้างการ์ด Action Action ที่คุณกําหนดจะระบุฟังก์ชัน Callback ของ Apps Script ที่เรียกใช้เมื่อมีการคลิกปุ่ม ในกรณีนี้ คุณต้องใช้ฟังก์ชัน Callback เพื่อสร้างการ์ดที่ต้องการและแสดงผลออบเจ็กต์ ActionResponse ออบเจ็กต์การตอบกลับจะบอกส่วนเสริมให้แสดงการ์ดที่ฟังก์ชัน Callback สร้างขึ้น

หน้านี้จะอธิบายการดำเนินการของวิดเจ็ตเฉพาะปฏิทินที่คุณรวมไว้ในส่วนเสริมได้

การโต้ตอบกับปฏิทิน

ส่วนเสริม Google Workspace ที่ขยายความสามารถของปฏิทินอาจรวมการดำเนินการวิดเจ็ตเฉพาะปฏิทินเพิ่มเติมอีก 2-3 รายการ การดําเนินการเหล่านี้ต้องใช้ฟังก์ชัน Callback ของการดําเนินการที่เกี่ยวข้องเพื่อแสดงผลออบเจ็กต์การตอบกลับเฉพาะ

พยายามดำเนินการ	ฟังก์ชัน Callback ควรแสดงผล
การเพิ่มผู้เข้าร่วม	CalendarEventActionResponse
การตั้งค่าข้อมูลการประชุม	CalendarEventActionResponse
การเพิ่มไฟล์แนบ	CalendarEventActionResponse

หากต้องการใช้การดําเนินการของวิดเจ็ตและออบเจ็กต์การตอบกลับเหล่านี้ เงื่อนไขต่อไปนี้ต้องตรงกันทั้งหมด

• ระบบจะทริกเกอร์การดำเนินการขณะที่ผู้ใช้เปิดกิจกรรมในปฏิทินอยู่
• ช่องไฟล์ Manifest addOns.calendar.currentEventAccessของส่วนเสริมได้รับการตั้งค่าเป็น WRITE หรือ READ_WRITE
• ส่วนเสริมมี https://www.googleapis.com/auth/calendar.addons.current.event.write ขอบเขตปฏิทิน

นอกจากนี้ การเปลี่ยนแปลงใดๆ ที่ฟังก์ชันการเรียกกลับการดำเนินการทำจะไม่ได้รับการบันทึกจนกว่าผู้ใช้จะบันทึกกิจกรรมในปฏิทิน

การเพิ่มผู้เข้าร่วมด้วยฟังก์ชันการเรียกกลับ

ตัวอย่างต่อไปนี้แสดงวิธีสร้างปุ่มที่เพิ่มผู้เข้าร่วมที่เฉพาะเจาะจงไปยังกิจกรรมในปฏิทินที่กำลังแก้ไข

  /**
   * Build a simple card with a button that sends a notification.
   * This function is called as part of the eventOpenTrigger that builds
   * a UI when the user opens an event.
   *
   * @param e The event object passed to eventOpenTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onAddAttendeesButtonClicked');
    var button = CardService.newTextButton()
        .setText('Add new attendee')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can add
    // attendees and disable the button if not.
    if (!e.calendar.capabilities.canAddAttendees) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Adds attendees to the
   * Calendar event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onAddAttendeesButtonClicked (e) {
    return CardService.newCalendarEventActionResponseBuilder()
        .addAttendees(["[e-mail]", "[e-mail]"])
        .build();
  }

การตั้งค่าข้อมูลการประชุมด้วยฟังก์ชันการเรียกกลับ

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

ตัวอย่างต่อไปนี้แสดงวิธีสร้างปุ่มที่ตั้งค่าข้อมูลการประชุมสําหรับกิจกรรมที่กําลังแก้ไข

  /**
   * Build a simple card with a button that sends a notification.
   * This function is called as part of the eventOpenTrigger that builds
   * a UI when the user opens a Calendar event.
   *
   * @param e The event object passed to eventOpenTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onSaveConferenceOptionsButtonClicked')
        .setParameters(
          {'phone': "1555123467", 'adminEmail': "[e-mail]"});
    var button = CardService.newTextButton()
        .setText('Add new attendee')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can set
    // conference data and disable the button if not.
    if (!e.calendar.capabilities.canSetConferenceData) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Sets conference data for the
   * Calendar event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onSaveConferenceOptionsButtonClicked(e) {
    var parameters = e.commonEventObject.parameters;

    // Create an entry point and a conference parameter.
    var phoneEntryPoint = ConferenceDataService.newEntryPoint()
      .setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
      .setUri('tel:' + parameters['phone']);

    var adminEmailParameter = ConferenceDataService.newConferenceParameter()
        .setKey('adminEmail')
        .setValue(parameters['adminEmail']);

    // Create a conference data object to set to this Calendar event.
    var conferenceData = ConferenceDataService.newConferenceDataBuilder()
        .addEntryPoint(phoneEntryPoint)
        .addConferenceParameter(adminEmailParameter)
        .setConferenceSolutionId('myWebScheduledMeeting')
        .build();

    return CardService.newCalendarEventActionResponseBuilder()
        .setConferenceData(conferenceData)
        .build();
  }

เพิ่มไฟล์แนบด้วยฟังก์ชันการเรียกกลับ

ตัวอย่างต่อไปนี้แสดงวิธีสร้างปุ่มที่เพิ่มไฟล์แนบไปยังกิจกรรมในปฏิทินที่กำลังแก้ไข

  /**
   * Build a simple card with a button that creates a new attachment.
   * This function is called as part of the eventAttachmentTrigger that
   * builds a UI when the user goes through the add-attachments flow.
   *
   * @param e The event object passed to eventAttachmentTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onAddAttachmentButtonClicked');
    var button = CardService.newTextButton()
        .setText('Add a custom attachment')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can add
    // attachments and disable the button if not.
    if (!e.calendar.capabilities.canAddAttachments) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Adds attachments to the Calendar
   * event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onAddAttachmentButtonClicked(e) {
    return CardService.newCalendarEventActionResponseBuilder()
             .addAttachments([
               CardService.newAttachment()
                 .setResourceUrl("https://example.com/test")
                 .setTitle("Custom attachment")
                 .setMimeType("text/html")
                 .setIconUrl("https://example.com/test.png")
             ])
        .build();
  }

การตั้งค่าไอคอนไฟล์แนบ

ไอคอนไฟล์แนบต้องโฮสต์บนโครงสร้างพื้นฐานของ Google ดูรายละเอียดได้ที่ระบุไอคอนไฟล์แนบ