Obiekty zdarzenia

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

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

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

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

    Obiekty zdarzeń tworzone podczas uruchamiania reguł na stronie głównej nie zawierają wszystkich pola uwzględnione w 2 pozostałych przypadkach, pól dotyczących widżetów i informacje kontekstowe są pomijane.

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

    Po uruchomieniu aktywatora kontekstowego aplikacja hostująca wywołuje metodę odpowiednie pola runFunction wymienione w pliku manifestu dodatku, przekazując go do jako parametru zdarzenia. Obiekty zdarzeń tworzone, gdy są kontekstowe uruchomienie reguł zawiera wszystkie pola uwzględnione w zdarzeniu reguły dotyczącej strony głównej obiektów oraz pól zawierających informacje kontekstowe.

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

Struktura obiektu zdarzenia

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

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

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
Widoczny tylko wtedy, gdy hostem połączenia jest Kalendarz Google. Obiekt który zawiera informacje o kalendarzu i wydarzeniach.
eventObject.drive Drive event object
Widoczny tylko wtedy, gdy hostem połączenia jest Dysk Google. Obiekt zawierającym informacje o Dysku.
eventObject.gmail Gmail event object
Widoczny tylko wtedy, gdy hostem połączeń jest Gmail. Obiekt zawierających 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
Widoczny tylko wtedy, gdy hostem połączenia są Prezentacje Google. Obiekt zawierających informacje z Prezentacji.
Oryginalne pola dodatków w Gmailu
eventObject.messageMetadata.accessToken string
Wycofano. Token dostępu. Za pomocą aby włączyć dostęp do danych użytkowników za pomocą tymczasowych zakresów dodatków do Gmaila.

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

eventObject.messageMetadata.messageId string
Wycofano. Identyfikator wiadomości wątku. który możesz otworzyć w interfejsie Gmaila.

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

eventObject.clientPlatform string
Wycofano. Wskazuje, gdzie zdarzenie (internet, iOS lub Android).

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

eventObject.formInput object
Wycofano. 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 formInput jako wygoda przy odczytywaniu danych z wielu widżetów oczekiwanych wartości pojedynczych, takich jak wprowadzanie tekstu 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żety na karcie, w postaci list ciągów. Klucze są identyfikatorów ciągu tekstowego powiązanych z widżetem. W przypadku widżetów jednowartościowych parametr jest przedstawiona w tablicy jednoelementowej. Widżety wielowartościowe np. grupy pól wyboru, wszystkie wartości są przedstawione w formie listy.

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 do Google Workspace te informacje znajdziesz w eventObject.commonEventObject.parameters .

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

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

eventObject.userLocale string
Domyślnie wycofane i wyłączone. dwuliterowy ISO 639 wskazujący język użytkownika. Zobacz Dostępny użytkownik język i strefę czasową, by dowiedzieć się więcej.

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. Przykłady: 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 czasu względem uniwersalnego czasu koordynowanego (UTC) strefy czasowej (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 .

Typowy obiekt zdarzenia

Wspólny obiekt zdarzenia to część ogólnego obiektu zdarzenia, która zawiera ogólne, niezależne od hosta informacje o dodatku przekazane przez klienta użytkownika. Ten informacje obejmują m.in. język użytkownika, aplikację hostującą i platformę.

Oprócz reguł na stronie głównej i reguł kontekstowych dodatki mogą tworzyć i przekazywać obiektów zdarzeń do funkcji wywołania zwrotnego działania gdy użytkownik korzysta z widżetów. Funkcja wywołania zwrotnego dodatku może wysyłać zapytania typowy obiekt zdarzenia służący do określania zawartości otwartych widżetów klienta. Dodatek może na przykład znajdować tekst wpisany przez użytkownika w TextInput w eventObject.commentEventObject.formInputs obiekt.

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 są identyfikatorami ciągów znaków z każdym widżetem.

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 przejdź do DateTimeInput obiekt za pomocą e.commonEventObject.formInputs.myDTPicker.dateTimeInput

  • A date-only picker: 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ę hosta, w której dodatek jest aktywny . Możliwe wartości to m.in. parametr :
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Dodatkowe parametry dostarczania do usługi Action przy użyciu Action.setParameters()
commonEventObject.userLocale string
Domyślnie wyłączona. 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 zakresów 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.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 zakresów 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. Obejmuje to wybrane przez użytkownika wartości daty lub godziny w selektorze daty lub godziny widżety. Struktura tych informacji różni się jednak w zależności od tego, czy widżet został skonfigurowany jako selektor daty i godziny, samej daty lub godziny . Różnice strukturalne zostały opisane w tej tabeli:

Obiekt 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 uwzględnia licznik czasu; jeśli false uwzględnia tylko datę.
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
Liczba godzin wybrana przez użytkownika.
timeInput.minutes number
Liczba minut wybrana 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 generowane przez użytkowników są: znajduje się w obiekcie wydarzenia tylko wtedy, gdy dane są dostępne w kalendarzu , a dodatek ustawi jego addOns.calendar.currentEventAccess manifestuj pole do READ lub READ_WRITE.

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 użytkowników. 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 użytkowników. true czy dodatek może odczytywać dane konferencji; false w przeciwnym razie.
calendar.capabilities.canSetConferenceData boolean
Dane użytkowników. true czy dodatek może aktualizować dane rozmowy wideo; false w przeciwnym razie.
calendar.capabilities.canAddAttachments boolean
Dane użytkowników. true jeśli dodatek może dodawać nowe załączniki do wydarzenia; W przeciwnym razie: false.
calendar.conferenceData Conference data object
Dane użytkowników. Obiekt reprezentujący dowolne dane rozmowy wideo powiązane z tym wydarzeniem, na przykład szczegóły rozmowy wideo w Google Meet.
calendar.id string
Identyfikator zdarzenia.
calendar.organizer object
Obiekt reprezentujący organizatora wydarzenia .
calendar.organizer.email string
Adres e-mail organizatora wydarzenia.
calendar.recurringEventId string
Identyfikator wydarzenia cyklicznego.

Uczestnik

Obiekty uczestników przekazują informacje o poszczególnych uczestnikach do Kalendarza Google zdarzeń. Te informacje są obecne w obiekcie zdarzenia tylko wtedy, gdy dane znajduje się w wydarzeniu w Kalendarzu, a dodatek ustawia jego addOns.calendar.currentEventAccess manifestuj pole do READ lub READ_WRITE.

Obiekt uczestnika
attendee.additionalGuests number
Liczba dodatkowych gości uczestnika oświadczył, że przyjedzie. Wartość domyślna to 0.
attendee.comment string
Komentarz uczestnika w razie potrzeby odpowiedzi
attendee.displayName string
Wyświetliła się nazwa uczestnika.
attendee.email string
Adres e-mail uczestnika.
attendee.optional boolean
true, jeśli obecność na tym wydarzeniu uczestnik jest oznaczony jako opcjonalny. W przeciwnym razie false.
attendee.organizer boolean
true, jeśli uczestnik jest organizatora tego wydarzenia.
attendee.resource boolean
true, jeśli uczestnik reprezentuje zasoby, takie jak sala lub sprzęt; false w przeciwnym razie.
attendee.responseStatus string
Stan odpowiedzi uczestnika. Możliwe wartości:
  • accepted: uczestnik zaakceptował 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 konferencyjne Google, takie jak: w Google Meet i rozmowach wideo innych firm. Te informacje są dostępne w tylko wtedy, gdy dane są obecne w wydarzeniu z Kalendarza oraz w obiekcie dodatek ustawia: addOns.calendar.currentEventAccess manifestuj pole do READ lub READ_WRITE.

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 konferencję takich jak Hangouts czy 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 na to wydarzenie.
conferenceData.conferenceSolution.key.type string
Typ rozwiązania konferencyjnego. Możliwe wartości należy uwzględnić następujące elementy:
  • eventHangout w Hangouts dla klientów indywidualnych (http://hangouts.google.com).
  • eventNamedHangout w klasycznej wersji Hangouts dla Użytkownicy Google Workspace (http://hangouts.google.com).
  • hangoutsMeet w Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Nazwa rozmowy widoczna dla użytkowników (niezlokalizowane).
conferenceData.entryPoints[] list of entry point objects
Lista punktów wejścia do konferencji, 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 użyty do uzyskania dostępu 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.entryPointFeatures list
Cechy 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: punkt wejścia to bezpłatne połączenie telefoniczne.
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. W konferencji może być tylko jedna Punkt wejścia more; jeśli występuje co najmniej jeden inny typ wymagane jest podanie punktu wejścia.
  • phone: dołącz do konferencji, używając numeru telefonu. O 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. Konferencja może mogą mieć maksymalnie jeden punkt wejścia sip.
  • 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 uzyskania dostępu 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.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. Dopasuj i wyświetl tylko pola przez dostawcę rozmowy wideo.
entryPoint.pin string
Kod PIN, za pomocą którego uzyskano dostęp 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.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 numeru (na przykład „tel:+12345678900,,12345678;1234”).
  • sip: sip: lub sips: schemat jest wymagany. Na przykład „sip:12345678@mojdostawca.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 przedstawiającej wybrany element.
item.mimeType string
Typ MIME wybranego elementu.
item.title string
Tytuł wybranego elementu.

Obiekt zdarzenia w Gmailu

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

Obiekt zdarzenia w Gmailu
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łączona. Lista „UDW:” adresy e-mail odbiorców znajdujące się obecnie w wersji roboczej trwa tworzenie dodatku. Aby włączyć to pole, musisz ustawić addOns.gmail.composeTrigger.draftAccess w pliku manifestu do METADATA
gmail.ccRecipients[] list of strings
Domyślnie wyłączona. Lista „DW:” adresy e-mail odbiorców znajdujące się obecnie w wersji roboczej trwa tworzenie dodatku. Aby włączyć to pole, musisz ustawić addOns.gmail.composeTrigger.draftAccess w pliku manifestu do 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 z „Do:” adresy e-mail odbiorców znajdujące się obecnie w wersji roboczej trwa tworzenie dodatku. Aby włączyć to pole, musisz ustawić addOns.gmail.composeTrigger.draftAccess w pliku manifestu do METADATA

Obiekt zdarzenia Dokumentów

Obiekt zdarzenia Dokumentów to część ogólnego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on dostępny tylko w , jeśli aplikacją hosta są Dokumenty Google.

Obiekt zdarzenia Dokumentów
docs.id string
Występuje tylko wtedy, gdy został określony zakres https://www.googleapis.com/auth/drive.file autoryzowane przez użytkownika.
Identyfikator dokumentu otwartego w interfejsie Dokumentów.
docs.title string
Występuje tylko wtedy, gdy został określony zakres https://www.googleapis.com/auth/drive.file autoryzowane przez użytkownika.
Tytuł dokumentu otwiera się 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
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 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 Arkuszy jest częścią ogólnego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on dostępny tylko w , jeśli aplikacją hosta są Arkusze Google.

Obiekt zdarzenia Arkuszy
sheets.id string
Występuje tylko wtedy, gdy został określony zakres https://www.googleapis.com/auth/drive.file autoryzowana przez użytkownika. Identyfikator arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.title string
Występuje tylko wtedy, gdy został określony zakres https://www.googleapis.com/auth/drive.file autoryzowana przez użytkownika. Tytuł arkusza kalkulacyjnego otwarty w Arkuszach Interfejs.
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 jest 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 jest zgodny ze wzorcem hosta określonym w aktywatorze LinkPreviewTriggers.
.
Adres URL linku generującego podgląd w Arkuszach Google. Aby użyć tego pola, musisz skonfigurować LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków 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 Prezentacji to część ogólnego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on dostępny tylko w , jeśli aplikacja hostująca to Prezentacje Google.

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 Prezentacjach Interfejs.
slides.title string
Występuje tylko wtedy, gdy został określony zakres https://www.googleapis.com/auth/drive.file autoryzowana przez użytkownika. Tytuł prezentacji otwiera się w Interfejs 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
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 jest zgodny ze wzorcem hosta określonym w aktywatorze LinkPreviewTriggers.
.
Adres URL linku generującego 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ładowy ładunek, gdy użytkownik wyświetli podgląd linku https://www.example.com/12345:

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