Obiekty zdarzenia

Ta strona przedstawia strukturę 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 wejdzie w interakcję z dodatkiem. Obiekty zdarzeń przekazują do funkcji wywołania zwrotnego po stronie serwera dodatku informacje o aplikacji goszczącej i bieżącym kontekście po stronie klienta.

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

  • Wyzwalacze 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żywać tego obiektu w funkcji reguły strony głównej, aby zidentyfikować aktywną aplikację hosta, platformę klienta, lokalizację użytkownika i inne informacje.

    Obiekty zdarzeń utworzone po wywołaniu przez stronę główną nie zawierają wszystkich pól uwzględnionych w 2 pozostałych przypadkach. Nie uwzględniono pól dotyczących widżetów i informacji kontekstowych.

  • Reguły kierowania kontekstowego. Każda aplikacja hosta udostępnia inny zestaw wyzwalaczy kontekstowych, które działają, gdy użytkownik wejdzie w określony kontekst. Na przykład:

    Gdy zostanie uruchomiony kontekstowy reguła, aplikacja hosta wywołuje odpowiednią runFunction wymienioną w pliku manifestu dodatku, przekazując jej obiekt zdarzenia jako parametr. Obiekty zdarzeń tworzone podczas aktywacji przez wyzwalacze kontekstowe zawierają wszystkie pola zawarte w obiektach zdarzeń wyzwalacza strony głównej oraz pola zawierające informacje kontekstowe.

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

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

  • Reguły wywoływania linku do podglądu. 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 linku w aplikacji gospodarza. Możesz też tworzyć działania widżetu, aby umożliwić użytkownikom interakcję z kartą podglądu i jej zawartością.

  • Reguły aplikacji Google Chat (wersja dla programistów). W Google Chat Twój dodatek jest widoczny dla użytkowników jako aplikacja Google Chat, z którą mogą wchodzić w interakcje, dodając ją do pokoi, wysyłając wiadomości, używając poleceń po ukośniku itp. Aby tworzyć funkcje interaktywne, skonfiguruj i używaj różnych komend aplikacji Google Chat. Każdy taki element wysyła inny ładunek obiektu zdarzenia, który pomaga przetwarzać lub odpowiadać na różne typy interakcji.

Struktura obiektu zdarzenia

Tabela poniżej opisuje strukturę najwyższego poziomu obiektów zdarzeń wtyczek Google Workspace. Struktura obiektu zdarzenia zawiera pole najwyższego poziomu commonEventObject z informacjami niezależnymi 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ń w dodatkach Google Workspace zawierają też wszystkie oryginalne pola używane w obiektach zdarzeń działania w dodatkach do Gmaila. Te pola znajdziesz w tabeli poniżej w sekcji „Pierwotne pola dodatku Gmaila”. Informacje z tych pól są powielane w nowej strukturze obiektu.

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 jest użytkownik Kalendarza Google. Obiekt zawierający informacje o kalendarzu i wydarzeniu.
eventObject.chat Chat event object
Widoczny tylko wtedy, gdy gospodarzem jest Google Chat Obiekt zawierający informacje o Google Chat.
eventObject.drive Drive event object
Widoczne tylko wtedy, gdy host wywołania to Dysk Google. Obiekt zawierający informacje o Dysk.
eventObject.gmail Gmail event object
Widoczny tylko wtedy, gdy gospodarzem jest Gmail. Obiekt zawierający informacje o Gmailu.
eventObject.docs Docs event object
Widoczny tylko wtedy, gdy host wywołania to Dokumenty Google. Obiekt zawierający informacje o dokumentach.
eventObject.sheets Sheets event object
Widoczny tylko wtedy, gdy host wywołujący to Arkusze Google. Obiekt zawierający informacje z Arkuszy.
eventObject.slides Slides event object
Widoczne tylko wtedy, gdy gospodarzem jest osoba dzwoniąca z Prezentacji Google. Obiekt zawierający informacje o prezentacjach.
Oryginalne pola dodatku w Gmailu
eventObject.messageMetadata.accessToken string
Wycofany. token dostępu; Możesz użyć tej funkcji, aby włączyć dostęp do danych użytkownika za pomocą tymczasowych zakresów uprawnień dodatku Gmail.

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

eventObject.messageMetadata.messageId string
Wycofany. Identyfikator wiadomości wątku otwartego w interfejsie Gmaila.

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

eventObject.clientPlatform string
Wycofany. Wskazuje, z czego pochodzi zdarzenie (sieć, iOS lub Android).

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

eventObject.formInput object
Wycofany. Mapowanie bieżących wartości wszystkich widżetów formularza na karcie, ograniczone do jednej wartości na widżet. Klucze to identyfikatory ciągów tekstowych powiązane z widżetami, a wartości to ciągi tekstowe. Obiekt zdarzenia udostępnia parametr formInput, aby ułatwić odczytywanie danych z wielu widżetów, które mają mieć pojedyncze wartości, np. pola tekstowe i przełączniki. W przypadku widżetów z wieloma wartościami, takich jak pola wyboru, możesz zamiast tego odczytać każdą wartość z formInputs.

W przypadku dodatków Google Workspace informacje te znajdziesz w polu eventObject.commonEventObject.formInputs. Widgety z pojedynczymi wartościami są reprezentowane jako tablice z jednym elementem.

eventObject.formInputs object
Wycofany. Mapa bieżących wartości widżetów na karcie, przedstawiona jako lista ciągów znaków. Klucze to identyfikatory ciągu znaków powiązane z widżetem. W przypadku widżetów o pojedynczej wartości wartość jest przedstawiana w tablicy jednoelementowej. W przypadku widżetów z wieloma wartościami, takich jak grupy pól wyboru, wszystkie wartości są wyświetlane na liście.

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

eventObject.parameters object
Wycofany. mapowanie 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 informacje te znajdziesz w polu eventObject.commonEventObject.parameters.

eventObject.userCountry string
Wycofany i domyślnie wyłączony. Dwulitrowy kod wskazujący kraj lub region użytkownika. Może to być także numeryczny kod kraju UN M49.

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

eventObject.userLocale string
Wycofany i domyślnie wyłączony. Dwuliterowy kod ISO 639 wskazujący język użytkownika. Więcej informacji znajdziesz w artykule Dostęp do ustawień języka i strefy czasowej użytkownika.

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

eventObject.userTimezone.id string
Wycofany i domyślnie wyłączony. Identyfikator strefy czasowej strefy czasowej użytkownika. Przykłady:America/New_York, Europe/Vienna i Asia/Seoul. Więcej informacji znajdziesz w artykule Dostęp do ustawień języka i strefy czasowej użytkownika.

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

eventObject.userTimezone.offset string
Wycofany i domyślnie wyłączony. przesunięcie czasowe względem uniwersalnego czasu koordynowanego (UTC) w strefie czasowej użytkownika, mierzone w milisekundach. Więcej informacji znajdziesz w artykule Dostęp do ustawień języka i strefy czasowej użytkownika.

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

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. Te informacje obejmują takie dane jak lokalizacja użytkownika, aplikacja hosta i platforma.

Oprócz reguł dotyczących strony głównej i reguł kontekstowych dodatki tworzą i przekazują obiekty zdarzeń do funkcji wywołania działania, gdy użytkownik wchodzi w interakcję z widżetami. 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. Twój dodatek może na przykład znaleźć tekst wpisany przez użytkownika w widżecie TextInput w obiekcie eventObject.commentEventObject.formInputs.

Typowe pola obiektu zdarzenia
commonEventObject.platform string
Wskazuje, skąd pochodzi zdarzenie (WEB, IOS lub ANDROID).
commonEventObject.formInputs object
Mapa zawierająca bieżące wartości widżetów na wyświetlonej karcie. Klucze mapy to identyfikatory ciągów znaków przypisane do każdego widżetu.

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

  • Elementy z jedną wartością (np. pole tekstowe): lista ciągów znaków (tylko jeden element).

    Przykład: w przypadku widżetu danych wejściowych typu tekst o identyfikatorzeemployeeName możesz uzyskać dostęp do wartości danych wejściowych za pomocą wyrażenia: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Elementy z wieloma wartościami (np. grupy pól wyboru): lista ciągów tekstowych.

    Przykład: w przypadku widżetu z wieloma wartościami o identyfikatorze participants dostęp do tablicy wartości uzyskasz za pomocą: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: a DateTimeInput object.

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

  • A date-only picker: a DateInput object.

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

  • A time-only picker: a TimeInput object.

    Przykład: w przypadku selektora o identyfikatorze myTimePicker uzyskaj dostęp do obiektu TimeInput za pomocą parametru e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Wskazuje aplikację goszczącą, w której dodatek jest aktywny w momencie generowania obiektu zdarzenia. Możliwe wartości:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Wszelkie dodatkowe parametry, które przekazujesz działaniu za pomocą parametru actionParameters lub Action.setParameters().

Podgląd dla deweloperów: w przypadku dodatków rozszerzających Google Chat, aby sugerować użytkownikom elementy na podstawie tego, co wpisują w menu z wieloma opcjami, użyj wartości klucza "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Możesz użyć tej wartości, aby zapytać bazę danych i sugerować użytkownikom elementy do wyboru w trakcie pisania. Szczegółowe informacje znajdziesz w artykule Zbieranie i przetwarzanie informacji od użytkowników Google Chat.
commonEventObject.userLocale string
Domyślnie wyłączone. Język użytkownika i identyfikator kraju/regionu w formacie ISO 639 kod języka-ISO 3166 kod kraju/regionu. Na przykład: en-US.

Aby włączyć to pole, musisz ustawić 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 Dostęp do ustawień języka i strefy czasowej użytkownika.

commonEventObject.timeZone string
Domyślnie wyłączone. Identyfikator strefy czasowej i przesunięcie. Aby włączyć to pole, musisz ustawić wartość 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 Dostęp do ustawień języka i strefy czasowej użytkownika.
commonEventObject.timeZone.id string
Identyfikator strefy czasowej użytkownika. Przykłady:America/New_York, Europe/Vienna i Asia/Seoul. Aby włączyć to pole, musisz ustawić wartość 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 Dostęp do ustawień języka i strefy czasowej użytkownika.
commonEventObject.timeZone.offset string
przesunięcie czasowe względem uniwersalnego czasu koordynowanego (UTC) w strefie czasowej użytkownika, mierzone w milisekundach. Więcej informacji znajdziesz w artykule Dostęp do ustawień języka i strefy czasowej użytkownika.

Dane wejściowe formularza selektora daty i godziny

Funkcje wywołania zwrotnego akcji mogą otrzymywać 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 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 godziny. Różnice strukturalne zostały opisane w tabeli poniżej:

Obiekt DateTimeInput
dateTimeInput.hasDate boolean
true, jeśli podana data i godzina zawiera datę; jeśli false podana jest tylko godzina.
dateTimeInput.hasTime boolean
true, jeśli podana data i godzina zawiera godzinę; jeśli false podana jest tylko data.
dateTimeInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od epoki (00:00:00 UTC 1 stycznia 1970 r.).
Obiekt DateInput
dateInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od epoki (00:00:00 UTC 1 stycznia 1970 r.).
Obiekt TimeInput
timeInput.hours number
Numer godziny wybrany przez użytkownika.
timeInput.minutes number
Numer minuty wybrany przez użytkownika.

Obiekt zdarzenia w kalendarzu

Obiekt zdarzenia w kalendarzu to część ogólnego obiektu zdarzenia, która zawiera informacje o kalendarzu i wydarzeniach w kalendarzu użytkownika. Jest on obecny w obiekcie zdarzenia tylko wtedy, gdy aplikacją goszczącą jest Kalendarz Google.

W tabeli poniżej znajdziesz listę pól w polu 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.

Obiekt zdarzenia w kalendarzu
calendar.attendees[] list of attendee objects
Dane generowane przez użytkowników. Lista uczestników wydarzenia w kalendarzu.
calendar.calendarId string
Identyfikator kalendarza.
calendar.capabilities object
Dane wygenerowane przez użytkowników. Obiekt opisujący możliwości dodatku do wyświetlania lub aktualizowania informacji o zdarzeniu.
calendar.capabilities.canAddAttendees boolean
Dane wygenerowane przez 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 wygenerowane przez użytkowników. true jeśli dodatek może odczytać listę uczestników wydarzenia; false w przeciwnym razie.
calendar.capabilities.canSeeConferenceData boolean
Dane wygenerowane przez użytkowników. truejeśli dodatek może odczytywać dane konferencji wydarzenia; falsew przeciwnym razie.
calendar.capabilities.canSetConferenceData boolean
Dane wygenerowane przez użytkowników. true jeśli dodatek może aktualizować dane konferencji wydarzenia; false w przeciwnym razie.
calendar.capabilities.canAddAttachments boolean
Dane wygenerowane przez użytkowników. true jeśli dodatek może dodawać nowe załączniki do wydarzenia; false w przeciwnym razie.
calendar.conferenceData Conference data object
Dane generowane przez użytkowników. Obiekt reprezentujący dane konferencji powiązane z tym zdarzeniem, np. szczegóły konferencji 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 zawierają informacje o poszczególnych uczestnikach wydarzeń w Kalendarzu Google. 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.

Obiekt uczestnika
attendee.additionalGuests number
Liczba dodatkowych gości, których uczestnik zamierza zabrać ze sobą. Wartość domyślna to 0.
attendee.comment string
Komentarz uczestnika z odpowiedzią (jeśli istnieje).
attendee.displayName string
Wyświetlana nazwa uczestnika.
attendee.email string
Adres e-mail uczestnika.
attendee.optional boolean
true, jeśli uczestnictwo tego uczestnika jest oznaczone jako opcjonalne; w przeciwnym razie false.
attendee.organizer boolean
true, jeśli jest on organizatorem tego wydarzenia.
attendee.resource boolean
true jeśli uczestnik reprezentuje zasób, taki jak sala lub sprzęt; falsew przeciwnym razie.
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 ta osoba reprezentuje kalendarz, w którym znajduje się to wydarzenie; false w przeciwnym razie.

Dane konferencji

Obiekty danych konferencji zawierają informacje o konferencjach dołączonych 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ą obecne w obiekcie zdarzenia, jeśli i tylko jeśli dane są obecne w wydarzeniu w kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifest na wartość READ lub READ_WRITE.

Obiekt danych konferencji
conferenceData.conferenceId string
Identyfikator konferencji. Ten identyfikator ma na celu umożliwienie aplikacjom śledzenia konferencji. Nie powinien być wyświetlany użytkownikom.
conferenceData.conferenceSolution object
Obiekt reprezentujący rozwiązanie do konferencji, takie jak Hangouts lub Google Meet.
conferenceData.conferenceSolution.iconUri string
Identyfikator URI widocznej dla użytkownika ikony reprezentującej to rozwiązanie konferencyjne.
conferenceData.conferenceSolution.key object
Klucz, który jednoznacznie identyfikuje rozwiązanie konferencyjne dla tego zdarzenia.
conferenceData.conferenceSolution.key.type string
Typ rozwiązania do obsługi rozmów wideo. Możliwe wartości:
  • eventHangout w przypadku Hangouts dla użytkowników indywidualnych (http://hangouts.google.com).
  • eventNamedHangout dla użytkowników klasycznej wersji Hangouts (http://hangouts.google.com).
  • hangoutsMeet w Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Nazwa widoczna dla użytkownika tego rozwiązania do obsługi konferencji (nieprzetłumaczona).
conferenceData.entryPoints[] list of entry point objects
Lista punktów wejścia na konferencję, takich jak adresy URL lub numery telefonów.
conferenceData.notes string
Dodatkowe informacje (np. instrukcje administratora domeny lub powiadomienia prawne) dotyczące konferencji, które mają być wyświetlane użytkownikowi. Może zawierać kod HTML. Maksymalna długość to 2048 znaków.
conferenceData.parameters object
Obiekt zawierający mapę zdefiniowanych danych parametru do użycia przez dodatek.
conferenceData.parameters.addOnParameters object
Mapa kluczy i wartości ciągu parametru. Te klucze i wartości są definiowane przez dewelopera dodatku w celu dołączania informacji do konkretnej konferencji na potrzeby dodatku.

Punkt wejścia

Obiekty punktów dostępu zawierają informacje o ustalonych sposobach dostępu do danej konferencji, takich jak telefon lub wideo. Te informacje są obecne w obiekcie zdarzenia, jeśli i tylko jeśli dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifest na READ lub READ_WRITE.

Obiekt punktu wejścia
entryPoint.accessCode string
Kod dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy konferencji zazwyczaj używają tylko podzbioru opcji {accessCode, meetingCode, passcode, password, pin} do zapewnienia dostępu do konferencji. Dopasowywać i wyświetlać tylko pola, których używa dostawca konferencji.
entryPoint.entryPointFeatures list
Funkcje punktu wejścia. Obecnie te funkcje dotyczą tylko punktów wejścia phone:
  • toll: punkt wejścia to połączenie telefoniczne z dopłatą.
  • toll_free: punktem wejścia jest bezpłatny telefon.
entryPoint.entryPointType string
Typ punktu wejścia. Możliwe wartości:
  • more: dodatkowe instrukcje dotyczące dołączania do konferencji, takie jak alternatywne numery telefonów. Rozmowa wideo może mieć tylko jeden punkt wejściamore; jeśli jest obecny, wymagany jest co najmniej jeden inny typ punktu wejścia.
  • phone: dołącz do konferencji za pomocą numeru telefonu. Konferencja może mieć zero lub więcej punktów wejścia phone. Kalendarz Google wyświetla tylko 2 pierwsze punkty wejścia z telefonu po sformatowaniu i posortowaniu alfabetycznie.
  • sip: dołącz do konferencji przez SIP. Rozmowa wideo może mieć maksymalnie 1 sip punkt wejścia.
  • video: dołącz do konferencji przez HTTP. Rozmowa wideo może mieć maksymalnie 1 video punkt wejścia.
entryPoint.label string
Etykieta widoczna dla użytkownika dla identyfikatora URI punktu wejścia (niezlokalizowana).
entryPoint.meetingCode string
Kod spotkania używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy konferencji zazwyczaj używają tylko podzbioru opcji {accessCode, meetingCode, passcode, password, pin} do zapewnienia dostępu do konferencji. Dopasowywać i wyświetlać tylko pola, których używa dostawca konferencji.
entryPoint.passcode string
Kod dostępu używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy konferencji zazwyczaj używają tylko podzbioru opcji {accessCode, meetingCode, passcode, password, pin} do zapewnienia dostępu do konferencji. Dopasowywać i wyświetlać tylko pola, których używa dostawca konferencji.
entryPoint.password string
Hasło używane do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy konferencji zazwyczaj używają tylko podzbioru opcji {accessCode, meetingCode, passcode, password, pin} do zapewnienia dostępu do konferencji. Dopasowywać i wyświetlać tylko pola, których używa dostawca konferencji.
entryPoint.pin string
Kod PIN używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy konferencji zazwyczaj używają tylko podzbioru opcji {accessCode, meetingCode, passcode, password, pin} do zapewnienia dostępu do konferencji. Dopasowywać i wyświetlać tylko pola, których używa dostawca konferencji.
entryPoint.regionCode string
Kod regionu numeru telefonu. Potrzebny użytkownikom, jeśli identyfikator URI nie zawiera kodu kraju. Wartości są określane na podstawie publicznej listy kodów regionów CLDR.
entryPoint.uri string
Identyfikator URI punktu wejścia. Maksymalna długość to 1300 znaków. Formatowanie 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 (np. „tel:+12345678900,,,12345678;1234”).
  • sip: wymagany jest schemat sip: lub sips:. Na przykład „sip:12345678@mójdostawca.com”.
  • video: wymagany jest schemat http: lub https:.

Obiekt zdarzenia na Dysku

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

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

Element na Dysku

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

Obiekt elementu na Dysku
item.addonHasFileScopePermission boolean
Jeśli true, oznacza to, że dodatek poprosił o autoryzację w zakresie https://www.googleapis.com/auth/drive.file dla tego elementu. W przeciwnym razie to pole będzie miało wartość 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 Gmail to część ogólnego obiektu zdarzenia, który zawiera informacje o wiadomościach Gmaila użytkownika. Jest on obecny tylko w obiekcie zdarzenia, jeśli aplikacją hosta jest Gmail.

Obiekt zdarzenia Gmaila
gmail.accessToken string
Token dostępu do Gmaila. Możesz użyć tego tokena za pomocą metody GmailApp.setCurrentMessageAccessToken(accessToken), aby przyznać dodatkowi tymczasowy dostęp do aktualnie otwartej wiadomości Gmail użytkownika lub pozwolić dodatkowi tworzyć nowe wersje robocze.
gmail.bccRecipients[] list of strings
Domyślnie wyłączone. Lista adresów e-mail odbiorców „UDW”, która jest obecnie uwzględniona w projekcie tworzonym przez dodatek. Aby włączyć to pole, musisz ustawić w pliku manifestu pole addOns.gmail.composeTrigger.draftAccess na wartość METADATA.
gmail.ccRecipients[] list of strings
Domyślnie wyłączone. Lista adresów e-mail odbiorców w polu „DW:”, które są obecnie uwzględnione w projekcie tworzonym przez dodatek. Aby włączyć to pole, musisz ustawić w pliku manifestu pole addOns.gmail.composeTrigger.draftAccess na wartość METADATA.
gmail.messageId string
Identyfikator aktualnie otwartej wiadomości w Gmailu.
gmail.threadId string
Identyfikator aktualnie otwartego wątku w Gmailu.
gmail.toRecipients[] list of strings
Domyślnie wyłączone. Lista adresów e-mail odbiorców „Do:”, które są obecnie uwzględnione w projekcie tworzonym przez dodatek. Aby włączyć to pole, musisz ustawić w pliku manifestu pole addOns.gmail.composeTrigger.draftAccess na wartość METADATA.

Obiekt zdarzenia Dokumenty

Obiekt zdarzenia Docs to część ogólnego obiektu zdarzenia, który zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on obecny w obiekcie event tylko wtedy, gdy aplikacją hostującą jest Dokumenty Google.

Obiekt zdarzenia Dokumenty
docs.id string
Wyświetlany tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file.
Identyfikator dokumentu otwartego w interfejsie Dokumentów.
docs.title string
Wyświetlany tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file.
Tytuł dokumentu otwartego w interfejsie Dokumentów.
docs.addonHasFileScopePermission boolean
Jeśli true, oznacza to, że dodatek poprosił o autoryzację https://www.googleapis.com/auth/drive.filezakresu dokumentu otwartego w interfejsie Dokumentów. W przeciwnym razie to pole ma wartość false.
docs.matchedUrl.url string
Wyświetlaj tylko wtedy, gdy są spełnione te warunki:
  • https://www.googleapis.com/auth/workspace.linkpreview został autoryzowany przez użytkownika.
  • Adres URL pasuje do wzorca hosta określonego w wyzwalaczu 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ąd linków za pomocą elementów inteligentnych.

Przykład ładunku, gdy 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 w Sheets to część ogólnego obiektu zdarzenia, który zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on obecny tylko w obiekcie zdarzenia, jeśli aplikacją hostującą jest Arkusze Google.

Obiekt zdarzenia Arkuszy
sheets.id string
Wyświetlany tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file. Identyfikator arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.title string
Wyświetlana tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file. Tytuł arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.addonHasFileScopePermission boolean
Jeśli true, oznacza to, że dodatek poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file w arkuszu otwartym w interfejsie Arkuszy Google. W przeciwnym razie to pole ma wartość false.
sheets.matchedUrl.url string
Wyświetlaj tylko wtedy, gdy są spełnione te warunki:
  • https://www.googleapis.com/auth/workspace.linkpreview został autoryzowany przez użytkownika.
  • Adres URL pasuje do wzorca hosta określonego w wyzwalaczu LinkPreviewTriggers.

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

Przykład ładunku, gdy użytkownik wyświetla podgląd linku:https://www.example.com/12345

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

Obiekt zdarzenia Slides

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

Obiekt zdarzenia Slides
slides.id string
Wyświetlany tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file. Identyfikator prezentacji otwartej w interfejsie Prezentacji.
slides.title string
Wyświetlany tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file. Tytuł prezentacji otwartej w interfejsie Prezentacji.
slides.addonHasFileScopePermission boolean
Jeśli true, oznacza to, że dodatek poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file dla prezentacji otwartej w interfejsie Prezentacji Google. W przeciwnym razie to pole ma wartość false.
slides.matchedUrl.url string
Wyświetlaj tylko wtedy, gdy są spełnione te warunki:
  • https://www.googleapis.com/auth/workspace.linkpreview został autoryzowany przez użytkownika.
  • Adres URL pasuje do wzorca hosta określonego w wyzwalaczu LinkPreviewTriggers.

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

Przykład ładunku, gdy użytkownik wyświetla podgląd linku:https://www.example.com/12345

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