Obiekty zdarzenia

Ta strona przedstawia strukturę obiektów zdarzeń dodatków do Google Workspace.

Obiekty zdarzeń to struktury JSON, które są automatycznie konstruowane i przekazywane jako parametry wyzwalające funkcje lub wywołania zwrotne, gdy użytkownik wchodzi w interakcję z dodatkiem. Obiekty zdarzeń przekazują po stronie klienta informacje o aplikacji hosta oraz aktualny kontekst do funkcji wywołania zwrotnego po stronie serwera dodatku.

Dodatki do Google Workspace korzystają z obiektów zdarzeń w tych miejscach:

  • Reguły dotyczące strony głównej. Każda zdefiniowana przez Ciebie funkcja homepageTrigger automatycznie przekazuje obiekt zdarzenia po uruchomieniu funkcji aktywatora strony głównej. Możesz użyć tego obiektu w funkcji aktywatora strony głównej, aby zidentyfikować aktywną aplikację hosta, platformę klienta, język użytkownika i inne informacje.

    Obiekty zdarzeń utworzone po uruchomieniu reguły na stronie głównej nie zawierają wszystkich pól zawartych w pozostałych 2 przypadkach; pola dotyczące widżetów i informacji kontekstowych są pomijane.

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

    Po uruchomieniu reguły kontekstowej aplikacja hostująca wywołuje odpowiedni element runFunction wymieniony w pliku manifestu dodatku, przekazując go jako parametr jako obiekt zdarzenia. Obiekty zdarzeń utworzone po uruchomieniu reguł kontekstowych zawierają wszystkie pola uwzględnione w obiektach zdarzenia reguły na stronie głównej oraz pola zawierające informacje kontekstowe.

  • Działania widżetu. Obiekty zdarzeń służą też do udostępniania interakcji z widżetami przy użyciu tego samego modelu działań, którego używają dodatki do Gmaila. Dodatki do Google Workspace korzystają z tych samych funkcji obsługi widżetów, obiektów Action i odpowiedzi na działanie. Jednak w dodatkach do Google Workspace obiekty zdarzeń akcji zawierają jeszcze więcej informacji, na podstawie których może działać funkcja wywołania zwrotnego.

    Obiekty zdarzeń utworzone w wyniku działań widżetów zawierają wszystkie pola zawarte w obiektach zdarzeń aktywatora kontekstowego, a także pola zawierające informacje o widżetach.

  • Podgląd reguł połączenia. W Dokumentach, Arkuszach i Prezentacjach Google możesz skonfigurować podgląd linków do usług innych firm na podstawie określonych wzorców adresów URL. Gdy użytkownicy wchodzą w interakcje z linkiem zgodnym ze wzorcem, uruchamia się obiekt linkPreviewTriggers, a obiekt zdarzenia zawierający link jest przekazywany do funkcji wywołania zwrotnego aktywatora. Dodatek może używać tego obiektu zdarzenia do utworzenia elementu inteligentnego i karty, która wyświetla informacje o linku w aplikacji hosta. Możesz też tworzyć działania widżetów, które umożliwią użytkownikom interakcję z kartą podglądu i jej zawartością.

Struktura obiektu zdarzenia

W tabeli poniżej opisujemy ogólną strukturę najwyższego poziomu obiektów zdarzeń dodatków do Google Workspace. Struktura obiektu zdarzenia zawiera pole commonEventObject najwyższego poziomu z informacjami zależnymi od hosta. Każdy obiekt zdarzenia może też zawierać jedno z tych pól najwyższego poziomu specyficznych dla hosta, które jest określane przez aktywną aplikację hosta: gmailEventObject, calendarEventObject lub driveEventObject.

Aby zapewnić zgodność wsteczną, obiekty zdarzeń dodatków do Google Workspace zawierają też wszystkie oryginalne pola używane w obiektach zdarzeń działania dodatku w Gmailu. Te pola są wymienione w tabeli poniżej w sekcji „Pola oryginalnych dodatków w Gmailu”. Informacje w tych polach są powielane w nowej strukturze obiektów.

Obiekt zdarzenia
eventObject.commonEventObject Common fields object
Obiekt zawierający informacje wspólne dla wszystkich obiektów zdarzeń niezależnie od aplikacji hosta.
eventObject.calendar Calendar event object
Widoczne tylko wtedy, gdy gospodarzem połączenia jest Kalendarz Google. Obiekt zawierający informacje o kalendarzu i wydarzeniu.
eventObject.drive Drive event object
Widoczny tylko wtedy, gdy hostem połączenia jest Dysk Google. Obiekt zawierający informacje o Dysku.
eventObject.gmail Gmail event object
Widoczne tylko wtedy, gdy hostem połączenia jest Gmail. Obiekt zawierający informacje z Gmaila.
eventObject.docs Docs event object
Widoczny tylko wtedy, gdy hostem połączenia jest Dokumenty Google. Obiekt zawierający informacje z Dokumentów.
eventObject.sheets Sheets event object
Widoczny tylko wtedy, gdy gospodarzem połączenia jest Arkusze Google. Obiekt zawierający informacje z Arkuszy.
eventObject.slides Slides event object
Widoczny tylko wtedy, gdy gospodarzem połączenia jest Prezentacje Google. Obiekt zawierający informacje z Prezentacji.
Pola pierwotnych dodatków w Gmailu
eventObject.messageMetadata.accessToken string
Wycofano. Token dostępu. Możesz go użyć, aby włączyć dostęp do danych użytkowników za pomocą tymczasowych zakresów dodatków w Gmailu.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Wycofano. Identyfikator wiadomości wątku otwierający w interfejsie Gmaila.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.gmail.messageId.

eventObject.clientPlatform string
Wycofano. Wskazuje, skąd pochodzi zdarzenie (internet, iOS lub Android).

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.commonEventObject.platform.

eventObject.formInput object
Wycofano. Mapa bieżących wartości wszystkich widżetów formularzy na karcie, ograniczona do 1 wartości na widżet. Klucze to identyfikatory ciągów znaków powiązane z widżetami, a ich wartości to ciągi tekstowe. Obiekt zdarzenia zapewnia funkcję formInput, która ułatwia odczyt danych z wielu widżetów z oczekiwaną liczbą pojedynczą, takich jak dane wejściowe i przełączniki tekstowe. W przypadku widżetów o wielu wartościach, na przykład pól wyboru, możesz odczytać każdą z wartości z formInputs.

W przypadku dodatków do Google Workspace tę informację znajdziesz w polu eventObject.commonEventObject.formInputs. Widżety z pojedynczymi wartościami są reprezentowane jako tablice z pojedynczym elementem.

eventObject.formInputs object
Wycofano. Mapa bieżących wartości widżetów na karcie, prezentująca listę ciągów znaków. Klucze to identyfikatory ciągu znaków powiązane z widżetem. W przypadku widżetów jednowartościowych wartość jest prezentowana w tablicy jednoelementowej. W przypadku widżetów o wielu wartościach, takich jak grupy pól wyboru, wszystkie wartości są prezentowane w postaci listy.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.commonEventObject.formInputs.

eventObject.parameters object
Wycofano. Mapa wszystkich dodatkowych parametrów, które przekazujesz do Action za pomocą Action.setParameters(). Klucze i wartości mapy to ciągi tekstowe.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.commonEventObject.parameters.

eventObject.userCountry string
Domyślnie wycofane i wyłączone. Dwuliterowy kod wskazujący kraj lub region użytkownika. Może to być też numeryczny kod kraju UN M49.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Domyślnie wycofane i wyłączone. Dwuliterowy kod ISO 639 wskazujący język użytkownika. Więcej informacji znajdziesz w artykule Uzyskiwanie dostępu do języka i strefy czasowej użytkownika.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Domyślnie wycofane i wyłączone. Identyfikator strefy czasowej strefy czasowej użytkownika. Przykłady: America/New_York, Europe/Vienna i Asia/Seoul. Więcej informacji znajdziesz w artykule o dostępie do języka i strefy czasowej użytkownika.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Domyślnie wycofane i wyłączone. Opóźnienie względem uniwersalnego czasu koordynowanego (UTC) strefy czasowej użytkownika (mierzone w milisekundach). Więcej informacji znajdziesz w artykule o dostępie do języka i strefy czasowej użytkownika.

W przypadku dodatków do Google Workspace znajdziesz te informacje w polu eventObject.commonEventObject.timeZone.offset.

Typowe obiekty zdarzeń

Typowy obiekt zdarzenia to część ogólnego obiektu zdarzenia, która przekazuje do dodatku ogólne informacje niezależne od hosta z klienta użytkownika. Informacje te obejmują szczegóły takie jak język użytkownika, aplikacja hosta i platforma.

Oprócz wywoływania strony głównej i reguł kontekstowych dodatki tworzą i przekazują obiekty zdarzeń do funkcji wywołania zwrotnego działania, gdy użytkownik wejdzie w interakcję z widżetami. Funkcja wywołania zwrotnego dodatku może wysyłać zapytania do wspólnego obiektu zdarzenia, aby określić zawartość otwartych widżetów w kliencie użytkownika. Dodatek może na przykład zlokalizować tekst wpisany przez użytkownika w widżecie TextInput w obiekcie eventObject.commentEventObject.formInputs.

Typowe pola obiektów zdarzeń
commonEventObject.platform string
Wskazuje, skąd pochodzi zdarzenie („INTERNET”, „IOS” lub „ANDROID”).
commonEventObject.formInputs object
Mapa z bieżącymi wartościami widżetów na wyświetlanej karcie. Klucze mapy to identyfikatory ciągu znaków przypisane do każdego widżetu.

Struktura obiektu wartości mapy zależy od typu widżetu:

  • Widżety o jednej wartości (np. pole tekstowe): lista ciągów znaków (tylko 1 element).

    Przykład: w przypadku widżetu do wprowadzania tekstu, którego identyfikatorem jest employeeName, możesz uzyskać dostęp do wprowadzonej wartości tekstowej za pomocą polecenia: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widżety wielowartościowe (np. grupy pól wyboru): lista ciągów znaków.

    Przykład: w przypadku widżetu wielowartościowego o identyfikatorze participants otwórz tablicę wartości za pomocą: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

    Przykład: w przypadku selektora o identyfikatorze myDTPicker uzyskaj dostęp do obiektu DateTimeInput za pomocą e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: DateInput object.

    Przykład: w przypadku selektora o identyfikatorze myDatePicker uzyskaj dostęp do obiektu DateInput za pomocą właściwości e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: TimeInput object.

    Przykład: w przypadku selektora o identyfikatorze myTimePicker uzyskaj dostęp do obiektu TimeInput za pomocą właściwości e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Wskazuje aplikację hosta, w której dodatek jest aktywny, podczas generowania obiektu zdarzenia. Możliwe wartości:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Wszystkie dodatkowe parametry, które podasz w interfejsie Action za pomocą parametru Action.setParameters().
commonEventObject.userLocale string
Domyślnie wyłączona. Identyfikator języka i kraju/regionu użytkownika w formacie ISO 639 – kod kraju lub regionu w formacie ISO 3166. Przykład: en-US.

Aby włączyć to pole, ustaw addOns.common.useLocaleFromApp na true w pliku manifestu dodatku. Lista zakresu dodatku musi też zawierać https://www.googleapis.com/auth/script.locale. Więcej informacji znajdziesz w artykule na temat dostępu do języka i strefy czasowej użytkownika.

commonEventObject.timeZone string
Domyślnie wyłączona. Identyfikator strefy czasowej i przesunięcie. Aby włączyć to pole, ustaw addOns.common.useLocaleFromApp na true w pliku manifestu dodatku. Lista zakresu dodatku musi też zawierać https://www.googleapis.com/auth/script.locale. Więcej informacji znajdziesz w artykule na temat dostępu do języka i strefy czasowej użytkownika.
commonEventObject.timeZone.id string
Identyfikator strefy czasowej strefy czasowej użytkownika. Przykłady: America/New_York, Europe/Vienna i Asia/Seoul. Aby włączyć to pole, ustaw addOns.common.useLocaleFromApp na true w pliku manifestu dodatku. Lista zakresu dodatku musi też zawierać https://www.googleapis.com/auth/script.locale. Więcej informacji znajdziesz w artykule o dostępie do języka i strefy czasowej użytkownika.
commonEventObject.timeZone.offset string
Opóźnienie w stosunku do uniwersalnego czasu koordynowanego (UTC) strefy czasowej użytkownika, mierzone w milisekundach. Więcej informacji znajdziesz w artykule o dostępie do języka i strefy czasowej użytkownika.

Dane wejściowe formularza selektora daty i godziny

Funkcje wywołania zwrotnego działania mogą otrzymywać bieżące wartości widżetu z pola commonEventObject.formInputs. Obejmuje to wybrane przez użytkownika wartości daty i godziny w widżetach selektora daty i godziny. Struktura tych informacji różni się jednak w zależności od tego, czy widżet został skonfigurowany jako selektor daty i godziny, selektor tylko daty, czy selektor tylko godzin. Różnice strukturalne zostały opisane w tej tabeli:

Obiekt DateTimeInput
dateTimeInput.hasDate boolean
true, jeśli wpisana data i godzina zawiera datę, a jeśli false zawiera tylko godzinę.
dateTimeInput.hasTime boolean
true, jeśli wejściowa data i godzina zawiera godzinę, a jeśli false zawiera tylko datę.
dateTimeInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od początku epoki (00:00:00 czasu UTC 1 stycznia 1970 r.).
Obiekt DateInput
dateInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od początku epoki (00:00:00 czasu UTC 1 stycznia 1970 r.).
Obiekt TimeInput
timeInput.hours number
Godzina wybrana przez użytkownika.
timeInput.minutes number
Liczba minut w minutach wybrana przez użytkownika.

Obiekt wydarzenia w kalendarzu

Obiekt wydarzenia w Kalendarzu to część ogólnego obiektu wydarzenia, który zawiera informacje o kalendarzu i wydarzeniach kalendarza użytkownika. Jest on widoczny w obiekcie wydarzenia tylko wtedy, gdy aplikacja hostująca to Kalendarz Google.

W tabeli poniżej znajdziesz pola calendarEventObject obiektu zdarzenia. Pola oznaczone jako Dane wygenerowane przez użytkowników są widoczne w obiekcie zdarzenia tylko wtedy, gdy dane te występują w zdarzeniu w Kalendarzu, a dodatek ustawi w polu addOns.calendar.currentEventAccess pliku manifestu wartość READ lub READ_WRITE.

Obiekt wydarzenia w kalendarzu
calendar.attendees[] list of attendee objects
Dane użytkowników. Lista uczestników wydarzenia w kalendarzu.
calendar.calendarId string
Identyfikator kalendarza.
calendar.capabilities object
Dane użytkowników. Obiekt opisujący uprawnienia dodatku w zakresie wyświetlania lub aktualizowania informacji o zdarzeniu.
calendar.capabilities.canAddAttendees boolean
Dane użytkowników. true jeśli dodatek może dodawać nowych uczestników do listy uczestników wydarzenia; false w przeciwnym razie.
calendar.capabilities.canSeeAttendees boolean
Dane użytkowników. true, jeśli dodatek może odczytywać listę uczestników wydarzenia. false, jeśli jest inaczej,
calendar.capabilities.canSeeConferenceData boolean
Dane użytkowników. true, jeśli dodatek może odczytywać dane rozmowy wideo. W przeciwnym razie false.
calendar.capabilities.canSetConferenceData boolean
Dane użytkowników. true, jeśli dodatek może aktualizować dane rozmowy wideo. W przeciwnym razie false.
calendar.capabilities.canAddAttachments boolean
Dane użytkowników. true, jeśli dodatek może dodawać do wydarzenia nowe załączniki. W przeciwnym razie false.
calendar.conferenceData Conference data object
Dane użytkowników. Obiekt reprezentujący dane rozmowy wideo powiązane z tym wydarzeniem, np. szczegóły rozmowy wideo w Google Meet.
calendar.id string
Identyfikator zdarzenia.
calendar.organizer object
Obiekt reprezentujący organizatora wydarzenia.
calendar.organizer.email string
Adres e-mail organizatora wydarzenia.
calendar.recurringEventId string
Identyfikator wydarzenia cyklicznego.

Uczestnik

Obiekty uczestników przenoszą informacje o poszczególnych uczestnikach do wydarzeń w Kalendarzu Google. Informacje te pojawiają się w obiekcie zdarzenia tylko wtedy, gdy dane są dostępne w wydarzeniu w Kalendarzu, a dodatek ustawi w polu addOns.calendar.currentEventAccess manifest wartość READ lub READ_WRITE.

Obiekt uczestnika
attendee.additionalGuests number
Liczba dodatkowych gości wyznaczonych przez uczestnika. Wartość domyślna to 0.
attendee.comment string
Komentarz uczestnika do odpowiedzi (jeśli został dodany).
attendee.displayName string
Wyświetlana nazwa uczestnika.
attendee.email string
Adres e-mail uczestnika.
attendee.optional boolean
true, jeśli obecność tego uczestnika jest oznaczona jako opcjonalna; false w przeciwnym razie.
attendee.organizer boolean
true, jeśli uczestnik jest organizatorem tego wydarzenia.
attendee.resource boolean
true, jeśli uczestnik reprezentuje zasób, na przykład salę lub sprzęt; false w innym przypadku.
attendee.responseStatus string
Stan odpowiedzi uczestnika. Możliwe wartości:
  • accepted: uczestnik zaakceptował zaproszenie na wydarzenie.
  • declined: uczestnik odrzucił zaproszenie na wydarzenie.
  • needsAction: uczestnik nie odpowiedział na zaproszenie na wydarzenie.
  • tentative: uczestnik wstępnie zaakceptował zaproszenie na wydarzenie.
attendee.self boolean
true, jeśli ten uczestnik reprezentuje kalendarz, w którym występuje to wydarzenie. W przeciwnym razie false.

Dane rozmowy wideo

Obiekty danych rozmów wideo zawierają informacje o rozmowach wideo dołączonych do wydarzeń w Kalendarzu Google. Mogą to być rozwiązania Google do prowadzenia rozmów wideo, np. Google Meet, lub usługi do prowadzenia rozmów wideo z innymi firmami. Informacje te pojawiają się w obiekcie zdarzenia tylko wtedy, gdy dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawi w polu addOns.calendar.currentEventAccess manifest wartość READ lub READ_WRITE.

Obiekt danych rozmowy wideo
conferenceData.conferenceId string
Identyfikator konferencji. Ten identyfikator umożliwia aplikacjom śledzenie rozmów wideo. Nie należy go wyświetlać użytkownikom.
conferenceData.conferenceSolution object
Obiekt reprezentujący rozwiązanie do obsługi konferencji, np. Hangouts lub Google Meet.
conferenceData.conferenceSolution.iconUri string
Identyfikator URI ikony widocznej dla użytkownika reprezentującej to rozwiązanie do obsługi konferencji.
conferenceData.conferenceSolution.key object
Klucz, który jednoznacznie identyfikuje rozwiązanie konferencyjne dla tego wydarzenia.
conferenceData.conferenceSolution.key.type string
Typ rozwiązania do obsługi konferencji. Możliwe wartości:
  • eventHangout w Hangouts dla klientów indywidualnych (http://hangouts.google.com).
  • eventNamedHangout w klasycznej wersji Hangouts dla użytkowników Google Workspace (http://hangouts.google.com).
  • hangoutsMeet w Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Widoczna dla użytkownika nazwa tego rozwiązania do obsługi rozmów wideo (nie zlokalizowana).
conferenceData.entryPoints[] list of entry point objects
Lista punktów wejścia do konferencji, np. adresy URL lub numery telefonów.
conferenceData.notes string
Dodatkowe uwagi na temat konferencji (na przykład instrukcje od administratora domeny lub informacje prawne) do wyświetlenia użytkownikowi. Może zawierać kod HTML. Maksymalna długość to 2048 znaków.
conferenceData.parameters object
Obiekt zawierający mapę danych zdefiniowanych parametrów na potrzeby dodatku.
conferenceData.parameters.addOnParameters object
Mapa kluczy i wartości ciągu parametrów. Te klucze i wartości są definiowane przez programistę dodatku w celu dołączania do konkretnej rozmowy wideo informacji na temat wykorzystania tego dodatku.

Punkt wejścia

Obiekty punktów wejścia zawierają informacje o ustalonych sposobach dostępu do danej konferencji, np. za pomocą telefonu lub połączenia wideo. Informacje te pojawiają się w obiekcie zdarzenia tylko wtedy, gdy dane znajdują się w wydarzeniu w Kalendarzu, a dodatek ustawia w polu addOns.calendar.currentEventAccess manifest wartość READ lub READ_WRITE.

Obiekt punktu wejścia
entryPoint.accessCode string
Kod dostępu używany do uzyskania dostępu do konferencji. Maksymalna długość to 128 znaków. Aby zapewnić dostęp do konferencji, dostawcy usług konferencyjnych zwykle używają tylko podzbioru tych elementów: {accessCode, meetingCode, passcode, password, pin}. Dopasuj i wyświetlaj tylko pola używane przez dostawcę konferencji.
entryPoint.entryPointFeatures list
Cechy punktu wejścia. Obecnie te funkcje mają zastosowanie tylko do punktów wejścia phone:
  • toll: punkt wejścia to płatne połączenie telefoniczne.
  • toll_free: punktem wejścia jest bezpłatne połączenie telefoniczne.
entryPoint.entryPointType string
Typ punktu wejścia. Możliwe wartości:
  • more: dodatkowe instrukcje dołączania do rozmowy wideo, takie jak alternatywne numery telefonów. Konferencja może mieć tylko 1 punkt wejścia more. Jeśli istnieje co najmniej 1 punkt wejścia innego typu, wymagany jest też co najmniej 1 punkt wejścia.
  • phone: dołącz do konferencji przy użyciu numeru telefonu. Konferencja nie może mieć żadnych punktów wejścia phone. Po sformatowaniu i posortowaniu alfabetycznie Kalendarz Google wyświetla tylko 2 pierwsze punkty wejścia na telefonie.
  • sip: dołącz do rozmowy przez SIP. Konferencja może mieć maksymalnie 1 punkt wejścia sip.
  • video: dołącz do konferencji przez HTTP. Konferencja może mieć maksymalnie 1 punkt wejścia video.
entryPoint.label string
Widoczna dla użytkownika etykieta identyfikatora URI punktu wejścia (nie zlokalizowana).
entryPoint.meetingCode string
Kod spotkania używany do uzyskania dostępu do rozmowy wideo. Maksymalna długość to 128 znaków. Aby zapewnić dostęp do konferencji, dostawcy usług konferencyjnych zwykle używają tylko podzbioru tych elementów: {accessCode, meetingCode, passcode, password, pin}. Dopasuj i wyświetlaj tylko pola używane przez dostawcę konferencji.
entryPoint.passcode string
Kod dostępu umożliwiający dostęp do rozmowy wideo. Maksymalna długość to 128 znaków. Aby zapewnić dostęp do konferencji, dostawcy usług konferencyjnych zwykle używają tylko podzbioru tych elementów: {accessCode, meetingCode, passcode, password, pin}. Dopasuj i wyświetlaj tylko pola używane przez dostawcę konferencji.
entryPoint.password string
Hasło użyte do uzyskania dostępu do konferencji. Maksymalna długość to 128 znaków. Aby zapewnić dostęp do konferencji, dostawcy usług konferencyjnych zwykle używają tylko podzbioru tych elementów: {accessCode, meetingCode, passcode, password, pin}. Dopasuj i wyświetlaj tylko pola używane przez dostawcę konferencji.
entryPoint.pin string
Kod PIN służący do uzyskania dostępu do rozmowy wideo. Maksymalna długość to 128 znaków. Aby zapewnić dostęp do konferencji, dostawcy usług konferencyjnych zwykle używają tylko podzbioru tych elementów: {accessCode, meetingCode, passcode, password, pin}. Dopasuj i wyświetlaj tylko pola używane przez dostawcę konferencji.
entryPoint.regionCode string
Kod regionu numeru telefonu. Wymagana przez użytkowników, jeśli identyfikator URI nie zawiera kodu kraju. Wartości są oparte na publicznej liście kodów regionów CLDR.
entryPoint.uri string
Identyfikator URI punktu wejścia. Maksymalna długość to 1300 znaków. Format zależy od typu punktu wejścia:
  • more: wymagany jest schemat http: lub https:.
  • phone: wymagany jest schemat tel:. Identyfikator URI powinien zawierać całą sekwencję wybierania numeru (np. „tel:+12345678900,,,12345678;1234”).
  • sip: wymagany jest schemat sip: lub sips:. Na przykład „sip:12345678@myprovider.com”.
  • video: wymagany jest schemat http: lub https:.

Obiekt zdarzenia na Dysku

Obiekt zdarzenia na Dysku to część ogólnego obiektu zdarzenia, który zawiera informacje o Dysku Google użytkownika i jego zawartości. Jest on widoczny w obiekcie zdarzenia tylko wtedy, gdy aplikacja hostująca to Dysk Google.

Obiekt zdarzenia na Dysku
drive.activeCursorItem Drive item object
Element na Dysku jest obecnie aktywny.
drive.selectedItems[] list of Drive item objects
Lista elementów (plików lub folderów) wybranych na Dysku.

Element na Dysku

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

Obiekt elementu na Dysku
item.addonHasFileScopePermission boolean
Jeśli true, dodatek zażądał i otrzymał autoryzację zakresu na poziomie https://www.googleapis.com/auth/drive.file dla tego elementu. W przeciwnym razie to pole to false.
item.id string
Identyfikator wybranego elementu.
item.iconUrl string
Adres URL ikony reprezentującej wybrany element.
item.mimeType string
Typ MIME wybranego elementu.
item.title string
Tytuł wybranego elementu.

Obiekt zdarzenia Gmaila

Obiekt zdarzenia Gmaila to część obiektu ogólnego zdarzenia, która zawiera informacje o wiadomościach użytkownika w Gmailu. Jest on widoczny w obiekcie zdarzenia tylko wtedy, gdy aplikacją hostującą jest Gmail.

Obiekt zdarzenia Gmaila
gmail.accessToken string
Token dostępu dla Gmaila. Możesz użyć tego tokena z metodą GmailApp.setCurrentMessageAccessToken(accessToken), aby przyznać dodatkowi tymczasowy dostęp do aktualnie otwartej wiadomości w Gmailu lub umożliwić mu tworzenie nowych wersji roboczych.
gmail.bccRecipients[] list of strings
Domyślnie wyłączona. Lista adresów e-mail odbiorców z polem „UDW:” znajdujących się obecnie w wersji roboczej tworzonej przez dodatek. Aby włączyć to pole, ustaw pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.
gmail.ccRecipients[] list of strings
Domyślnie wyłączona. Lista adresów e-mail odbiorców z polem „DW:” znajdujących się obecnie w wersji roboczej dodatku w ramach jego tworzenia. Aby włączyć to pole, ustaw pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.
gmail.messageId string
Identyfikator aktualnie otwartej wiadomości w Gmailu.
gmail.threadId string
Identyfikator aktualnie otwartego wątku z Gmaila.
gmail.toRecipients[] list of strings
Domyślnie wyłączona. Lista adresów e-mail odbiorców z polem „To:” znajdujących się obecnie w wersji roboczej dodatku. Aby włączyć to pole, ustaw pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.

Obiekt zdarzenia Dokumentów

Obiekt zdarzenia Dokumentów to część obiektu ogólnego zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on widoczny w obiekcie zdarzenia tylko wtedy, gdy aplikacja hostująca to Dokumenty Google.

Obiekt zdarzenia Dokumentów
docs.id string
Widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika.
Identyfikator dokumentu jest otwarty w interfejsie Dokumentów.
docs.title string
Widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika.
Tytuł dokumentu jest otwarty w interfejsie Dokumentów.
docs.addonHasFileScopePermission boolean
Jeśli true, dodatek zażądał i otrzymał autoryzację zakresu https://www.googleapis.com/auth/drive.file dla dokumentu otwartego w interfejsie Dokumentów. W przeciwnym razie pole ma wartość false.
docs.matchedUrl.url string
Widoczny tylko wtedy, gdy są spełnione te warunki:
  • Aplikacja https://www.googleapis.com/auth/workspace.linkpreview została autoryzowana przez użytkownika.
  • Adres URL pasuje do wzorca hosta określonego w aktywatorze LinkPreviewTriggers.

Adres URL linku, który generuje podgląd w Dokumentach Google. Aby użyć tego pola, musisz skonfigurować LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków za pomocą elementów inteligentnych.

Przykładowy ładunek, w którym użytkownik wyświetla podgląd linku https://www.example.com/12345: 

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

Obiekt zdarzenia Arkuszy

Obiekt zdarzenia Arkuszy to część obiektu ogólnego zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on widoczny w obiekcie zdarzenia tylko wtedy, gdy aplikacją hostującą są Arkusze Google.

Obiekt zdarzenia Arkuszy
sheets.id string
Widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Identyfikator arkusza kalkulacyjnego jest otwarty w interfejsie Arkuszy.
sheets.title string
Widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Tytuł arkusza kalkulacyjnego otwiera się w interfejsie Arkuszy.
sheets.addonHasFileScopePermission boolean
Jeśli true, dodatek zażądał i otrzymał autoryzację zakresu https://www.googleapis.com/auth/drive.file dla arkusza kalkulacyjnego otwartego w interfejsie Arkuszy. W przeciwnym razie pole ma wartość false.
sheets.matchedUrl.url string
Widoczny tylko wtedy, gdy są spełnione te warunki:
  • Aplikacja https://www.googleapis.com/auth/workspace.linkpreview została autoryzowana przez użytkownika.
  • Adres URL pasuje do wzorca hosta określonego w aktywatorze LinkPreviewTriggers.

Adres URL linku, który generuje podgląd w Arkuszach Google. Aby użyć tego pola, musisz skonfigurować LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków za pomocą elementów inteligentnych.

Przykładowy ładunek, w przypadku którego użytkownik wyświetla podgląd linku https://www.example.com/12345:

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

Obiekt zdarzenia w Prezentacjach

Obiekt zdarzenia Prezentacji to część obiektu ogólnego zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on widoczny w obiekcie zdarzenia tylko wtedy, gdy aplikacja hostująca to Prezentacje Google.

Obiekt zdarzenia w Prezentacjach
slides.id string
Widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Identyfikator prezentacji otwarty w interfejsie Prezentacji.
slides.title string
Widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Tytuł prezentacji otwiera się w interfejsie Prezentacji.
slides.addonHasFileScopePermission boolean
Jeśli true, dodatek zażądał i otrzymał autoryzację zakresu https://www.googleapis.com/auth/drive.file dla prezentacji otwartej w interfejsie Prezentacji. W przeciwnym razie pole ma wartość false.
slides.matchedUrl.url string
Widoczny tylko wtedy, gdy są spełnione te warunki:
  • Aplikacja https://www.googleapis.com/auth/workspace.linkpreview została autoryzowana przez użytkownika.
  • Adres URL pasuje do wzorca hosta określonego w aktywatorze LinkPreviewTriggers.

Adres URL linku, który generuje podgląd w Prezentacjach Google. Aby użyć tego pola, musisz skonfigurować LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków za pomocą elementów inteligentnych.

Przykładowy ładunek, w przypadku którego użytkownik wyświetla podgląd linku https://www.example.com/12345:

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