Mit Action-Objekten können Sie Google Workspace-Add-ons interaktives Verhalten integrieren. Sie definieren, was passiert, wenn ein Nutzer mit einem Widget (z. B. einer Schaltfläche) in der Add-on-UI interagiert.
Eine Aktion wird mithilfe einer Widget-Handler-Funktion an ein bestimmtes Widget angehängt. Damit wird auch die Bedingung definiert, die die Aktion auslöst. Bei Auslösung führt die Aktion eine vorgesehene 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, mit der beim Anklicken eine neue Karte erstellt und angezeigt wird. Dazu müssen Sie ein neues Schaltflächen-Widget erstellen und die Handler-Funktion setOnClickAction(action) für das Schaltflächen-Widget verwenden, um ein Kartenerstellungs-Action festzulegen. Mit dem von Ihnen definierten Action wird eine Apps Script-Callback-Funktion definiert, 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 ein ActionResponse-Objekt zurückzugeben. Das Antwortobjekt weist das Add-on an, die Karte anzuzeigen, die die Callback-Funktion erstellt hat.
Auf dieser Seite werden kalenderspezifische Widget-Aktionen beschrieben, die Sie Ihrem Add-on hinzufügen können.
Kalenderinteraktionen
Add-ons für Google Workspace, mit denen Google Kalender erweitert wird, können einige weitere kalenderspezifische Widget-Aktionen enthalten. Für diese Aktionen muss die zugehörige Callback-Funktion der Aktion spezielle Antwortobjekte zurückgeben:
| Aktion versucht | Callback-Funktion sollte |
|---|---|
| Teilnehmer hinzufügen | CalendarEventActionResponse |
| Konferenzdaten festlegen | CalendarEventActionResponse |
| Anhänge hinzufügen | CalendarEventActionResponse |
Damit Sie diese Widget-Aktionen und -Antwortobjekte verwenden können, müssen alle folgenden Bedingungen erfüllt sein:
- Die Aktion wird ausgelöst, während der Nutzer einen Kalendertermin geöffnet hat.
- Das Manifestfeld
addOns.calendar.currentEventAccessdes Add-ons ist aufWRITEoderREAD_WRITEfestgelegt. - Das Add-on hat den Kalenderbereich
https://www.googleapis.com/auth/calendar.addons.current.event.write.
Darüber hinaus werden alle von der Aktions-Callback-Funktion vorgenommenen Änderungen 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 Kalendertermin, der gerade bearbeitet wird, 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
Durch diese Aktion werden die Konferenzdaten für den offenen Termin festgelegt. Für diese Konferenzdaten muss die Konferenzlösungs-ID angegeben werden, da die Aktion nicht durch den Nutzer ausgelöst wurde, der die gewünschte Lösung ausgewählt hat.
Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, mit der Konferenzdaten für einen gerade bearbeiteten Termin 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, über die ein Anhang zu einem Kalendertermin hinzugefügt wird, der gerade bearbeitet 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 „Anhang“ festlegen
Das Symbol für Anhänge muss in der Infrastruktur von Google gehostet werden. Weitere Informationen finden Sie unter Symbole für Anhänge anzeigen.