Obiekty zdarzenia

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

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

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

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

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

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

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

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

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

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

Struktura obiektu zdarzenia

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

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

Obiekt 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.drive Drive event object
Widoczny tylko wtedy, gdy hostem połączenia jest Dysk Google. Obiekt zawierający informacje o Dysk.
eventObject.gmail Gmail event object
Widoczny tylko wtedy, gdy gospodarzem jest Gmail. Obiekt zawierający informacje z Gmaila.
eventObject.docs Docs event object
Widoczny tylko wtedy, gdy hostem wywołania są Dokumenty Google. Obiekt zawierającym informacje o Dokumentach.
eventObject.sheets Sheets event object
Widoczny tylko wtedy, gdy hostem wywołania są 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ących informacje z Prezentacji.
Oryginalne pola dodatku w Gmailu
eventObject.messageMetadata.accessToken string
Wycofano. 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 Google Workspace informacje te znajdziesz w polu eventObject.gmail.accessToken.

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

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

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

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

eventObject.formInput object
Wycofany. Mapa bieżących wartości wszystkich widżetów na karcie, z ograniczeniem do jednej wartości na widżet. klucze to identyfikatory ciągów powiązane z widżetami, a wartości są 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. Dla: wielowartościowych widżetów, takich jak pola wyboru, możesz odczytywać każdą wartość z formInputs.

W przypadku dodatków do Google Workspace te informacje znajdziesz w eventObject.commonEventObject.formInputs , widżety z pojedynczymi wartościami są reprezentowane jako tablice z argumentem jeden element.

eventObject.formInputs object
Wycofano. Mapa bieżących wartości widżetów na karcie, przedstawiona jako lista ciągów znaków. Klucze są identyfikatorów ciągu tekstowego powiązanych 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 te informacje znajdziesz w eventObject.commonEventObject.formInputs .

eventObject.parameters object
Wycofano. mapy wszystkich dodatkowych parametrów, które dostarczasz funkcji Action korzysta z: Action.setParameters() Klucze i wartości mapy są ciągi tekstowe.

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

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

W przypadku dodatków Google Workspace informacje te znajdziesz w polueventObject.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 Dostęp do ustawień języka i strefy czasowej użytkownika.

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

eventObject.userTimezone.id string
Domyślnie wycofane i wyłączone. identyfikator strefy czasowej użytkownika. na przykład: America/New_York, Europe/Vienna i Asia/Seoul. Zobacz Dostęp do ustawień regionalnych i strefy czasowej użytkownika, aby dowiedzieć się więcej.

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

eventObject.userTimezone.offset string
Domyślnie wycofane i wyłączone. przesunięcie czasowe względem uniwersalnego czasu koordynowanego (UTC) w strefie czasowej użytkownika, mierzone w milisekundach. Zobacz Dostęp do ustawień regionalnych i strefy czasowej użytkownika, aby dowiedzieć się więcej.

W przypadku dodatków do Google Workspace te informacje znajdziesz w 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. Ten informacje obejmują m.in. język użytkownika, aplikację hostującą i platformę.

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

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

Struktura obiektu wartości mapy jest w zależności od typu widżetu:

  • Widżety jednowartościowe (np. pole tekstowe): lista ciągów (tylko jeden element).

    Przykład: w przypadku widżetu wpisywania tekstu z Jako jego identyfikator wybierz employeeName, przejdź do tekstu wartość wejściowa z: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

    Przykład: w przypadku widżetu wielowartościowego z atrybutem Jako jego identyfikator wybierz participants, przejdź do wartości tablica z: 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ą parametru e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: a DateInput object.

    Przykład: w przypadku selektora o identyfikatorze myDatePicker przejdź do DateInput obiekt za pomocą e.commonEventObject.formInputs.myDatePicker.dateInput

  • A time-only picker: TimeInput object

    Przykład: w przypadku selektora o identyfikatorze myTimePicker przejdź do TimeInput obiekt za pomocą 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 podajesz w ramach Action za pomocą Action.setParameters().
commonEventObject.userLocale string
Domyślnie wyłączone. Język użytkownika i identyfikatora 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 w polu addOns.common.useLocaleFromApp ustawić wartość true w pliku manifestu dodatku. Lista zakresów dodatku musi też obejmują https://www.googleapis.com/auth/script.locale. Zobacz Dostęp do ustawień regionalnych i strefy czasowej użytkownika, aby dowiedzieć się więcej.

commonEventObject.timeZone string
Domyślnie wyłączona. Identyfikator strefy czasowej i przesunięcie. Aby włączyć to pole, musisz ustawić Z 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ć Z addOns.common.useLocaleFromApp na true w pliku manifestu dodatku. Lista zakresu dodatku musi też zawierać: https://www.googleapis.com/auth/script.locale. Zobacz Dostęp do ustawień regionalnych i strefy czasowej użytkownika, aby dowiedzieć się więcej.
commonEventObject.timeZone.offset string
przesunięcie czasu względem uniwersalnego czasu koordynowanego (UTC) strefy użytkownika strefy czasowej (w milisekundach). Zobacz Dostęp do ustawień regionalnych i strefy czasowej użytkownika, aby dowiedzieć się więcej.

Dane wejściowe formularza selektora daty i godziny

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

Obiekt DateTimeInput
dateTimeInput.hasDate boolean
true, jeśli podana data i godzina zawiera datę; jeśli false uwzględnia tylko 1 raz.
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 wydarzenia w kalendarzu

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

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

Obiekt wydarzenia w kalendarzu
calendar.attendees[] list of attendee objects
Dane użytkowników. Lista uczestników kalendarza .
calendar.calendarId string
Identyfikator kalendarza.
calendar.capabilities object
Dane wygenerowane przez użytkownika. Obiekt opis możliwości wyświetlania lub aktualizowania zdarzeń przez dodatek. i informacjami o nich.
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; false w przeciwnym razie.
calendar.capabilities.canSeeConferenceData boolean
Dane wygenerowane przez użytkownika. true jeśli dodatek może odczytywać dane konferencji wydarzenia; false w przeciwnym razie.
calendar.capabilities.canSetConferenceData boolean
Dane wygenerowane przez użytkownika. true jeśli dodatek może aktualizować dane konferencji wydarzenia; false w przeciwnym razie.
calendar.capabilities.canAddAttachments boolean
Dane wygenerowane przez użytkownika. true jeśli dodatek może dodawać nowe załączniki do wydarzenia; W przeciwnym razie: false.
calendar.conferenceData Conference data object
Dane wygenerowane przez użytkownika. 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 przekazują informacje o poszczególnych uczestnikach do Kalendarza Google zdarzeń. Te informacje są obecne w obiekcie zdarzenia, jeśli i tylko jeśli dane są obecne w zdarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifest na wartość READ lub READ_WRITE.

Obiekt uczestnika
attendee.additionalGuests number
Liczba dodatkowych gości uczestnika oświadczył, że przyjedzie. Wartość domyślna to 0.
attendee.comment string
Komentarz uczestnika z odpowiedzią (jeśli istnieje).
attendee.displayName string
Wyświetliła się 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ł 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 pojawia się to wydarzenie; W przeciwnym razie false.

Dane konferencji

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

Obiekt danych konferencji
conferenceData.conferenceId string
Identyfikator konferencji. Ten identyfikator ma umożliwianie aplikacjom śledzenia konferencji; nie powinieneś wyświetlać go użytkownikom.
conferenceData.conferenceSolution object
Obiekt reprezentujący rozwiązanie do konferencji, takie jak Hangouts lub Google Meet.
conferenceData.conferenceSolution.iconUri string
Identyfikator URI ikony widocznej dla użytkownika to rozwiązanie do obsługi konferencji.
conferenceData.conferenceSolution.key object
Klucz, który jednoznacznie identyfikuje rozwiązanie konferencyjne dla tego zdarzenia.
conferenceData.conferenceSolution.key.type string
Typ rozwiązania konferencyjnego. Możliwe wartości:
  • eventHangout w Hangouts dla klientó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 uwagi (np. instrukcje z administratora domeny lub informacji prawnych) na temat konferencji, nie są wyświetlane użytkownikowi. Może zawierać kod HTML. Maksymalna długość to 2048 znaków znaków.
conferenceData.parameters object
Obiekt zawierający mapę zdefiniowanej lokalizacji danych parametrów używanych przez dodatek.
conferenceData.parameters.addOnParameters object
Mapa kluczy i wartości ciągu parametrów. Te klucze i wartości są zdefiniowane przez programistę dodatku do dołączenia z konkretną konferencją, aby można było skorzystać z tego dodatku.

Punkt wejścia

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

Obiekt punktu wejścia
entryPoint.accessCode string
Kod dostępu do konferencji. Maksymalna długość to 128 znaków. Zwykle dostawcy usług konferencyjnych używaj tylko podzbioru: {accessCode, meetingCode, passcode, password, pin} do umożliwienia udziału w konferencjach. Dopasuj i wyświetl tylko pola przez dostawcę rozmowy wideo.
entryPoint.entryPointFeatures list
Funkcje punktu wejścia. Obecnie te funkcje mają zastosowanie tylko do phone punktów wejścia:
  • toll: punkt wejścia to płatne połączenie telefoniczne.
  • toll_free: punktem wejścia jest bezpłatny telefon.
entryPoint.entryPointType string
Typ punktu wejścia. Możliwe wartości to następujące:
  • more: dodatkowe instrukcje dołączania do konferencji, takich jak dodatkowe 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 dwa pierwsze punkty wejścia 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. O konferencja może mieć maksymalnie jeden punkt wejścia video.
entryPoint.label string
Widoczna dla użytkownika etykieta identyfikatora URI punktu wejścia (brak lokalizacji).
entryPoint.meetingCode string
Kod spotkania używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Zwykle dostawcy usług konferencyjnych używaj tylko podzbioru: {accessCode, meetingCode, passcode, password, pin} do umożliwienia udziału w konferencjach. Dopasuj i wyświetl tylko pola przez dostawcę rozmowy wideo.
entryPoint.passcode string
Hasło umożliwiające dostęp do rozmowy wideo. Maksymalna długość to 128 znaków. Zwykle dostawcy usług konferencyjnych używaj tylko podzbioru: {accessCode, meetingCode, passcode, password, pin} do umożliwienia udziału w konferencjach. Dopasuj i wyświetl tylko pola przez dostawcę rozmowy wideo.
entryPoint.password string
Hasło użyte do uzyskania dostępu do konferencji. Maksymalna długość to 128 znaków. Zwykle dostawcy usług konferencyjnych używaj tylko podzbioru: {accessCode, meetingCode, passcode, password, pin} do umożliwienia udziału w konferencjach. Dopasowywać i wyświetlać tylko pola, których używa dostawca konferencji.
entryPoint.pin string
Kod PIN, za pomocą którego uzyskano dostęp 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. Potrzebne przez jeśli identyfikator URI nie zawiera kodu kraju. Wartości są oparte na: publiczne Lista kodów regionów CLDR.
entryPoint.uri string
Identyfikator URI punktu wejścia. Maksymalna wartość ma 1300 znaków. Formatowanie zależy od punktu wejścia typ:
  • more: http: lub https: schemat jest wymagany.
  • phone: wymagany jest schemat tel:. Identyfikator URI powinien zawierać całą sekwencję wybierania (np. „tel:+12345678900,,,12345678;1234”).
  • sip: sip: lub sips: schemat jest wymagany. Na przykład „sip:12345678@mójdostawca.com”.
  • video: http: lub https: schemat jest wymagany.

Obiekt zdarzenia na Dysku

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

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 lub folderów.

Obiekt elementu na Dysku
item.addonHasFileScopePermission boolean
Jeśli true, dodatek żąda żądania i otrzymano https://www.googleapis.com/auth/drive.file zakres autoryzacji dla tego produktu; W przeciwnym razie to pole jest 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 w Gmailu użytkownika. Jest on obecny tylko w obiekcie zdarzenia, jeśli aplikacja hosta to Gmail.

Obiekt zdarzenia Gmaila
gmail.accessToken string
Token dostępu do Gmaila. Za pomocą ten token z GmailApp.setCurrentMessageAccessToken(accessToken) aby przyznać dodatkowi tymczasowy dostęp do bieżącego otwórz wiadomość w Gmailu lub zezwól dodatkowi na tworzenie nowych wersji roboczych.
gmail.bccRecipients[] list of strings
Domyślnie wyłączone. Lista „UDW:” adresy e-mail odbiorców znajdujące się obecnie w wersji roboczej trwa tworzenie dodatku. 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łączona. Lista adresów e-mail odbiorców w polu „DW:”, które są obecnie uwzględnione w wersji roboczej tworzonej 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łączona. 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 Dokumentów to część ogólnego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on dostępny tylko w , jeśli aplikacją hosta są Dokumenty Google.

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, dodatek żąda żądania i otrzymano https://www.googleapis.com/auth/drive.file autoryzacja zakresu dla dokumentu otwartego w interfejsie Dokumentów; w przeciwnym razie to to 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 jest zgodny ze wzorcem hosta określonym w aktywatorze LinkPreviewTriggers.
.
Adres URL linku generującego 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 z elementami inteligentnymi.

Przykładowy ładunek, gdy użytkownik wyświetli 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 dostępny tylko w , jeśli aplikacją hosta są Arkusze Google.

Obiekt zdarzenia Arkuszy
sheets.id string
Wyświetlana 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, dodatek żąda żądania i otrzymano https://www.googleapis.com/auth/drive.file autoryzacji zakresu dla arkusza kalkulacyjnego otwartego w interfejsie Arkuszy. w przeciwnym razie to pole to false.
sheets.matchedUrl.url string
Występuje tylko wtedy, gdy są spełnione te warunki:
  • Użytkownik https://www.googleapis.com/auth/workspace.linkpreview wyraził zgodę na wykorzystanie danych.
  • 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ądu linków z elementami inteligentnymi.

Przykładowy ładunek, gdy użytkownik wyświetli podgląd linku https://www.example.com/12345:

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

Obiekt zdarzenia w Prezentacjach

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

Obiekt zdarzenia w Prezentacjach
slides.id string
Występuje tylko wtedy, gdy został określony zakres https://www.googleapis.com/auth/drive.file autoryzowana przez użytkownika. Identyfikator prezentacji otwartej w interfejsie Prezentacji.
slides.title string
Wyświetlana 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, dodatek żąda żądania i otrzymano https://www.googleapis.com/auth/drive.file autoryzacja zakresu dla prezentacji otwartej w interfejsie Prezentacji; w przeciwnym razie to pole jest false.
slides.matchedUrl.url string
Wyświetlaj tylko wtedy, gdy są spełnione te warunki:
  • Użytkownik https://www.googleapis.com/auth/workspace.linkpreview wyraził zgodę na wykorzystanie danych.
  • Adres URL jest zgodny ze wzorcem hosta określonym 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 z elementami inteligentnymi.

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

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