Kalenderaktionen

Mit Action-Objekten können Sie in Google Workspace-Add-ons interaktive Funktionen einbinden. 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 über eine Widget-Handlerfunktion an ein bestimmtes Widget angehängt. Diese Funktion definiert auch die Bedingung, die die Aktion auslöst. Wenn die Aktion ausgelöst wird, wird eine bestimmte Callback-Funktion ausgeführt. Der Callback-Funktion wird ein Ereignisobjekt übergeben, das Informationen zu den clientseitigen Interaktionen des Nutzers enthält. Sie müssen die Callback-Funktion implementieren und sie so konfigurieren, dass sie ein bestimmtes Antwortobjekt zurückgibt.

Angenommen, Sie möchten eine Schaltfläche haben, die beim Klicken eine neue Karte erstellt und anzeigt. Dazu müssen Sie ein neues Schaltflächen-Widget erstellen und mit der Handlerfunktion für das Schaltflächen-Widget setOnClickAction(action) eine Karte Action festlegen. Mit der 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 Rückruffunktion, um die gewünschte Karte zu erstellen und ein ActionResponse-Objekt zurückzugeben. Das Antwortobjekt weist das Add-on an, die Karte anzuzeigen, die mit der Rückruffunktion erstellt wurde.

Auf dieser Seite werden kalenderspezifische Widget-Aktionen beschrieben, die Sie in Ihr Add-on einbinden können.

Kalenderinteraktionen

Google Workspace-Add-ons, die Google Kalender erweitern, können einige zusätzliche kalenderspezifische Widget-Aktionen enthalten. Für diese Aktionen muss die zugehörige Callback-Funktion spezielle Antwortobjekte zurückgeben:

Versuchte Aktion Die Callback-Funktion sollte Folgendes zurückgeben:
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.currentEventAccess des Add-ons ist auf WRITE oder READ_WRITE gesetzt.
  • Das Add-on enthält den https://www.googleapis.com/auth/calendar.addons.current.event.write Kalenderbereich.

Außerdem werden alle Änderungen, die über die Aktions-Callback-Funktion vorgenommen werden, erst gespeichert, wenn der Nutzer den Kalendertermin speichert.

Teilnehmer mit einer Rückruffunktion hinzufügen

Im folgenden Beispiel wird gezeigt, wie Sie eine Schaltfläche erstellen, mit der einem bearbeiteten Kalenderereignis 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 das geöffnete Ereignis festgelegt. Für diese Konferenzdaten muss die Konferenzlösungs-ID angegeben werden, da die Aktion nicht durch die Auswahl der gewünschten Lösung durch den Nutzer ausgelöst wurde.

Im folgenden Beispiel wird gezeigt, wie eine Schaltfläche erstellt wird, 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 Rückruffunktion hinzufügen

Das folgende Beispiel zeigt, wie Sie eine Schaltfläche erstellen, mit der einem bearbeiteten Kalenderereignis 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();
  }

Anhangsymbol festlegen

Das Symbol für Anhänge muss in der Google-Infrastruktur gehostet werden. Weitere Informationen finden Sie unter Anhängesymbole bereitstellen.