ออบเจ็กต์ Action
ช่วยให้คุณสร้างลักษณะการทำงานแบบอินเทอร์แอกทีฟในส่วนเสริมของ Google Workspace ได้ ซึ่งจะกำหนดสิ่งที่จะเกิดขึ้นเมื่อผู้ใช้โต้ตอบกับวิดเจ็ต (เช่น ปุ่ม) ใน UI ของส่วนเสริม
มีการดำเนินการแนบอยู่กับวิดเจ็ตที่กำหนด โดยใช้ ฟังก์ชันเครื่องจัดการวิดเจ็ต ซึ่งกำหนดเงื่อนไขที่ทริกเกอร์การดำเนินการด้วย เมื่อทริกเกอร์ จะดำเนินการกำหนด ฟังก์ชัน Callback ฟังก์ชัน Callback จะส่งผ่าน ออบเจ็กต์เหตุการณ์ที่มี ข้อมูลเกี่ยวกับการโต้ตอบฝั่งไคลเอ็นต์ของผู้ใช้ คุณต้องใช้ Callback และทำให้ฟังก์ชันแสดงออบเจ็กต์การตอบกลับที่เฉพาะเจาะจง
ตัวอย่างเช่น สมมติว่าคุณต้องการปุ่มที่สร้างและแสดงการ์ดใหม่เมื่อ
คลิกแล้ว โดยคุณต้องสร้างวิดเจ็ตปุ่มใหม่และใช้ฟังก์ชันตัวแฮนเดิลของวิดเจ็ตปุ่ม setOnClickAction(action)
เพื่อตั้งค่าการสร้างการ์ด Action
Action
ที่คุณกำหนดจะระบุ Apps Script
ฟังก์ชัน Callback ที่จะทำงานเมื่อมีการคลิกปุ่ม ในกรณีนี้ คุณ
ใช้ฟังก์ชัน Callback เพื่อสร้างบัตรที่คุณต้องการและแสดงผล
ActionResponse
ออบเจ็กต์ ออบเจ็กต์การตอบกลับจะบอกส่วนเสริมให้แสดงการ์ดที่ฟังก์ชัน Callback สร้างขึ้น
หน้านี้จะอธิบายการดำเนินการของวิดเจ็ตเฉพาะปฏิทินที่คุณรวมไว้ในส่วนเสริมได้
การโต้ตอบกับปฏิทิน
ส่วนเสริมของ Google Workspace ที่ขยายการใช้งานปฏิทิน สามารถรวมการดำเนินการเพิ่มเติม 2-3 รายการสำหรับวิดเจ็ตเฉพาะปฏิทิน การดำเนินการเหล่านี้ ต้องใช้ฟังก์ชัน Callback ของการดำเนินการที่เกี่ยวข้อง เพื่อแสดงผลออบเจ็กต์การตอบสนองแบบพิเศษ
พยายามดำเนินการแล้ว | ฟังก์ชัน Callback ควรแสดงผล |
---|---|
การเพิ่มผู้เข้าร่วม | CalendarEventActionResponse |
การตั้งค่าข้อมูลการประชุม | CalendarEventActionResponse |
การเพิ่มไฟล์แนบ | CalendarEventActionResponse |
หากต้องการใช้การทำงานของวิดเจ็ตและออบเจ็กต์การตอบสนอง คุณจะทำสิ่งต่อไปนี้ได้ ต้องเป็นจริง
- ระบบจะทริกเกอร์การดำเนินการขณะที่ผู้ใช้เปิดกิจกรรมในปฏิทินอยู่
addOns.calendar.currentEventAccess
ของส่วนเสริม ตั้งค่าฟิลด์ไฟล์ Manifest เป็นWRITE
หรือREAD_WRITE
- ส่วนเสริมนี้ประกอบด้วย
https://www.googleapis.com/auth/calendar.addons.current.event.write
ขอบเขตของปฏิทิน
นอกจากนี้ ระบบจะไม่บันทึกการเปลี่ยนแปลงใดๆ จากฟังก์ชัน Callback สำหรับการดำเนินการจนกว่า ผู้ใช้บันทึกกิจกรรมในปฏิทิน
การเพิ่มผู้เข้าร่วมด้วยฟังก์ชัน Callback
ตัวอย่างต่อไปนี้แสดงวิธีการสร้างปุ่มที่เพิ่มปุ่ม ผู้เข้าร่วมกิจกรรมในปฏิทินที่กำลังแก้ไข:
/**
* 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();
}
การตั้งค่าข้อมูลการประชุมด้วยฟังก์ชัน Callback
การดำเนินการนี้จะตั้งค่าข้อมูลการประชุมในกิจกรรมที่เปิดอยู่ สำหรับข้อมูลการประชุมนี้ ต้องระบุรหัสโซลูชันการประชุม เนื่องจากการดำเนินการไม่ได้ทริกเกอร์โดยผู้ใช้ที่เลือกโซลูชันที่ต้องการ
ตัวอย่างต่อไปนี้แสดงวิธีสร้างปุ่มที่ตั้งค่าข้อมูลการประชุม สำหรับกิจกรรมที่กำลังแก้ไข
/**
* 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();
}
เพิ่มไฟล์แนบด้วยฟังก์ชัน Callback
ตัวอย่างต่อไปนี้แสดงวิธีการสร้างปุ่มที่เพิ่มไฟล์แนบใน กิจกรรมในปฏิทินที่กำลังแก้ไข:
/**
* 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 ดูรายละเอียดได้ที่ระบุไอคอนไฟล์แนบ