Działania w kalendarzu

Obiekty Action pozwalają tworzyć interaktywne zachowanie w dodatkach do Google Workspace. Określają one, co się stanie, gdy użytkownik wejdzie w interakcję z widżetem (np. przyciskiem) w interfejsie dodatku.

Działanie jest dołączane do danego widżetu za pomocą funkcji obsługi widżetu, która określa też warunek wywołujący działanie. Wywołane działanie powoduje wykonanie określonej funkcji wywołania zwrotnego. Funkcja wywołania zwrotnego przekazuje obiekt zdarzenia zawierający informacje o interakcjach użytkownika po stronie klienta. Musisz wdrożyć funkcję wywołania zwrotnego, która będzie zwracać określony obiekt odpowiedzi.

Załóżmy, że chcesz, aby przycisk, który po kliknięciu tworzy i wyświetla nową kartę. W tym celu musisz utworzyć nowy widżet przycisku i użyć funkcji obsługi widżetu przycisku setOnClickAction(action), aby skonfigurować tworzenie kart Action. Zdefiniowany przez Ciebie element Action określa funkcję wywołania zwrotnego Apps Script wykonywaną po kliknięciu przycisku. W takim przypadku zaimplementujesz funkcję wywołania zwrotnego, aby utworzyć odpowiednią kartę i zwrócić obiekt ActionResponse. Obiekt odpowiedzi informuje dodatek, że ma wyświetlić kartę utworzoną przez funkcję wywołania zwrotnego.

Na tej stronie opisujemy działania związane z widżetem Kalendarzem, które możesz uwzględnić w swoim dodatku.

Interakcje z Kalendarzem

Dodatki do Google Workspace, które rozszerzają Kalendarz, mogą zawierać kilka dodatkowych działań na widżetach związanych z Kalendarzem. Te działania wymagają powiązanej funkcji wywołania zwrotnego, która zwraca wyspecjalizowane obiekty odpowiedzi:

Podjęto próbę wykonania działania Funkcja wywołania zwrotnego powinna zwrócić
Dodawanie uczestników CalendarEventActionResponse
Konfigurowanie danych rozmowy wideo CalendarEventActionResponse
Dodawanie załączników CalendarEventActionResponse

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

  • Czynność jest wyzwalana, gdy użytkownik otworzy wydarzenie w Kalendarzu.
  • Pole manifestu addOns.calendar.currentEventAccess dodatku jest ustawione na WRITE lub READ_WRITE.
  • Dodatek zawiera https://www.googleapis.com/auth/calendar.addons.current.event.write zakres Kalendarza.

Dodatkowo 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 dodający konkretną osobę 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 konferencyjnych przy użyciu funkcji wywołania zwrotnego

To działanie ustawia dane rozmowy wideo w otwartym wydarzeniu. W przypadku tych danych rozmowy wideo trzeba podać identyfikator rozwiązania do obsługi konferencji, ponieważ to działanie nie zostało aktywowane przez użytkownika wybierającego odpowiednie rozwiązanie.

Poniższy przykład pokazuje, jak utworzyć przycisk, który ustawia dane rozmowy wideo 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': "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 pokazuje, jak utworzyć przycisk dodający 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 sekcji Dodawanie ikon załączników.