Obiekty zdarzenia

Na tej stronie opisujemy 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 aktywatora lub wywołania zwrotnego, gdy użytkownik wchodzi w interakcję z dodatkiem. Obiekty zdarzeń zawierają informacje po stronie klienta o aplikacji hostującej i bieżącym kontekście, które są przekazywane do funkcji wywołania zwrotnego po stronie serwera dodatku.

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

  • Reguły strony głównej Każda zdefiniowana funkcja homepageTrigger automatycznie otrzymuje obiekt zdarzenia, gdy uruchamia się funkcja reguły strony głównej. Możesz użyć tego obiektu w funkcji wywołującej stronę główną, aby zidentyfikować aktywną aplikację hosta, platformę klienta, region użytkownika i inne informacje.

    Obiekty zdarzeń tworzone podczas uruchamiania wyzwalaczy strony głównej nie zawierają wszystkich pól uwzględnionych w pozostałych 2 przypadkach. Pominięte są pola dotyczące widżetów i informacji kontekstowych.

  • Reguły kontekstowe Każda aplikacja hostująca udostępnia inny zestaw wyzwalaczy kontekstowych, które są aktywowane, gdy użytkownik znajdzie się w określonym kontekście. Na przykład:

    Gdy zostanie wywołany wyzwalacz kontekstowy, aplikacja hosta wywołuje odpowiednią funkcję runFunction wymienioną w manifeście dodatku, przekazując jej obiekt zdarzenia jako parametr. Obiekty zdarzeń tworzone po wywołaniu wyzwalaczy kontekstowych zawierają wszystkie pola uwzględnione w obiektach zdarzeń wyzwalacza strony głównej oraz pola zawierające informacje kontekstowe.

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

    Obiekty zdarzeń utworzone w wyniku działań widżetu zawierają wszystkie pola uwzględnione w obiektach zdarzeń wywołujących kontekstowo oraz pola zawierające informacje o widżecie.

  • Reguły 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 wzorców adresów URL. Gdy użytkownicy wejdą w interakcję z linkiem, który pasuje do wzorca, wywoływana jest funkcja linkPreviewTriggers, a do funkcji zwrotnej wyzwalacza przekazywany jest obiekt zdarzenia zawierający link. Dodatek może używać tego obiektu zdarzenia do tworzenia elementu inteligentnego i karty, które wyświetlają informacje o linku 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ą.

  • Triggery aplikacji Google Chat. W Google Chat dodatek jest widoczny dla użytkowników jako aplikacja Google Chat, z którą mogą oni wchodzić w interakcje, dodając ją do pokoi, wysyłając wiadomości, używając poleceń po ukośniku i wykonując inne czynności. Aby tworzyć funkcje interaktywne, musisz skonfigurować i używać różnych aktywatorów aplikacji do obsługi czatu. Każdy wyzwalacz wysyła inny ładunek obiektu zdarzenia, który pomaga przetwarzać każdy rodzaj interakcji lub na niego odpowiadać.

Struktura obiektu zdarzenia

W tabeli poniżej opisano strukturę najwyższego poziomu obiektów zdarzeń dodatków do 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 jest specyficzne dla hosta i zależy od aktywnej aplikacji hosta: gmailEventObject, calendarEventObject lub driveEventObject.

Aby zachować zgodność wsteczną, obiekty zdarzeń dodatków Google Workspace zawierają też wszystkie oryginalne pola używane w obiektach zdarzeń działań dodatków do Gmaila. Pola te są wymienione w tabeli poniżej w sekcji „Pola oryginalnego dodatku do Gmaila”; informacje w tych polach są odtwarzane 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
Występuje tylko wtedy, gdy gospodarz połączenia korzysta z Kalendarza Google. Obiekt zawierający informacje o kalendarzu i wydarzeniach.
eventObject.chat Chat event object
Występuje tylko wtedy, gdy gospodarz połączenia korzysta z Google Chat. Obiekt zawierający informacje o czacie.
eventObject.drive Drive event object
Występuje tylko wtedy, gdy hostem wywołującym jest Dysk Google. Obiekt zawierający informacje o Dysku.
eventObject.gmail Gmail event object
Występuje tylko wtedy, gdy hostem połączenia jest Gmail. Obiekt zawierający informacje o Gmailu.
eventObject.docs Docs event object
Występuje tylko wtedy, gdy hostem wywołującym są Dokumenty Google. Obiekt zawierający informacje o Dokumentach.
eventObject.sheets Sheets event object
Występuje tylko wtedy, gdy hostem wywołującym są Arkusze Google. Obiekt zawierający informacje o Arkuszach.
eventObject.slides Slides event object
Występuje tylko wtedy, gdy aplikacją wywołującą są Prezentacje Google. Obiekt zawierający informacje o Prezentacjach.
Pola oryginalnego dodatku do Gmaila
eventObject.messageMetadata.accessToken string
Wycofano. token dostępu, Możesz użyć tego ustawienia, aby włączyć dostęp do danych użytkownika za pomocą tymczasowych zakresów dodatków do Gmaila.

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

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

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

eventObject.clientPlatform string
Wycofano. Wskazuje, skąd pochodzi zdarzenie (internet, iOS lub Android).

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

eventObject.formInput object
Wycofano. Mapa bieżących wartości wszystkich widżetów formularza na karcie, ograniczona do jednej wartości na widżet. Kluczami są identyfikatory ciągów tekstowych powiązane z widżetami, a wartościami – ciągi tekstowe. Obiekt zdarzenia udostępnia formInput, co jest wygodne, gdy musisz odczytać dane z wielu widżetów z oczekiwanymi wartościami pojedynczymi, np. z pól tekstowych i przełączników. W przypadku widżetów wielowartościowych, takich jak pola wyboru, możesz odczytać każdą wartość z formInputs.

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

eventObject.formInputs object
Wycofano. Mapa bieżących wartości widżetów na karcie przedstawionych jako listy ciągów znaków. Klucze to identyfikatory ciągów znaków powiązane z widżetem. W przypadku widżetów jednowartościowych wartość jest prezentowana w tablicy z jednym elementem. 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 polu eventObject.commonEventObject.formInputs.

eventObject.parameters object
Wycofano. Mapa wszystkich dodatkowych parametrów, które przekazujesz do funkcji Action za pomocą funkcji Action.setParameters(). Klucze i wartości mapy to ciągi tekstowe.

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

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

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

eventObject.userLocale string
Wycofane i domyślnie wyłączone. Dwuliterowy kod ISO 639 określający język użytkownika. Więcej informacji znajdziesz w artykule Uzyskiwanie dostępu do ustawień regionalnych i strefy czasowej użytkownika.

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

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

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

eventObject.userTimezone.offset string
Wycofane i domyślnie wyłączone. Przesunięcie czasowe od uniwersalnego czasu koordynowanego (UTC) strefy czasowej użytkownika, mierzone w milisekundach. Więcej informacji znajdziesz w artykule Dostęp do ustawień regionalnych i strefy czasowej użytkownika.

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

Obiekt zdarzenia wspólnego

Obiekt zdarzenia wspólnego to część ogólnego obiektu zdarzenia, która przekazuje do dodatku z klienta użytkownika ogólne informacje niezależne od hosta. Te informacje obejmują szczegóły takie jak ustawienia regionalne użytkownika, aplikacja hosta i platforma.

Oprócz wywołań na stronie głównej i 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ć zapytania do wspólnego obiektu zdarzenia, aby określić zawartość otwartych widżetów na urządzeniu klienta użytkownika. Na przykład dodatek może zlokalizować 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świetlanej 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:

  • Widżety z jedną wartością (np. pole tekstowe): lista ciągów znaków (tylko 1 element).

    Przykład: w przypadku widżetu do wprowadzania tekstu o identyfikatorze employeeName uzyskaj dostęp do wartości wprowadzania tekstu za pomocą tego kodu: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

    Przykład: w przypadku widżetu z wieloma wartościami o identyfikatorze participants dostęp do tablicy wartości uzyskasz za pomocą tego kodu: 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ą 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ą 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ą e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Wskazuje aplikację hosta, w której dodatek jest aktywny, gdy generowany jest obiekt zdarzenia. Możliwe wartości to między innymi:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Wszystkie dodatkowe parametry, które przekazujesz do działania za pomocą actionParameters lub Action.setParameters().

Wersja zapoznawcza dla deweloperów: w przypadku dodatków rozszerzających Google Chat, aby sugerować elementy na podstawie tego, co użytkownicy wpisują w menu wielokrotnego wyboru, użyj wartości klucza "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Możesz użyć tej wartości do wysyłania zapytań do bazy danych i sugerowania użytkownikom elementów do wyboru podczas wpisywania. Szczegółowe informacje znajdziesz w artykule Zbieranie i przetwarzanie informacji od użytkowników Google Chat.
commonEventObject.userLocale string
Domyślnie wyłączona. Identyfikator języka i kraju/regionu użytkownika w formacie ISO 639 (kod języka) – ISO 3166 (kod kraju/regionu). Na przykład: en-US.

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

commonEventObject.timeZone string
Domyślnie wyłączona. Identyfikator strefy czasowej i przesunięcie. Aby włączyć to pole, musisz ustawić wartość addOns.common.useLocaleFromApp na true w pliku manifestu dodatku. Lista zakresów dodatku musi też zawierać https://www.googleapis.com/auth/script.locale. Więcej informacji znajdziesz w artykule Uzyskiwanie dostępu do ustawień regionalnych i strefy czasowej użytkownika.
commonEventObject.timeZone.id string
  Identyfikator strefy czasowej strefy czasowej użytkownika. Przykłady:America/New_York, Europe/Vienna i Asia/Seoul. Aby włączyć to pole, musisz ustawić wartość addOns.common.useLocaleFromApp na true w pliku manifestu dodatku. Lista zakresów dodatku musi też zawierać https://www.googleapis.com/auth/script.locale. Więcej informacji znajdziesz w artykule Dostęp do ustawień regionalnych i strefy czasowej użytkownika.
commonEventObject.timeZone.offset string
Różnica czasu użytkownika w milisekundach w stosunku do uniwersalnego czasu koordynowanego (UTC). Więcej informacji znajdziesz w artykule Dostęp do ustawień regionalnych i strefy czasowej użytkownika.

Pola formularza selektora daty i godziny

Funkcje wywołania zwrotnego działania mogą otrzymywać bieżące wartości widżetu w polu commonEventObject.formInputs. Obejmuje to wybrane 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 data i godzina wejściowa zawierają datę; jeśli false zawiera tylko godzinę.
dateTimeInput.hasTime boolean
true – jeśli data i godzina wejściowa zawiera godzinę; jeśli false zawiera 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
Godzina wybrana przez użytkownika.
timeInput.minutes number
Numer minuty wybrany przez użytkownika.

Obiekt zdarzenia czatu

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

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

string (Timestamp format)

Czas wystąpienia interakcji.

Pole unii payload.

payload może mieć tylko jedną z tych wartości:
chat.messagePayload

object (MessagePayload)

Ładunek, który aplikacje do obsługi czatu otrzymują z wyzwalacza Wiadomość.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Ładunek, który aplikacje Google Chat otrzymują z wyzwalacza Dodano do pokoju.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Ładunek, który aplikacje Google Chat otrzymują z wyzwalacza Usunięto z pokoju.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Ładunek, który aplikacje Google Chat otrzymują, gdy użytkownicy klikają przycisk w wiadomości lub 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)

Ładunek, który aplikacje do obsługi czatu otrzymują, gdy użytkownicy wpisują tekst w menu wielokrotnego wyboru widżetu selectionInput. Aplikacje do obsługi czatu mogą używać tego obiektu zdarzenia do wypełniania sugerowanych produktów z dynamicznego źródła danych. Na przykład aby wypełnić zgłoszenia pomocy z zewnętrznego źródła danych, aplikacja do czatu może wysyłać zapytania do źródła danych na podstawie tego, co użytkownik wpisuje w menu, a następnie zwracać pasujące zgłoszenia pomocy jako elementy do wyboru.

Obiekt CommonEventObject.parameters['autocomplete_widget_query'] zawiera wartość ciągu, którą użytkownik wpisuje w menu.

chat.appCommandPayload

object (AppCommandPayload)

Ładunek, który aplikacje Google Chat otrzymują, gdy użytkownik używa polecenia aplikacji Google Chat.

Ładunek

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

Ładunek wiadomości
MessagePayload
chat.messagePayload.message object (Message)
Wiadomość na czacie, 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ę do obsługi czatu.
chat.messagePayload.configCompleteRedirectUri string
Adres URL, na który aplikacja 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 kosmicznego
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Pokój w Google Chat, do którego użytkownik dodał lub w którym zainstalował aplikację Google Chat.

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

chat.addedToSpacePayload.interactionAdd boolean
Czy użytkownik dodaje aplikację Google Chat do pokoju za pomocą wiadomości. Na przykład @wzmianka aplikacji Google Chat lub użycie polecenia. Jeśli true, Chat wysyła kolejny obiekt zdarzenia z parametrem messagePayload, który zawiera informacje o wiadomości.
chat.addedToSpacePayload.configCompleteRedirectUri string
Adres URL, na który aplikacja 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 kosmicznego
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Pokój na czacie, z którego użytkownik usunął lub odinstalował aplikację Google Chat.

Gdy administratorzy odinstalowują aplikacje Google Chat, pole space.adminInstalled jest ustawione na false.

Ładunek klikniętego przycisku
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Wiadomość na czacie zawierająca przycisk, który kliknął użytkownik.
chat.buttonClickedPayload.space object (Space)
Pokój w Google Chat, w którym użytkownik kliknął przycisk w wiadomości aplikacji Google Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Informuje, czy użytkownik kliknął przycisk, aby wejść w interakcję z oknem.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Jeśli isDialogEvent ma wartość true, oznacza to typ interakcji w oknie.

Wyliczenie DialogEventType.

Wartość dialogEventType może być tylko jedną z tych wartości:
TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
REQUEST_DIALOG Użytkownik prosi o wyświetlenie okna. Na przykład używają polecenia lub klikają przycisk w wiadomości.
SUBMIT_DIALOG Użytkownik klika element interaktywny w oknie. Na przykład użytkownik wypełnia informacje w oknie i klika przycisk, aby je przesłać.

Ładunek zaktualizowanego widżetu
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Pokój na czacie, w którym doszło do interakcji.

Ładunek polecenia aplikacji
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadane dotyczące polecenia użytego przez użytkownika i sposobu jego wywołania.
chat.appCommandPayload.space object (Space)
Pokój czatu, w którym użytkownik użył polecenia.
chat.appCommandPayload.thread object (Thread)
Jeśli interakcja miała miejsce w wątku, wątek Google Chat, w którym użytkownik użył polecenia.
chat.appCommandPayload.message object (Message)
W przypadku poleceń po ukośniku jest to wiadomość zawierająca polecenie po ukośniku.
chat.appCommandPayload.configCompleteRedirectUri string
Jeśli polecenie wymaga autoryzacji lub konfiguracji, podaj adres URL, na który użytkownik zostanie przekierowany po zakończeniu procesu poza Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Określa, czy polecenie otwiera okno.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Typ interakcji z oknem.

Wyliczenie DialogEventType.

Wartość dialogEventType może być tylko jedną z tych wartości:
TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
REQUEST_DIALOG Użytkownik prosi o wyświetlenie okna. Na przykład używają polecenia lub klikają przycisk w wiadomości.
SUBMIT_DIALOG Użytkownik klika element interaktywny w oknie. Na przykład użytkownik wypełnia informacje w oknie 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 być 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 wydarzenia w kalendarzu

Obiekt wydarzenia w Kalendarzu to część ogólnego obiektu wydarzenia, która zawiera informacje o kalendarzu użytkownika i wydarzeniach w kalendarzu. Jest on obecny w obiekcie wydarzenia tylko wtedy, gdy dodatek rozszerza Kalendarz Google.

W tabeli poniżej znajdziesz pola występujące w polu calendarEventObject obiektu zdarzenia. Pola oznaczone jako Dane wygenerowane przez użytkownika występują w obiekcie zdarzenia tylko wtedy, gdy dane są obecne w zdarzeniu Kalendarza, a dodatek ustawia pole addOns.calendar.currentEventAccess manifestu na READ lub READ_WRITE.

.
Obiekt wydarzenia 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 generowane przez użytkowników Obiekt opisujący możliwości dodatku w zakresie wyświetlania i aktualizowania informacji o wydarzeniu.
calendar.capabilities.canAddAttendees boolean
Dane generowane 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 generowane przez użytkowników true jeśli dodatek może odczytać listę uczestników wydarzenia; false w przeciwnym razie.
calendar.capabilities.canSeeConferenceData boolean
Dane generowane przez użytkowników true jeśli dodatek może odczytywać dane konferencji wydarzenia; false w przeciwnym razie.
calendar.capabilities.canSetConferenceData boolean
Dane generowane przez użytkowników true jeśli dodatek może aktualizować dane konferencji wydarzenia; false w przeciwnym razie.
calendar.capabilities.canAddAttachments boolean
Dane generowane 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 wszelkie dane rozmowy wideo powiązane z tym wydarzeniem, np. 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 zawierają informacje o poszczególnych uczestnikach wydarzeń w Kalendarzu Google. Te informacje są obecne w obiekcie zdarzenia tylko wtedy, gdy dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifestu na READ lub READ_WRITE.

Obiekt uczestnika
attendee.additionalGuests number
Liczba dodatkowych gości, których uczestnik zadeklarował, że przyprowadzi. Domyślna wartość to 0.
attendee.comment string
Komentarz uczestnika, jeśli występuje.
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; false w przeciwnym razie.
attendee.organizer boolean
true jeśli uczestnik jest organizatorem tego wydarzenia.
attendee.resource boolean
true jeśli uczestnik reprezentuje zasób, np. salę lub sprzęt;false w przeciwnym razie.
attendee.responseStatus string
Stan odpowiedzi uczestnika. Możliwe wartości to:
  • 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 uczestnik reprezentuje kalendarz, w którym pojawia 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 obsługi rozmów wideo Google, takie jak Google Meet, lub rozmowy wideo innych firm. Te informacje są obecne w obiekcie wydarzenia tylko wtedy, gdy dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifest na READ lub READ_WRITE.

Obiekt danych konferencji
conferenceData.conferenceId string
Identyfikator konferencji. Ten identyfikator ma umożliwiać aplikacjom śledzenie konferencji. Nie należy go wyświetlać użytkownikom.
conferenceData.conferenceSolution object
Obiekt reprezentujący rozwiązanie do prowadzenia konferencji, np. Hangouts lub Google Meet.
conferenceData.conferenceSolution.iconUri string
Identyfikator URI ikony widocznej dla użytkownika, która reprezentuje to rozwiązanie konferencyjne.
conferenceData.conferenceSolution.key object
Klucz, który jednoznacznie identyfikuje rozwiązanie konferencyjne dla tego wydarzenia.
conferenceData.conferenceSolution.key.type string
Typ rozwiązania do obsługi konferencji. Możliwe wartości to między innymi:
  • eventHangout Hangouts dla konsumentów (http://hangouts.google.com).
  • eventNamedHangout w przypadku klasycznej wersji Hangouts dla użytkowników Google Workspace (http://hangouts.google.com).
  • hangoutsMeet Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Nazwa tego rozwiązania do obsługi konferencji widoczna dla użytkownika (nie jest zlokalizowana).
conferenceData.entryPoints[] list of entry point objects
Lista punktów wejścia na konferencję, np. adresów URL lub numerów telefonów.
conferenceData.notes string
Dodatkowe uwagi (np. instrukcje od administratora domeny lub informacje 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 parametrów do użycia przez dodatek.
conferenceData.parameters.addOnParameters object
Mapa kluczy i wartości ciągów parametrów. Te klucze i wartości są definiowane przez dewelopera dodatku, aby dołączyć informacje do konkretnej konferencji na potrzeby dodatku.

Punkt wejścia

Obiekty punktu wejścia zawierają informacje o ustalonych sposobach uzyskiwania dostępu do danej konferencji, np. przez telefon lub wideo. Te informacje są obecne w obiekcie zdarzenia tylko wtedy, gdy dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess manifestu na READ lub READ_WRITE.

Obiekt punktu wejścia
entryPoint.accessCode string
Kod dostępu używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy usług konferencyjnych zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do konferencji. Dopasuj i wyświetlaj tylko pola, których używa dostawca usług konferencyjnych.
entryPoint.entryPointFeatures list
Funkcje punktu wejścia. Obecnie te funkcje dotyczą tylko punktów wejścia phone:
  • toll: Punktem wejścia jest połączenie telefoniczne z numerem płatnym.
  • toll_free: Punktem kontaktu jest bezpłatne połączenie telefoniczne.
entryPoint.entryPointType string
Typ punktu wejścia. Możliwe wartości to:
  • more: dodatkowe instrukcje dołączania do konferencji, np. alternatywne numery telefonów. Rozmowa wideo może mieć tylko 1 punkt wejścia. Jeśli jest on obecny, wymagany jest co najmniej 1 inny typ punktu wejścia.more
  • phone: dołącz do konferencji za pomocą numeru telefonu. Konferencja może mieć zero lub więcej phone punktów wejścia. Kalendarz Google wyświetla tylko 2 pierwsze punkty wejścia do telefonu po sformatowaniu i posortowaniu ich alfabetycznie.
  • sip: dołącz do konferencji przez SIP. Rozmowa wideo może mieć maksymalnie 1 punkt wejścia sip.
  • video: dołącz do konferencji przez HTTP. Rozmowa wideo może mieć maksymalnie 1 punkt wejścia video.
entryPoint.label string
Etykieta widoczna dla użytkownika dla identyfikatora URI punktu wejścia (nie jest zlokalizowana).
entryPoint.meetingCode string
Kod spotkania użyty do uzyskania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy usług konferencyjnych zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do konferencji. Dopasuj i wyświetlaj tylko pola, których używa dostawca usług konferencyjnych.
entryPoint.passcode string
Kod dostępu używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy usług konferencyjnych zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do konferencji. Dopasuj i wyświetlaj tylko pola, których używa dostawca usług konferencyjnych.
entryPoint.password string
Hasło używane do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy usług konferencyjnych zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do konferencji. Dopasuj i wyświetlaj tylko pola, których używa dostawca usług konferencyjnych.
entryPoint.pin string
Kod PIN używany do uzyskiwania dostępu do konferencji. Maksymalna długość to 128 znaków. Dostawcy usług konferencyjnych zwykle używają tylko podzbioru {accessCode, meetingCode, passcode, password, pin}, aby zapewnić dostęp do konferencji. Dopasuj i wyświetlaj tylko pola, których używa dostawca usług konferencyjnych.
entryPoint.regionCode string
Kod regionu numeru telefonu. Wymagany przez użytkowników, jeśli identyfikator URI nie zawiera kodu kraju. Wartości są oparte na publicznej liście 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 tel:. Identyfikator URI powinien zawierać całą sekwencję wybierania numeru (np. „tel:+12345678900,,,12345678;1234”).
  • sip: wymagany jest schemat sip: lub sips:. Na przykład „sip:12345678@myprovider.com”.
  • video: wymagany jest schemat http: lub https:.

Obiekt zdarzenia na Dysku

Obiekt zdarzenia Dysku to część ogólnego obiektu zdarzenia, która 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
Obecnie aktywny element 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, dodatek poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file i ją otrzymał w przypadku tego elementu. W przeciwnym razie to pole ma wartość false.
item.id string
Identyfikator wybranego elementu.
item.iconUrl string
Adres URL ikony reprezentującej wybrany element.
item.mimeType string
Typ MIME wybranego elementu.
item.title string
Tytuł wybranego elementu.

Obiekt zdarzenia Gmaila

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

Obiekt zdarzenia Gmaila
gmail.accessToken string
Token dostępu do Gmaila. Możesz użyć tego tokena z metodą GmailApp.setCurrentMessageAccessToken(accessToken) , aby przyznać dodatkowi tymczasowy dostęp do aktualnie otwartej wiadomości w Gmailu lub umożliwić mu tworzenie nowych wersji roboczych.
gmail.bccRecipients[] list of strings
Domyślnie wyłączona. Lista adresów e-mail odbiorców „UDW:” aktualnie uwzględnionych 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łączona. Lista adresów e-mail odbiorców „DW:” obecnie uwzględnionych 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 adresatów w polu „Do:” aktualnie uwzględnionych 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 Dokumenty to część ogólnego obiektu zdarzenia, która 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
Występuje tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file.
Identyfikator dokumentu otwartego w interfejsie Dokumentów.
docs.title string
Występuje 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 poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file i ją otrzymał w przypadku dokumentu otwartego w interfejsie Dokumentów; w przeciwnym razie to pole ma wartość false.
docs.matchedUrl.url string
Występuje tylko wtedy, gdy są spełnione te warunki:
  • https://www.googleapis.com/auth/workspace.linkpreview został autoryzowany przez użytkownika.
  • Adres URL pasuje do wzorca hosta określonego w wyzwalaczu LinkPreviewTriggers.

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

Przykładowy ładunek, 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 Arkuszy to część ogólnego obiektu zdarzenia, która zawiera informacje o dokumencie użytkownika i jego zawartości. Występuje w obiekcie zdarzenia tylko wtedy, gdy dodatek rozszerza Arkusze Google.

Obiekt zdarzenia w Arkuszach
sheets.id string
Występuje tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file. Identyfikator arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.title string
Występuje 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 poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file i ją otrzymał w przypadku arkusza kalkulacyjnego otwartego w interfejsie Arkuszy; w przeciwnym razie to pole ma wartość false.
sheets.matchedUrl.url string
Występuje 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 użyć tego pola, musisz skonfigurować LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linku za pomocą elementów inteligentnych.

Przykładowy ładunek, 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 Prezentacji to część ogólnego obiektu zdarzenia, która 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
Występuje tylko wtedy, gdy użytkownik autoryzował zakres https://www.googleapis.com/auth/drive.file. Identyfikator prezentacji otwartej w interfejsie Prezentacji.
slides.title string
Występuje 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 poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file i ją otrzymał w przypadku prezentacji otwartej w interfejsie Prezentacji; w przeciwnym razie to pole ma wartość false.
slides.matchedUrl.url string
Występuje 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 użyć tego pola, musisz skonfigurować LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linku za pomocą elementów inteligentnych.

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

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