- EventObject
- CommonEventObject
- HostApp
- Platform
- TimeZone
- Dane wejściowe
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Organizator
- Uczestnik
- ConferenceData
- ConferenceSolution
- Klucz
- EntryPoint
- Parametry
- AddOnParameters
- Możliwości
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Chip
- Ikona
- StyledText
- Styl
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
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 ( |
| Pola | |
|---|---|
commonEventObject |
Obiekt zawierający informacje wspólne dla wszystkich obiektów zdarzeń, niezależnie od aplikacji hostowanej. |
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 |
Widoczny tylko wtedy, gdy hostem wywołującym jest Kalendarz Google. Obiekt zawierający informacje o kalendarzu i wydarzeniu. |
drive |
Widoczny tylko wtedy, gdy hostem wywołującym jest Dysk Google. Obiekt zawierający informacje o Dysku. |
gmail |
Obecne tylko wtedy, gdy hostem wywołującym jest Gmail. Obiekt zawierający informacje o Gmailu. |
sheets |
Widoczny tylko wtedy, gdy hostem wywołującym są Arkusze Google. Obiekt zawierający informacje o Arkuszach. |
slides |
Wyświetlane tylko wtedy, gdy hostem wywołującym są Prezentacje Google. Obiekt zawierający informacje o Prezentacjach. |
docs |
Widoczny tylko wtedy, gdy hostem wywołującym są Dokumenty Google. Obiekt zawierający informacje o Dokumentach. |
chat |
Widoczny tylko wtedy, gdy hostem wywołującym jest Google Chat. Obiekt zawierający informacje o Google Chat. |
workflow |
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 ( |
| Pola | |
|---|---|
userLocale |
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: Aby włączyć to pole, musisz ustawić |
hostApp |
Wskazuje aplikację hosta, w której dodatek jest aktywny, gdy generowany jest obiekt zdarzenia. Możliwe wartości:
|
platform |
Typ wyliczeniowy platformy, który wskazuje platformę, z której pochodzi zdarzenie ( |
timeZone |
Domyślnie wyłączone. Identyfikator strefy czasowej i przesunięcie względem uniwersalnego czasu koordynowanego (UTC). Aby włączyć to pole, musisz ustawić Obsługiwane tylko w przypadku typów zdarzeń |
formInputs |
Mapa zawierająca bieżące wartości widżetów na wyświetlanej karcie. Klucze mapy to wartości ciągu znaków 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ć
Przykład: w przypadku widżetu do wprowadzania tekstu z
Przykład: w przypadku widżetu z wieloma wartościami, którego
Przykład: w przypadku selektora z
Przykład: w przypadku selektora z
Przykład: w przypadku selektora z Obiekt zawierający listę par |
parameters |
wszelkie dodatkowe parametry, które podajesz w działaniu za pomocą 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 Obiekt zawierający listę par |
invokedFunction |
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 |
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 |
Kod bazy danych stref czasowych IANA TZ, np. „America/Toronto”. |
offset |
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 ( |
| 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 |
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 |
dateTimeInput |
Wartości wejściowe daty i godziny z widżetu |
dateInput |
Wartości wejściowe daty z widżetu |
timeInput |
Wartości wejściowe czasu z widżetu |
| 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[] |
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 |
Czas od początku epoki uniksowej w milisekundach. |
hasDate |
Czy dane wejściowe |
hasTime |
Czy dane wejściowe |
DateInput
Wartości wejściowe daty.
| Zapis JSON |
|---|
{ "msSinceEpoch": string } |
| Pola | |
|---|---|
msSinceEpoch |
Czas od początku epoki uniksowej w milisekundach. |
TimeInput
Wartości wejściowe czasu.
| Zapis JSON |
|---|
{ "hours": integer, "minutes": integer } |
| Pola | |
|---|---|
hours |
Godzina w formacie 24-godzinnym. |
minutes |
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 |
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 |
token identyfikacji użytkownika, jeśli wymagane są odpowiednie zakresy identyfikatorów; |
systemIdToken |
token identyfikacji konta usługi dodatków do G Suite dla tego wdrożenia, |
authorizedScopes[] |
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 ( |
| Pola | |
|---|---|
id |
Identyfikator zdarzenia. |
recurringEventId |
Identyfikator wydarzenia cyklicznego. |
calendarId |
Identyfikator kalendarza. |
organizer |
Obiekt reprezentujący organizatora wydarzenia. |
attendees[] |
Dane generowane przez użytkowników. Lista uczestników wydarzenia w kalendarzu. |
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 |
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 |
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 |
Adres e-mail uczestnika. |
displayName |
Wyświetlana nazwa uczestnika. |
organizer |
true, jeśli uczestnik jest organizatorem tego wydarzenia. |
self |
true, jeśli ten uczestnik reprezentuje kalendarz, w którym pojawia się to wydarzenie; w przeciwnym razie false. |
resource |
true, jeśli uczestnik reprezentuje zasób, taki jak sala lub sprzęt; w przeciwnym razie false. |
optional |
true, jeśli obecność tego uczestnika jest oznaczona jako opcjonalna; w przeciwnym razie false. |
responseStatus |
Stan odpowiedzi uczestnika. Możliwe wartości:
|
comment |
Komentarz uczestnika (jeśli został dodany). |
additionalGuests |
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 ( |
| Pola | |
|---|---|
conferenceId |
Identyfikator konferencji. Ten identyfikator umożliwia aplikacjom śledzenie konferencji. Nie należy go wyświetlać użytkownikom. |
conferenceSolution |
Obiekt reprezentujący rozwiązanie do obsługi rozmów wideo, takie jak Hangouts lub Google Meet. |
entryPoints[] |
Lista punktów wejścia do rozmowy, takich jak adresy URL lub numery telefonów. |
notes |
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 |
Obiekt zawierający mapę zdefiniowanych danych parametrów do użycia przez dodatek. |
ConferenceSolution
| Zapis JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| Pola | |
|---|---|
iconUri |
Identyfikator URI ikony widocznej dla użytkownika, która reprezentuje to rozwiązanie do obsługi rozmów wideo. |
key |
Klucz, który jednoznacznie identyfikuje rozwiązanie do obsługi rozmów wideo dla tego wydarzenia. |
name |
Nazwa tego rozwiązania do obsługi rozmów wideo widoczna dla użytkownika (niezlokalizowana). |
Klucz
| Zapis JSON |
|---|
{ "type": string } |
| Pola | |
|---|---|
type |
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 |
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 |
Typ punktu wejścia. Możliwe wartości:
|
label |
Widoczna dla użytkownika etykieta identyfikatora URI punktu wejścia (niezlokalizowana). |
meetingCode |
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 |
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 |
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 |
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 |
Identyfikator URI punktu wejścia. Maksymalna długość to 1300 znaków. Formatowanie zależy od typu punktu wejścia:
|
regionCode |
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[] |
Funkcje punktu wejścia. Obecnie te funkcje dotyczą tylko punktów wejścia przez telefon:
|
Parametry
| Zapis JSON |
|---|
{
"addOnParameters": {
object ( |
| Pola | |
|---|---|
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 |
Obiekt zawierający listę par |
Uprawnienia
| Zapis JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Pola | |
|---|---|
canSeeAttendees |
Dane wygenerowane przez użytkownika. true, jeśli dodatek może odczytać listę uczestników wydarzenia; w przeciwnym razie false. |
canAddAttendees |
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 |
Dane wygenerowane przez użytkownika. true, jeśli dodatek może odczytywać dane konferencji zdarzenia; w przeciwnym razie false. |
canSetConferenceData |
Dane wygenerowane przez użytkownika. true, jeśli dodatek może aktualizować dane konferencji wydarzenia; w przeciwnym razie false. |
canAddAttachments |
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 ( |
| Pola | |
|---|---|
selectedItems[] |
Lista elementów (plików lub folderów) wybranych na Dysku. |
activeCursorItem |
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 |
Identyfikator wybranego elementu. |
iconUrl |
Adres URL ikony reprezentującej wybrany element. |
mimeType |
Typ MIME wybranego elementu. |
title |
Tytuł wybranego elementu. |
addonHasFileScopePermission |
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 |
Identyfikator aktualnie otwartej wiadomości w Gmailu. |
threadId |
Identyfikator aktualnie otwartego wątku Gmaila. |
accessToken |
Token dostępu do Gmaila. Możesz użyć tego tokena z metodą |
toRecipients[] |
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 |
ccRecipients[] |
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 |
bccRecipients[] |
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 |
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 ( |
| Pola | |
|---|---|
id |
Występuje tylko wtedy, gdy zakres |
title |
Występuje tylko wtedy, gdy zakres |
addonHasFileScopePermission |
Jeśli |
matchedUrl |
Wyświetla się tylko wtedy, gdy spełnione są te warunki:
URL linku, który generuje podgląd w Arkuszach Google. Aby użyć tego pola, musisz skonfigurować Przykładowy ładunek, gdy użytkownik wyświetla podgląd linku |
MatchedUrl
Obiekt zdarzenia zwracany z prośbami o podgląd linku.
| Zapis JSON |
|---|
{ "url": string } |
| Pola | |
|---|---|
url |
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 ( |
| Pola | |
|---|---|
id |
Występuje tylko wtedy, gdy zakres |
title |
Występuje tylko wtedy, gdy zakres |
addonHasFileScopePermission |
Jeśli |
matchedUrl |
Wyświetla się tylko wtedy, gdy spełnione są te warunki:
Adres URL linku, który generuje podgląd w Prezentacjach Google. Aby użyć tego pola, musisz skonfigurować Przykładowy ładunek, gdy użytkownik wyświetla podgląd linku |
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 ( |
| Pola | |
|---|---|
id |
Występuje tylko wtedy, gdy zakres |
title |
Występuje tylko wtedy, gdy zakres |
addonHasFileScopePermission |
Jeśli |
matchedUrl |
Wyświetla się tylko wtedy, gdy spełnione są te warunki:
URL linku, który generuje podgląd w Dokumentach Google. Aby użyć tego pola, musisz skonfigurować Przykładowy ładunek, gdy użytkownik wyświetla podgląd linku |
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 ( |
| Pola | |
|---|---|
type |
Typ zdarzenia, wypełniany tylko w przypadku zdarzeń na stronie głównej aplikacji w aplikacjach do Google Chat, które nie są dodatkami. |
user |
użytkownik, który wchodzi w interakcję z aplikacją Google Chat; |
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 |
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: |
| Ł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 |
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 |
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 |
Użytkownik usuwa aplikację do Google Chat z pokoju. |
buttonClickedPayload |
Reprezentuje dane ładunku, gdy użytkownik wchodzi w interakcję z elementem interaktywnym karty lub okna, który wywołuje wywołanie zwrotne Jeśli użytkownik wejdzie w interakcję z oknem, pole Pełny ładunek zawiera też parametry |
widgetUpdatedPayload |
Użytkownik aktualizuje widżet na karcie In-Stream lub w oknie. Pełny ładunek zawiera też |
appCommandPayload |
Użytkownik wywołuje polecenie aplikacji. |
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 ( |
| Pola | |
|---|---|
space |
Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia. |
message |
Wiadomość, która wyzwala obiekt zdarzenia. |
configCompleteRedirectUri |
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 ( |
| Pola | |
|---|---|
space |
Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia. |
interactionAdd |
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 |
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 ( |
| Pola | |
|---|---|
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 ( |
| Pola | |
|---|---|
space |
Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia. |
message |
Wiadomość, która wyzwala obiekt zdarzenia. |
isDialogEvent |
W przypadku obiektów zdarzeń |
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 ( |
| Pola | |
|---|---|
space |
Wymagane. Pokój czatu, w którym występuje obiekt zdarzenia. |
AppCommandPayload
Użytkownik wywołuje polecenie aplikacji.
| Zapis JSON |
|---|
{ "appCommandMetadata": { object ( |
| Pola | |
|---|---|
appCommandMetadata |
Wypełniane w przypadku poleceń aplikacji, w tym poleceń po ukośniku i szybkich poleceń. |
space |
Opcjonalnie: Pokój czatu, w którym występuje obiekt zdarzenia. |
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 |
Opcjonalnie: Wiadomość, która wyzwala obiekt zdarzenia (jeśli dotyczy). To pole jest wypełniane tylko w przypadku poleceń po ukośniku. |
configCompleteRedirectUri |
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 |
Opcjonalnie: Czy użytkownik wchodzi w interakcję z oknem lub zamierza to zrobić. |
dialogEventType |
Opcjonalnie: Typ odebranego obiektu zdarzenia okna. To pole ma zastosowanie tylko wtedy, gdy |
AppCommandMetadata
Metadane dotyczące polecenia aplikacji Google Chat.
| Zapis JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Pola | |
|---|---|
appCommandId |
Identyfikator polecenia określony w konfiguracji interfejsu Chat API. |
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 ( |
| Pola | |
|---|---|
systemCommandMetadata |
Metadane dotyczące wywołanego polecenia systemowego. |
space |
Opcjonalnie: Pokój czatu, w którym występuje obiekt zdarzenia. |
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 ( |
| 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 |
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 |
Wymagane. Nazwa zasobu wiadomości strumieniowej, na której wykonano polecenie anulowania. Format: |
WorkflowEventObject
LINT.IfChange Obiekt zdarzenia przekazywany do dodatków do przepływu pracy.
| Zapis JSON |
|---|
{ "executionMetadata": { object ( |
| Pola | |
|---|---|
executionMetadata |
Metadane dotyczące wykonywania przepływu pracy. |
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 |
Wywołanie działania przepływu pracy. |
triggerCreation |
utworzenie aktywatora przepływu pracy, |
triggerDeletion |
usunięcie aktywatora przepływu pracy, |
resourceRetrieval |
Pobieranie zasobu (używane do rozwijania zmiennych). |
elementConfiguration |
Konfiguracja elementu przepływu pracy. |
resourceFieldsDefinitionRetrieval |
pobieranie definicji pól obsługiwanych przez zasób; |
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 ( |
| Pola | |
|---|---|
inputs |
Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej. Obiekt zawierający listę par |
triggerId |
Identyfikator aktywatora do użycia w odpowiedziach na działania asynchroniczne. |
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 ( |
| Pola | |
|---|---|
booleanValues[] |
Wartości logiczne. |
integerValues[] |
Wartości w formie liczb całkowitych. |
floatValues[] |
Wartości zmiennoprzecinkowe. |
stringValues[] |
Wartości typu ciąg znaków. |
timestampValues[] |
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: |
resourceReferences[] |
odwołania do zasobów (identyfikatory), |
emailAddressValues[] |
Wartości adresów e-mail. |
googleUserValues[] |
Wartości użytkownika Google w formacie |
textFormatValues[] |
Wartości formatu tekstu w przepływie pracy. |
ResourceReference
Wartość identyfikatora zasobu aplikacji.
| Zapis JSON |
|---|
{
"resourceType": {
object ( |
| Pola | |
|---|---|
resourceType |
Typ zasobu, na który wskazuje ten identyfikator. |
resourceId |
Identyfikator zasobu. |
ResourceType
Nazwa niestandardowego typu zasobu.
| Zapis JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Pola | |
|---|---|
workflowBundleId |
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 |
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 ( |
| Pola | |
|---|---|
textFormatElements[] |
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 ( |
| 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 |
Tekst w formacie tekstowym. |
chip |
Klikalny element w formacie tekstowym. |
styledText |
Tekst sformatowany w formacie tekstowym. |
hyperlink |
Hiperlink w formacie tekstowym. |
listContainer |
Kontener listy w formacie tekstowym. |
| Koniec pól wykluczających się wzajemnie. | |
Chip
Klikalny element w formacie tekstowym.
| Zapis JSON |
|---|
{
"icon": {
object ( |
| Pola | |
|---|---|
icon |
Ikona wyświetlana na elemencie. |
label |
Tekst wyświetlany w elemencie. |
url |
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 |
Wyświetl ikonę niestandardową hostowaną pod adresem URL HTTPS. Na przykład: Obsługiwane typy plików to |
materialIconName |
Nazwa ikony zdefiniowana w ikonach w stylu Material Design, np. |
| Koniec pól wykluczających się wzajemnie. | |
StyledText
Element tekstowy ze stylami, takimi jak pogrubienie, kursywa i kolor.
| Zapis JSON |
|---|
{ "text": string, "styles": [ enum ( |
| Pola | |
|---|---|
text |
Główna treść tekstu. |
styles[] |
Zbiór stylów zastosowanych do tekstu. |
fontWeight |
Grubość czcionki tekstu. |
color |
Kolor tekstu. |
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. |
Hiperlink
Element hiperlinku z tekstem i linkiem.
| Zapis JSON |
|---|
{ "link": string, "text": string } |
| Pola | |
|---|---|
link |
Docelowy adres URL hiperlinku. |
text |
Tekst hiperlinku. |
ListContainer
Kontener na elementy listy, z których każdy może zawierać wiele elementów TextFormatElement.
| Zapis JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Pola | |
|---|---|
listNestLevel |
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 |
Typ listy. |
listItems[] |
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 ( |
| Pola | |
|---|---|
textFormatElements[] |
Kolekcja elementów formatu tekstu. |
FlowLevelContext
Kontekst na poziomie przepływu zawierający dane wyjściowe z poprzednich kroków.
| Zapis JSON |
|---|
{
"stepContexts": [
{
object ( |
| Pola | |
|---|---|
stepContexts[] |
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 ( |
| Pola | |
|---|---|
stepId |
Opcjonalnie: Unikalny identyfikator kroku w wykresie przepływu pracy. |
outputs |
Opcjonalnie: Mapa zmiennych wyjściowych utworzonych przez ten krok, z kluczami według nazwy zmiennej. Obiekt zawierający listę par |
TriggerCreation
utworzenie aktywatora przepływu pracy,
| Zapis JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Pola | |
|---|---|
triggerId |
Unikalny identyfikator aktywatora podany podczas tworzenia. |
triggerType |
Typ aktywatora. |
inputs |
Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej. Obiekt zawierający listę par |
notifyUri |
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 |
Unikalny identyfikator aktywatora podany podczas tworzenia. |
ResourceRetrieval
pobranie zasobu,
| Zapis JSON |
|---|
{
"resourceReference": {
object ( |
| Pola | |
|---|---|
resourceReference |
Typ i identyfikator zasobu, który ma zostać pobrany. |
ElementConfiguration
wywołanie podczas konfigurowania elementu przepływu pracy.
| Zapis JSON |
|---|
{ "inputs": { string: { object ( |
| Pola | |
|---|---|
inputs |
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 |
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 |
Identyfikator węzła renderowanej konfiguracji podstawowej. |
workflowId |
Identyfikator przepływu pracy renderowanej konfiguracji podstawowej. |
availableVariables[] |
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 ( |
| Pola | |
|---|---|
parentElementId |
Identyfikator elementu podstawowego, który generuje zmienną. W razie potrzeby możemy rozszerzyć go do WorkflowElement lub bardziej szczegółowego proto metadanych. |
nodeId |
Identyfikator referencyjny węzła |
path |
Podpis ścieżki selektora zmiennej |
dataType |
Typ danych zmiennej |
iconUrl |
Adres URL ikony elementu podstawowego, który generuje tę zmienną. |
stepNumber |
Numer kroku elementu podstawowego, który generuje tę zmienną. |
descriptionText |
Opis zmiennej. |
displayText |
Tekst wyświetlany elementu zmiennej. |
DataType
Typ zmiennej.
| Zapis JSON |
|---|
{ "valueMetadata": { object ( |
| Pola | |
|---|---|
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 |
Podstawowy typ danych. |
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 ( |
| Pola | |
|---|---|
enumValues[] |
Opcjonalnie: Określa dozwolone wartości ciągu znaków. Można to ustawić tylko wtedy, gdy |
dynamicTypes[] |
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[] |
Opcjonalnie: Pomaga opisać semantyczne znaczenie zmiennej. |
dynamicSchema |
Opcjonalnie: Konfiguracja dynamicznego rozpoznawania schematu tej zmiennej. |
defaultValue |
Opcjonalnie: Ciąg znaków określający domyślną wartość tej zmiennej. Na przykład w przypadku wartości logicznych |
SemanticDescriptor
Metadane dotyczące semantycznego znaczenia zmiennej.
| Zapis JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Pola | |
|---|---|
resourceAttribute |
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: – Przykłady: Klient użyje tych informacji, aby podpowiedzieć użytkownikowi, które zmienne wyjściowe są zgodne z określonymi danymi wejściowymi. |
disallowedResourceAttributes[] |
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[] |
Identyfikatory powiązanych zmiennych wejściowych, które muszą zostać podane, zanim schemat tej zmiennej będzie mógł zostać dynamicznie rozwiązany. |
strictEnum |
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 ( |
| Pola | |
|---|---|
elementId |
Określa identyfikator elementu, którego schemat zasobu dynamicznego ma zostać pobrany. |
inputs |
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 |
ElementUiAutocomplete
Sugestie autouzupełniania dla aktualnie renderowanej karty.
| Zapis JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Pola | |
|---|---|
query |
Zapytanie do autouzupełnienia. |
inputs |
Mapa zmiennych wejściowych z kluczami według nazwy zmiennej wejściowej. Obiekt zawierający listę par |
invokedFunction |
Wywołana funkcja powiązana z widżetem. |
resourceId |
Identyfikator zasobu, dla którego ma być używane autouzupełnianie. To pole jest opcjonalne i może nie być ustawione. |
operationId |
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 |
Wersja wywoływanego elementu przepływu pracy. |
timeZone |
Strefa czasowa zapisywanego przepływu pracy, np. „America/Los_Angeles”. |
stepNumber |
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. |