Etkinlik nesneleri

Bu sayfada, Google Workspace eklentisi etkinlik nesnelerinin yapısı özetlenmiştir.

Etkinlik nesneleri, kullanıcı bir eklentiyle etkileşimde bulunduğunda işlevleri tetiklemek veya geri çağırılmak üzere otomatik olarak oluşturulan ve parametre olarak iletilen JSON yapılardır. Etkinlik nesneleri, ana uygulama ve mevcut bağlamla ilgili istemci tarafı bilgileri eklentinin sunucu tarafı geri çağırma işlevine taşır.

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

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

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

  • İçeriğe dayalı tetikleyiciler. Her barındırıcı uygulaması, kullanıcı belirli bir bağlama girdiğinde tetiklenen farklı bir bağlama tetikleyicisi grubu sağlar. Örneğin:

    Bağlamsal tetikleyici etkinleştirildiğinde, barındıran uygulama eklenti manifestinde listelenen ilgili runFunction öğesini çağırır ve parametre olarak bir etkinlik nesnesi iletir. İçeriğe dayalı tetikleyiciler etkinleştiğinde oluşturulan etkinlik nesneleri, ana sayfa tetikleyici etkinlik nesnelerine dahil edilen tüm alanları ve içeriğe dayalı bilgileri içeren alanları içerir.

  • Widget işlemleri. Etkinlik nesneleri, Gmail eklentilerinin kullandığı işlem modelini kullanarak widget etkileşimi sağlamak için de kullanılır. Google Workspace eklentileri, widget işleyici işlevlerinin, Action nesnelerinin ve işlem yanıtlarının tümünü kullanır. Ancak Google Workspace eklentilerindeki işlem etkinliği nesneleri, geri çağırma işlevinin kullanabileceği daha da fazla bilgi içerir.

    Widget işlemleri sonucunda oluşturulan etkinlik nesneleri, bağlamsal tetikleyici etkinlik nesnelerine dahil edilen tüm alanları ve widget bilgilerini içeren alanları içerir.

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

  • Google Chat uygulaması tetikleyicileri (geliştirici önizlemesi). 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 fazlasını yaparak bu eklentiyle etkileşim kurabilir. Etkileşimli özellikler oluşturmak için çeşitli Chat uygulaması tetikleyicileri oluşturup kullanırsınız. Her tetikleyici, her etkileşim türünü işlemenize veya yanıtlamanıza yardımcı olan farklı bir etkinlik nesnesi yükü gönderir.

Etkinlik nesnesi yapısı

Aşağıdaki tabloda, Google Workspace eklentisi etkinlik nesnelerinin üst düzey yapısı açıklanmaktadır. Etkinlik nesnesi yapısı, ana makineye bağlı olmayan bilgiler için commonEventObject üst düzey bir alan içerir. Her etkinlik nesnesi, etkin ana makine uygulamasına göre belirlenen aşağıdaki ana makineye özgü üst düzey alanlardan birine de sahip olabilir: gmailEventObject, calendarEventObject veya driveEventObject.

Geriye dönük uyumluluk için Google Workspace eklentisi etkinlik nesneleri, Gmail eklentisi işlem etkinlik nesnelerinde kullanılan tüm orijinal alanları da içerir. Bu alanlar aşağıdaki tabloda "Orijinal Gmail eklenti alanları" bölümünde 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 nesnelerinde ortak olan bilgileri içeren bir nesne.
eventObject.calendar Calendar event object
Yalnızca arayan düzenleyen Google Takvim ise mevcuttur. Takvim ve etkinlik bilgilerini içeren bir nesne.
eventObject.chat Chat event object
Yalnızca arayan düzenleyen Google Chat ise mevcuttur. Chat bilgilerini içeren bir nesne.
eventObject.drive Drive event object
Yalnızca arayan ana makine Google Drive ise mevcuttur. Drive bilgilerini içeren bir nesne.
eventObject.gmail Gmail event object
Yalnızca arayan ana makine Gmail ise mevcuttur. Gmail bilgilerini içeren bir nesne.
eventObject.docs Docs event object
Yalnızca arayan ana makine Google Dokümanlar ise mevcuttur. Docs bilgilerini içeren bir nesne.
eventObject.sheets Sheets event object
Yalnızca arayan düzenleyen Google E-Tablolar ise mevcuttur. E-Tablolar bilgilerini içeren bir nesne.
eventObject.slides Slides event object
Yalnızca arayan düzenleyen 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 eklentisi kapsamlarını kullanarak kullanıcı verilerine erişimi etkinleştirmek için bu özelliği kullanabilirsiniz.

Google Workspace eklentilerinde bu bilgiyi eventObject.gmail.accessToken alanında bulabilirsiniz.

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

Google Workspace eklentilerinde bu bilgiyi eventObject.gmail.messageId alanında bulabilirsiniz.

eventObject.clientPlatform string
Kullanımdan kaldırıldı. Etkinliğin kaynağını (web, iOS veya Android) belirtir.

Google Workspace eklentilerinde bu bilgiyi eventObject.commonEventObject.platform alanında bulabilirsiniz.

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

Google Workspace eklentileri için bu bilgiyi eventObject.commonEventObject.formInputs alanında bulabilirsiniz. Tek değere sahip widget'lar tek bir öğeye sahip diziler olarak temsil edilir.

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

Google Workspace eklentilerinde bu bilgiyi eventObject.commonEventObject.formInputs alanında bulabilirsiniz.

eventObject.parameters object
Kullanımdan kaldırıldı. Action.setParameters() kullanarak Action parametresine gönderdiğiniz ek parametrelerin haritası. Harita anahtarları ve değerleri dizedir.

Google Workspace eklentilerinde bu bilgiyi eventObject.commonEventObject.parameters alanında bulabilirsiniz.

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

Google Workspace eklentilerinde bu bilgiyi eventObject.commonEventObject.userLocale alanında bulabilirsiniz.

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

Google Workspace eklentilerinde bu bilgiyi eventObject.commonEventObject.userLocale alanında bulabilirsiniz.

eventObject.userTimezone.id string
Desteği sonlandırıldı ve varsayılan olarak devre dışıdır. 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 eklentilerinde bu bilgiyi eventObject.commonEventObject.timeZone.id alanında bulabilirsiniz.

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

Google Workspace eklentilerinde bu bilgiyi eventObject.commonEventObject.timeZone.offset alanında bulabilirsiniz.

Ortak etkinlik nesnesi

Ortak etkinlik nesnesi, genel etkinlik nesnesinin, kullanıcının istemcisinden eklentiye ana makineye bağlı olmayan genel bilgileri taşıyan bölümüdür. Bu bilgiler arasında kullanıcının yerel ayarı, barındırma uygulaması ve platformu gibi ayrıntılar yer alır.

Eklentiler, ana sayfa ve bağlamsal tetikleyicilere ek olarak, kullanıcı widget'larla etkileşimde bulunduğunda etkinlik nesnelerini oluşturup işlem geri çağırma işlevlerine iletir. Eklentinizin geri çağırma işlevi, kullanıcının istemcisinde 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 nesnesinde bir TextInput widget'ına girdiği metni bulabilir.

Sık kullanılan etkinlik nesnesi alanları
commonEventObject.platform string
Etkinliğin nereden geldiğini 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): dize listesi (yalnızca bir öğe).

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

  • Çok değerli widget'lar (ör. onay kutusu grupları): dizelerden oluşan bir liste.

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

  • A date-time picker: a DateTimeInput object.

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

  • A date-only picker: a DateInput object.

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

  • A time-only picker: a TimeInput object.

    Örnek: myTimePicker kimlikli bir seçici için e.commonEventObject.formInputs.myTimePicker.timeInput kullanarak TimeInput nesnesine 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 eklentiler için, kullanıcıların çoklu seçim menülerine yazdıklarına göre öğe önermek üzere "autocomplete_widget_query" anahtarının değerini (event.commonEventObject.parameters["autocomplete_widget_query"]) kullanın. Bu değeri, bir veritabanını sorgulamak 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 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. Ö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 https://www.googleapis.com/auth/script.locale değerini de 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 https://www.googleapis.com/auth/script.locale değerini de 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 https://www.googleapis.com/auth/script.locale değerini de 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ı saat diliminin Eşgüdümlü Evrensel Zaman (UTC) ile arasındaki 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, tarih veya saat seçici widget'larında kullanıcının seçtiği tarih ya da saat değerleri de 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ılıp yapılandırılmadığı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ş tarih ve saati bir tarih içeriyorsa boolean
true; false yalnızca saat içeriyorsa.
dateTimeInput.hasTime Giriş tarih ve saati bir saat içeriyorsa boolean
true; false yalnızca bir tarih içeriyorsa.
dateTimeInput.msSinceEpoch string
Kullanıcı tarafından seçilen zaman (milisaniye cinsinden), sıfır zamandan (1 Ocak 1970'de 00:00:00 UTC) itibaren.
DateInput nesnesi
dateInput.msSinceEpoch string
Kullanıcı tarafından seçilen zaman (milisaniye cinsinden), sıfır zamandan (1 Ocak 1970'de 00:00:00 UTC) itibaren.
TimeInput nesnesi
timeInput.hours number
Kullanıcı tarafından seçilen saat numarası.
timeInput.minutes number
Kullanıcı tarafından seçilen dakika sayısı.

Chat etkinliği nesnesi

Chat etkinlik nesnesi, genel etkinlik nesnesinin bir kullanıcının Chat uygulamasıyla etkileşimleri hakkında bilgi 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şime geçen 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 zaman.

Birlik alanı payload.

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

object (MessagePayload)

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

object (AddedToSpacePayload)

Chat uygulamalarının Alana eklendi 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 mesaj veya karttaki düğmeyi tıkladığında Chat uygulamalarının aldığı yük. Kullanıcı bir düğmeyi tıklayarak bilgi gönderirse 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 girdiğinde Chat uygulamalarının aldığı yük. Sohbet uygulamaları, önerilen öğeleri dinamik bir veri kaynağından 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ığına göre veri kaynağını sorgulayabilir ve ardından eşleşen tüm 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)

Kullanıcı Chat uygulamasından bir 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ı, Chat uygulamasını çağıran mesajı gönderdiği Chat alanı.
chat.messagePayload.configCompleteRedirectUri string
Kullanıcı, Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra Chat uygulamasının kullanıcıyı 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ğini belirtir. Örneğin, Chat uygulamasını @mention eder veya bir komut kullanır. true ise Chat, mesajla ilgili bilgileri içeren bir messagePayload ile başka bir etkinlik nesnesi gönderir.
chat.addedToSpacePayload.configCompleteRedirectUri string
Kullanıcı, Google Chat dışında bir yetkilendirme veya yapılandırma akışını tamamladıktan sonra Chat uygulamasının kullanıcıyı 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ünden kaldırıldı
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Kullanıcının Chat uygulamasını kaldırdığı veya kaldırdığı Chat alanı.

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

Düğme tıklama 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ı, Chat uygulaması mesajındaki bir düğmeyi tıkladığı Chat alanı.
chat.buttonClickedPayload.isDialogEvent boolean
Kullanıcının iletişim kutusuyla etkileşim kurmak için düğmeyi tıklayıp tıklamadığını belirtir.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Eğer isDialogEvent true ise bir iletişim kutusunda 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 komutu kullanır veya bir iletideki düğmeyi tıklar.
SUBMIT_DIALOG Kullanıcı, bir iletişim kutusundaki etkileşimli bir öğeyi tıklar. Örneğin, bir kullanıcı bir iletişim kutusunda bilgileri doldurur ve bilgileri göndermek için bir düğmeyi tıklar.

Widget güncelleme 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ı tarafından kullanılan komut ve komutun nasıl tetiklendiğiyle ilgili meta veriler.
chat.appCommandPayload.space object (Space)
Kullanıcı 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 mesaj.
chat.appCommandPayload.configCompleteRedirectUri string
Komut için yetkilendirme veya yapılandırma gerekiyorsa kullanıcının, işlemi Google Chat dışında tamamladıktan sonra yönlendirileceği URL.
chat.appCommandPayload.isDialogEvent boolean
Komutun bir iletişim kutusu açıp açmayacağını belirtir.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
İletiş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 komutu kullanır veya bir iletideki düğmeyi tıklar.
SUBMIT_DIALOG Kullanıcı, bir iletişim kutusundaki etkileşimli bir öğeyi tıklar. Örneğin, bir kullanıcı bir 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ında bilgi 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. Etkinlik bilgilerini görüntüleme veya güncelleme konusunda eklentinin yeteneklerini açıklayan bir nesne.
calendar.capabilities.canAddAttendees boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti, etkinlik katılımcısı listesine yeni katılımcı ekleyebiliyorsa; false aksi takdirde.
calendar.capabilities.canSeeAttendees boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti etkinlik katılımcısı 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. Bu etkinlikle ilişkili tüm konferans verilerini (ör. Google Meet konferansı ayrıntıları) 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üzenleyen kullanıcının e-posta adresi.
calendar.recurringEventId string
Düzenli bir etkinliğin kimliği.

Katılımcı

Katılımcı nesneleri, Google Takvim etkinliklerindeki katılımcılarla ilgili bilgileri 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ıya gösterilen 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şaretlendiyse boolean
true, aksi takdirde false.
attendee.organizer boolean
true katılımcı bu etkinliğin düzenleyicisiyse
attendee.resource boolean
true katılımcı bir oda veya ekipman gibi bir kaynağı temsil ediyorsa; false aksi takdirde.
attendee.responseStatus string
Katılımcıya ait yanıt durumu. Olası değerler şunlardır:
  • accepted: Katılımcı etkinlik davetini kabul etmiş demektir.
  • declined: Katılımcı etkinlik davetini reddetti.
  • needsAction: Katılımcı, etkinlik davetine yanıt vermemiştir.
  • tentative: Katılımcı, etkinlik davetini geçici olarak kabul etti.
attendee.self Bu katılımcı, etkinliğin göründüğü takvimi temsil ediyorsa boolean
true, aksi takdirde false değerini alır.

Konferans verileri

Konferans veri nesneleri, Google Takvim etkinliklerine ekli konferanslarla ilgili bilgileri içerir. Bunlar Google konferans çözümleri (ör. Google Meet) veya üçüncü taraf konferansları olabilir. Bu bilgiler, veriler Takvim etkinliğinde mevcutsa ve eklenti addOns.calendar.currentEventAccess manifest alanını READ veya READ_WRITE olarak ayarlarsa etkinlik nesnesinde bulunur.

Konferans veri nesnesi
conferenceData.conferenceId string
Konferansın kimliği. Bu kimliğin amacı, uygulamaların konferansları takip etmesine izin vermektir. Bu kimliği kullanıcılara göstermemeniz gerekir.
conferenceData.conferenceSolution object
Hangouts veya Google Meet gibi konferans çözümünü temsil eden bir nesne.
conferenceData.conferenceSolution.iconUri string
Bu konferans çözümünü temsil eden, kullanıcılara görünen simgeye ait URI.
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:
  • Tüketiciler için Hangouts'ta eventHangout (http://hangouts.google.com).
  • eventNamedHangout Google Workspace kullanıcıları için klasik Hangouts'ta (http://hangouts.google.com).
  • 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 konferans 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 uyarılar). HTML içerebilir. Maksimum uzunluk 2.048 karakterdir.
conferenceData.parameters object
Eklentinin kullanacağı tanımlanmış parametre verilerinin haritasını içeren bir nesne.
conferenceData.parameters.addOnParameters object
Parametre dize anahtarlarının ve değerlerinin haritası. Bu anahtarlar ve değerler, eklentinin kullanımı için belirli bir konferansa bilgi eklemek amacıyla eklenti geliştiricisi tarafından tanımlanır.

Giriş noktası

Giriş noktası nesneleri, belirli bir konferansa erişmek için kullanılan yöntemler (ör. telefon veya video) hakkında bilgi içerir. 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 genellikle konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} değerlerinin yalnızca bir alt kümesini kullanır. Konferans sağlayıcının kullandığı alanları eşleştirip yalnızca bu alanları 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 telefon görüşmesidir.
  • toll_free: Giriş noktası, ücretsiz 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ı bulunabilir. Giriş noktası varsa en az bir başka giriş noktası türü de gereklidir.
  • phone: Konferansta telefon numarası üzerinden oturum açın. Bir konferansta sıfır veya daha fazla phone giriş noktası olabilir. Google Takvim, biçimlendirilip alfabetik olarak sıralanan telefon giriş noktalarının yalnızca ilk ikisini gösterir.
  • sip: SIP üzerinden konferansa 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'si için kullanıcı tarafından görülebilen etiket (yerelleştirilmez).
entryPoint.meetingCode string
Konferansa erişmek için kullanılan toplantı kodu. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar genellikle konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} değerlerinin yalnızca bir alt kümesini kullanır. Konferans sağlayıcının kullandığı alanları eşleştirip yalnızca bu alanları gösterin.
entryPoint.passcode string
Konferansa erişmek için kullanılan şifre kodu. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar genellikle konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} değerlerinin yalnızca bir alt kümesini kullanır. Konferans sağlayıcının kullandığı alanları eşleştirip yalnızca bu alanları gösterin.
entryPoint.password string
Konferansa erişmek için kullanılan şifre. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar genellikle konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} değerlerinin yalnızca bir alt kümesini kullanır. Konferans sağlayıcının kullandığı alanları eşleştirip yalnızca bu alanları gösterin.
entryPoint.pin string
Konferansa erişmek için kullanılan PIN. Maksimum uzunluk 128 karakterdir. Konferans sağlayıcılar genellikle konferanslara erişim sağlamak için genellikle {accessCode, meetingCode, passcode, password, pin} değerlerinin yalnızca bir alt kümesini kullanır. Konferans sağlayıcının kullandığı alanları eşleştirip yalnızca bu alanları 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 kodları listesine dayalıdır.
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, arama sırasının tamamını içermelidir (ör. "tel:+12345678900,,,12345678;1234").
  • sip: sip: veya sips: şeması gereklidir. Örneğin "sip:12345678@sağlayıcım.com".
  • video: http: veya https: şeması gereklidir.

Drive etkinlik nesnesi

Drive etkinlik nesnesi, genel etkinlik nesnesinin kullanıcının Google Drive'ı ve içeriği hakkında bilgi 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çili öğelerin (dosyalar veya klasörler) listesi.

Drive öğesi

Drive öğesi nesneleri, dosya veya klasör gibi belirli Drive öğeleriyle ilgili bilgileri içerir.

Drive öğesi nesnesi
item.addonHasFileScopePermission boolean
true ise eklenti bu öğe için https://www.googleapis.com/auth/drive.file kapsamlı yetkilendirme isteğinde bulunmuş ve bu yetkilendirmeyi almış demektir. Aksi takdirde bu alan false değerini alır.
item.id string
Seçilen öğenin kimliği.
item.iconUrl string
Seçilen öğeyi temsil eden simgesinin 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 özgü erişim jetonu. Bu jetonu, eklentinizin bir kullanıcının şu anda açık olan Gmail iletisine geçici olarak erişmesine izin vermek veya eklentinizin yeni taslaklar oluşturmasına izin vermek için GmailApp.setCurrentMessageAccessToken(accessToken) yöntemiyle kullanabilirsiniz.
gmail.bccRecipients[] list of strings
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu bir taslakta şu anda bulunan "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 taslakta şu anda yer alan "CC:" 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.messageId string
Şu anda açık olan Gmail iletisinin kimliği.
gmail.threadId string
Şu anda açık olan Gmail ileti dizisi kimliği.
gmail.toRecipients[] list of strings
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu bir taslakta şu anda yer alan "Kime:" 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.

Dokümanlar etkinlik nesnesi

Docs etkinlik nesnesi, genel etkinlik nesnesinin bir 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 etkinlik nesnesinde bulunur.

Dokümanlar etkinlik nesnesi
docs.id string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirilmişse mevcuttur.
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 yetkilendirilmişse mevcuttur.
Dokümanlar kullanıcı arayüzünde açık olan dokümanın başlığı.
docs.addonHasFileScopePermission boolean
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ış demektir. Aksi takdirde bu alan false olur.
docs.matchedUrl.url string
Yalnızca aşağıdaki koşullar karşılanırsa 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şir.

Google Dokümanlar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında LinkPreviewTriggers öğesini yapılandırmanız gerekir. Daha fazla bilgi için Akıllı çiplerle bağlantıları önizleme bölümüne bakın.

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

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

E-Tablolar etkinlik nesnesi

E-Tablolar etkinlik nesnesi, genel etkinlik 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 etkinlik nesnesinde bulunur.

E-Tablolar etkinlik nesnesi
sheets.id string
Yalnızca https://www.googleapis.com/auth/drive.file kapsamı kullanıcı tarafından yetkilendirilmişse bulunur. 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 yetkilendirilmişse bulunur. E-Tablolar kullanıcı arayüzünde açık olan e-tablonun başlığı.
sheets.addonHasFileScopePermission boolean
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 almış demektir. Aksi takdirde bu alan false olur.
sheets.matchedUrl.url string
Yalnızca aşağıdaki koşullar karşılanırsa 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şir.

Google E-Tablolar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında LinkPreviewTriggers öğesini yapılandırmanız gerekir. Daha fazla bilgi için Akıllı çiplerle bağlantıları önizleme bölümüne bakın.

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

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

Slaytlar etkinlik nesnesi

Slaytlar etkinlik nesnesi, genel etkinlik nesnesinin kullanıcının dokümanı ve içeriği hakkında bilgi 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 yetkilendirilmişse bulunur. 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 yetkilendirilmişse bulunur. Slaytlar kullanıcı arayüzünde açık olan sununun başlığı.
slides.addonHasFileScopePermission boolean
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 almış demektir. Aksi takdirde bu alan false olur.
slides.matchedUrl.url string
Yalnızca aşağıdaki koşullar karşılanırsa 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şir.

Google Slaytlar'da önizleme oluşturan bağlantının URL'si. Bu alanı kullanmak için eklentinizin manifest dosyasında LinkPreviewTriggers öğesini yapılandırmanız gerekir. Daha fazla bilgi için Akıllı çiplerle bağlantıları önizleme bölümüne bakın.

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

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