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 parametrów do wywołania funkcji lub wywołania zwrotnego, gdy użytkownik wejdzie w interakcję z Google Analytics. 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 zdarzenie po uruchomieniu funkcji reguły strony 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 uruchamiania reguł na stronie głównej nie zawierają wszystkich pola uwzględnione w 2 pozostałych przypadkach, pól dotyczących widżetów i informacje kontekstowe są pomijane.

• 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 regułę kontekstową, gdy użytkownik otwiera wiadomość oraz drugiego, gdy użytkownik tworzy wiadomość.
  • Kalendarz Google generuje kontekst kontekstowy, gdy użytkownik otwiera wydarzenie.
  • Dysk Google udostępnia regułę kontekstową, gdy użytkownik wybierze pliki na Dysku.

  Po uruchomieniu aktywatora kontekstowego aplikacja hostująca wywołuje metodę odpowiednie runFunction wymienione w pliku manifestu dodatku, przekazując go do jako parametru zdarzenia. 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 widżetu. Obiekty zdarzeń służą też do wyświetlania widżetów i interaktywność, w ten sam sposób model działania dodawany przez Gmaila. 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: konfigurowanie podglądów linków dla usług innych firm na podstawie konkretnych wzorców adresów URL. Gdy użytkownicy wchodzą w interakcję z linkiem zgodnym wzorzec, linkPreviewTriggers uruchamia się, a obiekt zdarzenia zawierający link jest przekazywany do metody funkcji wywołania zwrotnego. Dodatek może użyć tego obiektu zdarzenia do utworzenia element inteligentny i karta, które wyświetlają informacje o linku w obrębie hosta aplikacji. Możesz też utworzyć działania związane z widżetami, aby umożliwić użytkownikom interakcję kartę podglądu i jej zawartość.

Struktura obiektu zdarzenia

W poniższej tabeli opisano strukturę najwyższego poziomu Obiekty zdarzeń dodatków do Google Workspace. Wydarzenie struktura obiektu obejmuje commonEventObject pole najwyższego poziomu zawierające informacje niezależne od hosta. Każdy obiekt zdarzenia może też mają jedno z tych pól najwyższego poziomu specyficznych dla hosta, określone przez aktywna aplikacja hostująca: gmailEventObject, calendarEventObject lub driveEventObject.

Aby zapewnić zgodność wsteczną, dodatki do Google Workspace obiekty zdarzeń zawierają też wszystkie oryginalne pola użyte w funkcji Obiekty zdarzeń działania dodatku do Gmaila. Pola te znajdziesz w tabeli poniżej w sekcji „Pierwotne pola dodatków w Gmailu”. informacje w tych polach są odtwarzane w nowej strukturze obiektów.

Typowy obiekt zdarzenia

Wspólny obiekt zdarzenia to część ogólnego obiektu zdarzenia, która zawiera ogólne, niezależne od hosta informacje o dodatku przekazane przez 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ć zapytania typowy obiekt zdarzenia służący do określania zawartości otwartych widżetów klienta. 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. Obejmuje to wybrane przez użytkownika wartości daty lub godziny w selektorze daty lub godziny widżety. 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 generowane przez użytkowników są: znajduje się w obiekcie wydarzenia tylko wtedy, gdy dane są dostępne w kalendarzu , a dodatek ustawi jego addOns.calendar.currentEventAccess manifestuj pole do 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 tylko wtedy, gdy dane znajduje się w wydarzeniu w Kalendarzu, a dodatek ustawia jego addOns.calendar.currentEventAccess manifestuj pole do 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 konferencyjne Google, takie jak: w Google Meet i rozmowach wideo 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 w Gmailu

Obiekt zdarzenia w Gmailu to część ogólnego obiektu zdarzenia, która zawiera informacje o wiadomościach użytkownika w Gmailu. Występuje tylko w obiekcie zdarzenia jeśli aplikacją hosta jest Gmail.

Obiekt zdarzenia Dokumentów

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 Arkuszy jest częścią 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ą Arkusze Google.

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

Obiekt zdarzenia w Prezentacjach

Obiekt zdarzenia Prezentacji 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 aplikacja hostująca to Prezentacje Google.

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