Etkinlik nesneleri

Bu sayfada, Google Workspace eklentisi etkinlik nesnelerinin yapısı açıklanmaktadır.

Etkinlik nesneleri, bir kullanıcı bir 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, ana makine uygulaması ve mevcut bağlamla ilgili istemci tarafı bilgilerini eklentinin sunucu tarafı geri çağırma işlevine taşır.

Google Workspace eklentileri, etkinlik nesnelerini aşağıdaki yerlerde 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. Bu nesneyi ana sayfa tetikleyici işlevinizde kullanarak etkin ana makine uygulamasını, istemcinin platformunu, kullanıcı yerel ayarını ve diğer bilgileri tanımlayabilirsiniz.

    Ana sayfa tetikleyicileri etkinleştiğinde oluşturulan etkinlik nesneleri, diğer durumlarda dahil edilen tüm alanları içermez. Widget'lar ve bağlamsal bilgilerle ilgili alanlar atlanır.

  • Bağlama dayalı tetikleyiciler. Her barındırılan uygulama, kullanıcı belirli bir bağlama girdiğinde tetiklenen farklı bağlamsal tetikleyiciler sunar:

    Bağlamsal bir tetikleyici etkinleştiğinde barındırılan uygulama, eklenti manifestinde listelenen ilgili runFunction öğesini çağırır ve parametre olarak bir etkinlik nesnesi iletir. Bağlama dayalı tetikleyiciler etkinleştiğinde oluşturulan etkinlik nesneleri, ana sayfa tetikleyici etkinlik nesnelerinde bulunan tüm alanların yanı sıra bağlama dayalı bilgiler içeren alanları da içerir.

  • Widget işlemleri. Etkinlik nesneleri, Gmail eklentilerinin kullandığı işlem modelini kullanarak widget etkileşimi sağlar. Google Workspace eklentileri aynı widget işleyici işlevlerini, Action nesnelerini ve işlem yanıtlarını kullanır. 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şlemlerinden oluşturulan etkinlik nesneleri, bağlamsal tetikleyici etkinlik nesnelerine dahil edilen 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, üçü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, barındırılan uygulamadaki bağlantıyla ilgili bilgileri gösteren bir akıllı çip ve kart oluşturmak için bu etkinlik nesnesini kullanabilir. Kullanıcıların önizleme kartı ve içeriğiyle etkileşim kurabilmesi için widget işlemleri de oluşturabilirsiniz.

  • Google Chat uygulaması tetikleyicileri. Google Chat'te eklentiniz kullanıcılara bir Chat uygulaması olarak görünür. Kullanıcılar, eklentinizi alanlara ekleyerek, mesaj göndererek, eğik çizgi komutlarını kullanarak ve daha birçok yöntemle 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. Yapı, ana makineden bağımsız bilgiler için commonEventObject üst düzey alanını içerir. Her etkinlik nesnesi, etkin ana makine uygulaması tarafından belirlenen şu ana makineye özel ü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 etkinliği nesnelerinde kullanılan orijinal alanları içerir. Bu alanlar "Orijinal Gmail eklenti alanları" bölümünde yer alır ve commonEventObject parametresinin bir parçası değildir.

Orijinal Gmail eklenti alanları kullanımdan kaldırıldı. Google Workspace eklentisi geliştirirken veya taşırken bunun yerine daha yeni etkinlik nesnesi yapısını kullanın. Bu alanlar gelecekteki bir güncellemede kaldırılabilir.

Etkinlik nesnesi
eventObject.commonEventObject Common fields object
Barındırılan uygulama ana makinesinden bağımsız olarak tüm etkinlik nesneleri için ortak bilgiler içeren bir nesne.
eventObject.calendar Calendar event object
Yalnızca çağrıyı yapan ana makine Google Takvim ise mevcuttur. Takvim ve etkinlik bilgilerini içeren bir nesne.
eventObject.chat Chat event object
Yalnızca görüşme ana makinesi Google Chat ise mevcuttur. Chat bilgilerini içeren bir nesne.
eventObject.drive Drive event object
Yalnızca çağıran ana makine Google Drive ise mevcuttur. Drive bilgilerini içeren bir nesne.
eventObject.gmail Gmail event object
Yalnızca çağrı yapan ana makine Gmail ise mevcuttur. Gmail bilgilerini içeren bir nesne.
eventObject.docs Docs event object
Yalnızca çağrı yapan ana makine Google Dokümanlar ise mevcuttur. Dokümanlar bilgilerini içeren bir nesne.
eventObject.sheets Sheets event object
Yalnızca çağıran ana makine Google E-Tablolar ise mevcuttur. E-Tablolar bilgilerini içeren bir nesne.
eventObject.slides Slides event object
Yalnızca çağrı yapan ana makine Google Slaytlar ise mevcuttur. Slaytlar bilgilerini içeren bir nesne.
Orijinal Gmail eklenti 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 yöntemi kullanabilirsiniz.

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

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

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

eventObject.clientPlatform string
Desteği sonlandırıldı. Etkinliğin nereden kaynaklandığını (web, iOS veya Android) gösterir.

Google Workspace eklentileri için bu bilgileri 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 haritası. Her widget için bir değerle sınırlıdır. Anahtarlar, widget'larla ilişkili dize kimlikleridir ve değerler dizedir. Etkinlik nesnesi, metin girişleri ve anahtarlar gibi beklenen tekil değerlere sahip birden fazla widget'tan veri okumanız gerektiğinde kolaylık sağlamak için formInput değerini sağlar. Onay kutuları gibi çok değerli widget'lar için her değeri formInputs üzerinden okuyun.

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 listesi olarak sunulan bir haritası. Anahtarlar, widget ile 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 liste halinde sunulur.

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

eventObject.parameters object
Kullanımdan kaldırıldı. Action.setParameters kullanarak Action'e sağladığınız ek parametrelerin haritası. Harita anahtarları ve değerleri dizedir.

Google Workspace eklentileri için bu bilgileri 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. Sayısal bir UN M49 ülke kodu da olabilir.

Google Workspace eklentileri için bu bilgileri 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ı 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 bilgileri 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'dan (UTC) 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, kullanıcının istemcisinden eklentiye genel, ana makineden bağımsız bilgiler taşıyan genel etkinlik nesnesinin bir parçası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 etkinlik 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 etkinlik nesnesini sorgulayabilir. Örneğin, eklentiniz kullanıcının eventObject.commentEventObject.formInputs nesnesindeki bir TextInput widget'ına girdiği metni bulabilir.

Ortak etkinlik nesnesi alanları
commonEventObject.platform string
Etkinliğin nereden kaynaklandığını gösterir (`WEB`, `IOS` veya `ANDROID`).
commonEventObject.formInputs object
Görüntülenen 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ı): dize listesi.

    Ö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: DateTimeInput object.

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

  • A date-only picker: DateInput object.

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

  • A time-only picker: TimeInput object.

    Örnek: Kimliği myTimePicker olan 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ı belirtir. Olası değerler şunları içerir:
  • 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 uygulamalarında, kullanıcıların çoklu seçim menülerine yazdıklarına göre öğe önermek için "autocomplete_widget_query" anahtarının (event.commonEventObject.parameters["autocomplete_widget_query"]) değerini kullanın. Bu değeri, bir veritabanını sorgulamak ve kullanıcılara 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 dil ve ülke/bölge tanımlayıcısı, ISO 639 dil kodu-ISO 3166 ülke/bölge kodu biçimindedir. Ö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 kapsamını da 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 kapsamını da 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 kapsamını da 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'dan (UTC) 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.

Tarih/saat seçici form girişleri

İşlem geri çağırma işlevleri, commonEventObject.formInputs alanında mevcut widget değerlerini alabilir. Bu, kullanıcının tarih veya saat seçici widget'larında seçtiği tarih ya da saat değerlerini içerir. Bilgi yapısı, widget'ın tarih-saat seçici, yalnızca tarih seçici veya yalnızca saat seçici olarak yapılandırılmasına bağlı olarak farklılık gösterir. Yapısal farklılıklar aşağıdaki tabloda açıklanmıştır:

DateTimeInput nesnesi
dateTimeInput.hasDate Giriş tarih saati bir tarih içeriyorsa boolean
true; yalnızca saat içeriyorsa false.
dateTimeInput.hasTime Giriş tarih ve saati bir saat içeriyorsa boolean
true; yalnızca bir tarih içeriyorsa false.
dateTimeInput.msSinceEpoch string
Kullanıcı tarafından seçilen saat (başlangıçtan [1 Ocak 1970 00:00:00 UTC] bu yana geçen milisaniye cinsinden).
DateInput nesnesi
dateInput.msSinceEpoch string
Kullanıcı tarafından seçilen zaman (başlangıçtan [1 Ocak 1970 00:00:00 UTC] bu yana geçen 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 sayısı.

Sohbet 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ş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 zaman.

payload birleşik alanı. Uygulama Ana Sayfası tetikleyicisi için (kullanıcı Ana Sayfa sekmesini açtığında) payload ayarlanmaz ve chat, chat.user ile chat.eventTime değerlerini içerir.

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

object (MessagePayload)

Chat uygulamalarının bir 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ı bilgi göndermek için bir düğmeyi tıklarsa 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. Chat uygulamaları, dinamik bir veri kaynağından önerilen öğeleri doldurmak için bu etkinlik nesnesini kullanabilir. Örneğin, harici bir veri kaynağından destek kayıtlarını doldurmak için Chat uygulaması, kullanıcının menüye yazdığı bilgilere 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)

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 sohbet 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, 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 Google Workspace eklentinizi üçüncü taraf hizmetine bağlama başlıklı makaleyi inceleyin.
Alana eklenen yük
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, mesaj kullanarak Chat uygulamasını bir alana 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, 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 Google Workspace eklentinizi üçüncü taraf hizmetine bağlama başlıklı makaleyi inceleyin.
Alandan kaldırıldı yükü
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Kullanıcının Chat uygulamasını kaldırdığı veya yüklemesini kaldırdığı 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 bir Chat uygulaması mesajındaki 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 bir iletişim kutusundaki etkileşim türü.

Enum DialogEventType.

dialogEventType değeri aşağıdakilerden yalnızca 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 bir mesajdaki düğmeyi tıklarlar.
SUBMIT_DIALOG Kullanıcı, iletişim kutusundaki etkileşimli bir öğeyi tıklar. Örneğin, kullanıcı bir iletişim kutusundaki bilgileri doldurur ve bilgileri göndermek için bir düğmeyi tıklar.
Widget güncellenmiş 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 bu 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 mesaj dizisinde gerçekleştiyse kullanıcının komutu kullandığı Chat mesaj 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ıyı Google Chat dışında işlemi tamamladıktan sonra yönlendirecek URL.
chat.appCommandPayload.isDialogEvent boolean
Komutun bir iletişim kutusu açıp açmayacağı.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
İletişim kutusuyla etkileşim türü.

Enum DialogEventType.

dialogEventType değeri aşağıdakilerden yalnızca 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 bir mesajdaki düğmeyi tıklarlar.
SUBMIT_DIALOG Kullanıcı, iletişim kutusundaki etkileşimli bir öğeyi tıklar. Örneğin, kullanıcı bir iletişim kutusundaki 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 aşağıdakilerden yalnızca 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 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 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 etkinlik nesnesinde bulunur.

Bu nesnedeki ve alt yapılarındaki alanların çoğu, aynı ada sahip Calendar API Etkinlik kaynağı alanlarıyla doğrudan eşlenir. Alan açıklamaları farklıysa aşağıdaki tablodaki bilgiler doğrudur.

Takvim etkinliği nesnesi
calendar.attendees[] list of attendee objects
Kullanıcı tarafından oluşturulan veriler. Takvim etkinliğine katılanların listesi.
calendar.calendarId string
Takvim kimliği.
calendar.capabilities object
Kullanıcı tarafından oluşturulan veriler. Etkinlik bilgilerini görüntülemek veya güncellemek için eklentinin özelliklerini açıklayan bir nesne.
calendar.capabilities.canAddAttendees boolean
Kullanıcı tarafından oluşturulan veriler. true Eklenti, etkinlik katılımcı listesine yeni katılımcılar ekleyebiliyorsa; false Aksi takdirde.
calendar.capabilities.canSeeAttendees boolean
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinlik katılımcı listesini okuyabiliyorsa true, aksi takdirde false.
calendar.capabilities.canSeeConferenceData boolean
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinlik konferans verilerini okuyabiliyorsa true, aksi takdirde false.
calendar.capabilities.canSetConferenceData boolean
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinlik konferans verilerini güncelleyebiliyorsa true, aksi takdirde false.
calendar.capabilities.canAddAttachments boolean
Kullanıcı tarafından oluşturulan veriler. Eklenti, etkinliğe yeni ekler ekleyebiliyorsa true, aksi takdirde false.
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üzenleyen kişiyi 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ı

Attendee nesneleri, Google Takvim etkinliklerinin katılımcılarıyla 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 ayarlıyorsa etkinlik nesnesinde bulunur.

Attendee 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 Katılımcı bu etkinliğin düzenleyicisiyse boolean
true.
attendee.resource boolean
true Katılımcı bir kaynağı (ör. oda veya ekipman) temsil ediyorsa; false Diğer durumlarda.
attendee.responseStatus string
Katılımcının yanıt durumu. Olası değerler şunları içerir:
  • 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 belirsiz olarak kabul etti.
attendee.self booleanBu katılımcı, bu etkinliğin göründüğü takvimi temsil ediyorsa
true; aksi takdirde false.

Konferans verileri

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 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ır. 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 ve 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 şunlardır:
  • Tüketiciler için Hangouts'ta (http://hangouts.google.com) eventHangout.
  • Google Workspace kullanıcıları için klasik Hangouts'ta eventNamedHangout (http://hangouts.google.com).
  • Google Meet (http://meet.google.com) için hangoutsMeet.
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
Eklenti tarafından kullanılmak üzere 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 üzere eklenti geliştiricisi tarafından tanımlanır.

Giriş noktası

Giriş noktası nesneleri, belirli bir konferansa erişmek için oluşturulan yöntemler (ö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 genellikle konferanslara erişim sağlamak için {accessCode, meetingCode, passcode, password, pin} 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 aramasıdır.
  • toll_free: Giriş noktası, ücretsiz bir telefon aramasıdır.
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. Varsa en az bir başka giriş noktası türü de gereklidir.
  • phone: Telefon numarasıyla konferansa katılma. Bir konferansın sıfır veya daha fazla phone giriş noktası olabilir. Google Takvim, alfabetik olarak biçimlendirme ve sıralama yaptıktan sonra yalnızca ilk iki telefon giriş noktasını gösterir.
  • sip: SIP üzerinden konferansa katılın. Bir konferansın en fazla bir sip giriş noktası olabilir.
  • video: Konferansa HTTP üzerinden katılın. Bir konferansın 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 genellikle konferanslara erişim sağlamak için {accessCode, meetingCode, passcode, password, pin} 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 genellikle konferanslara erişim sağlamak için {accessCode, meetingCode, passcode, password, pin} 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 genellikle konferanslara erişim sağlamak için {accessCode, meetingCode, passcode, password, pin} 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 {accessCode, meetingCode, passcode, password, pin} 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 bir ülke kodu içermiyorsa kullanıcılar tarafından gereklidir. Değerler, herkese açık CLDR bölge kodları listesine dayanı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, 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 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 (dosya veya klasör) listesi.

Drive öğesi

Drive öğesi nesneleri, dosya veya klasör gibi belirli Drive öğeleri hakkında bilgi 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çilen öğeyi temsil eden simgenin URL'si.
item.mimeType string
Seçili öğ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ırılan uygulama Gmail ise bir etkinlik nesnesinde bulunur.

Gmail etkinlik nesnesi
gmail.accessToken string
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 GmailApp.setCurrentMessageAccessToken yöntemiyle kullanın.
gmail.bccRecipients[] list of strings
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 addOns.gmail.composeTrigger.draftAccess alanını METADATA olarak ayarlayın.
gmail.ccRecipients[] list of strings
Varsayılan olarak devre dışıdır. Eklentinin oluşturduğu taslakta 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 ayarlayın.
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şturmakta olduğu bir taslakta 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 ayarlayın.

Dokümanlar etkinlik nesnesi

Dokümanlar 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 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 gösterilir.
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ış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 yetkilendirildi.
  • 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ı https://www.example.com/12345 bağlantısını önizlediğinde gönderilen ö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 mevcuttur. 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 mevcuttur. 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ıştır. 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 yetkilendirildi.
  • 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 alanını yapılandırın. Daha fazla bilgi için Akıllı çipleri kullanarak bağlantıları önizleme başlıklı makaleyi inceleyin.

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

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

Slaytlar etkinlik nesnesi

Slaytlar etkinlik nesnesi, kullanıcının dokümanı ve içeriğiyle ilgili bilgileri taşıyan genel etkinlik nesnesinin bir parçası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 mevcuttur. 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 mevcuttur. 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ıştır. 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 yetkilendirildi.
  • 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ırın. Daha fazla bilgi için Akıllı çipleri kullanarak bağlantıları önizleme başlıklı makaleyi inceleyin.

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

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