Etkinlik nesneleri

Bu sayfada, Google Workspace eklentileri etkinlik nesnelerinin yapısı özetlenmektedir.

Etkinlik nesneleri, bir kullanıcı eklentiyle etkileşimde bulunduğunda otomatik olarak oluşturulan ve tetikleyici veya geri çağırma işlevlerine parametre olarak iletilen JSON yapılarıdır. Etkinlik nesneleri, eklentinin sunucu taraflı geri çağırma işlevine ana makine uygulaması ve mevcut bağlam hakkında istemci tarafı bilgileri taşır.

Google Workspace eklentileri, aşağıdaki yerlerde etkinlik nesnelerini kullanır:

  • Ana sayfa tetikleyicileri. Tanımladığınız her homepageTrigger işlevine, ana sayfa tetikleyici işlevi etkinleştirildiğinde otomatik olarak bir etkinlik nesnesi iletilir. Etkin ana makine uygulamasını, istemcinin platformunu, kullanıcının yerel ayarlarını ve diğer bilgileri belirlemek için bu nesneyi ana sayfa tetikleyici işlevinizde kullanabilirsiniz.

    Ana sayfa tetikleyicileri tetiklendiğinde oluşturulan etkinlik nesneleri, diğer iki durumda yer alan tüm alanları içermez. Widget'larla ve bağlamsal bilgilerle ilgili alanlar atlanır.

  • Bağlamsal tetikleyiciler. Her barındırıcı uygulama, kullanıcı belirli bir bağlama girdiğinde tetiklenen farklı bir bağlamsal tetikleyici grubu sağlar. Örneğin:

    Bağlamsal tetikleyici etkinleştirildiğinde, ana uygulama, eklenti manifestinde listelenen ilgili runFunction işlevini çağırır ve parametre olarak bir etkinlik nesnesi iletir. İçeriğe dayalı tetikleyiciler tetiklendiğinde oluşturulan etkinlik nesneleri, ana sayfa tetikleyici etkinlik nesnelerinde bulunan tüm alanların yanı sıra içeriğe dayalı bilgiler içeren alanları da içerir.

  • Widget işlemleri. Etkinlik nesneleri, Gmail eklentilerinin kullandığı işlem modeli kullanılarak widget etkileşimi sağlamak için de kullanılır. Google Workspace eklentileri, tüm widget işleyici işlevlerini, Action nesnelerini ve işlem yanıtlarını kullanır. Ancak Google Workspace eklentilerinde işlem etkinliği nesneleri, geri çağırma işlevinin üzerinde işlem yapabileceği daha fazla bilgi içerir.

    Widget işlemleri sonucunda oluşturulan etkinlik nesneleri, bağlamsal tetikleyici etkinlik nesnelerinde bulunan tüm alanların yanı sıra widget bilgilerini içeren alanları da içerir.

  • Bağlantı tetikleyicilerini önizleme. Google Dokümanlar, E-Tablolar ve Slaytlar'da, belirli URL kalıplarına göre üçüncü taraf hizmetleri için bağlantı önizlemelerini yapılandırabilirsiniz. Kullanıcılar, kalıba uyan bir bağlantıyla etkileşimde bulunduğunda linkPreviewTriggers tetiklenir ve bağlantıyı içeren bir etkinlik nesnesi, tetikleyicinin geri çağırma işlevine iletilir. Eklentiniz, bu etkinlik nesnesini kullanarak ana uygulama içindeki bağlantıyla ilgili bilgileri gösteren bir akıllı çip ve kart oluşturabilir. Kullanıcıların önizleme kartı ve içeriğiyle etkileşime girmesine olanak tanıyan widget işlemleri de oluşturabilirsiniz.

  • Google Chat uygulama tetikleyicileri. Google Chat'te eklentiniz kullanıcılara Chat uygulaması olarak görünür. Kullanıcılar, eklentiyi alanlara ekleyerek, mesaj göndererek, eğik çizgi komutlarını kullanarak ve daha birçok şekilde eklentiyle etkileşimde bulunabilir. Etkileşimli özellikler oluşturmak için çeşitli Chat uygulaması tetikleyicilerini ayarlayıp kullanırsınız. Her tetikleyici, her etkileşim türünü işlemenize veya bunlara yanıt vermenize yardımcı olan farklı bir etkinlik nesnesi yükü gönderir.

Etkinlik nesnesi yapısı

Aşağıdaki tabloda, Google Workspace eklentileri etkinlik nesnelerinin üst düzey yapısı açıklanmaktadır. Etkinlik nesnesi yapısı, ana bilgisayardan bağımsız bilgiler için commonEventObject üst düzey alanını içerir. Her etkinlik nesnesi, etkin ana makine uygulamasına göre belirlenen ana makineye özgü üst düzey alanlardan birini de içerebilir: gmailEventObject, calendarEventObject veya driveEventObject.

Google Workspace eklentileri etkinlik nesneleri, geriye dönük uyumluluk için Gmail eklenti işlemi etkinlik nesnelerinde kullanılan tüm orijinal alanları da içerir. Bu alanlar, aşağıdaki tabloda "Orijinal Gmail eklentisi alanları" altında listelenir. Bu alanlardaki bilgiler, yeni nesne yapısında yeniden oluşturulur.

Etkinlik nesnesi
eventObject.commonEventObject Common fields object
Barındıran uygulamadan bağımsız olarak tüm etkinlik nesneleri için ortak olan bilgileri içeren bir nesne.
eventObject.calendar Calendar event object
Yalnızca görüşmeyi düzenleyen Google Takvim ise mevcut olur. Takvim ve etkinlik bilgilerini içeren bir nesne.
eventObject.chat Chat event object
Yalnızca arama düzenleyeni Google Chat ise gösterilir. Chat bilgilerini içeren bir nesne.
eventObject.drive Drive event object
Yalnızca arayan ana makine Google Drive ise bulunur. Drive bilgilerini içeren bir nesne.
eventObject.gmail Gmail event object
Yalnızca görüşmeyi düzenleyen Gmail ise gösterilir. Gmail bilgilerini içeren bir nesne.
eventObject.docs Docs event object
Yalnızca çağıran ana makine Google Dokümanlar ise mevcut olur. Dokümanlar bilgilerini içeren bir nesne.
eventObject.sheets Sheets event object
Yalnızca arayan taraf Google E-Tablolar ise gösterilir. E-tablo bilgilerini içeren bir nesne.
eventObject.slides Slides event object
Yalnızca arayan ana makine Google Slaytlar ise gösterilir. Slaytlar bilgilerini içeren bir nesne.
Orijinal Gmail eklentisi alanları
eventObject.messageMetadata.accessToken string
Kullanımdan kaldırıldı. Erişim jetonu. Geçici Gmail eklenti kapsamlarını kullanarak kullanıcı verilerine erişimi etkinleştirmek için bu ayarı kullanabilirsiniz.

Google Workspace eklentileri için bu bilgiyi eventObject.gmail.accessToken alanında bulabilirsiniz.

eventObject.messageMetadata.messageId string
Kullanımdan kaldırıldı. Gmail kullanıcı arayüzünde açılan ileti dizisinin ileti kimliği.

Google Workspace eklentileri için bu bilgiyi eventObject.gmail.messageId alanında bulabilirsiniz.

eventObject.clientPlatform string
Kullanımdan kaldırıldı. Etkinliğin nereden kaynaklandığını (web, iOS veya Android) gösterir.

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.platform alanında bulabilirsiniz.

eventObject.formInput object
Kullanımdan kaldırıldı. Karttaki tüm form widget'larının geçerli değerlerinin haritası. Widget başına bir değerle sınırlıdır. Anahtarlar, widget'larla ilişkili dize kimlikleri, değerler ise dizelerdir. Etkinlik nesnesi, metin girişleri ve anahtarlar gibi tekil değerler içeren birden fazla widget'tan veri okumanız gerektiğinde kolaylık sağlamak için formInput özelliğini sunar. Onay kutuları gibi çok değerli widget'lar için her değeri formInputs öğesinden okuyabilirsiniz.

Google Workspace eklentileri için bu bilgileri eventObject.commonEventObject.formInputs alanında bulabilirsiniz. Tek değer içeren widget'lar, tek öğeli diziler olarak gösterilir.

eventObject.formInputs object
Kullanımdan kaldırıldı. Karttaki widget'ların mevcut değerlerinin dize listeleri olarak sunulduğu bir harita. Anahtarlar, widget'la ilişkili dize kimlikleridir. Tek değerli widget'lar için değer, tek öğeli bir dizide sunulur. Onay kutusu grupları gibi çok değerli widget'larda tüm değerler bir listede gösterilir.

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.formInputs alanında bulabilirsiniz.

eventObject.parameters object
Kullanımdan kaldırıldı. Action.setParameters() kullanarak Action öğesine sağladığınız ek parametrelerin haritası. Harita anahtarları ve değerleri dizelerdir.

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.parameters alanında bulabilirsiniz.

eventObject.userCountry string
Desteği sonlandırıldı ve varsayılan olarak devre dışı bırakıldı. Kullanıcının ülkesini veya bölgesini belirten iki harfli kod. Ayrıca sayısal bir UN M49 ülke kodu da olabilir.

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.userLocale alanında bulabilirsiniz.

eventObject.userLocale string
Desteği sonlandırıldı ve varsayılan olarak devre dışı bırakıldı. Kullanıcının dilini belirten iki harfli ISO 639 kodu. Daha fazla bilgi için Kullanıcının yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.userLocale alanında bulabilirsiniz.

eventObject.userTimezone.id string
Desteği sonlandırıldı ve varsayılan olarak devre dışı bırakıldı. Kullanıcının saat diliminin saat dilimi tanımlayıcısı. Örnekler: America/New_York, Europe/Vienna ve Asia/Seoul. Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.timeZone.id alanında bulabilirsiniz.

eventObject.userTimezone.offset string
Desteği sonlandırıldı ve varsayılan olarak devre dışı bırakıldı. Kullanıcının saat diliminin Eşgüdümlü Evrensel Zaman'a (UTC) göre saat farkı (milisaniye cinsinden). Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.timeZone.offset alanında bulabilirsiniz.

Ortak etkinlik nesnesi

Ortak etkinlik nesnesi, genel ve ana makineden bağımsız bilgileri kullanıcının istemcisinden eklentiye taşıyan genel etkinlik nesnesinin bir bölümüdür. Bu bilgiler arasında kullanıcının yerel ayarı, barındırıcı uygulama ve platform gibi ayrıntılar yer alır.

Ana sayfa ve bağlamsal tetikleyicilere ek olarak, kullanıcı widget'larla etkileşimde bulunduğunda eklentiler işlem geri çağırma işlevlerine etkinlik nesneleri oluşturup iletir. Eklentinizin geri çağırma işlevi, kullanıcının istemcisindeki açık widget'ların içeriğini belirlemek için ortak etkinlik nesnesini sorgulayabilir. Örneğin, eklentiniz kullanıcının eventObject.commentEventObject.formInputs nesnesindeki TextInput widget'ına girdiği metni bulabilir.

Sık kullanılan etkinlik nesnesi alanları
commonEventObject.platform string
Etkinliğin kaynağını gösterir (`WEB`, `IOS` veya `ANDROID`).
commonEventObject.formInputs object
Gösterilen karttaki widget'ların mevcut değerlerini içeren bir harita. Harita anahtarları, her widget'a atanan dize kimlikleridir.

Harita değeri nesnesinin yapısı, widget türüne bağlıdır:

  • Tek değerli widget'lar (ör. metin kutusu): bir dizeler listesi (yalnızca bir öğe).

    Örnek: Kimliği employeeName olan bir metin girişi widget'ı için metin girişi değerine e.commonEventObject.formInputs.employeeName.stringInputs.value[0] ile erişin.

  • Çok değerli widget'lar (ör. onay kutusu grupları): bir dizi dize.

    Örnek: Kimliği participants olan çok değerli bir widget için değer dizisine e.commonEventObject.formInputs.participants.stringInputs.value ile erişin.

  • A date-time picker: a DateTimeInput object.

    Örnek: Kimliği myDTPicker olan bir seçici için, DateTimeInput nesnesine e.commonEventObject.formInputs.myDTPicker.dateTimeInput kullanarak erişin.

  • A date-only picker: a DateInput object.

    Örnek: Kimliği myDatePicker olan bir seçici için, DateInput nesnesine e.commonEventObject.formInputs.myDatePicker.dateInput kullanarak erişin.

  • A time-only picker: a TimeInput object.

    Örnek: Kimliği myTimePicker olan bir seçici için, TimeInput nesnesine e.commonEventObject.formInputs.myTimePicker.timeInput kullanarak erişin.
commonEventObject.hostApp string
Etkinlik nesnesi oluşturulduğunda eklentinin etkin olduğu ana uygulamayı gösterir. Olası değerler şunlardır:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
actionParameters veya Action.setParameters() kullanarak bir işleme sağladığınız ek parametreler.

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 "autocomplete_widget_query" anahtarının değerini (event.commonEventObject.parameters["autocomplete_widget_query"]) kullanın. Bu değeri, bir veritabanına sorgu göndermek ve kullanıcılar yazarken seçilebilir öğeler önermek için kullanabilirsiniz. Ayrıntılı bilgi için Google Chat kullanıcılarından bilgi toplama ve bu bilgileri işleme başlıklı makaleyi inceleyin.
commonEventObject.userLocale string
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çiminde olmalıdır. Örneğin, en-US.

Bu alanı etkinleştirmek için eklentinizin manifest dosyasında addOns.common.useLocaleFromApp değerini true olarak ayarlamanız gerekir. Eklentinizin kapsam listesi de https://www.googleapis.com/auth/script.locale kapsamını içermelidir. Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.

commonEventObject.timeZone string
Varsayılan olarak devre dışıdır. Saat dilimi kimliği ve farkı. Bu alanı etkinleştirmek için eklentinizin manifest dosyasında addOns.common.useLocaleFromApp değerini true olarak ayarlamanız gerekir. Eklentinizin kapsam listesi de https://www.googleapis.com/auth/script.locale içermelidir. Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.
commonEventObject.timeZone.id string
Kullanıcının saat diliminin saat dilimi tanımlayıcısı. Örnekler: America/New_York, Europe/Vienna ve Asia/Seoul. Bu alanı etkinleştirmek için eklentinizin manifest dosyasında addOns.common.useLocaleFromApp değerini true olarak ayarlamanız gerekir. Eklentinizin kapsam listesi de https://www.googleapis.com/auth/script.locale içermelidir. Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.
commonEventObject.timeZone.offset string
Kullanıcının saat diliminin Eşgüdümlü Evrensel Zaman'a (UTC) göre zaman farkı (milisaniye cinsinden). Daha fazla bilgi için Kullanıcı yerel ayarına ve saat dilimine erişme başlıklı makaleyi inceleyin.

Tarih/saat seçici form girişleri

İşlem geri çağırma işlevleri commonEventObject.formInputs alanında mevcut widget değerlerini alabilir. Buna, kullanıcının tarih veya saat seçici widget'larında seçtiği tarih ya da saat değerleri dahildir. Ancak bilgilerin yapısı, widget'ın tarih ve saat seçici, yalnızca tarih seçici veya yalnızca saat seçici olarak yapılandırılmasına bağlı olarak değişir. Yapısal farklılıklar aşağıdaki tabloda açıklanmıştır:

DateTimeInput nesnesi
dateTimeInput.hasDate Giriş tarihi ve saati tarih içeriyorsa boolean
true, yalnızca saat içeriyorsa false.
dateTimeInput.hasTime Giriş tarihi ve saati saat içeriyorsa boolean
true, yalnızca tarih içeriyorsa false.
dateTimeInput.msSinceEpoch string
Kullanıcı tarafından seçilen zaman, sıfır zamandan (1 Ocak 1970'te 00:00:00 UTC) itibaren milisaniye cinsinden.
DateInput nesnesi
dateInput.msSinceEpoch string
Kullanıcı tarafından seçilen zaman, sıfır zamandan (1 Ocak 1970'te 00:00:00 UTC) itibaren milisaniye cinsinden.
TimeInput nesnesi
timeInput.hours number
Kullanıcı tarafından seçilen saat numarası.
timeInput.minutes number
Kullanıcı tarafından seçilen dakika numarası.

Sohbet etkinliği nesnesi

Chat etkinlik nesnesi, genel etkinlik nesnesinin bir kullanıcının Chat uygulamasıyla etkileşimleri hakkındaki bilgileri taşıyan kısmıdır. Yalnızca eklenti Google Chat'i genişletiyorsa bir etkinlik nesnesinde bulunur.

Sohbet
chat.user object (User)
Chat uygulamasıyla etkileşimde bulunan Chat kullanıcısı.
chat.space object (Space)
Kullanıcının Chat uygulamasıyla etkileşimde bulunduğu Chat alanı.
chat.eventTime

string (Timestamp format)

Etkileşimin gerçekleştiği saat.

Birleştirme alanı payload.

payload yalnızca aşağıdakilerden biri olabilir:
chat.messagePayload

object (MessagePayload)

Chat uygulamalarının bir Message tetikleyicisinden aldığı yük.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Chat uygulamalarının bir Added to space tetikleyicisinden aldığı yük.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Chat uygulamalarının Alandan kaldırıldı tetikleyicisinden aldığı yük.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Kullanıcılar bir mesajdaki veya karttaki düğmeyi tıkladığında Chat uygulamalarının aldığı yük. Kullanıcı bilgi göndermek için bir düğmeyi tıkladığında commonEventObject.formInputs nesnesi, kullanıcıdan toplanan değerleri içerir. Ayrıntılı bilgi için Google Chat kullanıcılarından bilgi toplama başlıklı makaleyi inceleyin.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Kullanıcılar bir selectionInput widget'ının çoklu seçim menüsüne metin yazdığında Chat uygulamalarının aldığı yük. Sohbet uygulamaları, dinamik bir veri kaynağındaki önerilen öğeleri doldurmak için bu etkinlik nesnesini kullanabilir. Örneğin, bir Chat uygulaması, harici bir veri kaynağından destek kayıtlarını doldurmak için kullanıcının menüye yazdıklarına göre veri kaynağını sorgulayabilir ve ardından eşleşen destek kayıtlarını seçilebilir öğeler olarak döndürebilir.

CommonEventObject.parameters['autocomplete_widget_query'] nesnesi, kullanıcının menüye yazdığı dize değerini içerir.

chat.appCommandPayload

object (AppCommandPayload)

Bir kullanıcı Chat uygulamasından komut kullandığında Chat uygulamalarının aldığı yük.

Yük

Chat uygulaması etkileşiminin türüne bağlı olarak, etkinlik bir veya daha fazla Chat API kaynağı içeren bir yük içerir.

Mesaj yükü
MessagePayload
chat.messagePayload.message object (Message)
Etkinliği tetikleyen Chat mesajı.
chat.messagePayload.space object (Space)
Kullanıcının Chat uygulamasını çağıran mesajı gönderdiği Chat alanı.
chat.messagePayload.configCompleteRedirectUri string
Chat uygulamasının, kullanıcıyı Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra yönlendirmesi gereken URL. Daha fazla bilgi için Google Workspace eklentinizi üçüncü taraf hizmetine bağlama başlıklı makaleyi inceleyin.

Uzay yüküne eklendi
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Kullanıcının Chat uygulamasını eklediği veya yüklediği Chat alanı.

Yöneticiler Chat uygulamalarını yüklediğinde space.adminInstalled alanı true olarak ayarlanır.

chat.addedToSpacePayload.interactionAdd boolean
Kullanıcının, Chat uygulamasını bir alana mesaj kullanarak ekleyip eklemediği. Örneğin, Chat uygulamasından @bahsetme veya komut kullanma. true ise Chat, mesajla ilgili bilgileri içeren bir messagePayload ile başka bir etkinlik nesnesi gönderir.
chat.addedToSpacePayload.configCompleteRedirectUri string
Chat uygulamasının, kullanıcıyı Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra yönlendirmesi gereken URL. Daha fazla bilgi için Google Workspace eklentinizi üçüncü taraf hizmetine bağlama başlıklı makaleyi inceleyin.

Alan yükünden kaldırıldı
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Kullanıcının Chat uygulamasını kaldırdığı veya uygulamanın yüklemesini sildiği Chat alanı.

Yöneticiler Chat uygulamalarını kaldırdığında space.adminInstalled alanı false olarak ayarlanır.

Düğme tıklandı yükü
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Kullanıcının tıkladığı düğmeyi içeren sohbet mesajı.
chat.buttonClickedPayload.space object (Space)
Kullanıcının Chat uygulaması mesajından bir düğmeyi tıkladığı Chat alanı.
chat.buttonClickedPayload.isDialogEvent boolean
Kullanıcının bir iletişim kutusuyla etkileşim kurmak için düğmeyi tıklayıp tıklamadığı.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
isDialogEvent true ise iletişim kutusundaki etkileşim türü.

Enum DialogEventType.

dialogEventType değeri yalnızca aşağıdakilerden biri olabilir:
TYPE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
REQUEST_DIALOG Kullanıcı bir iletişim kutusu ister. Örneğin, bir komut kullanır veya iletideki bir düğmeyi tıklarsa.
SUBMIT_DIALOG Kullanıcı, bir iletişim kutusundaki etkileşimli öğeyi tıklar. Örneğin, bir kullanıcı iletişim kutusunda bilgileri doldurur ve bilgileri göndermek için bir düğmeyi tıklar.

Widget güncellendi yükü
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Etkileşimin gerçekleştiği Chat alanı.

Uygulama komutu yükü
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Kullanıcının hangi komutu kullandığı ve komutu nasıl tetiklediğiyle ilgili meta veriler.
chat.appCommandPayload.space object (Space)
Kullanıcının komutu kullandığı Chat alanı.
chat.appCommandPayload.thread object (Thread)
Etkileşim bir ileti dizisinde gerçekleştiyse kullanıcının komutu kullandığı Sohbet ileti dizisi.
chat.appCommandPayload.message object (Message)
Eğik çizgi komutları için eğik çizgi komutunu içeren ileti.
chat.appCommandPayload.configCompleteRedirectUri string
Komut için yetkilendirme veya yapılandırma gerekiyorsa kullanıcıyı Google Chat dışında işlemi tamamladıktan sonra yönlendirecek bir URL.
chat.appCommandPayload.isDialogEvent boolean
Komutun bir iletişim kutusu açıp açmadığı.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Bir iletişim kutusuyla etkileşim türü.

Enum DialogEventType.

dialogEventType değeri yalnızca aşağıdakilerden biri olabilir:
TYPE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
REQUEST_DIALOG Kullanıcı bir iletişim kutusu ister. Örneğin, bir komut kullanır veya iletideki bir düğmeyi tıklarsa.
SUBMIT_DIALOG Kullanıcı, bir iletişim kutusundaki etkileşimli öğeyi tıklar. Örneğin, bir kullanıcı iletişim kutusunda bilgileri doldurur ve bilgileri göndermek için bir düğmeyi tıklar.
Uygulama Komutu Meta Verileri
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

Komut kimliği.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Komutun türü.

Enum AppCommandType.

AppCommandType değeri yalnızca aşağıdakilerden biri olabilir:
APP_COMMAND_TYPE_UNSPECIFIED Varsayılan değer. Belirtilmedi.
SLASH_COMMAND Kullanıcı, eğik çizgi / ile başlayan bir mesaj göndererek komutu kullanır.
QUICK_COMMAND Kullanıcı, mesaj yanıt alanındaki Chat menüsünden komutu seçer.

Takvim etkinliği nesnesi

Takvim etkinliği nesnesi, genel etkinlik nesnesinin bir kullanıcının takvimi ve takvim etkinlikleri hakkındaki bilgileri taşıyan kısmıdır. Yalnızca eklenti Google Takvim'i genişletiyorsa bir etkinlik nesnesinde bulunur.

Aşağıdaki tabloda, bir etkinlik nesnesinin calendarEventObject alanında bulunan alanlar listelenmektedir. 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 etkinlik nesnesinde bulunur.

Takvim etkinliği nesnesi
calendar.attendees[] list of attendee objects
Kullanıcı tarafından oluşturulan veriler. Takvim etkinliğinin katılımcılarının listesi.
calendar.calendarId string
Takvim kimliği.
calendar.capabilities object
Kullanıcı tarafından oluşturulan veriler. Eklentinin etkinlik bilgilerini görüntüleme veya güncelleme özelliklerini açıklayan bir nesne.
calendar.capabilities.canAddAttendees boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti, etkinliğin katılımcı listesine yeni katılımcılar ekleyebiliyorsa; false aksi takdirde.
calendar.capabilities.canSeeAttendees boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti, etkinliğin katılımcı listesini okuyabiliyorsa; false Aksi takdirde.
calendar.capabilities.canSeeConferenceData boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti, etkinlik konferans verilerini okuyabiliyorsa false aksi takdirde.
calendar.capabilities.canSetConferenceData boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti, etkinlik konferans verilerini güncelleyebiliyorsa false aksi takdirde.
calendar.capabilities.canAddAttachments boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti etkinliğe yeni ekler ekleyebiliyorsa; false aksi takdirde.
calendar.conferenceData Conference data object
Kullanıcı tarafından oluşturulan veriler. Google Meet konferans ayrıntıları gibi bu etkinlikle ilişkili tüm konferans verilerini temsil eden bir nesne.
calendar.id string
Etkinlik kimliği.
calendar.organizer object
Etkinliği düzenleyeni temsil eden bir nesne.
calendar.organizer.email string
Etkinliği düzenleyenin e-posta adresi.
calendar.recurringEventId string
Düzenli bir etkinliğin kimliği.

Katılımcı

Katılımcı nesneleri, Google Takvim etkinliklerine katılan kişiler hakkında bilgi taşır. Bu bilgiler, yalnızca veriler Takvim etkinliğinde mevcutsa ve eklenti addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa etkinlik nesnesinde bulunur.

Katılımcı nesnesi
attendee.additionalGuests number
Katılımcının getireceğini belirttiği ek konuk sayısı. Varsayılan değer sıfırdır.
attendee.comment string
Katılımcının yanıt yorumu (varsa).
attendee.displayName string
Katılımcının görünen adı.
attendee.email string
Katılımcının e-posta adresi.
attendee.optional Bu katılımcının katılımı isteğe bağlı olarak işaretlenmişse boolean
true, aksi takdirde false.
attendee.organizer boolean
true Katılımcı, bu etkinliğin düzenleyicisiyse.
attendee.resource boolean
true katılımcı, oda veya ekipman gibi bir kaynağı temsil ediyorsa; false aksi takdirde.
attendee.responseStatus string
Katılımcının yanıt durumu. Olası değerler şunlardır:
  • accepted: Katılımcı, etkinlik davetini kabul etti.
  • declined: Katılımcı, etkinlik davetini reddetti.
  • needsAction: Katılımcı, etkinlik davetiyesine yanıt vermedi.
  • tentative: Katılımcı, etkinlik davetini geçici olarak kabul etti.
attendee.self boolean
true Bu katılımcı, bu etkinliğin göründüğü takvimi temsil ediyorsa; false aksi takdirde.

Konferans verileri

Konferans verileri nesneleri, Google Takvim etkinliklerine eklenen konferanslarla ilgili bilgileri taşır. Bunlar Google Meet gibi Google konferans çözümleri veya üçüncü taraf konferansları olabilir. Bu bilgiler, yalnızca veriler Takvim etkinliğinde mevcutsa ve eklenti addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa etkinlik nesnesinde bulunur.

Konferans verileri nesnesi
conferenceData.conferenceId string
Konferansın kimliği. Bu kimlik, uygulamaların konferansları takip etmesine olanak tanımak için tasarlanmıştır. Bu kimliği kullanıcılara göstermemelisiniz.
conferenceData.conferenceSolution object
Konferans çözümünü temsil eden bir nesne (ör. Hangouts veya Google Meet).
conferenceData.conferenceSolution.iconUri string
Bu konferans çözümünü temsil eden, kullanıcı tarafından görülebilen simgenin URI'si.
conferenceData.conferenceSolution.key object
Bu etkinlik için konferans çözümünü benzersiz şekilde tanımlayan anahtar.
conferenceData.conferenceSolution.key.type string
Konferans çözümü türü. Olası değerler şunları içerir:
  • eventHangout Tüketiciler için Hangouts (http://hangouts.google.com).
  • Google Workspace kullanıcıları için klasik Hangouts'a (http://hangouts.google.com) eventNamedHangout
  • Google Meet için hangoutsMeet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Bu konferans çözümünün kullanıcı tarafından görülebilen adı (yerelleştirilmemiş).
conferenceData.entryPoints[] list of entry point objects
URL'ler veya telefon numaraları gibi konferansa giriş noktalarının listesi.
conferenceData.notes string
Kullanıcıya gösterilecek konferansla ilgili ek notlar (ör. alan yöneticisinden gelen talimatlar veya yasal bildirimler). HTML içerebilir. En çok 2.048 karakterden oluşabilir.
conferenceData.parameters object
Eklenti tarafından kullanılmak üzere tanımlanmış parametre verilerinin haritasını içeren bir nesne.
conferenceData.parameters.addOnParameters object
Parametre dizesi anahtarlarının ve değerlerinin haritası. Bu anahtarlar ve değerler, eklenti geliştiricisi tarafından tanımlanır. Amaç, eklentinin kullanımı için belirli bir konferansa bilgi eklemektir.

Giriş noktası

Giriş noktası nesneleri, belirli bir konferansa erişim yöntemleri (ör. telefon veya video) hakkında bilgi taşır. Bu bilgiler, yalnızca veriler Takvim etkinliğinde mevcutsa ve eklenti, addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa etkinlik nesnesinde bulunur.

Giriş noktası nesnesi
entryPoint.accessCode string
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 yalnızca {accessCode, meetingCode, passcode, password, pin} öğelerinin bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin.
entryPoint.entryPointFeatures list
Giriş noktasının özellikleri. Şu anda bu özellikler yalnızca phone giriş noktaları için geçerlidir:
  • toll: Giriş noktası, ücretli bir telefon görüşmesidir.
  • toll_free: Giriş noktası, ücretsiz bir telefon görüşmesidir.
entryPoint.entryPointType string
Giriş noktasının türü. Olası değerler şunlardır:
  • more: Alternatif telefon numaraları gibi ek konferansa katılma talimatları. Bir konferansta yalnızca bir more giriş noktası olabilir. Giriş noktası varsa en az bir başka türde giriş noktası da gereklidir.
  • phone: Telefon numarası üzerinden konferansa katılın. Bir konferansta sıfır veya daha fazla phone giriş noktası olabilir. Google Takvim, biçimlendirme ve alfabetik sıralamadan sonra yalnızca ilk iki telefon giriş noktasını gösterir.
  • sip: Konferansa SIP üzerinden katılın. Bir konferansta en fazla bir sip giriş noktası olabilir.
  • video: Konferansa HTTP üzerinden katılın. Bir konferansta en fazla bir video giriş noktası olabilir.
entryPoint.label string
Giriş noktası URI'sinin kullanıcı tarafından görülebilen etiketi (yerelleştirilmemiş).
entryPoint.meetingCode string
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 yalnızca {accessCode, meetingCode, passcode, password, pin} öğelerinin bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin.
entryPoint.passcode string
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 yalnızca {accessCode, meetingCode, passcode, password, pin} öğelerinin bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin.
entryPoint.password string
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 yalnızca {accessCode, meetingCode, passcode, password, pin} öğelerinin bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin.
entryPoint.pin string
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 yalnızca {accessCode, meetingCode, passcode, password, pin} öğelerinin bir alt kümesini kullanır. Yalnızca konferans sağlayıcının kullandığı alanları eşleştirin ve gösterin.
entryPoint.regionCode string
Telefon numarasının bölge kodu. URI'de ülke kodu yoksa kullanıcılar tarafından gereklidir. Değerler, herkese açık CLDR bölge kodu listesine göre belirlenir.
entryPoint.uri string
Giriş noktasının URI'si. Maksimum uzunluk 1.300 karakterdir. Biçimlendirme, giriş noktası türüne bağlıdır:
  • more: http: veya https: şeması gereklidir.
  • phone: tel: şeması gereklidir. URI, tüm arama sırasını içermelidir (örneğin, "tel:+12345678900,,,12345678;1234").
  • sip: sip: veya sips: şeması gereklidir. Örneğin "sip:12345678@myprovider.com".
  • video: http: veya https: şeması gereklidir.

Drive etkinlik nesnesi

Drive etkinlik nesnesi, genel etkinlik nesnesinin bir kullanıcının Google Drive'ı ve içeriğiyle ilgili bilgileri taşıyan kısmıdır. Yalnızca eklenti Google Drive'ı genişletiyorsa bir etkinlik nesnesinde bulunur.

Drive etkinlik nesnesi
drive.activeCursorItem Drive item object
Şu anda etkin olan Drive öğesi.
drive.selectedItems[] list of Drive item objects
Drive'da seçilen öğelerin (dosyalar veya klasörler) listesi.

Drive öğesi

Drive öğesi nesneleri, dosyalar veya klasörler gibi belirli Drive öğeleriyle ilgili bilgileri taşır.

Drive öğesi nesnesi
item.addonHasFileScopePermission boolean
true ise eklenti, bu öğe için https://www.googleapis.com/auth/drive.file kapsam yetkilendirmesi istemiş ve almıştır. Aksi takdirde bu alan false olur.
item.id string
Seçilen öğenin kimliği.
item.iconUrl string
Seçili öğeyi temsil eden simgenin URL'si.
item.mimeType string
Seçilen öğenin MIME türü.
item.title string
Seçilen öğenin başlığı.

Gmail etkinlik nesnesi

Gmail etkinlik nesnesi, genel etkinlik nesnesinin kullanıcının Gmail iletileriyle ilgili bilgileri taşıyan kısmıdır. Yalnızca barındıran uygulama Gmail ise bir etkinlik nesnesinde bulunur.

Gmail etkinlik nesnesi
gmail.accessToken string
Gmail'e özel erişim jetonu. Bu jetonu, eklentinize kullanıcının şu anda açık olan Gmail iletisine geçici erişim izni vermek veya eklentinizin yeni taslaklar oluşturmasına izin vermek için GmailApp.setCurrentMessageAccessToken(accessToken) yöntemiyle birlikte kullanabilirsiniz.
gmail.bccRecipients[] list of strings
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu bir taslağa şu anda dahil edilen "BCC:" alıcı e-posta adreslerinin listesi. Bu alanı etkinleştirmek için manifest dosyanızdaki addOns.gmail.composeTrigger.draftAccess alanını METADATA olarak ayarlamanız gerekir.
gmail.ccRecipients[] list of strings
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu bir taslağa şu anda dahil edilen "CC:" alıcısı e-posta adreslerinin listesi. Bu alanı etkinleştirmek için manifest dosyanızdaki addOns.gmail.composeTrigger.draftAccess alanını METADATA olarak ayarlamanız gerekir.
gmail.messageId string
Şu anda açık olan Gmail iletisinin kimliği.
gmail.threadId string
Şu anda açık olan Gmail ileti dizisinin kimliği.
gmail.toRecipients[] list of strings
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu bir taslağa şu anda dahil edilen "Kime" alıcısı e-posta adreslerinin listesi. Bu alanı etkinleştirmek için manifest dosyanızdaki addOns.gmail.composeTrigger.draftAccess alanını METADATA olarak ayarlamanız gerekir.

Dokümanlar etkinliği nesnesi

Docs etkinlik nesnesi, genel etkinlik nesnesinin bir kullanıcının dokümanı ve içeriğiyle ilgili bilgileri taşıyan kısmıdır. Yalnızca eklenti Google Dokümanlar'ı genişletiyorsa bir etkinlik nesnesinde bulunur.

Dokümanlar etkinliği nesnesi
docs.id string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirildiyse bulunur.
Dokümanlar kullanıcı arayüzünde açık olan dokümanın kimliği.
docs.title string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirildiyse bulunur.
Dokümanlar kullanıcı arayüzünde açık olan dokümanın başlığı.
docs.addonHasFileScopePermission boolean
Eğer true ise eklenti, Dokümanlar kullanıcı arayüzünde açık olan doküman için https://www.googleapis.com/auth/drive.file kapsam yetkilendirmesi istemiş ve almıştır. Aksi takdirde bu alan false olur.
docs.matchedUrl.url string
Yalnızca aşağıdaki koşullar karşılandığında gösterilir:
  • https://www.googleapis.com/auth/workspace.linkpreview, kullanıcı tarafından yetkilendirilmiş olmalıdır.
  • URL, LinkPreviewTriggers tetikleyicisinde belirtilen ana makine kalıbıyla eşleşiyor.

Google Dokümanlar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında LinkPreviewTriggers yapılandırmanız gerekir. Daha fazla bilgi için Akıllı çipleri kullanarak bağlantıları önizleme başlıklı makaleyi inceleyin.

Kullanıcı bağlantıyı önizlediğinde kullanılan örnek yük https://www.example.com/12345: 

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

E-Tablolar etkinlik nesnesi

E-Tablolar etkinlik nesnesi, genel etkinlik nesnesinin bir kullanıcının dokümanı ve içeriğiyle ilgili bilgileri taşıyan kısmıdır. Yalnızca eklenti Google E-Tablolar'ı genişletiyorsa bir etkinlik nesnesinde bulunur.

E-Tablolar etkinlik nesnesi
sheets.id string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirildiyse gösterilir. E-Tablolar kullanıcı arayüzünde açık olan e-tablonun kimliği.
sheets.title string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirildiyse gösterilir. E-Tablolar kullanıcı arayüzünde açık olan e-tablonun başlığı.
sheets.addonHasFileScopePermission boolean
Eğer true ise eklenti, E-Tablolar kullanıcı arayüzünde açık olan e-tablo için https://www.googleapis.com/auth/drive.file kapsam yetkilendirmesi istemiş ve bu yetkilendirmeyi almış demektir. Aksi takdirde bu alan false olur.
sheets.matchedUrl.url string
Yalnızca aşağıdaki koşullar karşılandığında gösterilir:
  • https://www.googleapis.com/auth/workspace.linkpreview, kullanıcı tarafından yetkilendirilmiş olmalıdır.
  • URL, LinkPreviewTriggers tetikleyicisinde belirtilen ana makine kalıbıyla eşleşiyor.

Google E-Tablolar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında LinkPreviewTriggers yapılandırmanız gerekir. Daha fazla bilgi için Akıllı çipleri kullanarak bağlantıları önizleme başlıklı makaleyi inceleyin.

Kullanıcı bağlantıyı önizlediğinde kullanılan örnek yük https://www.example.com/12345:

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

Slaytlar etkinlik nesnesi

Slaytlar etkinlik nesnesi, genel etkinlik nesnesinin bir kullanıcının dokümanı ve içeriğiyle ilgili bilgileri taşıyan kısmıdır. Yalnızca eklenti Google Slaytlar'ı genişletiyorsa bir etkinlik nesnesinde bulunur.

Slaytlar etkinlik nesnesi
slides.id string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirildiyse gösterilir. Slaytlar kullanıcı arayüzünde açık olan sununun kimliği.
slides.title string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirildiyse gösterilir. Slaytlar kullanıcı arayüzünde açık olan sununun başlığı.
slides.addonHasFileScopePermission boolean
Eğer true ise eklenti, Slaytlar kullanıcı arayüzünde açık olan sunu için https://www.googleapis.com/auth/drive.file kapsam yetkilendirmesi istemiş ve bu yetkilendirmeyi almış demektir. Aksi takdirde bu alan false olur.
slides.matchedUrl.url string
Yalnızca aşağıdaki koşullar karşılandığında gösterilir:
  • https://www.googleapis.com/auth/workspace.linkpreview, kullanıcı tarafından yetkilendirilmiş olmalıdır.
  • URL, LinkPreviewTriggers tetikleyicisinde belirtilen ana makine kalıbıyla eşleşiyor.

Google Slaytlar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında LinkPreviewTriggers yapılandırmanız gerekir. Daha fazla bilgi için Akıllı çipleri kullanarak bağlantıları önizleme başlıklı makaleyi inceleyin.

Kullanıcı bağlantıyı önizlediğinde kullanılan örnek yük https://www.example.com/12345:

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