Działania w kalendarzu

Obiekty Action umożliwiają wbudowanie interaktywnych działań w dodatki do Google Workspace. Określają one, co się dzieje, gdy użytkownik wchodzi w interakcję z widżetem (np. przyciskiem) w interfejsie dodatku.

Działanie jest dołączone do danego widżetu za pomocą funkcji obsługi widżetów, która definiuje też warunek, który wywoła działanie. Po uruchomieniu tej akcji wykonywana jest wyznaczona funkcja wywołania zwrotnego. Funkcja wywołania zwrotnego jest przekazywany obiekt zdarzenia, który zawiera informacje o interakcjach po stronie klienta. Musisz zaimplementować funkcję wywołania zwrotnego i zwrócić jej określony obiekt odpowiedzi.

Załóżmy na przykład, że chcesz, by po kliknięciu wyświetlił się przycisk do tworzenia nowej karty. Aby to zrobić, musisz utworzyć nowy widżet przycisku i skorzystać z funkcji obsługi widżetu setOnClickAction(action), aby skonfigurować kompilację karty Action. Podany przez Ciebie element Action określa wywołanie zwrotne Apps Script, które jest wykonywane po kliknięciu przycisku. W tym przypadku implementujesz funkcję wywołania zwrotnego, by utworzyć odpowiednią kartę i zwrócić obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek, by wyświetlić kartę utworzoną w wyniku wywołania zwrotnego.

Na tej stronie opisaliśmy działania widżetów związane z Kalendarzem, które możesz uwzględnić w dodatku.

Interakcje z kalendarzem

Dodatki do Google Workspace, które rozszerzają możliwości Kalendarza, mogą obejmować kilka dodatkowych czynności specyficznych dla Kalendarza. Te działania wymagają powiązanej z nimi funkcji wywołania zwrotnego, aby zwrócić specjalistyczne obiekty odpowiedzi:

Próba wykonania działania Funkcja wywołania zwrotnego powinna zostać zwrócona
Dodawanie uczestników CalendarEventActionResponse
Konfigurowanie danych rozmów wideo CalendarEventActionResponse
Dodawanie załączników CalendarEventActionResponse

Aby móc używać tych działań i obiektów odpowiedzi, widżet musi spełniać wszystkie te warunki:

  • Działanie jest wywoływane, gdy użytkownik ma otwarte wydarzenie w Kalendarzu.
  • Pole manifestu pliku addOns.calendar.currentEventAccess dodatku ma wartość WRITE lub READ_WRITE.
  • Dodatek obejmuje https://www.googleapis.com/auth/calendar.addons.current.event.writezakres Kalendarza.

Oprócz tego zmiany wprowadzone przez funkcję wywołania zwrotnego działania nie są zapisywane, dopóki użytkownik nie zapisze wydarzenia z Kalendarza.

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

Poniższy przykład pokazuje, jak utworzyć przycisk, który dodaje konkretnego uczestnika 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(["aiko@example.com", "malcom@example.com"])
        .build();
  }

Ustawianie danych rozmowy wideo z funkcją wywołania zwrotnego

To działanie ustawia dane rozmowy wideo w otwartym zdarzeniu. W przypadku tych danych konferencyjnych trzeba podać identyfikator rozwiązania konferencyjnego, ponieważ użytkownik nie wywołał działania.

Poniższy przykład pokazuje, jak utworzyć przycisk, który ustawia dane rozmowy wideo w edytowanym zdarzeniu:

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

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

Poniższy przykład przedstawia, jak utworzyć przycisk dodający do wydarzenia z Kalendarza załącznik:

  /**
   * 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 o udostępnianiu ikon załączników.