- EventObject
- CommonEventObject
- HostApp
- Platform
- TimeZone
- Girişler
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Düzenleyen
- Katılımcı
- ConferenceData
- ConferenceSolution
- Anahtar
- EntryPoint
- Parametreler
- AddOnParameters
- Özellikler
- 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
- Çip
- Simge
- StyledText
- Stil
- 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
Kullanıcının bir ana uygulamadaki eklentiyle etkileşimi hakkında veri içeren Google eklentisi etkileşim etkinliği.
Kullanıcı, bir ana makine uygulamasında eklentiyle etkileşimde bulunduğunda olay nesnesi, eklentinin geri çağırma işlevine veya tetikleyicisine (Apps Komut Dosyası için) ya da https uç noktasına (HTTP için) JSON olarak iletilir. Olay nesnesi, her ana makine uygulaması tarafından tanımlanan bir ana makine uygulaması olay nesnesinin yanı sıra olayla ilgili bazı ortak alanları içeren ortak bir olay nesnesini depolar.
Daha fazla bilgi için Olay nesneleri başlıklı makaleyi inceleyin.
| JSON gösterimi |
|---|
{ "commonEventObject": { object ( |
| Alanlar | |
|---|---|
commonEventObject |
Ana uygulamadan bağımsız olarak tüm etkinlik nesneleri için ortak bilgiler içeren bir nesne. |
authorizationEventObject |
Yalnızca HTTP uç noktalarına yönelik istekler için ayarlanır. |
| Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
calendar |
Yalnızca çağıran ana makine Google Takvim ise mevcuttur. Takvim ve etkinlik bilgilerini içeren bir nesne. |
drive |
Yalnızca çağıran ana makine Google Drive ise mevcuttur. Drive bilgilerini içeren bir nesne. |
gmail |
Yalnızca çağrıyı yapan ana makine Gmail ise mevcuttur. Gmail bilgilerini içeren bir nesne. |
sheets |
Yalnızca çağıran ana makine Google E-Tablolar ise mevcuttur. E-Tablolar bilgilerini içeren bir nesne. |
slides |
Yalnızca çağrı yapan ana makine Google Slaytlar ise mevcuttur. Slaytlar bilgilerini içeren bir nesne. |
docs |
Yalnızca çağrıyı yapan ana makine Google Dokümanlar ise mevcuttur. Dokümanlar bilgilerini içeren bir nesne. |
chat |
Yalnızca arayan ana makine Google Chat ise gösterilir. Chat bilgilerini içeren bir nesne. |
workflow |
Yalnızca çağrı yapan ana makine Google Workspace Studio ise gösterilir. İş akışı bilgilerini içeren bir nesne. |
| Birbirini hariç tutan alanların sonu. | |
CommonEventObject
Ortak olay nesnesi, genel olay nesnesinin, kullanıcı istemcisinden eklentiye genel, ana makineden bağımsız bilgiler taşıyan kısmıdır. Bu bilgiler arasında kullanıcının yerel ayarı, ana makine uygulaması ve platformu gibi ayrıntılar yer alır.
Ana sayfa ve bağlamsal tetikleyicilere ek olarak eklentiler, kullanıcı widget'larla etkileşimde bulunduğunda olay nesneleri oluşturur ve bunları işlem geri çağırma işlevlerine iletir. Eklentinizin geri çağırma işlevi, kullanıcının istemcisindeki açık widget'ların içeriğini belirlemek için ortak olay nesnesini sorgulayabilir. Örneğin, eklentiniz kullanıcının eventObject.commentEventObject.formInputs nesnesindeki bir TextInput widget'ına girdiği metni bulabilir.
Chat uygulamaları için, kullanıcının bir widget ile etkileşimde bulunurken çağırdığı işlevin adı.
| JSON gösterimi |
|---|
{ "userLocale": string, "hostApp": enum ( |
| Alanlar | |
|---|---|
userLocale |
Varsayılan olarak devre dışıdır. Kullanıcının dili ve ülke/bölge tanımlayıcısı, ISO 639 dil kodu-ISO 3166 ülke/bölge kodu biçimindedir. Örneğin, Bu alanı etkinleştirmek için eklentinizin manifest dosyasında |
hostApp |
Olay nesnesi oluşturulduğunda eklentinin etkin olduğu ana uygulamayı belirtir. Olası değerler şunlardır:
|
platform |
Etkinliğin kaynaklandığı platformu ( |
timeZone |
Varsayılan olarak devre dışıdır. Saat dilimi kimliği ve Eşgüdümlü Evrensel Zaman (UTC) ile saat farkı. Bu alanı etkinleştirmek için eklentinizin manifest dosyasında Yalnızca |
formInputs |
Görüntülenen karttaki widget'ların mevcut değerlerini içeren bir harita. Harita anahtarları, her giriş widget'ına (ör. Harita değeri nesnesinin yapısı, widget türüne bağlıdır: Not: Aşağıdaki örnekler, Apps Komut Dosyası'nın V8 çalışma zamanı için biçimlendirilmiştir. Rhino çalışma zamanını kullanıyorsanız değerden sonra
Örnek:
Örnek:
Örnek:
Örnek:
Örnek:
|
parameters |
Geliştirici Önizlemesi: Google Chat'i genişleten eklentilerde, kullanıcıların çoklu seçim menülerine yazdıklarına göre öğe önermek için
|
invokedFunction |
Çağrılacak işlevin adı. Bu alan, Google Chat'i genişleten Google Workspace eklentileri için doldurulmaz. Bunun yerine, tanımlayıcılar gibi işlev verilerini almak için Chat'i genişleten eklentiler |
HostApp
Google Workspace eklentisi veya Google Chat uygulaması için Google Workspace uygulaması.
Eklentiler için Google Workspace eklentisinin başlatıldığı Workspace uygulaması. Chat uygulamaları için ana uygulama her zaman CHAT olur.
| Sıralamalar | |
|---|---|
UNSPECIFIED_HOST_APP |
Google, ana uygulamayı tanımlayamıyor. |
GMAIL |
Eklenti, Gmail'den başlatılır. |
CALENDAR |
Eklenti, Google Takvim'den başlatılır. |
DRIVE |
Eklenti, Google Drive'dan başlatılır. |
DEMO |
Kullanılmıyor. |
DOCS |
Eklenti, Google Dokümanlar'dan başlatılır. |
MEET |
Eklenti, Google Meet'ten başlatılır. |
SHEETS |
Eklenti, Google E-Tablolar'dan başlatılır. |
SLIDES |
Eklenti, Google Slaytlar'dan başlatılır. |
DRAWINGS |
Eklenti, Google Çizimler'den başlatılır. |
CHAT |
Google Chat uygulaması. |
Platform
Bu aramanın hangi platformdan yapıldığını tanımlar.
| Sıralamalar | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
Saat dilimi kimliği ve Eşgüdümlü Evrensel Zaman (UTC) ile saat farkı. Yalnızca CARD_CLICKED ve SUBMIT_DIALOG etkinlik türleri için desteklenir.
| JSON gösterimi |
|---|
{ "id": string, "offset": integer } |
| Alanlar | |
|---|---|
id |
IANA TZ saat dilimi veritabanı kodu (ör. "America/Toronto"). |
offset |
Kullanıcının saat diliminin Eşgüdümlü Evrensel Zaman'dan (UTC) milisaniye cinsinden farkı. |
Girişler
Kullanıcıların kartlara veya iletişim kutularına girebileceği veri türleri. Giriş türü, widget'ın kabul ettiği değerlerin türüne bağlıdır.
| JSON gösterimi |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringInputs": { object ( |
| Alanlar | |
|---|---|
| Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
stringInputs |
Kullanıcının bir widget'a girdiği değerleri temsil eden dize listesi. Widget yalnızca bir değer kabul ediyorsa (ör. |
dateTimeInput |
Hem tarih hem de saat kabul eden bir |
dateInput |
Yalnızca tarih değerlerini kabul eden bir |
timeInput |
Yalnızca zaman değerlerini kabul eden bir |
| Birbirini hariç tutan alanların sonu. | |
StringInputs
Normal widget'lar için giriş parametresi. Tek değerli widget'lar için tek değerli bir listedir. Onay kutusu gibi çok değerli widget'lar için tüm değerler gösterilir.
| JSON gösterimi |
|---|
{ "value": [ string ] } |
| Alanlar | |
|---|---|
value[] |
Kullanıcı tarafından girilen dize listesi. |
DateTimeInput
Tarih ve saat giriş değerleri.
| JSON gösterimi |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| Alanlar | |
|---|---|
msSinceEpoch |
Epoch zamanından bu yana geçen süre (milisaniye cinsinden). |
hasDate |
|
hasTime |
|
DateInput
Tarih giriş değerleri.
| JSON gösterimi |
|---|
{ "msSinceEpoch": string } |
| Alanlar | |
|---|---|
msSinceEpoch |
Epoch zamanından bu yana geçen süre (milisaniye cinsinden). |
TimeInput
Zaman girişi değerleri.
| JSON gösterimi |
|---|
{ "hours": integer, "minutes": integer } |
| Alanlar | |
|---|---|
hours |
24 saatlik biçimde saat. |
minutes |
Saat başından sonra geçen dakika sayısı. Geçerli değerler 0 ile 59 arasındadır. |
AuthorizationEventObject
Eklenti isteği için yetkilendirme bilgilerini kapsar.
| JSON gösterimi |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| Alanlar | |
|---|---|
userOAuthToken |
İstenen kapsamlarla yetkilendirilmiş son kullanıcı OAuth erişim jetonu. (OAuth izni ayrıştırıldıktan sonra bu, son kullanıcı tarafından yetkilendirilmiş kapsamlarla yetkilendirilir.) |
userIdToken |
Uygun kimlik kapsamları istenirse son kullanıcı kimlik jetonu |
systemIdToken |
Bu dağıtım için G Suite Eklentileri hizmet hesabının kimlik jetonu |
authorizedScopes[] |
Kullanıcı tarafından yetkilendirilen OAuth kapsamlarının listesi. |
CalendarEventObject
Takvim olay nesnesi, genel olay nesnesinin kullanıcının takvimi ve takvim etkinlikleri hakkında bilgi taşıyan kısmıdır. Yalnızca ana makine uygulaması Google Takvim ise bir etkinlik nesnesinde bulunur.
Aşağıdaki tabloda, bir olay nesnesinin calendar alanında bulunan alanlar listelenmiştir. Kullanıcı tarafından oluşturulan veriler olarak işaretlenen alanlar, yalnızca veriler Takvim etkinliğinde mevcutsa ve eklenti, addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| Alanlar | |
|---|---|
id |
Etkinlik kimliği. |
recurringEventId |
Düzenli bir etkinliğin kimliği. |
calendarId |
Takvim kimliği. |
organizer |
Etkinliği düzenleyen kişiyi temsil eden bir nesne. |
attendees[] |
Kullanıcı tarafından oluşturulan veriler. Takvim etkinliğine katılanların listesi. |
conferenceData |
Kullanıcı tarafından oluşturulan veriler. Bu etkinlikle ilişkili tüm konferans verilerini (ör. Google Meet konferans ayrıntıları) temsil eden bir nesne. |
capabilities |
Kullanıcı tarafından oluşturulan veriler. Eklentinin etkinlik bilgilerini görüntüleme veya güncelleme özelliklerini açıklayan bir nesne. |
Düzenleyen
| JSON gösterimi |
|---|
{ "email": string } |
| Alanlar | |
|---|---|
email |
Etkinliği düzenleyen kişinin e-posta adresi. |
Katılımcı
Attendee nesneleri, Google Takvim etkinliklerinin her bir katılımcısı hakkında bilgi içerir. Bu bilgiler, yalnızca Takvim etkinliğinde mevcutsa ve eklenti, addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| Alanlar | |
|---|---|
email |
Katılımcının e-posta adresi. |
displayName |
Katılımcının görünen adı. |
organizer |
Katılımcı bu etkinliğin düzenleyicisiyse true değerini alır. |
self |
Bu katılımcı, bu etkinliğin göründüğü takvimi temsil ediyorsa true, aksi takdirde false. |
resource |
Katılımcı bir kaynağı (ör. oda veya ekipman) temsil ediyorsa true, aksi takdirde false. |
optional |
Bu katılımcının katılımı isteğe bağlı olarak işaretlenmişse true, aksi takdirde false. |
responseStatus |
Katılımcının yanıt durumu. Olası değerler şunlardır:
|
comment |
Katılımcının yanıt yorumu (varsa). |
additionalGuests |
Katılımcının getireceğini belirttiği ek konuk sayısı. Varsayılan değer sıfırdır. |
ConferenceData
Konferans veri nesneleri, Google Takvim etkinliklerine eklenen konferanslar hakkında bilgi taşır. Bunlar, Google Meet gibi Google konferans çözümleri veya üçüncü taraf konferanslar olabilir. Bu bilgiler, yalnızca Takvim etkinliğinde mevcutsa ve eklenti, addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| Alanlar | |
|---|---|
conferenceId |
Konferansın kimliği. Bu kimlik, uygulamaların konferansları takip etmesine olanak tanır. Bu kimliği kullanıcılara göstermemeniz gerekir. |
conferenceSolution |
Hangouts veya Google Meet gibi konferans çözümünü temsil eden bir nesne. |
entryPoints[] |
URL'ler veya telefon numaraları gibi konferans giriş noktalarının listesi. |
notes |
Kullanıcıya gösterilecek konferansla ilgili ek notlar (ör. alan yöneticisinden gelen talimatlar veya yasal uyarılar). HTML içerebilir. Maksimum uzunluk 2.048 karakterdir. |
parameters |
Eklenti tarafından kullanılmak üzere tanımlanmış parametre verilerinin haritasını içeren bir nesne. |
ConferenceSolution
| JSON gösterimi |
|---|
{
"iconUri": string,
"key": {
object ( |
| Alanlar | |
|---|---|
iconUri |
Bu konferans çözümünü temsil eden ve kullanıcı tarafından görülebilen simgenin URI'si. |
key |
Bu etkinlik için konferans çözümünü benzersiz şekilde tanımlayan anahtar. |
name |
Bu konferans çözümünün kullanıcı tarafından görülebilen adı (yerelleştirilmemiş). |
Anahtar
| JSON gösterimi |
|---|
{ "type": string } |
| Alanlar | |
|---|---|
type |
Konferans çözümü türü. Olası değerler şunlardır:
|
EntryPoint
Giriş noktası nesneleri, belirli bir konferansa erişmek için belirlenen yöntemler (ör. telefon veya video) hakkında bilgi taşır. Bu bilgiler, yalnızca Takvim etkinliğinde mevcutsa ve eklenti, addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| Alanlar | |
|---|---|
accessCode |
Konferansa erişmek için kullanılan erişim kodu. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar, konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} parametrelerinin yalnızca bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin. |
entryPointType |
Giriş noktasının türü. Olası değerler şunlardır:
|
label |
Giriş noktası URI'sinin kullanıcı tarafından görülebilen etiketi (yerelleştirilmemiş). |
meetingCode |
Konferansa erişmek için kullanılan toplantı kodu. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar, konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} parametrelerinin yalnızca bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin. |
passcode |
Konferansa erişmek için kullanılan şifre kodu. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar, konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} parametrelerinin yalnızca bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin. |
password |
Konferansa erişmek için kullanılan şifre. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar, konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} parametrelerinin yalnızca bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin. |
pin |
Konferansa erişmek için kullanılan PIN. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar, konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} parametrelerinin yalnızca bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin. |
uri |
Giriş noktasının URI'si. Maksimum uzunluk 1.300 karakterdir. Biçimlendirme, giriş noktası türüne bağlıdır:
|
regionCode |
Telefon numarasının bölge kodu. URI bir ülke kodu içermiyorsa kullanıcılar tarafından gereklidir. Değerler, herkese açık CLDR bölge kodları listesine dayanır. |
entryPointFeatures[] |
Giriş noktasının özellikleri. Şu anda bu özellikler yalnızca telefon giriş noktaları için geçerlidir:
|
Parametreler
| JSON gösterimi |
|---|
{
"addOnParameters": {
object ( |
| Alanlar | |
|---|---|
addOnParameters |
Parametre dize anahtarlarının ve değerlerinin bir haritası. Bu anahtarlar ve değerler, eklentinin kullanımı için belirli bir konferansa bilgi eklemek üzere eklenti geliştiricisi tarafından tanımlanır. |
AddOnParameters
| JSON gösterimi |
|---|
{ "parameters": { string: string, ... } } |
| Alanlar | |
|---|---|
parameters |
|
Özellikler
| JSON gösterimi |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Alanlar | |
|---|---|
canSeeAttendees |
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinlik katılımcı listesini okuyabiliyorsa true, okuyamıyorsa false değerini alır. |
canAddAttendees |
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinlik katılımcı listesine yeni katılımcılar ekleyebiliyorsa true, aksi takdirde false. |
canSeeConferenceData |
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinlik konferans verilerini okuyabiliyorsa true, okuyamıyorsa false değerini alır. |
canSetConferenceData |
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinlik konferans verilerini güncelleyebiliyorsa true, aksi takdirde false. |
canAddAttachments |
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinliğe yeni ekler ekleyebiliyorsa true, aksi takdirde false değerini alır. |
DriveEventObject
Drive olay nesnesi, genel olay nesnesinin kullanıcının Google Drive'ı ve içeriği hakkında bilgi taşıyan kısmıdır. Yalnızca barındırılan uygulama Google Drive ise bir olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{ "selectedItems": [ { object ( |
| Alanlar | |
|---|---|
selectedItems[] |
Drive'da seçilen öğelerin (dosya veya klasör) listesi. |
activeCursorItem |
Şu anda etkin olan Drive öğesi. |
DriveItemMetadata
Drive öğesi nesneleri, belirli Drive öğeleri (ör. dosyalar veya klasörler) hakkında bilgi taşır.
| JSON gösterimi |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| Alanlar | |
|---|---|
id |
Seçilen öğenin kimliği. |
iconUrl |
Seçilen öğeyi temsil eden simgenin URL'si. |
mimeType |
Seçili öğenin MIME türü. |
title |
Seçilen öğenin başlığı. |
addonHasFileScopePermission |
true ise eklenti, bu öğe için https://www.googleapis.com/auth/drive.file kapsam yetkilendirmesini istemiş ve almıştır. Aksi takdirde bu alan false olur. Eklenti, https://www.googleapis.com/auth/drive veya https://www.googleapis.com/auth/drive.readonly gibi daha geniş kapsamlı bir kapsam kullanıyorsa bu alan geçerli değildir. Kullanıcı bilgilerini korumak için eklenti tasarlarken her zaman mümkün olan en az izin verilen kapsamları kullanın. |
GmailEventObject
Gmail olay nesnesi, genel olay nesnesinin kullanıcının Gmail iletileriyle ilgili bilgileri taşıyan kısmıdır. Yalnızca barındırılan uygulama Gmail ise bir olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| Alanlar | |
|---|---|
messageId |
Şu anda açık olan Gmail iletisinin kimliği. |
threadId |
Şu anda açık olan Gmail ileti dizisi kimliği. |
accessToken |
Gmail'e özel erişim jetonu. Eklentinize, kullanıcının açık olan Gmail iletisine geçici erişim izni vermek veya eklentinizin yeni taslaklar oluşturmasına izin vermek için bu jetonu |
toRecipients[] |
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu taslakta yer alan "Kime:" alıcı e-posta adreslerinin listesi. Bu alanı etkinleştirmek için manifest dosyanızdaki |
ccRecipients[] |
Varsayılan olarak devre dışıdır. Eklentinin oluşturmakta olduğu bir taslakta bulunan "CC:" alıcı e-posta adreslerinin listesi. Bu alanı etkinleştirmek için manifest dosyanızdaki |
bccRecipients[] |
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu taslakta yer alan "BCC:" alıcı e-posta adreslerinin listesi. Bu alanı etkinleştirmek için manifest dosyanızdaki |
SheetsEventObject
E-Tablolar olay nesnesi, genel olay nesnesinin kullanıcının dokümanı ve içeriği hakkında bilgi taşıyan kısmıdır. Yalnızca eklenti Google E-Tablolar'ı genişletiyorsa bir olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Alanlar | |
|---|---|
id |
Yalnızca |
title |
Yalnızca |
addonHasFileScopePermission |
|
matchedUrl |
Yalnızca aşağıdaki koşullar karşılandığında gösterilir:
Google E-Tablolar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında Kullanıcı |
MatchedUrl
Bağlantı önizleme istekleriyle döndürülen olay nesnesi.
| JSON gösterimi |
|---|
{ "url": string } |
| Alanlar | |
|---|---|
url |
Eşleşen URL. |
SlidesEventObject
Slaytlar olay nesnesi, kullanıcının dokümanı ve içeriğiyle ilgili bilgileri taşıyan genel olay nesnesinin bir parçasıdır. Yalnızca eklenti Google Slaytlar'ı genişletiyorsa bir olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Alanlar | |
|---|---|
id |
Yalnızca |
title |
Yalnızca |
addonHasFileScopePermission |
|
matchedUrl |
Yalnızca aşağıdaki koşullar karşılandığında gösterilir:
Google Slaytlar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında Kullanıcı |
DocsEventObject
Dokümanlar olay nesnesi, genel olay nesnesinin kullanıcının dokümanı ve içeriği hakkında bilgi taşıyan kısmıdır. Yalnızca eklenti Google Dokümanlar'ı genişletiyorsa bir olay nesnesinde bulunur.
| JSON gösterimi |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Alanlar | |
|---|---|
id |
Yalnızca |
title |
Yalnızca |
addonHasFileScopePermission |
|
matchedUrl |
Yalnızca aşağıdaki koşullar karşılandığında gösterilir:
Google Dokümanlar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında Kullanıcı |
ChatEventObject
Google sunucusundan eklentilere gönderilen bir Google Chat uygulaması olay nesnesi yükü. Yükler, etkinlik türünü tanımlamak için kullanılabilir.
| JSON gösterimi |
|---|
{ "type": enum ( |
| Alanlar | |
|---|---|
type |
Etkinliğin türü. Yalnızca eklenti olmayan Chat uygulamalarındaki Uygulama Ana Sayfası etkinlikleri için doldurulur. |
user |
Chat uygulamasıyla etkileşimde bulunan kullanıcı. |
space |
Etkinliğin gerçekleştiği alan. Yalnızca eklenti olmayan Chat uygulamalarındaki Uygulama Ana Sayfası etkinlikleri için doldurulur. |
eventTime |
Olay nesnesinin ne zaman gerçekleştiğini gösteren zaman damgası. Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: |
| Olay nesnesinin yükü. Yükler, olay nesnesi türüne bağlıdır. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
messagePayload |
Kullanıcı, Chat uygulamasına mesaj gönderir veya bir alanda Chat uygulamasından @bahseder. Uygulama komutu çağrıları (ör. eğik çizgi komutları ve hızlı komutlar) bunun yerine |
addedToSpacePayload |
Bir kullanıcı, Chat uygulamasını bir Chat alanına ekler veya bir Google Workspace yöneticisi, Chat uygulamasını kuruluşundaki kullanıcılar için doğrudan mesaj alanlarına yükler. |
removedFromSpacePayload |
Kullanıcı, Chat uygulamasını bir alandan kaldırdığında |
buttonClickedPayload |
Kullanıcı, bir kartın veya iletişim kutusunun Kullanıcı bir iletişim kutusuyla etkileşime girerse ButtonClickedPayload'un Tam yükte |
widgetUpdatedPayload |
Kullanıcı, yayın içi karttaki veya iletişim kutusundaki bir widget'ı güncellediğinde. Tam yükte |
appCommandPayload |
Kullanıcı bir uygulama komutu çağırır. |
systemCommandPayload |
Kullanıcı bir sistem komutu çağırır. |
| Birbirini hariç tutan alanların sonu. | |
EventType
Etkinliğin türü. Yalnızca eklenti olmayan Chat uygulamalarındaki Uygulama Ana Sayfası etkinlikleri için doldurulur.
| Sıralamalar | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
Enum için varsayılan değer. DO NOT USE. |
APP_HOME |
Kullanıcı, uygulama ana sayfasını kullanan bir Chat uygulamasından doğrudan mesaj açar. Bu tür etkinlikler için yalnızca type, user ve space alanları dahil edilir. Daha fazla bilgi için Google Chat uygulaması için ana sayfa oluşturma başlıklı makaleyi inceleyin. |
SUBMIT_FORM |
Kullanıcı, uygulama ana sayfa kartına bilgi gönderdiğinde Bu tür etkinlikler için yalnızca type, user ve space alanları dahil edilir. Daha fazla bilgi için [Google Chat uygulaması için ana sayfa oluşturma]((https://developers.google.com/workspace/chat/send-app-home-card-message) başlıklı makaleyi inceleyin. |
MessagePayload
Kullanıcı, Chat uygulamasına mesaj gönderir veya bir alanda Chat uygulamasından @bahseder. Uygulama komutu çağrıları (ör. eğik çizgi komutları ve hızlı komutlar) bunun yerine AppCommandPayload kullanır.
| JSON gösterimi |
|---|
{ "space": { object ( |
| Alanlar | |
|---|---|
space |
Zorunlu. Olay nesnesinin gerçekleştiği Chat alanı. |
message |
Olay nesnesini tetikleyen mesaj. |
configCompleteRedirectUri |
İsteğe bağlıdır. Chat uygulamasının, Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra kullanıcıyı yönlendirmesi gereken URL. Daha fazla bilgi için Chat uygulamasını diğer hizmetlere ve araçlara bağlama başlıklı makaleyi inceleyin. |
AddedToSpacePayload
Kullanıcı, Chat uygulamasını bir alana ekler veya uygulama ile kullanıcı arasında bir DM oluşturulur.
| JSON gösterimi |
|---|
{
"space": {
object ( |
| Alanlar | |
|---|---|
space |
Zorunlu. Olay nesnesinin gerçekleştiği Chat alanı. |
interactionAdd |
Uygulamanın alana bir kullanıcı etkileşimiyle (ör. Chat uygulamasından @ bahsederek veya eğik çizgi komutuyla çağırarak) eklenip eklenmediği. Bu değer "true" olarak ayarlanırsa etkileşimin kendisiyle ilişkili ayrı bir olay nesnesi Chat uygulamasına gönderilir. |
configCompleteRedirectUri |
İsteğe bağlıdır. Chat uygulamasının, Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra kullanıcıyı yönlendirmesi gereken URL. Daha fazla bilgi için Chat uygulamasını diğer hizmetlere ve araçlara bağlama başlıklı makaleyi inceleyin. |
RemovedFromSpacePayload
Kullanıcı, Chat uygulamasını bir alandan kaldırdığında
| JSON gösterimi |
|---|
{
"space": {
object ( |
| Alanlar | |
|---|---|
space |
Zorunlu. Olay nesnesinin gerçekleştiği Chat alanı. |
ButtonClickedPayload
Kullanıcı, bir Chat eklentisindeki kartın veya iletişim kutusunun etkileşimli öğesiyle etkileşimde bulunur ve bu etkileşim, Action geri çağırma işlevini tetikler. Adına rağmen bu yük, düğme tıklamaları, onChangeAction tetikleyicileri, onClick işlemleri, CardAction tıklamaları ve iletişim kutusu gönderme veya iptal etme (SUBMIT_DIALOG ve CANCEL_DIALOG) dahil olmak üzere tüm kart ve iletişim kutusu Action geri çağırmaları için doldurulur.
Kullanıcı bir iletişim kutusuyla etkileşime girerse ButtonClickedPayload'un isDialogEvent alanı true olarak ayarlanır ve bir DialogEventType içerir. Bu yük, eklenti olmayan Chat uygulamaları için SUBMIT_FORM ve CARD_CLICKED etkinlik türleriyle eşlenir.
Tam yükte CommonEventObject.form_inputs ve CommonEventObject.parameters de bulunur.
| JSON gösterimi |
|---|
{ "space": { object ( |
| Alanlar | |
|---|---|
space |
Zorunlu. Olay nesnesinin gerçekleştiği Chat alanı. |
message |
Olay nesnesini tetikleyen mesaj. |
isDialogEvent |
|
dialogEventType |
Alınan iletişim kutusu olay nesnesinin türü. |
DialogEventType
ButtonClicked veya AppCommand etkinlik yükleri içeren olay nesneleri için iletişim kutularıyla etkileşim türleri.
Google Chat uygulaması etkinlik nesneleri hakkında daha fazla bilgi edinmek için Google Chat uygulamanızla etkileşimleri alma ve yanıtlama başlıklı makaleyi inceleyin.
| Sıralamalar | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
Varsayılan değer. Belirtilmedi. |
REQUEST_DIALOG |
Kullanıcı bir iletişim kutusu açar. |
SUBMIT_DIALOG |
Kullanıcı, bir iletişim kutusunun etkileşimli öğesini tıklar. Örneğin, kullanıcı bir iletişim kutusundaki bilgileri doldurur ve bilgileri göndermek için bir düğmeyi tıklar. |
CANCEL_DIALOG |
Kullanıcı, bilgi göndermeden bir iletişim kutusunu kapattığında veya iletişim kutusu iptal edildiğinde |
WidgetUpdatedPayload
Kullanıcı, yayın içi kart veya iletişim kutusundaki bir widget'ı güncellediğinde.
Tam yükte CommonEventObject.parameters['autocomplete_widget_query'] da bulunur.
| JSON gösterimi |
|---|
{
"space": {
object ( |
| Alanlar | |
|---|---|
space |
Zorunlu. Olay nesnesinin gerçekleştiği Chat alanı. |
AppCommandPayload
Kullanıcı bir uygulama komutu çağırır.
| JSON gösterimi |
|---|
{ "appCommandMetadata": { object ( |
| Alanlar | |
|---|---|
appCommandMetadata |
Eğik çizgi komutları ve hızlı komutlar dahil olmak üzere uygulama komutları için doldurulur. |
space |
İsteğe bağlıdır. Olay nesnesinin gerçekleştiği Chat alanı. |
thread |
İsteğe bağlıdır. Varsa olay nesnesinin gerçekleştiği mesaj dizisi. Olay nesnesi belirli bir mesaj veya ileti dizisiyle ilişkiliyse bu alan doldurulur. |
message |
İsteğe bağlıdır. Olay nesnesini tetikleyen mesaj (varsa). Bu alan yalnızca eğik çizgi komutları için doldurulur. |
configCompleteRedirectUri |
İsteğe bağlıdır. Kullanıcının Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra yönlendirilmesi gereken URL. Daha fazla bilgi için Chat uygulamasını diğer hizmetlere ve araçlara bağlama başlıklı makaleyi inceleyin. |
isDialogEvent |
İsteğe bağlıdır. Kullanıcının bir iletişim kutusuyla etkileşimde bulunup bulunmadığı veya bulunmak üzere olup olmadığı. |
dialogEventType |
İsteğe bağlıdır. Alınan iletişim kutusu olay nesnesinin türü. Bu alan yalnızca |
AppCommandMetadata
Chat uygulaması komutu ile ilgili meta veriler.
| JSON gösterimi |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Alanlar | |
|---|---|
appCommandId |
Chat API yapılandırmasında belirtilen komutun kimliği. |
appCommandType |
Chat uygulaması komutunun türü. |
AppCommandType
Chat uygulaması komutunun türü. Ayrıntılı bilgi için Chat uygulaması komutlarının türleri başlıklı makaleyi inceleyin.
| Sıralamalar | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
Varsayılan değer. Belirtilmedi. |
SLASH_COMMAND |
Eğik çizgi komutu. Kullanıcı, komutu bir sohbet mesajında gönderir. |
QUICK_COMMAND |
Hızlı komut. Kullanıcı, mesaj yanıt alanındaki Chat menüsünden komutu seçer. |
MESSAGE_ACTION |
Mesaj işlemi. Kullanıcı, Chat'teki mesaj bağlam menüsünden komutu seçer. |
SystemCommandPayload
Kullanıcı bir sistem komutu çağırır.
| JSON gösterimi |
|---|
{ "systemCommandMetadata": { object ( |
| Alanlar | |
|---|---|
systemCommandMetadata |
Çağrılan sistem komutuyla ilgili meta veriler. |
space |
İsteğe bağlıdır. Olay nesnesinin gerçekleştiği Chat alanı. |
thread |
İsteğe bağlıdır. Varsa olay nesnesinin gerçekleştiği mesaj dizisi. Olay nesnesi belirli bir mesaj veya ileti dizisiyle ilişkiliyse bu alan doldurulur. |
SystemCommandMetadata
Kullanıcı tarafından tetiklenen bir sistem komutuyla ilgili meta veriler.
| JSON gösterimi |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"cancelStream": {
object ( |
| Alanlar | |
|---|---|
| Sistem komutu çağrıldı. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
cancelStream |
Etkin bir akış mesajını iptal etme komutu. |
| Birbirini hariç tutan alanların sonu. | |
CancelStream
Etkin bir akış mesajını iptal etme komutu.
| JSON gösterimi |
|---|
{ "streamMessage": string } |
| Alanlar | |
|---|---|
streamMessage |
Zorunlu. İptal komutunun gerçekleştirildiği akış mesajının kaynak adı. Biçim: |
WorkflowEventObject
LINT.IfChange İş akışı eklentilerine iletilen olay nesnesi.
| JSON gösterimi |
|---|
{ "executionMetadata": { object ( |
| Alanlar | |
|---|---|
executionMetadata |
İş akışının yürütülmesiyle ilgili meta veriler. |
triggerEventSource |
Tetikleyici etkinliklerin kaynağı. |
| İş akışı etkinliği yükünün türü. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
actionInvocation |
İş akışı işleminin çağrılması. |
triggerCreation |
İş akışı tetikleyicisi oluşturma. |
triggerDeletion |
İş akışı tetikleyicisinin silinmesi. |
resourceRetrieval |
Bir kaynağın alınması (değişken enflasyonu için kullanılır). |
elementConfiguration |
İş akışı öğesinin yapılandırması. |
resourceFieldsDefinitionRetrieval |
Bir kaynak tarafından desteklenen alan tanımlarının alınması. |
elementUiAutocomplete |
Şu anda oluşturulan kart için otomatik tamamlama önerileri. |
| Birbirini hariç tutan alanların sonu. | |
ActionInvocation
İş akışı işleminin çağrılması.
| JSON gösterimi |
|---|
{ "inputs": { string: { object ( |
| Alanlar | |
|---|---|
inputs |
Giriş değişkeni adına göre anahtarlanmış giriş değişkenlerinin haritası.
|
triggerId |
Eşzamansız işlem yanıtları için kullanılacak tetikleyici kimliği. |
flowLevelContext |
İsteğe bağlıdır. Önceki adımlardan akış düzeyinde bağlam. |
VariableData
Farklı türlerde birden fazla değer içerebilen değişken verileri temsil eder.
| JSON gösterimi |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| Alanlar | |
|---|---|
booleanValues[] |
Boole değerleri. |
integerValues[] |
Tam sayı değerleri. |
floatValues[] |
Kayan noktalı değerler. |
stringValues[] |
Dize değerleri. |
timestampValues[] |
Zaman damgası değerleri. Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: |
resourceReferences[] |
Kaynak referansları (kimlikler). |
emailAddressValues[] |
E-posta adresi değerleri. |
googleUserValues[] |
|
textFormatValues[] |
İş akışı metin biçimi değerleri. |
ResourceReference
Uygulamaya özgü kaynağın kimlik değeri.
| JSON gösterimi |
|---|
{
"resourceType": {
object ( |
| Alanlar | |
|---|---|
resourceType |
Bu kimliğin işaret ettiği kaynağın türü. |
resourceId |
Kaynağın kimliği. |
ResourceType
Özel kaynak türünün adı.
| JSON gösterimi |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Alanlar | |
|---|---|
workflowBundleId |
Bu kaynak türünün sahibi olan iş akışı paketinin kimliği. Bu isteğe bağlıdır ve boş bırakılırsa kullanıldığı paketle aynı olduğu kabul edilir. |
workflowResourceDefinitionId |
Kaynağın benzersiz tanımlayıcısı. Bu değerin yalnızca aynı paket içinde benzersiz olması gerekir. |
WorkflowTextFormat
Stiller, köprüler ve etkileşimli öğeler gibi zengin biçimlendirme seçenekleri içeren bir metin bloğu.
| JSON gösterimi |
|---|
{
"textFormatElements": [
{
object ( |
| Alanlar | |
|---|---|
textFormatElements[] |
Metin biçimi öğeleri koleksiyonu. |
TextFormatElement
WorkflowTextFormat mesajındaki tek bir öğe. Bu öğe; çip, stilli metin, köprü veya liste kapsayıcısı olabilir.
| JSON gösterimi |
|---|
{ // 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 ( |
| Alanlar | |
|---|---|
| Olası birkaç metin biçimi öğesinden birini temsil eden öğe. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
text |
Metin biçimindeki metin. |
chip |
Metin biçiminde tıklanabilir çip. |
styledText |
Metin biçiminde stillendirilmiş metin. |
hyperlink |
Metin biçimindeki köprü. |
listContainer |
Metin biçimindeki liste kapsayıcısı. |
| Birbirini hariç tutan alanların sonu. | |
Çip
Metin biçiminde tıklanabilir bir çip.
| JSON gösterimi |
|---|
{
"icon": {
object ( |
| Alanlar | |
|---|---|
icon |
Çipte gösterilen simge. |
label |
Çipte gösterilen metin. |
url |
Çip tıklandığında gidilecek URL. |
Simge
Çipteki bir simge.
| JSON gösterimi |
|---|
{ // 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. } |
| Alanlar | |
|---|---|
| Çipte gösterilen simge. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
iconUrl |
HTTPS URL'sinde barındırılan özel bir simge gösterilir. Örneğin: Desteklenen dosya türleri |
materialIconName |
Google Materyal Simgesi'nde tanımlanan simge adı (ör. |
| Birbirini hariç tutan alanların sonu. | |
StyledText
Kalın, italik ve renk gibi stillere sahip metin öğesi.
| JSON gösterimi |
|---|
{ "text": string, "styles": [ enum ( |
| Alanlar | |
|---|---|
text |
Metnin ana içeriği. |
styles[] |
Metne uygulanan stiller koleksiyonu. |
fontWeight |
Metnin yazı tipi kalınlığı. |
color |
Metnin rengi |
wrapStyle |
Metnin kaydırma stili. |
Stil
İtalik, altı çizili vb. farklı metin stilleri için enum.
| Sıralamalar | |
|---|---|
STYLE_UNSPECIFIED |
Stil uygulanmadı. DO NOT USE. |
ITALIC |
İtalik stil. |
UNDERLINE |
Altı çizili stil. |
STRIKETHROUGH |
Üstü çizili stil. |
LINE_BREAK |
Satır sonu. |
UPPERCASE |
Büyük harf stili. |
CODE |
Kodlayın. |
CODE_BLOCK |
Kod bloğu. |
FontWeight
Farklı yazı tipi kalınlıkları için enum.
| Sıralamalar | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
Normal kalınlıkta standart ağırlık. DO NOT USE. |
LIGHT |
Daha ince ve hafif tasarım. |
MEDIUM |
Hafif ve kalın arasında orta ağırlık. |
BOLD |
Daha kalın ve daha ağır. |
WrapStyle
Farklı sarmalama stilleri için enum.
| Sıralamalar | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
Kaydırma stili belirtilmedi. |
NO_WRAP |
Sarma stili yok. |
Köprü
Metin ve bağlantı içeren köprü öğesi.
| JSON gösterimi |
|---|
{ "link": string, "text": string } |
| Alanlar | |
|---|---|
link |
Köprünün hedef URL'si. |
text |
Köprünün metni. |
ListContainer
Her liste öğesinin birden fazla TextFormatElement içerebileceği liste öğeleri için kapsayıcı.
| JSON gösterimi |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Alanlar | |
|---|---|
listNestLevel |
Listenin iç içe yerleştirme seviyesi. Üst düzey için 0'dan başlar ve her iç içe yerleştirilmiş liste için 1 artar. |
listType |
Listenin türü. |
listItems[] |
Liste öğeleri koleksiyonu. |
ListType
Farklı liste türleri için enum.
| Sıralamalar | |
|---|---|
LIST_TYPE_UNSPECIFIED |
Liste türü belirtilmedi. DO NOT USE. |
ORDERED |
Sıralı liste. |
UNORDERED |
Sırasız liste. |
BLOCKQUOTE |
Blok alıntı listesini temsil eder. |
ListItem
Liste öğesi.
| JSON gösterimi |
|---|
{
"textFormatElements": [
{
object ( |
| Alanlar | |
|---|---|
textFormatElements[] |
Metin biçimi öğeleri koleksiyonu. |
FlowLevelContext
Önceki adımların çıkışlarını içeren akış düzeyinde bağlam.
| JSON gösterimi |
|---|
{
"stepContexts": [
{
object ( |
| Alanlar | |
|---|---|
stepContexts[] |
İsteğe bağlıdır. Önceki adımların listesi. Sıralama önemlidir. Bu nedenle, yürütme sırasının bu listede korunduğundan emin olun. |
StepContext
Akış düzeyinde bağlam için adım bağlamı meta verileri ve çıkışları.
| JSON gösterimi |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| Alanlar | |
|---|---|
stepId |
İsteğe bağlıdır. İş akışı grafiğindeki adımın benzersiz kimliği. |
outputs |
İsteğe bağlıdır. Bu adımda oluşturulan çıkış değişkenlerinin haritası (değişken adına göre anahtarlanmış).
|
TriggerCreation
İş akışı tetikleyicisi oluşturma.
| JSON gösterimi |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Alanlar | |
|---|---|
triggerId |
Oluşturma sırasında sağlanan tetikleyicinin benzersiz tanımlayıcısı. |
triggerType |
Tetikleyicinin türü. |
inputs |
Giriş değişkeni adına göre anahtarlanmış giriş değişkenlerinin haritası.
|
notifyUri |
Tetikleyici etkinleştiğinde çağrılacak uç nokta. |
TriggerType
Tetikleyicinin türü.
| Sıralamalar | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
Varsayılan değer. DO NOT USE. |
REPEATING |
Tetikleyici, giriş koşulları her karşılandığında etkinleşir. |
TriggerDeletion
İş akışı tetikleyicisinin silinmesi.
| JSON gösterimi |
|---|
{ "triggerId": string } |
| Alanlar | |
|---|---|
triggerId |
Oluşturma sırasında sağlanan tetikleyicinin benzersiz tanımlayıcısı. |
ResourceRetrieval
Bir kaynağın alınması.
| JSON gösterimi |
|---|
{
"resourceReference": {
object ( |
| Alanlar | |
|---|---|
resourceReference |
Alınacak kaynağın türü ve kimliği. |
ElementConfiguration
İş akışı öğesi yapılandırılırken çağrılır.
| JSON gösterimi |
|---|
{ "inputs": { string: { object ( |
| Alanlar | |
|---|---|
inputs |
Giriş değişkeni adına göre anahtarlanmış giriş değişkenlerinin haritası. Bu harita boş olabilir. İş akışı ana sayfasında tek bir iş akışı öğesi (tetikleyici veya işlem) yapılandırılırken kullanılır.
|
displayDestination |
Öğe yapılandırma kartının hedefi. Öğeler, hedefe göre farklı yapılandırma kartı düzenleri döndürmek için bu alanı kullanabilir. |
nodeId |
Oluşturulan temel yapılandırmanın düğüm kimliği. |
workflowId |
Oluşturulan temel yapılandırmanın iş akışı kimliği. |
availableVariables[] |
Kullanılabilir değişkenler, düğüm konumuna göre sıralanır. |
DisplayDestination
Geri dönen öğe yapılandırma kartının nerede gösterileceğini belirtir.
| Sıralamalar | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
Varsayılan değer. DO NOT USE. |
DISPLAY_DESTINATION_SIDE_PANEL |
Yapılandırma kartı, yan panelde gösterilir. |
DISPLAY_DESTINATION_FULL_SCREEN |
Yapılandırma kartı, tam ekran uygulamada gösterilir. |
VariableReference
İş akışındaki bir değişkene yönelik değişken referansı.
| JSON gösterimi |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| Alanlar | |
|---|---|
parentElementId |
Değişkeni üreten öğenin temel kimliği. Gerekirse bunu WorkflowElement veya daha ayrıntılı bir meta veri proto'su olarak genişletebiliriz. |
nodeId |
Düğüm referans kimliği |
path |
Değişken seçici yol imzası |
dataType |
Değişken veri türü |
iconUrl |
Bu değişkeni üreten temel öğenin simge URL'si. |
stepNumber |
Bu değişkeni üreten temel öğenin adım numarası. |
descriptionText |
Değişkenin açıklaması. |
displayText |
Değişken çipinin görünen metni. |
DataType
Değişkenin türü.
| JSON gösterimi |
|---|
{ "valueMetadata": { object ( |
| Alanlar | |
|---|---|
valueMetadata |
Bir değişkenin potansiyel değerleri hakkındaki meta veriler. |
| Veri türü. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır: | |
basicType |
Temel veri türü. |
resourceType |
Uygulama kaynağı kimlik türü. |
| Birbirini hariç tutan alanların sonu. | |
BasicType
Temel genel veri türleri.
| Sıralamalar | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
Varsayılan değer. DO NOT USE. |
STRING |
Karakterlerden oluşan bir dize. |
INTEGER |
Tam sayı. |
FLOAT |
Kayan nokta biçiminde sayı. |
TIMESTAMP |
ISO 8601 biçiminde zaman damgası. |
BOOLEAN |
Doğru veya yanlış olabilen bir değer. |
EMAIL_ADDRESS |
E-posta adresi biçiminde bir dize olan e-posta adresi. |
GOOGLE_USER |
users/{user} biçiminde Google hizmetlerinin kullanıcısı. |
FILE |
Dosya referansı. |
FORMATTED_TEXT |
Zengin biçimlendirmeye sahip metin. |
ValueMetadata
Bir değişkenin potansiyel değerleri hakkında bilgi.
| JSON gösterimi |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| Alanlar | |
|---|---|
enumValues[] |
İsteğe bağlıdır. Bir dize için izin verilen değerleri belirtir. Bu yalnızca |
dynamicTypes[] |
İsteğe bağlıdır. Bir değişken için dinamik olarak dönüştürülebilecek izin verilen türleri belirtir. Bu, yalnızca DataType bir dize ve değişken bir çıkışsa ayarlanabilir. |
semanticDescriptors[] |
İsteğe bağlıdır. Bir değişkenin semantik anlamını açıklamaya yardımcı olur. |
dynamicSchema |
İsteğe bağlıdır. Bu değişkenin şemasını dinamik olarak çözümleme yapılandırması. |
defaultValue |
İsteğe bağlıdır. Bu değişkenin varsayılan değerini belirten dize. Örneğin, boole değerleri için |
SemanticDescriptor
Bir değişkenin semantik anlamıyla ilgili meta veriler.
| JSON gösterimi |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Alanlar | |
|---|---|
resourceAttribute |
Değişkenin bir kaynağın belirli bir özelliğine karşılık geldiğini gösterir. Bu, özellikle bir kaynağın tanımlayıcısını (kimlik, URL, anahtar vb.) temsil eden değişkenler için kullanışlıdır. Önerilen biçim: - Örnekler: - İstemci, belirli bir girişle uyumlu çıkış değişkenleri hakkında kullanıcıya ipucu vermek için bu bilgileri kullanır. |
disallowedResourceAttributes[] |
İsteğe bağlıdır. Yalnızca girişler için geçerlidir ve çıkışlar için yok sayılır. Bu semantik tanımlayıcıya karşılık gelen izin verilmeyen özellikler. İstemci, bu izin verilmeyen kaynak özelliklerinden herhangi birine karşılık gelen çıkışlar için değişken seçimini açıkça engeller. |
DynamicSchema
Bu değişkenin şemasını çalışma zamanında dinamik olarak çözümleme yapılandırması.
| JSON gösterimi |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| Alanlar | |
|---|---|
requiredInputIds[] |
Bu değişkenin şeması dinamik olarak çözümlenmeden önce sağlanması gereken eş giriş değişkenlerinin kimlikleri. |
strictEnum |
Doğru olduğunda, değişkenin değeri dinamik olarak çözümlenen enum değerlerinden biriyle eşleşmelidir. Yanlış olduğunda, dinamik olarak çözümlenen değerler katı olmayan öneriler olarak değerlendirilir. |
ResourceFieldsDefinitionRetrieval
Bir kaynak tarafından desteklenen alanların tanımını alır.
| JSON gösterimi |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| Alanlar | |
|---|---|
elementId |
Dinamik kaynak şeması getirilecek öğenin kimliğini belirtir. |
inputs |
Bu, değişkeni sağlayan düğümün alan girişlerinden oluşur. Giriş değişkeni adına göre anahtarlanmış giriş değişkenlerinin haritası.
|
ElementUiAutocomplete
Şu anda oluşturulan kart için otomatik tamamlama önerileri.
| JSON gösterimi |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Alanlar | |
|---|---|
query |
Otomatik tamamlanacak sorgu. |
inputs |
Giriş değişkeni adına göre anahtarlanmış giriş değişkenlerinin haritası.
|
invokedFunction |
Widget ile ilişkili çağrılan işlev. |
resourceId |
Otomatik olarak tamamlanması gereken kaynak kimliği. Bu alan isteğe bağlıdır ve ayarlanmayabilir. |
operationId |
Otomatik olarak tamamlanacak kaynağı sağlayan işlemin kimliği. Bu alan isteğe bağlıdır ve ayarlanmayabilir. |
ExecutionMetadata
İş akışının yürütülmesiyle ilgili meta veriler.
| JSON gösterimi |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| Alanlar | |
|---|---|
versionId |
Çağrılan iş akışı öğesinin sürümü. |
timeZone |
Kaydedilen iş akışının saat dilimi. Örneğin, "America/Los_Angeles". |
stepNumber |
Çağrılan temel öğenin adım numarasını temsil eder. |
TriggerEventSource
Bu yürütmeyi tetikleyen tetikleyici etkinliğin kaynağı.
| Sıralamalar | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
Varsayılan değer. DO NOT USE. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
Yürütme, etkinlikler tarafından otomatik olarak tetiklenir. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
Yürütme, test çalıştırması aracılığıyla tetiklenir. |