Działania w kalendarzu

Action obiektów umożliwia tworzenie interaktywnych w dodatkach do Google Workspace. Definiują co się dzieje, gdy użytkownik wchodzi w interakcję z widżetem (np. przyciskiem) w w interfejsie dodatku.

Akcja jest dołączona do danego widżetu za pomocą tagu funkcji obsługi widżetów, który definiuje również warunek wyzwalający działanie. Po uruchomieniu działanie powoduje wykonanie wyznaczonego funkcji wywołania zwrotnego. Funkcja wywołania zwrotnego jest przekazywana w obiekt zdarzenia przenoszący informacje o interakcjach użytkownika po stronie klienta. Musisz zaimplementować wywołania zwrotnego i zwracania konkretnego obiektu odpowiedzi.

Na przykład załóżmy, że chcesz mieć przycisk, który pozwala utworzyć i wyświetlić nową kartę kliknięto. W tym celu musisz utworzyć nowy widżet przycisku i użyć widżetu przycisku funkcja obsługi setOnClickAction(action) aby ustawić tworzenie kart Action. Zdefiniowany przez Ciebie Action określa Apps Script funkcja wywołania zwrotnego, która jest wykonywana po kliknięciu przycisku. W tym przypadku zaimplementuj funkcję wywołania zwrotnego, by utworzyć odpowiednią kartę i zwrócić ActionResponse obiektu. Obiekt odpowiedzi informuje dodatek o konieczności wyświetlenia karty wywołania zwrotnego funkcji.

Na tej stronie opisujemy działania specyficzne dla Kalendarza, które można uwzględnić w Google Analytics.

Interakcje z Kalendarzem

Dodatki do Google Workspace, które rozszerzają możliwości Kalendarza może zawierać kilka dodatkowych działań związanych z widżetami Kalendarza. Te działania wymaga powiązanej funkcji wywołania zwrotnego działania do zwracania specjalistycznych obiektów odpowiedzi:

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

Aby można było korzystać z tych działań widżetu i obiektów odpowiedzi, wszystkie z poniższych musi mieć wartość prawda:

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

Dodatkowo zmiany wprowadzone przez funkcję wywołania zwrotnego działania są zapisywane dopiero po użytkownik zapisze wydarzenie w Kalendarzu.

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

Poniższy przykład pokazuje, jak utworzyć przycisk dodający określony element uczestnik 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

Ta czynność powoduje ustawienie danych rozmowy wideo w otwartym wydarzeniu. Dla danych tej rozmowy wideo należy określić identyfikator rozwiązania do obsługi konferencji, ponieważ działanie nie gdy użytkownik wybierze odpowiednie rozwiązanie.

Poniższy przykład pokazuje, jak utworzyć przycisk służący do ustawiania danych konferencji dotyczące edytowanego zdarzenia:

  /**
   * 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

Poniższy przykład pokazuje, jak utworzyć przycisk dodający załącznik do Edytowane wydarzenie 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. Patrz sekcja Dostarczanie ikony załączników .