Obiekty zdarzenia

Na tej stronie opisano 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ń przenoszą informacje po stronie klienta o aplikacji hosta i bieżącym kontekście 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 uruchamiana jest funkcja aktywatora strony głównej. Możesz użyć tego obiektu w funkcji aktywatora strony głównej, aby zidentyfikować aktywną aplikację hosta, platformę klienta, region użytkownika i inne informacje.

    Obiekty zdarzeń utworzone po uruchomieniu aktywatorów strony głównej nie zawierają wszystkich pól uwzględnionych w innych przypadkach. Pola dotyczące widżetów i informacji kontekstowych są pomijane.

  • Reguły kontekstowe. Każda aplikacja hostowana udostępnia inny zestaw aktywatorów kontekstowych, które uruchamiają się, gdy użytkownik wejdzie w określony kontekst:

    Gdy uruchamia się aktywator kontekstowy, aplikacja hostująca wywołuje odpowiednią funkcję runFunction wymienioną w pliku manifestu dodatku, przekazując jej obiekt zdarzenia jako parametr. Obiekty zdarzeń tworzone po aktywowaniu aktywatorów kontekstowych zawierają wszystkie pola uwzględnione w obiektach zdarzeń aktywatora strony głównej oraz pola zawierające informacje kontekstowe.

  • Działania związane z widżetami. Obiekty zdarzeń zapewniają interaktywność widżetów, korzystając z tego samego modelu działania co dodatki do Gmaila. Dodatki do Google Workspace używają tych samych funkcji modułu obsługi widżetów, obiektów Action i odpowiedzi na działania. W dodatkach do Google Workspace obiekty zdarzeń działania zawierają więcej informacji, na których może działać funkcja wywołania zwrotnego.

    Obiekty zdarzeń utworzone na podstawie działań widżetów zawierają wszystkie pola uwzględnione w obiektach zdarzeń aktywatora kontekstowego oraz pola zawierające informacje o widżecie.

  • Reguły linków do podglądu W Dokumentach, Arkuszach i Prezentacjach Google możesz skonfigurować 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, uruchamia się linkPreviewTriggers, a obiekt zdarzenia zawierający link jest przekazywany do funkcji wywołania zwrotnego aktywatora. Dodatek może używać tego obiektu zdarzenia do tworzenia elementu inteligentnego i karty, które wyświetlają informacje o linku w aplikacji hostowanej. Możesz też utworzyć działania widżetu, aby użytkownicy mogli wchodzić w interakcje z kartą podglądu i jej zawartością.

  • Aktywatory 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, skonfiguruj i używaj różnych aktywatorów aplikacji do Google Chat. Każdy aktywator wysyła inny ładunek obiektu zdarzenia, który pomaga przetwarzać każdy rodzaj interakcji lub na niego reagować.

Struktura obiektu zdarzenia

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

Ze względu na zgodność wsteczną obiekty zdarzeń dodatków do Google Workspace zawierają oryginalne pola używane w obiektach zdarzeń działań dodatków w Gmailu. Te pola znajdują się w sekcji „Oryginalne pola dodatku do Gmaila” i nie są częścią commonEventObject.

Pierwotne pola dodatku w Gmailu są wycofane. Podczas tworzenia lub przenoszenia dodatku do Google Workspace używaj nowszej struktury obiektów zdarzeń. Te pola mogą zostać usunięte w przyszłej aktualizacji.

Obiekt zdarzenia
eventObject.commonEventObject Common fields object
Obiekt zawierający informacje wspólne dla wszystkich obiektów zdarzeń, niezależnie od aplikacji hostowanej.
eventObject.calendar Calendar event object
Widoczny tylko wtedy, gdy hostem wywołującym jest Kalendarz Google. Obiekt zawierający informacje o kalendarzu i wydarzeniu.
eventObject.chat Chat event object
Widoczny tylko wtedy, gdy hostem wywołującym jest Google Chat. Obiekt zawierający informacje o Google Chat.
eventObject.drive Drive event object
Widoczny 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 wywołującym jest Gmail. Obiekt zawierający informacje o Gmailu.
eventObject.docs Docs event object
Widoczny 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
Widoczny tylko wtedy, gdy hostem wywołującym są Prezentacje Google. Obiekt zawierający informacje o Prezentacjach.
Oryginalne pola dodatku w Gmailu
eventObject.messageMetadata.accessToken string
Wycofano. Token dostępu. Możesz użyć tej opcji, aby włączyć dostęp do danych użytkownika za pomocą tymczasowych zakresów dodatków w Gmailu.

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 (sieć, 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. Klucze to identyfikatory ciągów znaków powiązane z widżetami, a wartości to ciągi znaków. Obiekt zdarzenia udostępnia formInput jako wygodne rozwiązanie, gdy musisz odczytać dane z wielu widżetów z oczekiwanymi wartościami pojedynczymi, takimi jak pola tekstowe i przełączniki. W przypadku widżetów z wieloma wartościami, takich jak pola wyboru, odczytaj 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 pojedynczym elementem.

eventObject.formInputs object
Wycofano. Mapa bieżących wartości widżetów na karcie, przedstawiona 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 jednoelementowej. W przypadku widżetów z wieloma wartościami, takich jak grupy pól wyboru, wszystkie wartości są wyświetlane na liście.

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

eventObject.parameters object
Wycofano. Mapa dodatkowych parametrów, które podajesz w  Action za pomocą Action.setParameters. Klucze i wartości mapy są ciągami tekstowymi.

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 UN 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 wskazujący język użytkownika. Więcej informacji znajdziesz w artykule Uzyskiwanie dostępu do ustawień językowych 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 użytkownika. na przykład: America/New_York, Europe/Vienna i Asia/Seoul. Więcej informacji znajdziesz w artykule Dostęp do ustawień językowych 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 czasu 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ęzykowych i strefy czasowej użytkownika.

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

Obiekt zdarzenia typowego

Wspólny obiekt zdarzenia to część ogólnego obiektu zdarzenia, która przekazuje do dodatku ogólne, niezależne od hosta informacje z klienta użytkownika. Te informacje obejmują m.in. region użytkownika, aplikację hosta i platformę.

Oprócz strony głównej i aktywatorów 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 wysłać zapytanie do obiektu zdarzenia wspólnego, aby określić zawartość otwartych widżetów w kliencie użytkownika. Na przykład dodatek może znaleźć tekst wpisany przez użytkownika w widżecie TextInput w obiekcie eventObject.commentEventObject.formInputs.

Pola obiektu zdarzenia typowego
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 możesz uzyskać dostęp do wartości wpisanego tekstu za pomocą: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widżety 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 uzyskaj dostęp do tablicy wartości za pomocą: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

    Przykład: w przypadku selektora o identyfikatorze myDTPicker uzyskaj dostęp do obiektu DateTimeInput za pomocą e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: 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: 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 obiekt zdarzenia jest generowany. Możliwe wartości:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Wszelkie dodatkowe parametry, które przekazujesz do działania za pomocą actionParameters lub Action.setParameters.

Wersja przedpremierowa dla programistów: w przypadku aplikacji 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, aby wysłać zapytanie do bazy danych i sugerować użytkownikom elementy 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łączone. Identyfikator języka i kraju/regionu użytkownika w formacie kodu języka ISO 639 i kodu kraju/regionu ISO 3166. Na przykład: en-US.

Aby włączyć to pole, musisz ustawić 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ń językowych i strefy czasowej użytkownika.

commonEventObject.timeZone string
Domyślnie wyłączone. Identyfikator i przesunięcie strefy czasowej. Aby włączyć to pole, musisz ustawić 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ń językowych i strefy czasowej użytkownika.
commonEventObject.timeZone.id string
Identyfikator strefy czasowej użytkownika. na przykład: America/New_York, Europe/Vienna i Asia/Seoul. Aby włączyć to pole, musisz ustawić 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ń językowych i strefy czasowej użytkownika.
commonEventObject.timeZone.offset string
Przesunięcie czasu 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ęzykowych i strefy czasowej użytkownika.

Pola formularza wyboru daty i godziny

Funkcje wywołania zwrotnego działania mogą otrzymywać bieżące wartości widżetów w polu commonEventObject.formInputs. Obejmuje to wartości daty lub godziny wybrane przez użytkownika w widżetach selektora daty lub godziny. Struktura informacji różni się w zależności od tego, czy widżet został skonfigurowany jako selektor daty i godziny, selektor samej daty czy selektor samej godziny. Różnice strukturalne opisano w tej tabeli:

Obiekt DateTimeInput
dateTimeInput.hasDate boolean
true, jeśli data i godzina wejściowa zawiera datę; jeśli false, uwzględniana jest tylko godzina.
dateTimeInput.hasTime boolean
true, jeśli data i godzina wejściowa zawierają godzinę; jeśli false, uwzględniana jest tylko data.
dateTimeInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od epoki (godzina 00:00:00 czasu UTC 1 stycznia 1970 r.).
Obiekt DateInput
dateInput.msSinceEpoch string
Czas wybrany przez użytkownika w milisekundach od epoki (godzina 00:00:00 czasu UTC 1 stycznia 1970 r.).
Obiekt TimeInput
timeInput.hours number
Numer godziny wybrany przez użytkownika.
timeInput.minutes number
Liczba minut wybrana przez użytkownika.

Obiekt zdarzenia Google Chat

Obiekt zdarzenia Google Chat to część ogólnego obiektu zdarzenia, która zawiera informacje o interakcjach użytkownika z aplikacją do 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 wszedł w interakcję z aplikacją Google Chat.
chat.space object (Space)
Pokój czatu, w którym użytkownik wszedł w interakcję z aplikacją Google Chat.
chat.eventTime

string (Timestamp format)

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

Pole zbiorcze payload. W przypadku aktywatora Strona główna aplikacji (gdy użytkownik otwiera kartę Strona główna) parametr payload nie jest ustawiony, a parametr chat zawiera wartości chat.user i chat.eventTime.

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

object (MessagePayload)

Ładunek, który aplikacje do Google Chat otrzymują z aktywatora Wiadomość.
chat.addedToSpacePayload

object (AddedToSpacePayload)

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

object (RemovedFromSpacePayload)

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

object (ButtonClickedPayload)

Ładunek, który aplikacje do Google Chat otrzymują, gdy użytkownicy klikną przycisk w wiadomości lub na karcie. Jeśli użytkownik kliknie przycisk, aby przesłać informacje, obiekt commonEventObject.formInputs zawiera wartości zebrane od użytkownika. Szczegółowe informacje 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 Google Chat mogą używać tego obiektu zdarzenia do wypełniania sugerowanych elementów z dynamicznego źródła danych. Na przykład aby wypełnić zgłoszenia do zespołu pomocy z zewnętrznego źródła danych, aplikacja do Google Chat może wysłać zapytanie do źródła danych na podstawie tego, co użytkownik wpisze w menu, a następnie zwrócić pasujące zgłoszenia jako elementy do wyboru.

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

chat.appCommandPayload

object (AppCommandPayload)

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

Ładunek

W zależności od typu interakcji z aplikacją do Google Chat 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ść wywołującą aplikację Google Chat.
chat.messagePayload.configCompleteRedirectUri string
Adres URL, na który aplikacja do 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.
Ładunek dodany do pokoju
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Pokój 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
Określa, czy użytkownik dodaje aplikację do Google Chat do pokoju za pomocą wiadomości. Może to być na przykład @wzmianka o aplikacji do 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, na który 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.
Ładunek usunięty z pokoju
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Pokój czatu, z którego użytkownik usunął lub odinstalował aplikację do Google Chat.

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

Ładunek kliknięcia 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 czatu, w którym użytkownik kliknął przycisk w wiadomości z aplikacji do 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 oknie.

Typ wyliczeniowy DialogEventType.

Wartość pola dialogEventType może być tylko jedną z tych wartości:
TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
REQUEST_DIALOG Użytkownik prosi o okno. Na przykład używają polecenia lub klikają przycisk w wiadomości.
SUBMIT_DIALOG Użytkownik klika element interaktywny w oknie dialogowym. 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 czatu, w którym miała miejsce interakcja.
Ł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 – wiadomość z poleceniem po ukośniku.
chat.appCommandPayload.configCompleteRedirectUri string
Jeśli polecenie wymaga autoryzacji lub konfiguracji, 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.

Typ wyliczeniowy DialogEventType.

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

Typ wyliczeniowy AppCommandType.

Wartość pola 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. Występuje on w obiekcie zdarzenia tylko wtedy, gdy dodatek rozszerza Kalendarz Google.

W tabeli poniżej znajdziesz pola obecne w polu calendarEventObject obiektu zdarzenia. Pola oznaczone jako Dane wygenerowane przez użytkownika 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.

Wiele pól w tym obiekcie i jego podstrukturach jest bezpośrednio mapowanych na pola zasobu Event w interfejsie Calendar API o tej samej nazwie. Jeśli opisy pól się różnią, prawidłowe są informacje w tabeli poniżej.

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; w przeciwnym razie false.
calendar.capabilities.canSeeAttendees boolean
Dane generowane przez użytkowników. true, jeśli dodatek może odczytywać listę uczestników wydarzenia; w przeciwnym razie false.
calendar.capabilities.canSeeConferenceData boolean
Dane generowane przez użytkowników. true, jeśli dodatek może odczytywać dane rozmowy wideo w wydarzeniu; w przeciwnym razie false.
calendar.capabilities.canSetConferenceData boolean
Dane generowane przez użytkowników. true, jeśli dodatek może aktualizować dane rozmowy wideo w wydarzeniu; w przeciwnym razie false.
calendar.capabilities.canAddAttachments boolean
Dane generowane przez 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 generowane przez użytkowników. Obiekt reprezentujący dane konferencji powiązane z tym wydarzeniem, takie jak szczegóły spotkania 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 wydarzenia tylko wtedy, gdy dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess pliku manifestu na READ lub READ_WRITE.

Obiekt uczestnika
attendee.additionalGuests number
Liczba dodatkowych gości, których uczestnik zamierza przyprowadzić. Wartość domyślna to 0.
attendee.comment string
Komentarz uczestnika, jeśli został dodany.
attendee.displayName string
Wyświetlana nazwa uczestnika.
attendee.email string
Adres e-mail uczestnika.
attendee.optional boolean
true, jeśli obecność tego uczestnika jest oznaczona jako opcjonalna; w przeciwnym razie false.
attendee.organizer boolean
true, jeśli uczestnik jest organizatorem tego wydarzenia.
attendee.resource boolean
true, jeśli uczestnik reprezentuje zasób, taki jak sala lub sprzęt; false w 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 ten uczestnik reprezentuje kalendarz, w którym pojawia się to wydarzenie; w przeciwnym razie false.

Dane konferencji

Obiekty danych rozmowy wideo zawierają informacje o rozmowach wideo dołączonych do wydarzeń w Kalendarzu Google. Mogą to być rozwiązania Google do obsługi rozmów wideo, takie jak Google Meet, lub rozwiązania 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 pliku manifestu na READ lub READ_WRITE.

Obiekt danych konferencji
conferenceData.conferenceId string
Identyfikator konferencji. Ten identyfikator umożliwia aplikacjom śledzenie konferencji. Nie należy go wyświetlać użytkownikom.
conferenceData.conferenceSolution object
Obiekt reprezentujący rozwiązanie do obsługi rozmów wideo, takie jak Hangouts lub Google Meet.
conferenceData.conferenceSolution.iconUri string
Identyfikator URI ikony widocznej dla użytkownika, która reprezentuje to rozwiązanie do obsługi rozmów wideo.
conferenceData.conferenceSolution.key object
Klucz, który jednoznacznie identyfikuje rozwiązanie do obsługi rozmów wideo dla tego wydarzenia.
conferenceData.conferenceSolution.key.type string
Typ rozwiązania do obsługi rozmów wideo. Możliwe wartości:
  • eventHangout w Hangouts dla klientów indywidualnych (http://hangouts.google.com).
  • eventNamedHangout dla klasycznej wersji Hangouts dla użytkowników Google Workspace (http://hangouts.google.com).
  • hangoutsMeet dla Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Widoczna dla użytkownika nazwa tego rozwiązania do obsługi konferencji (niezlokalizowana).
conferenceData.entryPoints[] list of entry point objects
Lista punktów wejścia do rozmowy, takich jak adresy URL lub numery telefonów.
conferenceData.notes string
Dodatkowe uwagi (np. instrukcje od administratora domeny lub informacje prawne) dotyczące rozmowy wideo, 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 wykorzystania 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 dostępu do danej konferencji, np. przez telefon lub wideo. Te informacje są obecne w obiekcie wydarzenia tylko wtedy, gdy dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess pliku manifestu na READ lub READ_WRITE.

Obiekt punktu wejścia
entryPoint.accessCode string
Kod dostępu 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 te pola, których używa dostawca rozmów wideo.
entryPoint.entryPointFeatures list
Funkcje punktu wejścia. Obecnie te funkcje dotyczą tylko tych punktów wejścia phone:
  • toll: punktem wejścia jest płatne połączenie telefoniczne.
  • toll_free: punktem kontaktu jest bezpłatne połączenie telefoniczne.
entryPoint.entryPointType string
Typ punktu wejścia. Możliwe wartości:
  • more: dodatkowe instrukcje dołączania do rozmowy, np. alternatywne numery telefonów. Rozmowa wideo może mieć tylko 1 punkt wejścia more. Jeśli jest on obecny, wymagany jest też co najmniej 1 inny typ punktu wejścia.
  • phone: dołącz do konferencji, używając numeru telefonu. Konferencja może mieć 0 lub więcej punktów wejścia phone. Kalendarz Google wyświetla tylko pierwsze 2 punkty wejścia przez telefon po sformatowaniu i posortowaniu alfabetycznym.
  • 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
Widoczna dla użytkownika etykieta identyfikatora URI punktu wejścia (niezlokalizowana).
entryPoint.meetingCode string
Kod spotkania używany do uzyskania dostępu do rozmowy. 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 te pola, których używa dostawca rozmów wideo.
entryPoint.passcode string
Kod dostępu 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 te pola, których używa dostawca rozmów wideo.
entryPoint.password string
Hasło używane 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 te pola, których używa dostawca rozmów wideo.
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 te pola, których używa dostawca rozmów wideo.
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 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@myprovider.com”.
  • video: wymagany jest schemat http: lub https:.

Obiekt zdarzenia na Dysku

Obiekt zdarzenia na Dysku to część ogólnego obiektu zdarzenia, która zawiera informacje o Dysku Google użytkownika i jego zawartości. Występuje on w obiekcie zdarzenia tylko wtedy, gdy dodatek rozszerza Dysk Google.

Obiekt zdarzenia na Dysku
drive.activeCursorItem Drive item object
Obecnie 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 na Dysku zawierają informacje o konkretnych elementach na Dysku, takich jak pliki lub foldery.

Obiekt elementu na Dysku
item.addonHasFileScopePermission boolean
Jeśli true, dodatek poprosił o zakres https://www.googleapis.com/auth/drive.file i otrzymał go 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 Gmaila to część ogólnego obiektu zdarzenia, która zawiera informacje o wiadomościach użytkownika w Gmailu. Występuje on w obiekcie zdarzenia tylko wtedy, gdy aplikacją hostowaną jest Gmail.

Obiekt zdarzenia Gmaila
gmail.accessToken string
Token dostępu do Gmaila. Użyj tego tokena z metodą GmailApp.setCurrentMessageAccessToken, aby przyznać dodatkowi tymczasowy dostęp do otwartej obecnie wiadomości Gmail użytkownika lub umożliwić dodatkowi tworzenie nowych wersji roboczych.
gmail.bccRecipients[] list of strings
Domyślnie wyłączone. Lista adresów e-mail odbiorców „UDW:” obecnie uwzględnionych w wersji roboczej tworzonej przez dodatek. Aby włączyć to pole, ustaw pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.
gmail.ccRecipients[] list of strings
Domyślnie wyłączone. Lista adresów e-mail odbiorców w polu „DW” obecnie uwzględnionych w wersji roboczej tworzonej przez dodatek. Aby włączyć to pole, ustaw pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.
gmail.messageId string
Identyfikator aktualnie otwartej wiadomości w Gmailu.
gmail.threadId string
Identyfikator aktualnie otwartego wątku Gmaila.
gmail.toRecipients[] list of strings
Domyślnie wyłączone. Lista adresów e-mail odbiorców w polu „Do:” obecnie uwzględnionych w wersji roboczej tworzonej przez dodatek. Aby włączyć to pole, ustaw pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na 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. Występuje 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 zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika.
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ł dla dokumentu otwartego w interfejsie Dokumentów. W przeciwnym razie to pole ma wartość false.
docs.matchedUrl.url string
Wyświetlane tylko wtedy, gdy spełnione są te warunki:
  • Użytkownik autoryzował aplikację https://www.googleapis.com/auth/workspace.linkpreview.
  • Adres URL pasuje do wzorca hosta określonego w regule 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 linków 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 Arkuszy

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 Arkuszy
sheets.id string
Występuje tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Identyfikator arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.title string
Występuje tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Tytuł arkusza kalkulacyjnego otwartego w interfejsie Arkuszy.
sheets.addonHasFileScopePermission boolean
Jeśli true, dodatek poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file dla arkusza kalkulacyjnego otwartego w interfejsie Arkuszy i ją otrzymał. W przeciwnym razie to pole ma wartość false.
sheets.matchedUrl.url string
Wyświetlane tylko wtedy, gdy spełnione są te warunki:
  • Użytkownik autoryzował aplikację https://www.googleapis.com/auth/workspace.linkpreview.
  • Adres URL pasuje do wzorca hosta określonego w regule LinkPreviewTriggers.

Adres URL linku, który generuje podgląd w Arkuszach Google. Aby użyć tego pola, skonfiguruj LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków 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 Prezentacji

Obiekt zdarzenia Prezentacji 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 Prezentacje Google.

Obiekt zdarzenia Prezentacji
slides.id string
Występuje tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Identyfikator prezentacji otwartej w interfejsie Prezentacji.
slides.title string
Występuje tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. 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ł dla prezentacji otwartej w interfejsie Prezentacji. W przeciwnym razie to pole ma wartość false.
slides.matchedUrl.url string
Wyświetlane tylko wtedy, gdy spełnione są te warunki:
  • Użytkownik autoryzował aplikację https://www.googleapis.com/auth/workspace.linkpreview.
  • Adres URL pasuje do wzorca hosta określonego w regule LinkPreviewTriggers.

Adres URL linku, który generuje podgląd w Prezentacjach Google. Aby użyć tego pola, skonfiguruj LinkPreviewTriggers w pliku manifestu dodatku. Więcej informacji znajdziesz w artykule Wyświetlanie podglądu linków 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"
  }
}