Obiekty zdarzenia

Ta strona zawiera omówienie struktury obiektów zdarzeń dodatków do Google Workspace.

Obiekty zdarzeń to struktury JSON, które są automatycznie tworzone i przekazywane jako parametry do funkcji wywołania lub wywołania zwrotnego, gdy użytkownik wchodzi w interakcję z dodatkiem. Obiekty zdarzeń zawierają informacje po stronie klienta o aplikacji hostującej oraz w bieżącym kontekście funkcji wywołania zwrotnego po stronie dodatku.

Dodatki do Google Workspace używają obiektów zdarzeń w tych miejscach:

• Reguły dotyczące strony głównej. Każda zdefiniowana przez Ciebie funkcja homepageTrigger jest automatycznie przekazywana do obiektu zdarzenia, gdy uruchamia się funkcja reguły na stronie głównej. Możesz użyć tego obiektu w: funkcji aktywującej stronę główną do zidentyfikowania aktywnej aplikacji hosta, platformę, język użytkownika i inne informacje.

  Obiekty zdarzeń tworzone podczas wywołania przez stronę główną nie zawierają wszystkich pól uwzględnionych w 2 pozostałych przypadkach. Nie uwzględnia się pól dotyczących widżetów i informacji kontekstowych.

• Reguły kontekstowe. Każda aplikacja hostująca udostępnia inny zestaw aktywatorów kontekstowych, które uruchamia się, gdy użytkownik wpisze określony kontekst. Na przykład:

  • Gmail udostępnia wyzwalacz kontekstowy, gdy użytkownik otwiera wiadomość, oraz inny, gdy tworzy wiadomość.
  • Kalendarz Google udostępnia wyzwalacz kontekstowy, gdy użytkownik otwiera wydarzenie.
  • Dysk Google udostępnia regułę kontekstową, gdy użytkownik wybierze pliki na Dysku,

  Gdy zostanie uruchomiony kontekstowy wyzwalacz, aplikacja hosta wywołuje odpowiednią runFunction wymienioną w pliku manifestu dodatku, przekazując jej obiekt zdarzenia jako parametr. Obiekty zdarzeń tworzone, gdy są kontekstowe uruchomienie reguł zawiera wszystkie pola uwzględnione w zdarzeniu reguły dotyczącej strony głównej obiektów oraz pól zawierających informacje kontekstowe.

• Działania dotyczące widżetu. Obiekty zdarzeń służą też do wyświetlania widżetów i interaktywność, w ten sam sposób model działania, który dodaje Gmail. i ich używanie. Dodatki do Google Workspace używają tych samych funkcji obsługi widżetów. Action obiekty i działanie odpowiedzi. Jednak w dodatkach do Google Workspace obiekty zdarzeń akcji pozwalają uwzględnić jeszcze więcej informacji, na podstawie których może działać funkcja wywołania zwrotnego.

  Obiekty zdarzeń utworzone w wyniku działań widżetu zawierają wszystkie zawarte w obiektach zdarzenia aktywatora kontekstowego oraz pola zawierające informacje o widżecie.

• Wyświetl reguły dołączenia do linku. W Dokumentach, Arkuszach i Prezentacjach Google możesz konfigurować podgląd linków do usług innych firm na podstawie określonych wzorów adresów URL. Gdy użytkownicy wejdą w interakcję z linkiem, który spełnia wzór, uruchamia się zdarzenie linkPreviewTriggers, a do funkcji wywołania zwrotnego reguły przekazywany jest obiekt zdarzenia zawierający link. Twój dodatek może używać tego obiektu zdarzenia do tworzenia elementu inteligentnego i karty, które wyświetlają informacje o połączeniu w aplikacji hosta. Możesz też tworzyć działania widżetu, aby umożliwić użytkownikom interakcję z kartą podglądu i jej zawartością.

Struktura obiektu zdarzenia

Tabela poniżej opisuje strukturę najwyższego poziomu obiektów zdarzeń Google Workspace Add-ons. Wydarzenie struktura obiektu obejmuje commonEventObject pole najwyższego poziomu zawierające informacje niezależne od hosta. Każdy obiekt zdarzenia może też zawierać jedno z tych pól najwyższego poziomu, które zależy od aktywnej aplikacji hosta: gmailEventObject, calendarEventObject lub driveEventObject.

Ze względu na zgodność wsteczną obiekty zdarzeń Dodatków Google Workspace zawierają też wszystkie oryginalne pola używane w obiektach zdarzeń działania dodatku Gmaila. Te pola są wymienione w tabeli poniżej w sekcji „Pierwotne pola dodatku Gmaila”. Informacje z tych pól są powielane w nowej strukturze obiektu.

Obiekt wspólnego zdarzenia

Obiekt wspólnego zdarzenia to część ogólnego obiektu zdarzenia, który zawiera ogólne informacje niezależne od hosta i przesyła je do dodatku z klienta użytkownika. Ten informacje obejmują m.in. język użytkownika, aplikację hostującą i platformę.

Oprócz reguł na stronie głównej i reguł kontekstowych dodatki mogą tworzyć i przekazywać obiektów zdarzeń do funkcji wywołania zwrotnego działania gdy użytkownik korzysta z widżetów. Funkcja wywołania zwrotnego dodatku może wysyłać zapytanie do wspólnego obiektu zdarzenia, aby określić zawartość otwartych widżetów w kliencie użytkownika. Dodatek może na przykład znajdować tekst wpisany przez użytkownika w TextInput w eventObject.commentEventObject.formInputs obiekt.

Dane wejściowe formularza selektora daty i godziny

Funkcje wywołania zwrotnego działania może odbierać bieżące wartości widżetu w polu commonEventObject.formInputs. Dotyczy to wybranych przez użytkownika wartości daty lub czasu w widżetach selektora daty lub czasu. Struktura tych informacji różni się jednak w zależności od tego, czy widżet został skonfigurowany jako selektor daty i godziny, samej daty lub godziny . Różnice strukturalne zostały opisane w tej tabeli:

Obiekt wydarzenia w kalendarzu

Obiekt wydarzenia w Kalendarzu to część ogólnego obiektu wydarzenia, zawiera informacje o kalendarzu i wydarzeniach z kalendarza użytkownika. Jest tylko znajduje się w obiekcie wydarzenia, jeśli aplikacją hosta jest Kalendarz Google.

Tabela poniżej zawiera listę pól występujących w elemencie calendarEventObject obiektu zdarzenia. Pola oznaczone jako Dane utworzone przez użytkownika są obecne w obiekcie zdarzenia, jeśli i tylko jeśli dane są obecne w zdarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifest na wartość READ lub READ_WRITE.

Uczestnik

Obiekty uczestników przekazują informacje o poszczególnych uczestnikach do Kalendarza Google zdarzeń. Te informacje są obecne w obiekcie zdarzenia, jeśli i tylko jeśli dane są obecne w zdarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifest na wartość READ lub READ_WRITE.

Dane konferencji

Obiekty danych konferencji zawierają informacje o dołączonych konferencjach do wydarzeń w Kalendarzu Google. Mogą to być rozwiązania do rozmów wideo Google, takie jak Google Meet, lub rozmowy wideo z udziałem innych firm. Te informacje są dostępne w tylko wtedy, gdy dane są obecne w wydarzeniu z Kalendarza oraz w obiekcie dodatek ustawia: addOns.calendar.currentEventAccess manifestuj pole do READ lub READ_WRITE.

Punkt wejścia

Obiekty punktu wejścia zawierają informacje o ustalonych sposobach dostępu podczas danej konferencji, np. przez telefon lub wideo. Ta informacja jest dostępna w i tylko wtedy, gdy dane są dostępne w wydarzeniu z Kalendarza oraz dodatek ustawia: addOns.calendar.currentEventAccess manifestuj pole do READ lub READ_WRITE.

Obiekt zdarzenia na Dysku

Obiekt zdarzenia na Dysku to część ogólnego obiektu zdarzenia, zawiera informacje o Dysku Google użytkownika i jego zawartości. Jest tylko obecny w obiekcie zdarzenia, jeśli aplikacją hosta jest Dysk Google.

Element na Dysku

Obiekty elementów na Dysku zawierają informacje o konkretnych elementach na Dysku, takich jak pliki lub folderów.

Obiekt zdarzenia Gmaila

Obiekt zdarzenia Gmail to część ogólnego obiektu zdarzenia, który zawiera informacje o wiadomościach w Gmailu użytkownika. Jest on obecny tylko w obiekcie zdarzenia, jeśli aplikacja hosta to Gmail.

Obiekt zdarzenia Dokumenty

Obiekt zdarzenia Dokumentów to część ogólnego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on dostępny tylko w , jeśli aplikacją hosta są Dokumenty Google.

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

Obiekt zdarzenia Arkuszy

Obiekt zdarzenia w Sheets to część ogólnego obiektu zdarzenia, który zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on dostępny tylko w , jeśli aplikacją hosta są Arkusze Google.

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}
        

Obiekt zdarzenia w Prezentacjach

Obiekt zdarzenia Slides to część ogólnego obiektu zdarzenia, który zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on dostępny tylko w , jeśli aplikacja hostująca to Prezentacje Google.

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}