EventObject

EventObject

Zdarzenie interakcji z dodatkiem Google, które zawiera dane o interakcji użytkownika z dodatkiem w aplikacji hosta.

Obiekt zdarzenia jest przekazywany jako JSON do funkcji wywołania zwrotnego lub wyzwalacza dodatku (w przypadku Apps Script) albo do punktu końcowego https (w przypadku HTTP), gdy użytkownik wchodzi w interakcję z dodatkiem w aplikacji hosta. Obiekt zdarzenia przechowuje obiekt zdarzenia aplikacji hosta zdefiniowany przez każdą aplikację hosta, a także wspólny obiekt zdarzenia zawierający niektóre wspólne pola związane ze zdarzeniem.

Więcej informacji znajdziesz w artykule o obiektach zdarzeń.

Zapis JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
Pola
commonEventObject

object (CommonEventObject)

Obiekt zawierający informacje wspólne dla wszystkich obiektów zdarzeń, niezależnie od aplikacji hostowanej.

authorizationEventObject

object (AuthorizationEventObject)

Ustawiane tylko w przypadku żądań do punktów końcowych HTTP

Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
calendar

object (CalendarEventObject)

Widoczny tylko wtedy, gdy hostem wywołującym jest Kalendarz Google. Obiekt zawierający informacje o kalendarzu i wydarzeniu.

drive

object (DriveEventObject)

Widoczny tylko wtedy, gdy hostem wywołującym jest Dysk Google. Obiekt zawierający informacje o Dysku.

gmail

object (GmailEventObject)

Obecne tylko wtedy, gdy hostem wywołującym jest Gmail. Obiekt zawierający informacje o Gmailu.

sheets

object (SheetsEventObject)

Widoczny tylko wtedy, gdy hostem wywołującym są Arkusze Google. Obiekt zawierający informacje o Arkuszach.

slides

object (SlidesEventObject)

Wyświetlane tylko wtedy, gdy hostem wywołującym są Prezentacje Google. Obiekt zawierający informacje o Prezentacjach.

docs

object (DocsEventObject)

Widoczny tylko wtedy, gdy hostem wywołującym są Dokumenty Google. Obiekt zawierający informacje o Dokumentach.

chat

object (ChatEventObject)

Widoczny tylko wtedy, gdy hostem wywołującym jest Google Chat. Obiekt zawierający informacje o Google Chat.

workflow

object (WorkflowEventObject)

Wyświetlane tylko wtedy, gdy hostem wywołującym jest Google Workspace Studio. Obiekt zawierający informacje o przepływie pracy.

Koniec pól wykluczających się wzajemnie.

CommonEventObject

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

Oprócz aktywatorów 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.

W przypadku aplikacji do Google Chat nazwa funkcji wywołanej przez użytkownika podczas interakcji z widżetem.

Zapis JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Pola
userLocale

string

Domyślnie wyłączone. Identyfikator języka i kraju/regionu użytkownika w formacie: kod języka ISO 639-kod 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.

hostApp

enum (HostApp)

Wskazuje aplikację hosta, w której dodatek jest aktywny, gdy generowany jest obiekt zdarzenia. Możliwe wartości:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

Typ wyliczeniowy platformy, który wskazuje platformę, z której pochodzi zdarzenie (WEB, IOS lub ANDROID). Nie jest obsługiwany przez aplikacje do obsługi czatu.

timeZone

object (TimeZone)

Domyślnie wyłączone. Identyfikator strefy czasowej i przesunięcie względem uniwersalnego czasu koordynowanego (UTC). 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.

Obsługiwane tylko w przypadku typów zdarzeń CARD_CLICKED i SUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

Mapa zawierająca bieżące wartości widżetów na wyświetlanej karcie. Klucze mapy to wartości ciągu znaków name przypisane do każdego widżetu wejściowego (takiego jak TextInput.name, SelectionInput.name, DateTimePicker.name lub DecoratedText.SwitchControl.name).

Struktura obiektu wartości mapy zależy od typu widżetu:

Uwaga: poniższe przykłady są sformatowane pod kątem środowiska wykonawczego V8 w Apps Script. Jeśli używasz środowiska wykonawczego Rhino, po wartości musisz dodać [""]. Na przykład zamiast e.commonEventObject.formInputs.employeeName.stringInputs.value[0] sformatuj obiekt zdarzenia jako e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. Więcej informacji o środowiskach wykonawczych w Apps Script znajdziesz w omówieniu środowiska wykonawczego V8.

  • Widżety z jedną wartością (np. widżet TextInput lub widżet SelectionInput typu DROPDOWN lub RADIO_BUTTON): obiekt StringInputs zawierający listę z jednym elementem (lub pustą listę, jeśli nie dokonano wyboru).

Przykład: w przypadku widżetu do wprowadzania tekstu z employeeName jako name, uzyskaj dostęp do wartości wprowadzanej w polu tekstowym za pomocą: e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • Widżety z wieloma wartościami (np. widżet SelectionInput typu CHECK_BOX, SWITCH lub MULTI_SELECT): obiekt StringInputs zawierający listę ciągów znaków value wybranych elementów.

Przykład: w przypadku widżetu z wieloma wartościami, którego name to participants, dostęp do tablicy wartości można uzyskać za pomocą: e.commonEventObject.formInputs.participants.stringInputs.value.

  • Widżet DecoratedText.SwitchControl: obiekt StringInputs. Gdy selected to true, stringInputs.value zawiera pole value przełącznika (lub "", jeśli nie określono value; jeśli wiele przełączników ma ten sam name, na liście znajduje się value każdego wybranego przełącznika). Gdy selected jest false, value przełącznika jest pomijany w stringInputs.value.

  • Selektor daty i godziny (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

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

Przykład: w przypadku selektora z name o wartości myDatePicker uzyskaj dostęp do obiektu DateInput za pomocą e.commonEventObject.formInputs.myDatePicker.dateInput.

Przykład: w przypadku selektora z name o wartości myTimePicker uzyskaj dostęp do obiektu TimeInput za pomocą e.commonEventObject.formInputs.myTimePicker.timeInput.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

parameters

map (key: string, value: string)

wszelkie dodatkowe parametry, które podajesz w działaniu za pomocą actionParameters lub Action.setParameters().

Wersja przedpremierowa dla programistów: w przypadku dodatków, które rozszerzają 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.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

Nazwa funkcji do wywołania.

To pole nie jest wypełniane w przypadku dodatków do Google Workspace, które rozszerzają Google Chat. Aby otrzymywać dane funkcji, takie jak identyfikatory, dodatki rozszerzające Google Chat powinny używać pola parameters. Zobacz Tworzenie interaktywnych interfejsów aplikacji do Google Chat.

HostApp

Aplikacja Google Workspace dla dodatku do Google Workspace lub aplikacji do Google Chat.

W przypadku dodatków: aplikacja Workspace, z której uruchamiany jest dodatek do Google Workspace. W przypadku aplikacji do Google Chat aplikacją hosta jest zawsze CHAT.

Wartości w polu enum
UNSPECIFIED_HOST_APP Google nie może zidentyfikować aplikacji hosta.
GMAIL Dodatek uruchamia się z Gmaila.
CALENDAR Dodatek uruchamia się z Kalendarza Google.
DRIVE Dodatek uruchamia się z Dysku Google.
DEMO Nieużywane.
DOCS Dodatek uruchamia się z Dokumentów Google.
MEET Dodatek uruchamia się w Google Meet.
SHEETS Dodatek uruchamia się z Arkuszy Google.
SLIDES Dodatek uruchamia się z poziomu Prezentacji Google.
DRAWINGS Dodatek uruchamia się z Rysunków Google.
CHAT Aplikacja Google Chat.

Platforma

Identyfikuje platformę, z której pochodzi to wywołanie.

Wartości w polu enum
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

Identyfikator strefy czasowej i przesunięcie względem uniwersalnego czasu koordynowanego (UTC). Obsługiwane tylko w przypadku typów zdarzeń CARD_CLICKED i SUBMIT_DIALOG.

Zapis JSON
{
  "id": string,
  "offset": integer
}
Pola
id

string

Kod bazy danych stref czasowych IANA TZ, np. „America/Toronto”.

offset

integer

Przesunięcie strefy czasowej użytkownika w milisekundach względem uniwersalnego czasu koordynowanego (UTC).

Wejścia

Typy danych, które użytkownicy mogą wprowadzać na kartach lub w oknach. Typ danych wejściowych zależy od typu wartości akceptowanych przez widżet.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
Pola
Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
stringInputs

object (StringInputs)

Lista ciągów tekstowych reprezentujących wartości wprowadzane przez użytkownika w widżecie.

Jeśli widżet akceptuje tylko jedną wartość, np. widżet TextInput, lista zawiera jeden obiekt ciągu znaków. Jeśli widżet akceptuje wiele wartości, np. widżet SelectionInput z polami wyboru, lista zawiera obiekt ciągu znaków dla każdej wartości, którą użytkownik wpisze lub wybierze.

dateTimeInput

object (DateTimeInput)

Wartości wejściowe daty i godziny z widżetu DateTimePicker, który akceptuje zarówno datę, jak i godzinę.

dateInput

object (DateInput)

Wartości wejściowe daty z widżetu DateTimePicker, który akceptuje tylko wartości daty.

timeInput

object (TimeInput)

Wartości wejściowe czasu z widżetu DateTimePicker, który akceptuje tylko wartości czasu.

Koniec pól wykluczających się wzajemnie.

StringInputs

Parametr wejściowy zwykłych widżetów. W przypadku widżetów z jedną wartością jest to lista z jedną wartością. W przypadku widżetów z wieloma wartościami, takich jak pole wyboru, wyświetlane są wszystkie wartości.

Zapis JSON
{
  "value": [
    string
  ]
}
Pola
value[]

string

Lista ciągów znaków wpisanych przez użytkownika.

DateTimeInput

Wartości wejściowe daty i godziny.

Zapis JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Pola
msSinceEpoch

string (int64 format)

Czas od początku epoki uniksowej w milisekundach.

hasDate

boolean

Czy dane wejściowe datetime zawierają datę kalendarzową.

hasTime

boolean

Czy dane wejściowe datetime zawierają sygnaturę czasową.

DateInput

Wartości wejściowe daty.

Zapis JSON
{
  "msSinceEpoch": string
}
Pola
msSinceEpoch

string (int64 format)

Czas od początku epoki uniksowej w milisekundach.

TimeInput

Wartości wejściowe czasu.

Zapis JSON
{
  "hours": integer,
  "minutes": integer
}
Pola
hours

integer

Godzina w formacie 24-godzinnym.

minutes

integer

Liczba minut po godzinie. Prawidłowe wartości to od 0 do 59.

AuthorizationEventObject

Zawiera informacje o autoryzacji żądania dodatku

Zapis JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
Pola
userOAuthToken

string

Token dostępu OAuth użytkownika, autoryzowany z żądanymi zakresami. (Po rozdzieleniu zgody OAuth będzie to autoryzowane za pomocą zakresów autoryzowanych przez użytkownika)

userIdToken

string

token identyfikacji użytkownika, jeśli wymagane są odpowiednie zakresy identyfikatorów;

systemIdToken

string

token identyfikacji konta usługi dodatków do G Suite dla tego wdrożenia,

authorizedScopes[]

string

Lista zakresów OAuth, do których użytkownik przyznał dostęp.

CalendarEventObject

Obiekt zdarzenia Kalendarza to część ogólnego obiektu zdarzenia, która zawiera informacje o kalendarzu użytkownika i wydarzeniach w kalendarzu. Występuje tylko w obiekcie zdarzenia, jeśli aplikacją hostowaną jest Kalendarz Google.

W tabeli poniżej znajdziesz pola obecne w polu calendar 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 pliku manifestu na READ lub READ_WRITE.

Zapis JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Pola
id

string

Identyfikator zdarzenia.

recurringEventId

string

Identyfikator wydarzenia cyklicznego.

calendarId

string

Identyfikator kalendarza.

organizer

object (Organizer)

Obiekt reprezentujący organizatora wydarzenia.

attendees[]

object (Attendee)

Dane generowane przez użytkowników. Lista uczestników wydarzenia w kalendarzu.

conferenceData

object (ConferenceData)

Dane generowane przez użytkowników. Obiekt reprezentujący dane rozmowy wideo powiązane z tym wydarzeniem, takie jak szczegóły rozmowy wideo w Google Meet.

capabilities

object (Capabilities)

Dane generowane przez użytkowników. Obiekt opisujący możliwości dodatku w zakresie wyświetlania i aktualizowania informacji o wydarzeniu.

organizator;

Zapis JSON
{
  "email": string
}
Pola
email

string

Adres e-mail organizatora wydarzenia.

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 pliku manifestu na READ lub READ_WRITE.

Zapis JSON
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
Pola
email

string

Adres e-mail uczestnika.

displayName

string

Wyświetlana nazwa uczestnika.

organizer

boolean

true, jeśli uczestnik jest organizatorem tego wydarzenia.

self

boolean

true, jeśli ten uczestnik reprezentuje kalendarz, w którym pojawia się to wydarzenie; w przeciwnym razie false.

resource

boolean

true, jeśli uczestnik reprezentuje zasób, taki jak sala lub sprzęt; w przeciwnym razie false.

optional

boolean

true, jeśli obecność tego uczestnika jest oznaczona jako opcjonalna; w przeciwnym razie false.

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.
comment

string

Komentarz uczestnika (jeśli został dodany).

additionalGuests

integer

Liczba dodatkowych gości, których uczestnik zamierza przyprowadzić. Wartość domyślna to 0.

ConferenceData

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 zdarzenia tylko wtedy, gdy dane są obecne w wydarzeniu w Kalendarzu, a dodatek ustawia pole addOns.calendar.currentEventAccess pliku manifestu na READ lub READ_WRITE.

Zapis JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Pola
conferenceId

string

Identyfikator konferencji. Ten identyfikator umożliwia aplikacjom śledzenie konferencji. Nie należy go wyświetlać użytkownikom.

conferenceSolution

object (ConferenceSolution)

Obiekt reprezentujący rozwiązanie do obsługi rozmów wideo, takie jak Hangouts lub Google Meet.

entryPoints[]

object (EntryPoint)

Lista punktów wejścia do rozmowy, takich jak adresy URL lub numery telefonów.

notes

string

Dodatkowe uwagi (takie jak 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 liczba znaków: 2048.

parameters

object (Parameters)

Obiekt zawierający mapę zdefiniowanych danych parametrów do użycia przez dodatek.

ConferenceSolution

Zapis JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
Pola
iconUri

string

Identyfikator URI ikony widocznej dla użytkownika, która reprezentuje to rozwiązanie do obsługi rozmów wideo.

key

object (Key)

Klucz, który jednoznacznie identyfikuje rozwiązanie do obsługi rozmów wideo dla tego wydarzenia.

name

string

Nazwa tego rozwiązania do obsługi rozmów wideo widoczna dla użytkownika (niezlokalizowana).

Klucz

Zapis JSON
{
  "type": string
}
Pola
type

string

Typ rozwiązania do obsługi rozmów wideo. Możliwe wartości:

EntryPoint

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 pliku manifestu na READ lub READ_WRITE.

Zapis JSON
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
Pola
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. dopasowywać i wyświetlać tylko te pola, których używa dostawca usług konferencyjnych;

entryPointType

string

Typ punktu wejścia. Możliwe wartości:

  • more: dodatkowe instrukcje dołączania do rozmowy, takie jak alternatywne numery telefonów. Rozmowa wideo może mieć tylko 1 dodatkowy punkt wejścia. Jeśli jest on obecny, wymagany jest też co najmniej 1 inny typ punktu wejścia.
  • phone: dołącz do konferencji za pomocą numeru telefonu. Konferencja może mieć 0 lub więcej punktów wejścia telefon. Kalendarz Google wyświetla tylko pierwsze 2 punkty wejścia po sformatowaniu i posortowaniu ich w kolejności alfabetycznej.
  • sip: dołącz do konferencji przez SIP. Konferencja może mieć maksymalnie 1 punkt wejścia sip.
  • video: dołącz do konferencji przez HTTP. Konferencja może mieć maksymalnie 1 punkt wejścia wideo.
label

string

Widoczna dla użytkownika etykieta identyfikatora URI punktu wejścia (niezlokalizowana).

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. dopasowywać i wyświetlać tylko te pola, których używa dostawca usług konferencyjnych;

passcode

string

Kod dostępu używany 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. dopasowywać i wyświetlać tylko te pola, których używa dostawca usług konferencyjnych;

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. dopasowywać i wyświetlać tylko te pola, których używa dostawca usług konferencyjnych;

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. dopasowywać i wyświetlać tylko te pola, których używa dostawca usług konferencyjnych;

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:.
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.

entryPointFeatures[]

string

Funkcje punktu wejścia. Obecnie te funkcje dotyczą tylko punktów wejścia przez telefon:

  • toll: punktem wejścia jest płatne połączenie telefoniczne.
  • toll_free: punktem kontaktu jest bezpłatne połączenie telefoniczne.

Parametry

Zapis JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Pola
addOnParameters

object (AddOnParameters)

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.

AddOnParameters

Zapis JSON
{
  "parameters": {
    string: string,
    ...
  }
}
Pola
parameters

map (key: string, value: string)

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

Uprawnienia

Zapis JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Pola
canSeeAttendees

boolean

Dane wygenerowane przez użytkownika. true, jeśli dodatek może odczytać listę uczestników wydarzenia; w przeciwnym razie false.

canAddAttendees

boolean

Dane wygenerowane przez użytkownika. true, jeśli dodatek może dodawać nowych uczestników do listy uczestników wydarzenia; w przeciwnym razie false.

canSeeConferenceData

boolean

Dane wygenerowane przez użytkownika. true, jeśli dodatek może odczytywać dane konferencji zdarzenia; w przeciwnym razie false.

canSetConferenceData

boolean

Dane wygenerowane przez użytkownika. true, jeśli dodatek może aktualizować dane konferencji wydarzenia; w przeciwnym razie false.

canAddAttachments

boolean

Dane wygenerowane przez użytkownika. true, jeśli dodatek może dodawać nowe załączniki do wydarzenia; w przeciwnym razie false.

DriveEventObject

Obiekt zdarzenia na 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 aplikacją hostowaną jest Dysk Google.

Zapis JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Pola
selectedItems[]

object (DriveItemMetadata)

Lista elementów (plików lub folderów) wybranych na Dysku.

activeCursorItem

object (DriveItemMetadata)

Element na Dysku, który jest obecnie aktywny.

DriveItemMetadata

Obiekty elementów na Dysku zawierają informacje o konkretnych elementach na Dysku, takich jak pliki lub foldery.

Zapis JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
Pola
id

string

Identyfikator wybranego elementu.

iconUrl

string

Adres URL ikony reprezentującej wybrany element.

mimeType

string

Typ MIME wybranego elementu.

title

string

Tytuł wybranego elementu.

addonHasFileScopePermission

boolean

Jeśli ma wartość true, dodatek poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file dla tego elementu i ją otrzymał. W przeciwnym razie to pole ma wartość false.

Jeśli dodatek używa zakresu o większych uprawnieniach, takiego jak https://www.googleapis.com/auth/drive lub https://www.googleapis.com/auth/drive.readonly, to pole nie ma znaczenia. Podczas projektowania dodatków zawsze używaj najmniej restrykcyjnych zakresów, aby chronić informacje o użytkownikach.

GmailEventObject

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ą hostującą jest Gmail.

Zapis JSON
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
Pola
messageId

string

Identyfikator aktualnie otwartej wiadomości w Gmailu.

threadId

string

Identyfikator aktualnie otwartego wątku Gmaila.

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 użytkownika w Gmailu lub umożliwić dodatkowi tworzenie nowych wersji roboczych.

toRecipients[]

string

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, musisz ustawić pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.

ccRecipients[]

string

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, musisz ustawić pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.

bccRecipients[]

string

Domyślnie wyłączone. Lista adresów e-mail odbiorców w polu „UDW:” obecnie uwzględnionych w wersji roboczej tworzonej przez dodatek. Aby włączyć to pole, musisz ustawić pole addOns.gmail.composeTrigger.draftAccess w pliku manifestu na METADATA.

SheetsEventObject

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

Zapis JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Pola
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.

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.

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.

matchedUrl

object (MatchedUrl)

Wyświetla się 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.

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 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"
  }
}

MatchedUrl

Obiekt zdarzenia zwracany z prośbami o podgląd linku.

Zapis JSON
{
  "url": string
}
Pola
url

string

Adres URL, który został dopasowany.

SlidesEventObject

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.

Zapis JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Pola
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.

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.

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.

matchedUrl

object (MatchedUrl)

Wyświetla się 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, 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:

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

DocsEventObject

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.

Zapis JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Pola
id

string

Występuje tylko wtedy, gdy zakres https://www.googleapis.com/auth/drive.file został autoryzowany przez użytkownika. Identyfikator dokumentu otwartego w interfejsie Dokumentów.

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.

addonHasFileScopePermission

boolean

Jeśli true, dodatek poprosił o autoryzację zakresu https://www.googleapis.com/auth/drive.file dla dokumentu otwartego w interfejsie Dokumentów i otrzymał ją. W przeciwnym razie to pole ma wartość false.

matchedUrl

object (MatchedUrl)

Wyświetla się 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.

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"
  }
}

ChatEventObject

Ładunek obiektu zdarzenia aplikacji Google Chat wysyłany z serwera Google do dodatków. Ładunki mogą służyć do identyfikowania typu zdarzenia.

Zapis JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
Pola
type

enum (EventType)

Typ zdarzenia, wypełniany tylko w przypadku zdarzeń na stronie głównej aplikacji w aplikacjach do Google Chat, które nie są dodatkami.

user

object (User)

użytkownik, który wchodzi w interakcję z aplikacją Google Chat;

space

object (Space)

Pokój, w którym wystąpiło zdarzenie. Wartość jest podawana tylko w przypadku zdarzeń na stronie głównej aplikacji w aplikacjach do Google Chat, które nie są dodatkami.

eventTime

string (Timestamp format)

Sygnatura czasowa wskazująca, kiedy występuje obiekt zdarzenia.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

Ładunek obiektu zdarzenia. Ładunki zależą od typu obiektu zdarzenia. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
messagePayload

object (MessagePayload)

Użytkownik wysyła wiadomość do aplikacji Google Chat lub dodaje w pokoju wzmiankę o niej. Wywołania poleceń aplikacji (takich jak polecenia po ukośniku i szybkie polecenia) są dostarczane w appCommandPayload.

addedToSpacePayload

object (AddedToSpacePayload)

Użytkownik dodaje aplikację Google Chat do pokoju czatu lub administrator Google Workspace instaluje aplikację Google Chat w pokojach czatu dla użytkowników w organizacji.

removedFromSpacePayload

object (RemovedFromSpacePayload)

Użytkownik usuwa aplikację do Google Chat z pokoju.

buttonClickedPayload

object (ButtonClickedPayload)

Reprezentuje dane ładunku, gdy użytkownik wchodzi w interakcję z elementem interaktywnym karty lub okna, który wywołuje wywołanie zwrotne Action. Pomimo nazwy ten ładunek jest wypełniany w przypadku wszystkich wywołań zwrotnych Action kart i okien – nie tylko kliknięć przycisków, ale także aktywatorów onChangeAction, działań onClick, kliknięć CardAction oraz przesyłania lub anulowania okna (SUBMIT_DIALOG i CANCEL_DIALOG).

Jeśli użytkownik wejdzie w interakcję z oknem, pole isDialogEvent obiektu ButtonClickedPayload zostanie ustawione na true i będzie zawierać DialogEventType.

Pełny ładunek zawiera też parametry commonEventObject.formInputs i commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

Użytkownik aktualizuje widżet na karcie In-Stream lub w oknie.

Pełny ładunek zawiera też CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Użytkownik wywołuje polecenie aplikacji.

systemCommandPayload

object (SystemCommandPayload)

Użytkownik wywołuje polecenie systemowe.

Koniec pól wykluczających się wzajemnie.

EventType

Typ zdarzenia, wypełniany tylko w przypadku zdarzeń na stronie głównej aplikacji w aplikacjach do Google Chat, które nie są dodatkami.

Wartości w polu enum
EVENT_TYPE_UNSPECIFIED Wartość domyślna typu wyliczeniowego. NIE UŻYWAĆ.
APP_HOME Użytkownik otwiera czat z aplikacji do Google Chat, która korzysta z strony głównej aplikacji. W przypadku zdarzeń tego typu uwzględniane są tylko pola type, user i space. Więcej informacji znajdziesz w artykule Tworzenie strony głównej aplikacji Google Chat.
SUBMIT_FORM Użytkownik przesyła informacje na karcie głównej aplikacji. W przypadku zdarzeń tego typu uwzględniane są tylko pola type, user i space. Więcej informacji znajdziesz w artykule [Tworzenie strony głównej aplikacji Google Chat](https://developers.google.com/workspace/chat/send-app-home-card-message)).

MessagePayload

Użytkownik wysyła wiadomość do aplikacji Google Chat lub dodaje w pokoju wzmiankę o niej. Wywołania poleceń aplikacji (takich jak polecenia po ukośniku i szybkie polecenia) używają zamiast tego AppCommandPayload.

Zapis JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Pola
space

object (Space)

Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia.

message

object (Message)

Wiadomość, która wyzwala obiekt zdarzenia.

configCompleteRedirectUri

string

Opcjonalnie: 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 aplikacji Google Chat z innymi usługami i narzędziami.

AddedToSpacePayload

Użytkownik dodaje aplikację do Google Chat do pokoju lub tworzony jest czat między aplikacją a użytkownikiem.

Zapis JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Pola
space

object (Space)

Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia.

interactionAdd

boolean

Czy aplikacja została dodana do pokoju w wyniku interakcji użytkownika (np. przez @ wzmiankę o aplikacji do Google Chat lub wywołanie jej za pomocą polecenia po ukośniku). Jeśli ta opcja ma wartość „true”, do aplikacji Google Chat zostanie wysłany osobny obiekt zdarzenia powiązany z interakcją.

configCompleteRedirectUri

string

Opcjonalnie: 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 aplikacji Google Chat z innymi usługami i narzędziami.

RemovedFromSpacePayload

Użytkownik usuwa aplikację do Google Chat z pokoju.

Zapis JSON
{
  "space": {
    object (Space)
  }
}
Pola
space

object (Space)

Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia.

ButtonClickedPayload

Użytkownik wchodzi w interakcję z elementem interaktywnym karty lub okna z dodatku do Google Chat, który aktywuje wywołanie zwrotne Action. Pomimo nazwy ten ładunek jest wypełniany w przypadku wszystkich wywołań zwrotnych Action kart i okien, w tym kliknięć przycisków, aktywatorów onChangeAction, działań onClick, kliknięć CardAction oraz przesyłania lub anulowania okna (SUBMIT_DIALOG i CANCEL_DIALOG).

Jeśli użytkownik wejdzie w interakcję z oknem, pole isDialogEvent obiektu ButtonClickedPayload zostanie ustawione na true i będzie zawierać DialogEventType. Ten ładunek jest mapowany na typy zdarzeń SUBMIT_FORM i CARD_CLICKED w przypadku aplikacji do obsługi czatu, które nie są dodatkami.

Pełny ładunek zawiera też parametry CommonEventObject.form_inputs i CommonEventObject.parameters.

Zapis JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Pola
space

object (Space)

Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia.

message

object (Message)

Wiadomość, która wyzwala obiekt zdarzenia.

isDialogEvent

boolean

W przypadku obiektów zdarzeń ButtonClicked i Message – informacja o tym, czy użytkownik wchodzi lub zamierza wejść w interakcję z oknem.

dialogEventType

enum (DialogEventType)

Typ odebranego obiektu zdarzenia okna.

DialogEventType

W przypadku obiektów zdarzeń, które zawierają ładunki zdarzeń ButtonClicked lub AppCommand, typy interakcji z oknami.

Więcej informacji o obiektach zdarzeń aplikacji Google Chat znajdziesz w artykule Odbieranie interakcji z aplikacją Google Chat i odpowiadanie na nie.

Wartości w polu enum
DIALOG_EVENT_TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
REQUEST_DIALOG Użytkownik otwiera okno.
SUBMIT_DIALOG Użytkownik klika element interaktywny okna. Na przykład użytkownik wypełnia informacje w oknie i klika przycisk, aby je przesłać.
CANCEL_DIALOG Użytkownik zamyka okno bez przesyłania informacji lub okno zostaje anulowane.

WidgetUpdatedPayload

Użytkownik aktualizuje widżet na karcie In-Stream lub w oknie.

Pełny ładunek zawiera też CommonEventObject.parameters['autocomplete_widget_query'].

Zapis JSON
{
  "space": {
    object (Space)
  }
}
Pola
space

object (Space)

Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia.

AppCommandPayload

Użytkownik wywołuje polecenie aplikacji.

Zapis JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Pola
appCommandMetadata

object (AppCommandMetadata)

Wypełniane w przypadku poleceń aplikacji, w tym poleceń po ukośniku i szybkich poleceń.

space

object (Space)

Opcjonalnie: Pokój czatu, w którym występuje obiekt zdarzenia.

thread

object (Thread)

Opcjonalnie: Wątek, w którym występuje obiekt zdarzenia (jeśli dotyczy). To pole jest wypełniane, jeśli obiekt zdarzenia jest powiązany z konkretną wiadomością lub wątkiem.

message

object (Message)

Opcjonalnie: Wiadomość, która wyzwala obiekt zdarzenia (jeśli dotyczy). To pole jest wypełniane tylko w przypadku poleceń po ukośniku.

configCompleteRedirectUri

string

Opcjonalnie: Adres URL, na który użytkownik powinien zostać przekierowany po zakończeniu procesu autoryzacji lub konfiguracji poza Google Chat. Więcej informacji znajdziesz w artykule Łączenie aplikacji Google Chat z innymi usługami i narzędziami.

isDialogEvent

boolean

Opcjonalnie: Czy użytkownik wchodzi w interakcję z oknem lub zamierza to zrobić.

dialogEventType

enum (DialogEventType)

Opcjonalnie: Typ odebranego obiektu zdarzenia okna. To pole ma zastosowanie tylko wtedy, gdy isDialogEvent to true.

AppCommandMetadata

Metadane dotyczące polecenia aplikacji Google Chat.

Zapis JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Pola
appCommandId

integer

Identyfikator polecenia określony w konfiguracji interfejsu Chat API.

appCommandType

enum (AppCommandType)

Typ polecenia aplikacji do Google Chat.

AppCommandType

Typ polecenia aplikacji do Google Chat. Więcej informacji znajdziesz w artykule Typy poleceń aplikacji do Google Chat.

Wartości w polu enum
APP_COMMAND_TYPE_UNSPECIFIED Wartość domyślna. Nie określono.
SLASH_COMMAND polecenie po ukośniku, Użytkownik wysyła polecenie w wiadomości na czacie.
QUICK_COMMAND Szybkie polecenie. Użytkownik wybiera polecenie z menu Google Chat w obszarze odpowiedzi na wiadomość.
MESSAGE_ACTION Działanie związane z wiadomością. Użytkownik wybiera polecenie z menu kontekstowego wiadomości w Google Chat.

SystemCommandPayload

Użytkownik wywołuje polecenie systemowe.

Zapis JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Pola
systemCommandMetadata

object (SystemCommandMetadata)

Metadane dotyczące wywołanego polecenia systemowego.

space

string

Opcjonalnie: Pokój czatu, w którym występuje obiekt zdarzenia.

thread

object (Thread)

Opcjonalnie: Wątek, w którym występuje obiekt zdarzenia (jeśli dotyczy). To pole jest wypełniane, jeśli obiekt zdarzenia jest powiązany z konkretną wiadomością lub wątkiem.

SystemCommandMetadata

Metadane dotyczące polecenia systemowego wywołanego przez użytkownika.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
Pola
Wywołane polecenie systemowe. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
cancelStream

object (CancelStream)

Polecenie anulowania aktywnej wiadomości strumieniowej.

Koniec pól wykluczających się wzajemnie.

CancelStream

Polecenie anulowania aktywnej wiadomości strumieniowej.

Zapis JSON
{
  "streamMessage": string
}
Pola
streamMessage

string

Wymagane. Nazwa zasobu wiadomości strumieniowej, na której wykonano polecenie anulowania.

Format: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange Obiekt zdarzenia przekazywany do dodatków do przepływu pracy.

Zapis JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
Pola
executionMetadata

object (ExecutionMetadata)

Metadane dotyczące wykonywania przepływu pracy.

triggerEventSource

enum (TriggerEventSource)

Źródło zdarzeń aktywujących.

Typ ładunku zdarzenia przepływu pracy. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
actionInvocation

object (ActionInvocation)

Wywołanie działania przepływu pracy.

triggerCreation

object (TriggerCreation)

utworzenie aktywatora przepływu pracy,

triggerDeletion

object (TriggerDeletion)

usunięcie aktywatora przepływu pracy,

resourceRetrieval

object (ResourceRetrieval)

Pobieranie zasobu (używane do rozwijania zmiennych).

elementConfiguration

object (ElementConfiguration)

Konfiguracja elementu przepływu pracy.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

pobieranie definicji pól obsługiwanych przez zasób;

elementUiAutocomplete

object (ElementUiAutocomplete)

Sugestie autouzupełniania dla aktualnie renderowanej karty.

Koniec pól wykluczających się wzajemnie.

ActionInvocation

Wywołanie działania przepływu pracy.

Zapis JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Pola
inputs

map (key: string, value: object (VariableData))

Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

triggerId

string

Identyfikator aktywatora do użycia w odpowiedziach na działania asynchroniczne.

flowLevelContext

object (FlowLevelContext)

Opcjonalnie: Kontekst na poziomie przepływu z poprzednich kroków.

VariableData

Reprezentuje dane zmiennej, które mogą zawierać wiele wartości różnych typów.

Zapis JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Pola
booleanValues[]

boolean

Wartości logiczne.

integerValues[]

string (int64 format)

Wartości w formie liczb całkowitych.

floatValues[]

number

Wartości zmiennoprzecinkowe.

stringValues[]

string

Wartości typu ciąg znaków.

timestampValues[]

string (Timestamp format)

Wartości sygnatur czasowych.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

odwołania do zasobów (identyfikatory),

emailAddressValues[]

string

Wartości adresów e-mail.

googleUserValues[]

string

Wartości użytkownika Google w formacie users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Wartości formatu tekstu w przepływie pracy.

ResourceReference

Wartość identyfikatora zasobu aplikacji.

Zapis JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Pola
resourceType

object (ResourceType)

Typ zasobu, na który wskazuje ten identyfikator.

resourceId

string

Identyfikator zasobu.

ResourceType

Nazwa niestandardowego typu zasobu.

Zapis JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Pola
workflowBundleId

string

Identyfikator pakietu przepływu pracy, do którego należy ten typ zasobu. Jest to opcjonalne, a jeśli jest puste, uznaje się, że jest to ten sam pakiet, w którym jest używany.

workflowResourceDefinitionId

string

Unikalny identyfikator zasobu. Musi być unikalny tylko w obrębie tego samego pakietu.

WorkflowTextFormat

Blok tekstu z opcjami formatowania, w tym stylami, hiperlinkami i elementami interaktywnymi.

Zapis JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Pola
textFormatElements[]

object (TextFormatElement)

Kolekcja elementów formatu tekstu.

TextFormatElement

Pojedynczy element w wiadomości WorkflowTextFormat, który może być elementem, sformatowanym tekstem, hiperlinkiem lub kontenerem listy.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
Pola
Element, który reprezentuje jeden z kilku możliwych elementów formatu tekstu. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
text

string

Tekst w formacie tekstowym.

chip

object (Chip)

Klikalny element w formacie tekstowym.

styledText

object (StyledText)

Tekst sformatowany w formacie tekstowym.

listContainer

object (ListContainer)

Kontener listy w formacie tekstowym.

Koniec pól wykluczających się wzajemnie.

Chip

Klikalny element w formacie tekstowym.

Zapis JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
Pola
icon

object (Icon)

Ikona wyświetlana na elemencie.

label

string

Tekst wyświetlany w elemencie.

url

string

Adres URL, który zostanie otwarty po kliknięciu elementu.

Ikona

Ikona w elemencie.

Zapis JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
Pola
Ikona wyświetlana na elemencie. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
iconUrl

string

Wyświetl ikonę niestandardową hostowaną pod adresem URL HTTPS.

Na przykład:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Obsługiwane typy plików to .png i .jpg.

materialIconName

string

Nazwa ikony zdefiniowana w ikonach w stylu Material Design, np. check_box. Nieprawidłowe nazwy są odrzucane i zastępowane pustym ciągiem znaków, co powoduje, że ikona nie jest renderowana.

Koniec pól wykluczających się wzajemnie.

StyledText

Element tekstowy ze stylami, takimi jak pogrubienie, kursywa i kolor.

Zapis JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Pola
text

string

Główna treść tekstu.

styles[]

enum (Style)

Zbiór stylów zastosowanych do tekstu.

fontWeight

enum (FontWeight)

Grubość czcionki tekstu.

color

object (Color)

Kolor tekstu.

wrapStyle

enum (WrapStyle)

Styl zawijania tekstu.

Styl

Typ wyliczeniowy dla różnych stylów tekstu, takich jak kursywa, podkreślenie itp.

Wartości w polu enum
STYLE_UNSPECIFIED Nie zastosowano stylu. NIE UŻYWAĆ.
ITALIC Styl kursywy.
UNDERLINE Styl podkreślenia.
STRIKETHROUGH Styl przekreślony.
LINE_BREAK Podział wiersza.
UPPERCASE Styl z wielkimi literami.
CODE Koduj.
CODE_BLOCK Blok kodu.

FontWeight

Typ wyliczeniowy dla różnych grubości czcionki.

Wartości w polu enum
FONT_WEIGHT_UNSPECIFIED Standardowa grubość i waga. NIE UŻYWAĆ.
LIGHT Mniejsza waga i grubość.
MEDIUM Grubość pośrednia między cienką a pogrubioną.
BOLD Większa waga i grubość.

WrapStyle

Typ wyliczeniowy dla różnych stylów zawijania.

Wartości w polu enum
WRAP_STYLE_UNSPECIFIED Nie określono stylu zawijania.
NO_WRAP Brak stylu zawijania.

ListContainer

Kontener na elementy listy, z których każdy może zawierać wiele elementów TextFormatElement.

Zapis JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Pola
listNestLevel

string (int64 format)

Poziom zagnieżdżenia listy. Zaczyna się od 0 na najwyższym poziomie i zwiększa się o 1 dla każdej zagnieżdżonej listy.

listType

enum (ListType)

Typ listy.

listItems[]

object (ListItem)

Kolekcja elementów listy.

ListType

Typ wyliczeniowy dla różnych typów list.

Wartości w polu enum
LIST_TYPE_UNSPECIFIED Nie określono typu listy. NIE UŻYWAĆ.
ORDERED Lista uporządkowana.
UNORDERED Lista nieuporządkowana.
BLOCKQUOTE Reprezentuje listę cytatów.

ListItem

Element listy.

Zapis JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Pola
textFormatElements[]

object (TextFormatElement)

Kolekcja elementów formatu tekstu.

FlowLevelContext

Kontekst na poziomie przepływu zawierający dane wyjściowe z poprzednich kroków.

Zapis JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
Pola
stepContexts[]

object (StepContext)

Opcjonalnie: Lista poprzednich kroków. Kolejność ma znaczenie, więc upewnij się, że kolejność wykonywania jest zachowana na tej liście.

StepContext

Metadane i dane wyjściowe kontekstu kroku na potrzeby kontekstu na poziomie przepływu.

Zapis JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Pola
stepId

string

Opcjonalnie: Unikalny identyfikator kroku w wykresie przepływu pracy.

outputs

map (key: string, value: object (VariableData))

Opcjonalnie: Mapa zmiennych wyjściowych utworzonych przez ten krok, z kluczami według nazwy zmiennej.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

TriggerCreation

utworzenie aktywatora przepływu pracy,

Zapis JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Pola
triggerId

string

Unikalny identyfikator aktywatora podany podczas tworzenia.

triggerType

enum (TriggerType)

Typ aktywatora.

inputs

map (key: string, value: object (VariableData))

Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

notifyUri

string

Punkt końcowy, który zostanie wywołany po uruchomieniu aktywatora.

TriggerType

Typ aktywatora.

Wartości w polu enum
TRIGGER_TYPE_UNDEFINED Wartość domyślna. NIE UŻYWAĆ.
REPEATING Reguła będzie uruchamiana za każdym razem, gdy zostaną spełnione warunki wejściowe.

TriggerDeletion

Usunięcie aktywatora przepływu pracy.

Zapis JSON
{
  "triggerId": string
}
Pola
triggerId

string

Unikalny identyfikator aktywatora podany podczas tworzenia.

ResourceRetrieval

pobranie zasobu,

Zapis JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Pola
resourceReference

object (ResourceReference)

Typ i identyfikator zasobu, który ma zostać pobrany.

ElementConfiguration

wywołanie podczas konfigurowania elementu przepływu pracy.

Zapis JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Pola
inputs

map (key: string, value: object (VariableData))

Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej. Ta mapa może być pusta. Używane podczas konfigurowania pojedynczego elementu przepływu pracy (aktywatora lub działania) na stronie głównej przepływu pracy.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

displayDestination

enum (DisplayDestination)

Miejsce docelowe karty konfiguracji elementu. Elementy mogą używać tego pola do zwracania różnych układów kart konfiguracji w zależności od miejsca docelowego.

nodeId

string

Identyfikator węzła renderowanej konfiguracji podstawowej.

workflowId

string

Identyfikator przepływu pracy renderowanej konfiguracji podstawowej.

availableVariables[]

object (VariableReference)

Dostępne zmienne uporządkowane według pozycji węzła.

DisplayDestination

Wskazuje, gdzie będzie wyświetlana karta konfiguracji elementu zwracanego.

Wartości w polu enum
DISPLAY_DESTINATION_UNSPECIFIED Wartość domyślna. NIE UŻYWAĆ.
DISPLAY_DESTINATION_SIDE_PANEL Karta konfiguracji ma być wyświetlana w panelu bocznym.
DISPLAY_DESTINATION_FULL_SCREEN Karta konfiguracji ma być wyświetlana w aplikacji na pełnym ekranie.

VariableReference

odwołanie do zmiennej w przepływie pracy,

Zapis JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Pola
parentElementId

string

Identyfikator elementu podstawowego, który generuje zmienną. W razie potrzeby możemy rozszerzyć go do WorkflowElement lub bardziej szczegółowego proto metadanych.

nodeId

string

Identyfikator referencyjny węzła

path

string

Podpis ścieżki selektora zmiennej

dataType

object (DataType)

Typ danych zmiennej

iconUrl

string

Adres URL ikony elementu podstawowego, który generuje tę zmienną.

stepNumber

integer

Numer kroku elementu podstawowego, który generuje tę zmienną.

descriptionText

string

Opis zmiennej.

displayText

string

Tekst wyświetlany elementu zmiennej.

DataType

Typ zmiennej.

Zapis JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
Pola
valueMetadata

object (ValueMetadata)

Metadane dotyczące potencjalnych wartości zmiennej.

Typ danych. Poniżej znajduje się lista pól, które wzajemnie się wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
basicType

enum (BasicType)

Podstawowy typ danych.

resourceType

object (ResourceType)

Typ identyfikatora zasobu aplikacji.

Koniec pól wykluczających się wzajemnie.

BasicType

Podstawowe ogólne typy danych.

Wartości w polu enum
BASIC_TYPE_UNSPECIFIED Wartość domyślna. NIE UŻYWAĆ.
STRING Ciąg znaków.
INTEGER Liczba całkowita.
FLOAT Liczba zmiennoprzecinkowa.
TIMESTAMP Sygnatura czasowa w formacie ISO 8601.
BOOLEAN Wartość, która może być prawdą lub fałszem.
EMAIL_ADDRESS Adres e-mail, który jest ciągiem znaków w formacie adresu e-mail.
GOOGLE_USER Użytkownik usług Google w formacie users/{user}.
FILE Odwołanie do pliku.
FORMATTED_TEXT Tekst ze sformatowanym tekstem.

ValueMetadata

Informacje o potencjalnych wartościach zmiennej.

Zapis JSON
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Pola
enumValues[]

string

Opcjonalnie: Określa dozwolone wartości ciągu znaków. Można to ustawić tylko wtedy, gdy DataType ma wartość STRING.

dynamicTypes[]

enum (BasicType)

Opcjonalnie: Określa dozwolone typy, które można dynamicznie rzutować na zmienną. Można to ustawić tylko wtedy, gdy DataType to ciąg znaków, a zmienna jest wyjściem.

semanticDescriptors[]

object (SemanticDescriptor)

Opcjonalnie: Pomaga opisać semantyczne znaczenie zmiennej.

dynamicSchema

object (DynamicSchema)

Opcjonalnie: Konfiguracja dynamicznego rozpoznawania schematu tej zmiennej.

defaultValue

string

Opcjonalnie: Ciąg znaków określający domyślną wartość tej zmiennej. Na przykład w przypadku wartości logicznych defaultValue może być ustawione na true lub false.

SemanticDescriptor

Metadane dotyczące semantycznego znaczenia zmiennej.

Zapis JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Pola
resourceAttribute

string

Wskazuje, że zmienna odpowiada konkretnemu atrybutowi zasobu. Jest to szczególnie przydatne w przypadku zmiennych, które reprezentują identyfikator zasobu (identyfikator, adres URL, klucz itp.).

Zalecany format: – "{brand}/{appName}/{resource}:{attribute}" {brand} jest opcjonalny i należy go pominąć, jeśli jest taki sam jak {appName}.

Przykłady: "google/drive/file:id", "google/drive/folder:id", "google/docs/document:id", "google/sheets/spreadsheet:id", "jira/issue:key", "slack/channel:id" itp.

Klient użyje tych informacji, aby podpowiedzieć użytkownikowi, które zmienne wyjściowe są zgodne z określonymi danymi wejściowymi.

disallowedResourceAttributes[]

string

Opcjonalnie: Dotyczy tylko danych wejściowych i jest ignorowany w przypadku danych wyjściowych. Niedozwolone atrybuty, które odpowiadają temu deskryptorowi semantycznemu. Klient będzie wyraźnie uniemożliwiać wybór zmiennych dla danych wyjściowych, które odpowiadają dowolnemu z tych niedozwolonych atrybutów zasobów.

DynamicSchema

Konfiguracja dynamicznego rozpoznawania schematu tej zmiennej w czasie działania.

Zapis JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
Pola
requiredInputIds[]

string

Identyfikatory powiązanych zmiennych wejściowych, które muszą zostać podane, zanim schemat tej zmiennej będzie mógł zostać dynamicznie rozwiązany.

strictEnum

boolean

Jeśli ma wartość „true”, wartość zmiennej musi być zgodna z jedną z dynamicznie rozpoznawanych wartości typu wyliczeniowego. Jeśli ma wartość „fałsz”, dynamicznie rozpoznawane wartości są traktowane jako sugestie, które nie są rygorystyczne.

ResourceFieldsDefinitionRetrieval

Pobiera definicję pól obsługiwanych przez zasób.

Zapis JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Pola
elementId

string

Określa identyfikator elementu, którego schemat zasobu dynamicznego ma zostać pobrany.

inputs

map (key: string, value: object (VariableData))

Obejmuje to dane wejściowe pól węzła, który udostępnia zmienną. Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

ElementUiAutocomplete

Sugestie autouzupełniania dla aktualnie renderowanej karty.

Zapis JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Pola
query

string

Zapytanie do autouzupełnienia.

inputs

map (key: string, value: object (VariableData))

Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }

invokedFunction

string

Wywołana funkcja powiązana z widżetem.

resourceId

string

Identyfikator zasobu, dla którego ma być używane autouzupełnianie. To pole jest opcjonalne i może nie być ustawione.

operationId

string

Identyfikator operacji, która dostarczyła zasób do autouzupełnienia. To pole jest opcjonalne i może nie być ustawione.

ExecutionMetadata

Metadane dotyczące wykonywania przepływu pracy.

Zapis JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
Pola
versionId

integer

Wersja wywoływanego elementu przepływu pracy.

timeZone

string

Strefa czasowa zapisywanego przepływu pracy, np. „America/Los_Angeles”.

stepNumber

integer

Reprezentuje numer kroku wywoływanej funkcji podstawowej.

TriggerEventSource

Źródło zdarzenia aktywującego, które wywołało to wykonanie.

Wartości w polu enum
TRIGGER_EVENT_SOURCE_UNSPECIFIED Wartość domyślna. NIE UŻYWAĆ.
TRIGGER_EVENT_SOURCE_AUTOMATED Wykonywanie jest aktywowane automatycznie przez zdarzenia.
TRIGGER_EVENT_SOURCE_TEST_RUN Wykonywanie jest uruchamiane przez uruchomienie testowe.