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

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

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

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

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

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

ส่วนเสริมของ Google Workspace ที่ขยายปฏิทิน อาจรวมถึงการดําเนินการเพิ่มเติมของวิดเจ็ตปฏิทินบางรายการ การดําเนินการเหล่านี้ต้องใช้ฟังก์ชันเรียกกลับเพื่อดําเนินการที่เกี่ยวข้องเพื่อแสดงออบเจ็กต์การตอบกลับพิเศษ

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

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

  • ระบบจะทริกเกอร์การดําเนินการขณะที่ผู้ใช้เปิดกิจกรรมในปฏิทิน
  • ช่องไฟล์ 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(["aiko@example.com", "malcom@example.com"])
        .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': "joyce@example.com"});
    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 ดูรายละเอียดได้ที่ระบุไอคอนไฟล์แนบ