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 zdarzenia 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ń tworzone podczas wywołania strony głównej nie zawierają wszystkich pól uwzględnionych w 2 pozostałych przypadkach. Pomija się pola dotyczące 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 trigger, 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 za pomocą 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ądy 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 obiekt zdarzenia zawierający link jest przekazywany do funkcji wywołania zwrotnego reguły. 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. Mogą oni z nim wchodzić w interakcje, dodając go 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 z nich 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ń w dodatkach 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ń 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.chat Chat event object
Widoczny tylko wtedy, gdy gospodarzem jest Google Chat Obiekt zawierający informacje o Google Chat.
eventObject.drive Drive event object
Widoczna tylko wtedy, gdy host wywołujący 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łujący to Dokumenty Google. Obiekt zawierający informacje o dokumentach.
eventObject.sheets Sheets event object
Widoczny tylko wtedy, gdy host dzwoniący jest właścicielem Arkuszy 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 Gmaila.

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 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 (z sieci, z iOS lub z Androida).

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 listy 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. Dwucyfrowy 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 polueventObject.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 czasu użytkownika.

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

eventObject.userTimezone.id string
Wycofany i domyślnie wyłączony. Identyfikator 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 polueventObject.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 polueventObject.commonEventObject.timeZone.offset.

Obiekt wspólnego zdarzenia

Wspólny obiekt 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ł na stronie głównej i reguł kontekstowych dodatki tworzą i przekazują obiekty zdarzeń do funkcji wywołania zwrotnego 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ą: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

    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ę hosta, 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 w czasie 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.

Pola wejściowe 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 czatu

Obiekt zdarzenia czatu to część ogólnego obiektu zdarzenia, który zawiera informacje o interakcjach użytkownika z aplikacją Google Chat. Jest on obecny w obiekcie zdarzenia tylko wtedy, gdy dodatek rozszerza Google Chat.

Czat
chat.user object (User)
Użytkownik Google Chat, który korzystał z aplikacji Google Chat.
chat.space object (Space)
Pokój Google Chat, w którym użytkownik wszedł w interakcję z aplikacją Google Chat.
chat.eventTime

string (Timestamp format)

Czas, w którym nastąpiła interakcja.

Pole unii payload.

payload może być tylko jednym z tych elementów:
chat.messagePayload

object (MessagePayload)

Payload, który aplikacje Google Chat otrzymują z wyzwalacza wiadomości.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Dane, które aplikacje Google Chat otrzymują z wyzwalacza Dodano do pokoju.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Dane, które aplikacje Google Chat otrzymują z wyzwalacza Usunięty z pokoju.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Dane, które aplikacje Google Chat otrzymują, gdy użytkownicy klikają przycisk w wiadomości lub na karcie. Jeśli użytkownik kliknie przycisk, aby przesłać informacje, obiekt commonEventObject.formInputs będzie zawierać wartości zebrane od użytkownika. Więcej informacji znajdziesz w artykule Zbieranie informacji od użytkowników Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Payload, który aplikacje do obsługi czatu otrzymują, gdy użytkownicy wpisują tekst w menu wielowyboru widżetu selectionInput. Aplikacje do czatu mogą używać tego obiektu zdarzenia do wypełniania sugerowanych pozycji z dynamicznego źródła danych. Aby na przykład wypełnić zgłoszenia z zewnętrznego źródła danych, aplikacja do czatu może wysłać zapytanie do źródła danych na podstawie tego, co użytkownik wpisze w menu, a potem zwrócić wszystkie pasujące zgłoszenia jako elementy do wyboru.

Obiekt CommonEventObject.parameters['autocomplete_widget_query'] zawiera ciąg tekstowy, który użytkownik wpisze w menu.

chat.appCommandPayload

object (AppCommandPayload)

Dane, które aplikacje Google Chat otrzymują, gdy użytkownik używa polecenia z aplikacji Google Chat.

Ładunek

W zależności od typu interakcji z aplikacją do czatu zdarzenie zawiera ładunek z co najmniej 1 zasobem interfejsu Chat API.

Ładunek wiadomości
MessagePayload
chat.messagePayload.message object (Message)
Wiadomość w Google Chat, która wywołała zdarzenie.
chat.messagePayload.space object (Space)
Pokój czatu, w którym użytkownik wysłał wiadomość, która wywołała aplikację Google Chat.
chat.messagePayload.configCompleteRedirectUri string
Adres URL, do którego aplikacja Google Chat powinna przekierować użytkownika po zakończeniu procesu autoryzacji lub konfiguracji poza Google Chat. Więcej informacji znajdziesz w artykule Łączenie dodatku do Google Workspace z usługą innej firmy.

Dodano do ładunku w pokoju
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Pokój Google Chat, do którego użytkownik dodał lub zainstalował aplikację Google Chat.

Gdy administratorzy instalują aplikacje Google Chat, pole space.adminInstalled jest ustawione na true.

chat.addedToSpacePayload.interactionAdd boolean
Czy użytkownik dodał aplikację Google Chat do pokoju za pomocą wiadomości. Na przykład @wymienienie aplikacji Google Chat lub użycie polecenia. Jeśli true, Google Chat wysyła kolejny obiekt zdarzenia z messagePayload, który zawiera informacje o wiadomości.
chat.addedToSpacePayload.configCompleteRedirectUri string
Adres URL, do którego aplikacja Google Chat powinna przekierować użytkownika po zakończeniu procesu autoryzacji lub konfiguracji poza Google Chat. Więcej informacji znajdziesz w artykule Łączenie dodatku do Google Workspace z usługą innej firmy.

Usunięto z ładunku pokoju
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Pokój Google Chat, z którego użytkownik usunął lub odinstalował aplikację Google Chat.

Gdy administratorzy odinstalują aplikacje Google Chat, pole space.adminInstalled zostanie ustawione na false.

Treść ładunku po kliknięciu przycisku
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Wiadomość na czacie zawierająca przycisk, który użytkownik kliknął.
chat.buttonClickedPayload.space object (Space)
Pokój Google Chat, w którym użytkownik kliknął przycisk w wiadomości z aplikacji Google Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Czy użytkownik kliknął przycisk, aby wejść w interakcję z oknem.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Jeśli isDialogEvent to true, typ interakcji w dialogu.

Wyliczenie DialogEventType.

Wartość dialogEventType może mieć tylko jedną z tych wartości:
TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
REQUEST_DIALOG Użytkownik prosi o dialog. Użytkownik może na przykład użyć polecenia lub kliknąć przycisk w wiadomości.
SUBMIT_DIALOG Użytkownik klika element interaktywny w dialogu. Na przykład użytkownik wypełnia informacje w oknie dialogowym i klika przycisk, aby je przesłać.

Dane ładunku zaktualizowanego widżetu
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Pokój czatu, w którym miała miejsce interakcja.

Ładunek polecenia aplikacji
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadane o tym, którego polecenia użył użytkownik i jak je aktywował.
chat.appCommandPayload.space object (Space)
Pokój Google Chat, w którym użytkownik użył polecenia.
chat.appCommandPayload.thread object (Thread)
Jeśli interakcja miała miejsce w wątku, wątku czatu, w którym użytkownik użył polecenia.
chat.appCommandPayload.message object (Message)
W przypadku poleceń po ukośniku: wiadomość zawierająca polecenie po ukośniku.
chat.appCommandPayload.configCompleteRedirectUri string
Jeśli polecenie wymaga autoryzacji lub konfiguracji, adres URL, do którego użytkownik zostanie przekierowany po zakończeniu procesu poza Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Czy polecenie otwiera okno.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Typ interakcji z oknem dialogowym.

Wyliczenie DialogEventType.

Wartość dialogEventType może mieć tylko jedną z tych wartości:
TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
REQUEST_DIALOG Użytkownik prosi o dialog. Użytkownik może na przykład użyć polecenia lub kliknąć przycisk w wiadomości.
SUBMIT_DIALOG Użytkownik klika element interaktywny w dialogu. Na przykład użytkownik wypełnia informacje w oknie dialogowym i klika przycisk, aby je przesłać.
Metadane polecenia aplikacji
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

Identyfikator polecenia.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Typ polecenia.

Wyliczenie AppCommandType.

Wartość AppCommandType może mieć tylko jedną z tych wartości:
APP_COMMAND_TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
SLASH_COMMAND Użytkownik używa polecenia, wysyłając wiadomość, która zaczyna się od ukośnika /.
QUICK_COMMAND Użytkownik wybiera polecenie z menu Google Chat w obszarze odpowiedzi na wiadomość.

Obiekt zdarzenia w kalendarzu

Obiekt zdarzenia w kalendarzu to część ogólnego obiektu zdarzenia, który zawiera informacje o kalendarzu i wydarzeniach w kalendarzu użytkownika. Jest on obecny w obiekcie zdarzenia tylko wtedy, gdy dodatek rozszerza 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 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 dotyczące 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, takie jak 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 osób, które uczestnicy zamierzają 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 firm zewnętrznych. 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 konferencyjne, 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 tego rozwiązania do obsługi konferencji widoczna dla użytkownika (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 zdarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifest na wartość READ lub READ_WRITE.

Obiekt punktu wejścia
entryPoint.accessCode string
Kod dostępu do konferencji. Maksymalna długość to 128 znaków. Dostęp do konferencji zapewniają zazwyczaj tylko dostawcy konferencji, którzy używają do tego celu podzbioru funkcji {accessCode, meetingCode, passcode, password, pin}. dopasowywać i wyświetlać tylko pola używane przez dostawcę 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. Dostęp do konferencji zapewniają zazwyczaj tylko dostawcy konferencji, którzy używają do tego celu podzbioru funkcji {accessCode, meetingCode, passcode, password, pin}. 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. Dostęp do konferencji zapewniają zazwyczaj tylko dostawcy konferencji, którzy używają do tego celu podzbioru funkcji {accessCode, meetingCode, passcode, password, pin}. 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. Dostęp do konferencji zapewniają zazwyczaj tylko dostawcy konferencji, którzy używają do tego celu podzbioru funkcji {accessCode, meetingCode, passcode, password, pin}. 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. Dostęp do konferencji zapewniają zazwyczaj tylko dostawcy konferencji, którzy używają do tego celu podzbioru funkcji {accessCode, meetingCode, passcode, password, pin}. 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 dodatek rozszerza 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 produktu.
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 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 wersji roboczej tworzonej 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 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łączone. Lista adresów e-mail odbiorców „Do:”, 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.

Obiekt zdarzenia w Dokumentach

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 zdarzenia tylko wtedy, gdy dodatek rozszerza Dokumenty Google.

Obiekt zdarzenia w Dokumentach
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ę zakresu https://www.googleapis.com/auth/drive.file dla 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 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 danych payload, gdy użytkownik wyświetla podgląd linku:https://www.example.com/12345 

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

Obiekt zdarzenia w Arkuszach

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 w obiekcie zdarzenia tylko wtedy, gdy dodatek rozszerza Arkusze Google.

Obiekt zdarzenia w Arkuszach
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świetlany 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 linków za pomocą elementów inteligentnych.

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

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

Obiekt zdarzenia w Prezentacjach

Obiekt zdarzenia Slides to część ogólnego obiektu zdarzenia, który zawiera informacje o dokumencie użytkownika i jego zawartości. Jest on obecny w obiekcie zdarzenia tylko wtedy, gdy dodatek rozszerza Prezentacje Google.

Obiekt zdarzenia w Prezentacjach
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 danych payload, gdy użytkownik wyświetla podgląd linku:https://www.example.com/12345

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