אובייקטים מסוג Action
מאפשרים לכם ליצור התנהגות אינטראקטיבית בתוספים ל-Google Workspace. הם מגדירים מה קורה כשמשתמש מבצע אינטראקציה עם ווידג'ט (למשל, לחצן) בממשק המשתמש של התוסף.
פעולה מצורפת לווידג'ט נתון באמצעות פונקציית טיפול בווידג'ט, שמגדירה גם את התנאי שמפעיל את הפעולה. כשהפעולה מופעלת, היא מבצעת פונקציית קריאה חוזרת שהוגדרה מראש. לפונקציית ה-callback מועבר אובייקט אירוע שמכיל מידע על האינטראקציות של המשתמש בצד הלקוח. צריך להטמיע את פונקציית ה-callback ולגרום לה להחזיר אובייקט תגובה ספציפי.
לדוגמה, נניח שאתם רוצים ליצור לחצן שיוצר כרטיס חדש ומציג אותו כשלוחצים עליו. לשם כך, צריך ליצור ווידג'ט לחצן חדש ולהשתמש בפונקציית הטיפול בווידג'ט הלחצן setOnClickAction(action)
כדי להגדיר Action
ליצירת כרטיסים. הערך של Action
שצריך להגדיר מציין פונקציית קריאה חוזרת של Apps Script שתתבצע כשמקישים על הלחצן. במקרה כזה, צריך להטמיע את פונקציית הקריאה החוזרת כדי ליצור את הכרטיס הרצוי ולהחזיר אובייקט ActionResponse
. אובייקט התגובה מורה לתוסף להציג את הכרטיס שפונקציית הקריאה החוזרת יצרה.
בדף הזה מוסבר על פעולות ווידג'ט ספציפיות ליומן Google שאפשר לכלול בתוסף.
אינטראקציות ביומן
תוספים של Google Workspace שמרחיבים את יומן Google יכולים לכלול כמה פעולות נוספות של ווידג'טים שספציפיות ליומן Google. הפעולות האלה מחייבות את פונקציית הקריאה החוזרת של הפעולה המשויכת להחזיר אובייקטי תגובה מיוחדים:
ניסיון הפעולה | פונקציית הקריאה החוזרת צריכה להחזיר |
---|---|
הוספת משתתפים | CalendarEventActionResponse |
הגדרת נתוני כנס | CalendarEventActionResponse |
הוספת קבצים מצורפים | CalendarEventActionResponse |
כדי להשתמש באובייקטים של התגובה ובפעולות של הווידג'ט האלה, צריכים להתקיים כל התנאים הבאים:
- הפעולה מופעלת כשהמשתמש פותח אירוע ביומן.
- שדה המניפסט
addOns.calendar.currentEventAccess
של התוסף מוגדר ל-WRITE
או ל-READ_WRITE
. - התוסף כולל את
https://www.googleapis.com/auth/calendar.addons.current.event.write
היקף הרשאה ביומן.
בנוסף, שינויים שבוצעו על ידי פונקציית הקריאה החוזרת של הפעולה לא נשמרים עד שהמשתמש שומר את האירוע ביומן.
הוספת משתתפים באמצעות פונקציית קריאה חוזרת
הדוגמה הבאה מראה איך ליצור לחצן שמוסיף משתתף ספציפי לאירוע ביומן Google שעורכים:
/**
* 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();
}
הוספת קבצים מצורפים באמצעות פונקציית קריאה חוזרת
בדוגמה הבאה מוסבר איך ליצור לחצן שמוסיף קובץ מצורף לאירוע ביומן Google שעורכים:
/**
* 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. פרטים נוספים זמינים במאמר הוספת סמלי קבצים מצורפים.