Mit Action-Objekten können Sie interaktive Funktionen in Google Workspace-Add‑ons einbauen. Sie definieren, was passiert, wenn ein Nutzer mit einem Widget (z. B. einer Schaltfläche) in der Add-on-Benutzeroberfläche interagiert.
Eine Aktion wird einem bestimmten Widget mithilfe einer Widget-Handler-Funktion zugewiesen, die auch die Bedingung definiert, die die Aktion auslöst. Wenn sie ausgelöst wird, führt die Aktion eine bestimmte Callback-Funktion aus. An die Callback-Funktion wird ein Ereignisobjekt übergeben, das Informationen zu den clientseitigen Interaktionen des Nutzers enthält. Sie müssen die Callback-Funktion implementieren und ein bestimmtes Antwortobjekt zurückgeben lassen.
Angenommen, Sie möchten eine Schaltfläche, die beim Klicken eine neue Karte erstellt und anzeigt. Dazu müssen Sie ein neues Schaltflächen-Widget erstellen und die Handler-Funktion des Schaltflächen-Widgets setOnClickAction(action) verwenden, um ein Action für das Erstellen von Karten festzulegen. Mit dem von Ihnen definierten Action wird eine Apps Script-Callback-Funktion angegeben, die ausgeführt wird, wenn auf die Schaltfläche geklickt wird. In diesem Fall implementieren Sie die Callback-Funktion, um die gewünschte Karte zu erstellen, und geben ein ActionResponse-Objekt zurück. Das Antwortobjekt weist das Add-on an, die Karte anzuzeigen, die von der Callback-Funktion erstellt wurde.
Auf dieser Seite werden Kalender-spezifische Widget-Aktionen beschrieben, die Sie in Ihr Add-on einfügen können.
Kalenderinteraktionen
Google Workspace-Add-ons, die Kalender erweitern, können einige zusätzliche Kalender-spezifische Widget-Aktionen enthalten. Für diese Aktionen muss die zugehörige Callback-Funktion spezielle Antwortobjekte zurückgeben:
| Versuchte Aktion | Die Callback-Funktion sollte zurückgeben |
|---|---|
| Teilnehmer hinzufügen | CalendarEventActionResponse |
| Konferenzdaten festlegen | CalendarEventActionResponse |
| Anhänge hinzufügen | CalendarEventActionResponse |
Damit Sie diese Widget-Aktionen und Antwortobjekte nutzen können, müssen alle folgenden Bedingungen erfüllt sein:
- Die Aktion wird ausgelöst, während der Nutzer einen Termin in Google Kalender geöffnet hat.
- Das Manifestfeld
addOns.calendar.currentEventAccessdes Add-ons ist aufWRITEoderREAD_WRITEgesetzt. - Das Add-on enthält den
https://www.googleapis.com/auth/calendar.addons.current.event.writeKalenderbereich.
Außerdem werden alle Änderungen, die von der Aktions-Callback-Funktion vorgenommen werden, erst gespeichert, wenn der Nutzer den Kalendertermin speichert.
Teilnehmer mit einer Callback-Funktion hinzufügen
Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, mit der einem bearbeiteten Kalendertermin ein bestimmter Teilnehmer hinzugefügt wird:
/**
* 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();
}
Konferenzdaten mit einer Callback-Funktion festlegen
Mit dieser Aktion werden die Konferenzdaten für den geöffneten Termin festgelegt. Für diese Konferenzdaten muss die ID der Konferenzlösung angegeben werden, da die Aktion nicht durch die Auswahl der gewünschten Lösung durch den Nutzer ausgelöst wurde.
Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, mit der Konferenzdaten für ein bearbeitetes Ereignis festgelegt werden:
/**
* 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();
}
Anhänge mit einer Callback-Funktion hinzufügen
Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, mit der einem bearbeiteten Kalendertermin ein Anhang hinzugefügt wird:
/**
* 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();
}
Symbol für Anhang festlegen
Das Anhangssymbol muss in der Infrastruktur von Google gehostet werden. Weitere Informationen finden Sie unter Anhangsymbole bereitstellen.