Obiekty zdarzenia

Na tej stronie przedstawiono strukturę obiektów zdarzeń dodatków do Google Workspace.

Obiekty zdarzeń to struktury JSON, które są automatycznie tworzone i przekazywane jako parametry do aktywowania lub wywołania wywołania zwrotnego, gdy użytkownik korzysta z dodatku. Obiekty zdarzeń przekazują informacje po stronie klienta dotyczące aplikacji hostującej i bieżący kontekst funkcji wywołania zwrotnego po stronie dodatku.

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

  • Reguły na stronie głównej. Każda zdefiniowana przez Ciebie funkcja homepageTrigger automatycznie przekazuje obiekt zdarzenia po uruchomieniu funkcji strony głównej. Możesz użyć tego obiektu w funkcji aktywowania strony głównej do identyfikacji aktywnej aplikacji hosta, platformy klienta, regionu użytkownika i innych informacji.

    Obiekty zdarzeń utworzone podczas uruchamiania strony głównej nie zawierają wszystkich pól uwzględnionych w pozostałych dwóch przypadkach. Pola dotyczące widżetów i informacji kontekstowych są pomijane.

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

    • Gmail udostępnia kontekst kontekstowy, gdy użytkownik otwiera wiadomość, i kolejną, gdy użytkownik ją tworzy.
    • Kalendarz Google udostępnia kontekst kontekstowy, który służy do otwierania wydarzeń przez użytkowników.
    • Dysk Google udostępnia kontekst kontekstowy, który służy do wyboru plików z Dysku przez użytkowników.

    Po uruchomieniu aktywatora kontekstowego aplikacja hosta wywołuje odpowiedni element runFunction podany w pliku manifestu dodatku, przekazując obiekt zdarzenia jako parametr. Obiekty zdarzeń utworzone po uruchomieniu reguł kontekstowych zawierają wszystkie pola obiektów obiektów strony głównej oraz pola z informacjami kontekstowymi.

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

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

  • Reguły linku do podglądu (Wersja przedpremierowa). W Dokumentach Google możesz skonfigurować podgląd linków usług innych firm na podstawie określonych wzorców adresów URL. Gdy użytkownik wchodzi w interakcję z linkiem zgodnym ze wzorcem, funkcja previewLinkTrigger uruchamia się, a obiekt, który zawiera ten link, jest przekazywany do funkcji wywołania zwrotnego aktywatora. Twój dodatek może używać tego obiektu zdarzenia do tworzenia inteligentnego elementu i karty wyświetlającej informacje o linku w aplikacji hosta. Możesz też tworzyć działania widżetów, które pozwolą użytkownikom na interakcję z kartą podglądu i jej zawartością.

Struktura obiektów zdarzeń

W tabeli poniżej znajdziesz strukturę najwyższego poziomu obiektów zdarzeń dodatków do Google Workspace. Struktura obiektów zdarzeń zawiera pole najwyższego poziomu commonEventObject, które zawiera informacje niezależne od hosta. Każdy obiekt zdarzenia może też mieć jedno z tych pól najwyższego poziomu dotyczących hosta – jest to określane przez aktywną aplikację hosta: gmailEventObject, calendarEventObject lub driveEventObject.

Aby zapewnić zgodność wsteczną, obiekty zdarzeń dodatku Google Workspace zawierają też wszystkie pierwotne pola używane w obiektach zdarzeń dodatku w Gmailu. Te pola są wymienione w tabeli poniżej w sekcji „Oryginalne pola 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 typowe dla wszystkich obiektów zdarzeń, niezależnie od aplikacji hosta.
eventObject.calendar Calendar event object
Jest dostępne tylko wtedy, gdy gospodarzem spotkania jest Kalendarz Google. Obiekt zawierający informacje z kalendarza i wydarzeń.
eventObject.drive Drive event object
Jest dostępna tylko wtedy, gdy gospodarzem rozmowy jest Dysk Google. Obiekt zawierający informacje o Dysku.
eventObject.gmail Gmail event object
Jest widoczny tylko wtedy, gdy gospodarzem rozmowy jest Gmail. Obiekt zawierający informacje z Gmaila.
eventObject.docs Docs event object
Jest dostępna tylko wtedy, gdy gospodarzem spotkania jest dokument Google. Obiekt zawierający informacje z Dokumentów.
eventObject.sheets Sheets event object
Jest dostępna tylko wtedy, gdy gospodarzem rozmowy jest Arkusze Google. Obiekt zawierający informacje z Arkuszy.
eventObject.slides Slides event object
Jest dostępna tylko wtedy, gdy gospodarzem rozmowy jest Prezentacje Google. Obiekt zawierający informacje o Prezentacjach.
Oryginalne pola dodatku w Gmailu
eventObject.messageMetadata.accessToken string
Wycofane. Token dostępu. Możesz skorzystać z tej opcji, aby włączyć dostęp do danych użytkownika przy użyciu tymczasowych zakresów dodatków do Gmaila.

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

eventObject.messageMetadata.messageId string
Wycofane. Identyfikator wiadomości, który został otwarty w interfejsie Gmaila.

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

eventObject.clientPlatform string
Wycofane. Wskazuje źródło zdarzenia (sieć, iOS lub Android).

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

eventObject.formInput object
Wycofane. Mapa bieżących wartości wszystkich widżetów znajdujących się 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 – ciągi znaków. Obiekt zdarzenia to wygodne narzędzie formInput do odczytu danych z wielu widżetów z oczekiwanymi liczbami pojedynczymi, takimi jak dane tekstowe i przełączniki. W przypadku widżetów o wielu wartościach, takich jak pola wyboru, możesz czytać każdą wartość z poziomu formInputs.

W przypadku dodatków do Google Workspace informacje te znajdziesz w polu eventObject.commonEventObject.formInputs. Widżety z pojedynczymi wartościami są przedstawiane jako tablice z jednym elementem.

eventObject.formInputs object
Wycofane. Mapa bieżących wartości widżetów na karcie przedstawiona w postaci list ciągów znaków. Klucze to identyfikatory ciągów znaków powiązane z widżetem. W przypadku widżetów z jedną wartością wartość jest podawana 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
Wycofane. Mapa dodatkowych parametrów podanych przez Ciebie w narzędziu Action za pomocą narzędzia Action.setParameters(). Klucze i wartości mapy są ciągami.

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

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

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

eventObject.userLocale string
Wycofana i domyślnie wyłączona. Dwuliterowy kod w formacie ISO 639 wskazujący język użytkownika. Więcej informacji znajdziesz w sekcji Uzyskiwanie dostępu do ustawień regionalnych i strefy czasowej użytkownika.

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

eventObject.userTimezone.id string
Wycofana i domyślnie wyłączona. Identyfikator strefy czasowej strefy czasowej użytkownika. Przykłady: America/New_York, Europe/Vienna i Asia/Seoul. Więcej informacji znajdziesz w sekcji Uzyskiwanie dostępu do ustawień regionalnych 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
Wycofana i domyślnie wyłączona. Przesunięcie względem czasu uniwersalnego (UTC) strefy czasowej użytkownika (mierzone w milisekundach). Więcej informacji znajdziesz w sekcji Uzyskiwanie dostępu do ustawień regionalnych i strefy czasowej użytkownika.

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

Wspólny obiekt zdarzenia

Wspólny obiekt zdarzeń to część całego obiektu zdarzenia, która zawiera ogólne informacje niezależne od hosta od dodatku klienta. Te informacje obejmują szczegóły takie jak język użytkownika, aplikacja hosta i platforma.

Gdy użytkownik korzysta z widżetów, oprócz dodatków na stronie głównej i kontekstowych dodatków tworzy i przekazuje obiekty zdarzeń do funkcji wywołania zwrotnego działania. Funkcja wywołania zwrotnego dodatku może wysyłać zapytania do popularnych obiektów zdarzeń w celu określenia zawartości 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 („WEB”, „IOS” lub „ANDROID”).
commonEventObject.formInputs object
Mapa zawierająca bieżące wartości widżetów na wyświetlanej karcie. Klucze map to identyfikatory ciągów znaków przypisane do każdego widżetu. Każda wartość to kolejny obiekt kodu z pojedynczym kluczem "". Struktura obiektu wartości mapy zależy od typu widżetu:
  • Widżety z jedną wartością (np. pole tekstowe): lista ciągów (tylko 1 element).

    Przykład: w przypadku widżetu do wprowadzania tekstu, którego identyfikator to employeeName, wpisz wartość tego pola za pomocą: 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 z wieloma wartościami, których identyfikatorem jest 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 otwórz obiekt DateTimeInput za pomocą e.commonEventObject.formInputs.myDTPicker[""].dateTimeInput.

  • A date-only picker: DateInput object.

    Przykład: w przypadku selektora o identyfikatorze myDatePicker otwórz obiekt DateInput za pomocą e.commonEventObject.formInputs.myDatePicker[""].dateInput.

  • A time-only picker: TimeInput object.

    Przykład: w przypadku selektora o identyfikatorze myTimePicker otwórz obiekt TimeInput za pomocą 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 podajesz na stronie Action za pomocą właściwości Action.setParameters().
commonEventObject.userLocale string
Wyłączony domyślnie Identyfikator języka i kraju/regionu użytkownika w formacie kodu języka ISO 639 i kodu kraju w formacie ISO 3166. na przykład en-US.

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

commonEventObject.timeZone string
Wyłączony domyślnie Identyfikator strefy czasowej i przesunięcie. Aby włączyć to pole, w pliku manifestu dodatku ustaw addOns.common.useLocaleFromApp na true. Lista zakresów dodatku musi obejmować też https://www.googleapis.com/auth/script.locale. Więcej informacji znajdziesz w artykule na temat uzyskiwania dostępu do ustawień regionalnych 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, w pliku manifestu dodatku ustaw addOns.common.useLocaleFromApp na true. Lista zakresów dodatku musi obejmować też https://www.googleapis.com/auth/script.locale. Więcej informacji znajdziesz w sekcji Uzyskiwanie dostępu do ustawień regionalnych i strefy czasowej użytkownika.
commonEventObject.timeZone.offset string
Przesunięcie czasu względem uniwersalnego czasu koordynowanego (strefa czasowa UTC) strefy czasowej użytkownika mierzone w milisekundach. Więcej informacji znajdziesz w sekcji Uzyskiwanie dostępu do ustawień regionalnych i strefy czasowej użytkownika.

Dane w formularzu selektora daty i godziny

Funkcje wywołań zwrotnych mogą otrzymywać bieżące wartości widżetów w polu commonEventObject.formInputs. Obejmuje to wartości wybranego przez użytkownika daty i godziny w widżetach selektora daty lub godziny. Struktura informacji będzie się różnić w zależności od tego, czy widżet został skonfigurowany jako selektor daty, godziny czy selektor dat. Różnice strukturalne znajdziesz w tej tabeli:

Obiekt DataTimeInput
dateTimeInput.hasDate boolean
true, jeśli podana data zawiera datę, a false zawiera tylko godzinę.
dateTimeInput.hasTime boolean
true, jeśli podana data zawiera godzinę, a false zawiera tylko datę.
dateTimeInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od początku (00:00:00 UTC 1 stycznia 1970 roku).
Obiekt DataInput
dateInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od początku (00:00:00 UTC 1 stycznia 1970 roku).
Obiekt TimeInput
timeInput.hours number
Numer godziny wybrany przez użytkownika.
timeInput.minutes number
Numer minuty wybrany przez użytkownika.

Obiekt wydarzenia w Kalendarzu

Obiekt wydarzenia w Kalendarzu to część całego obiektu wydarzenia, która zawiera informacje o kalendarzu i wydarzeniach użytkownika. Istnieje ona w obiekcie zdarzenia tylko wtedy, gdy aplikacja hosta to Kalendarz Google.

Poniższa tabela zawiera pola, które znajdują się w polu calendarEventObject obiektu zdarzenia. Pola oznaczone jako Dane wygenerowane przez użytkownika znajdują się w obiekcie zdarzenia tylko wtedy, gdy dane są obecne w zdarzeniu Kalendarza, a dodatek ustawia w polu addOns.calendar.currentEventAccesspliku 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 możliwości dodatku w celu wyświetlania lub aktualizowania informacji o zdarzeniach.
calendar.capabilities.canAddAttendees boolean
Dane użytkowników. true, jeśli dodatek może dodawać nowych uczestników do listy uczestników wydarzenia. W przeciwnym razie false.
calendar.capabilities.canSeeAttendees boolean
Dane użytkowników. true, jeśli dodatek może odczytywać listę uczestników wydarzenia. W przeciwnym razie false.
calendar.capabilities.canSeeConferenceData boolean
Dane użytkowników. true, jeśli dodatek może odczytywać dane konferencji. W innym przypadku false.
calendar.capabilities.canSetConferenceData boolean
Dane użytkowników. true, jeśli dodatek może aktualizować dane rozmowy wideo w ramach wydarzenia. W przeciwnym razie false.
calendar.capabilities.canAddAttachments boolean
Dane użytkowników. true, jeśli dodatek może dodawać nowe załączniki do wydarzenia. W przeciwnym razie wybierz false.
calendar.conferenceData Conference data object
Dane użytkowników. Obiekt reprezentujący wszystkie dane rozmowy wideo powiązane z tym wydarzeniem, takie jak szczegóły rozmowy 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 do wydarzeń w Kalendarzu Google. Te informacje są zawarte w obiekcie zdarzenia, tylko jeśli dane są zawarte w wydarzeniu z Kalendarza, a dodatek ustawia w polu addOns.calendar.currentEventAccesspliku manifestu wartość READ lub READ_WRITE.

Obiekt uczestnika
attendee.additionalGuests number
Liczba dodatkowych gości wskazanych przez uczestnika. Wartość domyślna to zero.
attendee.comment string
Komentarz dotyczący odpowiedzi uczestnika, jeśli taki istnieje.
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; w przeciwnym razie false.
attendee.organizer boolean
true, jeśli uczestnik jest organizatorem tego wydarzenia.
attendee.resource boolean
true, jeśli uczestnik reprezentuje zasób, np. 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 dane wydarzenie się pojawia; false w przeciwnym razie

Dane konferencji

Obiekty danych rozmów wideo zawierają informacje o rozmowach wideo dołączonych do wydarzeń w Kalendarzu Google. Mogą to być rozwiązania konferencyjne Google, takie jak Google Meet, lub narzędzia do obsługi rozmów wideo innych firm. Te informacje są zawarte w obiekcie zdarzenia, tylko jeśli dane są zawarte w wydarzeniu z Kalendarza, a dodatek ustawia w polu addOns.calendar.currentEventAccesspliku manifestu pole READ lub READ_WRITE.

Obiekt danych rozmów wideo
conferenceData.conferenceId string
Identyfikator rozmowy wideo. Ten identyfikator służy do śledzenia aplikacji rozmów wideo przez aplikacje. Nie należy wyświetlać tego identyfikatora użytkownikom.
conferenceData.conferenceSolution object
Obiekt reprezentujący rozwiązanie konferencyjne, takie jak Hangouts lub Google Meet.
conferenceData.conferenceSolution.iconUri string
Identyfikator URI ikony widocznej dla użytkownika reprezentującej to rozwiązanie konferencyjne.
conferenceData.conferenceSolution.key object
Klucz, który jednoznacznie identyfikuje rozwiązanie konferencyjne dla tego wydarzenia.
conferenceData.conferenceSolution.key.type string
Typ rozwiązania konferencyjnego. Możliwe wartości:
  • eventHangout for 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
Nazwa użytkownika widoczna dla użytkownika (niezlokalizowana).
conferenceData.entryPoints[] list of entry point objects
Lista punktów wejścia konferencji, takich jak adresy URL lub numery telefonów.
conferenceData.notes string
Dodatkowe uwagi (na przykład instrukcje od administratora domeny lub informacje prawne) dotyczące rozmowy, 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 parametrów, który ma być używany przez dodatek.
conferenceData.parameters.addOnParameters object
Mapa kluczy i wartości ciągów znaków Te klucze i wartości są określane przez programistę dodatków w celu dołączenia informacji do określonej rozmowy wideo dotyczącej jego użycia.

Punkt wejścia

Obiekty punktów wejścia zawierają informacje o ustalonych sposobach dostępu do danej rozmowy wideo, np. przez telefon lub wideo. Te informacje są zawarte w obiekcie zdarzenia, tylko jeśli dane są obecne w wydarzeniu z Kalendarza, a dodatek ustawia w polu addOns.calendar.currentEventAccesspliku manifestu pole 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. Usługodawcy konferencyjne zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do rozmów wideo. Dopasuj i wyświetlaj tylko pola, których używa konferencja.
entryPoint.entryPointFeatures list
Funkcje punktu wejścia. Obecnie te funkcje mają zastosowanie tylko do phone punktów wejścia:
  • toll: punkt wejścia jest bezpłatnym numerem telefonu.
  • toll_free: połączenie telefoniczne jest bezpłatne.
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. W konferencji może występować tylko 1 punkt wejścia more, jeśli wymagany jest również co najmniej 1 inny punkt wejścia.
  • phone: dołączanie do konferencji za pomocą numeru telefonu Rozmowa wideo może mieć maksymalnie phone punktu wejścia. Kalendarz Google wyświetla tylko 2 pierwsze punkty wejścia telefonu – po sformatowaniu i posortowaniu alfabetycznym.
  • sip: dołączanie do konferencji przez SIP. Rozmowa wideo może mieć maksymalnie 1 punkt wejścia sip.
  • video: dołączanie do konferencji przez HTTP. Rozmowa wideo może mieć maksymalnie 1 punkt wejścia (video).
entryPoint.label string
Widoczne dla użytkownika etykiety z identyfikatorem URI punktu wejścia (nie zlokalizowane).
entryPoint.meetingCode string
Kod spotkania użyty do uzyskania dostępu do konferencji. Maksymalna długość to 128 znaków. Usługodawcy konferencyjne zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do rozmów wideo. Dopasuj i wyświetlaj tylko pola, których używa konferencja.
entryPoint.passcode string
Kod dostępu używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Usługodawcy konferencyjne zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do rozmów wideo. Dopasuj i wyświetlaj tylko pola, których używa konferencja.
entryPoint.password string
Hasło użyte do uzyskania dostępu do konferencji. Maksymalna długość to 128 znaków. Usługodawcy konferencyjne zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do rozmów wideo. Dopasuj i wyświetlaj tylko pola, których używa konferencja.
entryPoint.pin string
Kod PIN do wejścia w konferencję. Maksymalna długość to 128 znaków. Usługodawcy konferencyjne zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do rozmów wideo. Dopasuj i wyświetlaj tylko pola, których używa konferencja.
entryPoint.regionCode string
Kod regionu numeru telefonu. Wymagane, jeśli identyfikator URI nie zawiera kodu kraju. Wartości są oparte na publicznej liście kodów CLDR.
entryPoint.uri string
Identyfikator URI punktu wejścia. Maksymalna długość to 1300 znaków. Format formatowania 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 (na przykład „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ęść całego obiektu zdarzenia, która zawiera informacje o Dysku Google użytkownika i jego zawartości. Obiekt znajduje się w obiekcie zdarzenia tylko wtedy, gdy aplikacja hosta 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 dodatek true poprosił o przyznanie zakresu tego elementu i otrzymał https://www.googleapis.com/auth/drive.file zgodę, w przeciwnym razie pole to false.
item.id string
Identyfikator wybranego elementu.
item.iconUrl string
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ęść ogólnego obiektu zdarzenia, który zawiera informacje o wiadomościach Gmaila użytkownika. Jest ona zawarta w obiekcie zdarzenia tylko wtedy, gdy aplikacją hosta jest Gmail.

Obiekt zdarzenia Gmaila
gmail.accessToken string
Token dostępu w Gmailu. Możesz użyć tego tokena w metodzie GmailApp.setCurrentMessageAccessToken(accessToken), aby przyznać dodatkowy dostęp do aktualnie otwartej wiadomości użytkownika w Gmailu lub zezwolić mu na tworzenie nowych wersji roboczych.
gmail.bccRecipients[] list of strings
Wyłączony domyślnie Lista adresów e-mail adresatów w polu „UDW:” obecnych w wersji roboczej tworzonego dodatku. Aby włączyć to pole, musisz ustawić pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.
gmail.ccRecipients[] list of strings
Wyłączony domyślnie Lista adresów e-mail odbiorców „DW:” obecnych obecnie w wersji roboczej, w której jest tworzony dodatek. Aby włączyć to pole, musisz ustawić pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.
gmail.messageId string
Identyfikator aktualnie otwartej wiadomości w Gmailu.
gmail.threadId string
Obecny identyfikator wątku w Gmailu.
gmail.toRecipients[] list of strings
Wyłączony domyślnie Lista adresów e-mail odbiorców „Do:” obecnych w wersji roboczej tworzonego dodatku. Aby włączyć to pole, musisz ustawić pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.

Obiekt zdarzeń Dokumentów

Obiekt zdarzenia Dokumentów to część całego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Istnieje ona w obiekcie zdarzenia tylko wtedy, gdy aplikacja hosta to Dokumenty Google.

Obiekt zdarzeń Dokumentów
docs.id string
Jest widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika.
Identyfikator dokumentu otwartego w interfejsie Dokumentów.
docs.title string
Widoczny tylko wtedy, gdy użytkownik wyraził zgodę na zakres https://www.googleapis.com/auth/drive.file.
Tytuł dokumentu otworzy się w interfejsie Dokumentów.
docs.addonHasFileScopePermission boolean
Jeśli dodatek true poprosił o przyznanie dostępu do dokumentu (https://www.googleapis.com/auth/drive.file) w interfejsie Dokumentów, ale otrzymał jego https://www.googleapis.com/auth/drive.file, w przeciwnym razie pole to false.
docs.matched.url string
Jest obecny tylko wtedy, gdy są spełnione te warunki:
  • https://www.googleapis.com/auth/documents.readonly autoryzował(a) konto użytkownika.
  • URL pasuje do wzorca hosta określonego w regule LinkPreviewTriggers.

Adres URL linku generującego podgląd w Dokumentach Google. Aby korzystać z tego pola, musisz skonfigurować plik LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków w Dokumentach Google.

Obiekt zdarzenia w Arkuszach

Obiekt zdarzenia Arkuszy to część całego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Istnieje ona w obiekcie zdarzenia tylko wtedy, gdy aplikacja hosta to Arkusze Google.

Obiekt zdarzenia w Arkuszach
sheets.id string
Jest widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Identyfikator arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.title string
Jest widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Tytuł arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.addonHasFileScopePermission boolean
Jeśli dodatek true poprosił o przyznanie uprawnień do arkusza kalkulacyjnego https://www.googleapis.com/auth/drive.file w interfejsie Arkuszy i uzyskał jego https://www.googleapis.com/auth/drive.file, w przeciwnym razie pole to false.

Obiekt zdarzenia Prezentacji

Obiekt zdarzenia w Prezentacjach to część całego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Istnieje ona w obiekcie zdarzenia tylko wtedy, gdy aplikacją hostującą są Prezentacje Google.

Obiekt zdarzenia Prezentacji
slides.id string
Jest widoczny tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Identyfikator prezentacji otwartej w interfejsie Prezentacji.
slides.title string
Jest 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 dodatek true poprosił o dostęp do zakresu https://www.googleapis.com/auth/drive.file dla tej prezentacji w interfejsie Prezentacji, a w przeciwnym razie pole to false.