Działania w kalendarzu

Obiekty Action umożliwiają wzbogacenie dodatków do Google Workspace o interaktywne zachowanie. Określają, co się dzieje, gdy użytkownik wchodzi w interakcję z widżetem (np. przyciskiem) w interfejsie dodatku.

Działanie jest dołączane do widżetu za pomocą funkcji obsługi widżetu, która określa też warunek wywołujący działanie. Po wywołaniu działanie wykona określone wywołanie zwrotne. Do funkcji wywołania zwrotnego przekazywany jest obiekt zdarzenia zawierający informacje o interakcjach użytkownika po stronie klienta. Musisz zaimplementować funkcję wywołania zwrotnego i skonfigurować ją tak, aby zwracała określony obiekt odpowiedzi.

Załóżmy na przykład, że chcesz mieć przycisk, który po kliknięciu tworzy i wyświetla nową kartę. W tym celu musisz utworzyć nowy widget przycisku i użyć funkcji obsługi widgetu przycisku setOnClickAction(action), aby skonfigurować tworzenie karty Action. Zdefiniowany przez Ciebie parametr Action wskazuje funkcję wywołania zwrotnego Apps Script, która jest wykonywana po kliknięciu przycisku. W tym przypadku możesz zaimplementować funkcję zwrotną, aby utworzyć odpowiednią kartę i zwrócić obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek, że ma wyświetlić kartę utworzoną przez funkcję wywołania zwrotnego.

Ta strona opisuje działania widżetu dotyczące Kalendarza, które możesz uwzględnić w swoim dodatku.

Interakcje z kalendarzem

Dodatki do Google Workspace, które rozszerzają możliwości Kalendarza, mogą zawierać kilka dodatkowych działań związanych z widżetami. Te działania wymagają, aby powiązana z nimi funkcja wywołania zwrotnego zwracała wyspecjalizowane obiekty odpowiedzi:

Podjęto próbę wykonania działania	Wywołanie zwrotne powinno zwrócić
Dodawanie uczestników	CalendarEventActionResponse
Ustawianie danych konferencji	CalendarEventActionResponse
Dodawanie załączników	CalendarEventActionResponse

Aby można było korzystać z tych działań i obiektów odpowiedzi widżetu, muszą być spełnione wszystkie te warunki:

• Działanie jest wyzwalane, gdy użytkownik ma otwarte wydarzenie w Kalendarzu.
• W pliku manifestu dodatku pole addOns.calendar.currentEventAccess ma wartość WRITE lub READ_WRITE.
• Dodatek obejmuje https://www.googleapis.com/auth/calendar.addons.current.event.write zakres kalendarza.

Ponadto wszelkie zmiany wprowadzone przez funkcję wywołania zwrotnego działania nie są zapisywane, dopóki użytkownik nie zapisze wydarzenia w kalendarzu.

Dodawanie uczestników za pomocą funkcji wywołania zwrotnego

Poniższy przykład pokazuje, jak utworzyć przycisk powodujący dodanie określonej osoby do edytowanego wydarzenia w Kalendarzu:

  /**
   * 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(["[e-mail]", "[e-mail]"])
        .build();
  }

Ustawianie danych konferencji za pomocą funkcji wywołania zwrotnego

To działanie ustawia dane konferencji w otwartym wydarzeniu. W przypadku tych danych konferencyjnych należy określić identyfikator rozwiązania konferencyjnego, ponieważ działanie nie zostało wywołane przez użytkownika wybierającego odpowiednie rozwiązanie.

W tym przykładzie pokazujemy, jak utworzyć przycisk, który ustawia dane konferencji dla edytowanego wydarzenia:

  /**
   * 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': "[e-mail]"});
    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();
  }

Dodawanie załączników za pomocą funkcji wywołania zwrotnego

Ten przykład pokazuje, jak utworzyć przycisk, który dodaje załącznik do edytowanego wydarzenia w Kalendarzu:

  /**
   * 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();
  }

Ustawianie ikony załącznika

Ikona załącznika musi być hostowana w infrastrukturze Google. Więcej informacji znajdziesz w artykule Przekazywanie ikon załączników.