Etkinlik nesneleri

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

Etkinlik nesneleri, otomatik olarak oluşturulan ve iletilen JSON yapılarıdır. Kullanıcı bir kullanıcı belirli bir öğeyle etkileşime geçtiğinde ekleyebilirsiniz. Etkinlik nesneleri, ana makine uygulaması ve geçerli bağlamı, eklentinin sunucu tarafı geri çağırma işlevine ekleyebilirsiniz.

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

• Ana sayfa tetikleyicileri. Tanımladığınız her homepageTrigger işlevine otomatik olarak bir etkinlik iletilir nesnesini tanımlayın. Bu nesneyi şurada kullanabilirsiniz: etkin ana makine uygulamasını, istemcinin veya üçüncü tarafın platform, kullanıcının yerel ayarı ve diğer bilgiler.

  Ana sayfa tetikleyicileri etkinleştiğinde oluşturulan etkinlik nesneleri, diğer iki örnekte yer alan alanlar; widget'larla ilgili farklı alanlar, bağlamsal bilgiler atlanır.

• Bağlamsal tetikleyiciler. Her ana makine uygulaması, bir dizi bağlamsal tetikleyici sağlar. Kullanıcı belirli bir bağlam girdiğinde etkinleşir. Örneğin:

  • Gmail, bir kullanıcı şu işlemleri gerçekleştirdiğinde bağlamsal bir tetikleyici sağlar: Bir iletiyi açtığında bir diğeri ise kullanıcının bir ileti oluşturduğunda.
  • Google Takvim, bir kullanıcı şu işlemleri gerçekleştirdiğinde bağlamsal bir tetikleyici sağlar: Bir etkinliği açtığında.
  • Google Drive, bir kullanıcı Drive dosyalarını seçer.

  Bağlamsal bir tetikleyici etkinleştiğinde ana makine uygulaması manifest'inde listelenen karşılık gelen runFunction öğesini iletir. etkinlik nesnesini tanımlayın. Bağlamsal olduğunda oluşturulan etkinlik nesneleri etkinleşen tetikleyiciler, ana sayfa tetikleyici etkinliğine dahil edilen tüm alanları içerir nesneler ve bağlamsal bilgiler içeren alanlar sunar.

• Widget işlemleri. Etkinlik nesneleri Ayrıca, widget widget'ını sağlamak için de kullanılır. aynısını kullanarak Gmail eklentilerinin kullandığı eylem modeli pek de iyi olmadığını unutmayın. Google Workspace eklentilerinde, tüm widget'lar gibi Action nesne ve işlem tıklayın. Ancak Google Workspace Eklentilerinde işlem etkinliği nesneleri bir geri çağırma işlevinin çalışabileceği daha da fazla bilgi içerir.

  Widget işlemlerinin sonucunda oluşturulan etkinlik nesneleri, bağlamsal tetikleyici etkinlik nesnelerine dahil edilen alanlar ve şunları içeren alanlar: widget bilgileri.

• Bağlantı tetikleyicilerini önizleyin. Google Dokümanlar, E-Tablolar ve Slaytlar'da şunları yapabilirsiniz: üçüncü taraf hizmetler için bağlantı önizlemelerini yapılandırma belirli URL kalıplarına göre düzenleyebilirsiniz. Kullanıcılar karşılayan bir bağlantıyla etkileşimde bulunduğunda desen, linkPreviewTriggers etkinleşir ve bağlantıyı içeren bir etkinlik nesnesi, tetikleyicinin geri çağırma işlevinden yararlanırız. Eklentiniz, ana makinede bağlantıyla ilgili bilgileri gösteren akıllı çip ve kart bir uygulamadır. Kullanıcıların etkileşimde bulunabilmesi için widget işlemleri de oluşturabilirsiniz: önizleme kartını ve içeriğini kontrol edin.

Etkinlik nesnesi yapısı

Aşağıdaki tabloda, projenizin üst düzey yapısı Google Workspace Eklentileri etkinlik nesneleri. Etkinlik nesne yapısında commonEventObject bulunur ana makineden bağımsız bilgiler için en üst düzey alanı belirtir. Her etkinlik nesnesi ana makineye özel aşağıdaki üst düzey alanlardan birine sahip olduğundan emin olun. etkin ana makine uygulaması: gmailEventObject, calendarEventObject veya driveEventObject.

Geriye dönük uyumluluk için Google Workspace Eklentileri etkinlik nesneleri, Gmail eklentisi işlem etkinliği nesneleri. Bu alanlar, aşağıdaki tabloda "Orijinal Gmail eklenti alanları" altında listelenmiştir; bu alanlardaki bilgiler yeni nesne yapısında yeniden oluşturulur.

Ortak etkinlik nesnesi

Ortak etkinlik nesnesi, şunu içeren genel etkinlik nesnesinin kısmıdır: Kullanıcının istemcisindeki eklentiye ilişkin ana makineden bağımsız genel bilgilerdir. Bu Bu bilgiler arasında kullanıcının yerel ayarı, ana makine uygulaması ve platformu gibi ayrıntılar bulunur.

Eklentiler, ana sayfa tetikleyicileri ve bağlamsal tetikleyicilere ek olarak işlem geri çağırma işlevlerine etkinlik nesneleri Kullanıcı widget'larla etkileşimde bulunduğunda. Eklentinizin geri çağırma işlevi, kullanıcının cihazındaki açık widget'ların içeriğini belirlemek için ortak etkinlik nesnesini gerekir. Örneğin, eklentiniz bir kullanıcının TextInput widget'ı eventObject.commentEventObject.formInputs nesne.

Tarih ve saat seçici form girişleri

İşlem geri çağırma işlevleri commonEventObject.formInputs alanındaki geçerli widget değerlerini alabilir. Kullanıcının tarih veya saat seçicide seçtiği tarih veya saat değerleri de buna dahildir widget'lar. Ancak bilgilerin yapısı, bilginin mevcut olup olmadığına bağlı olarak widget; tarih ve saat seçici, yalnızca tarih seçici veya yalnızca saat olarak yapılandırıldı. kullanabilirsiniz. Yapısal farklılıklar aşağıdaki tabloda açıklanmıştır:

Takvim etkinliği nesnesi

Takvim etkinliği nesnesi, genel etkinlik nesnesinin Kullanıcının takvimi ve takvim etkinlikleri hakkında bilgi içerir. Yalnızca bir etkinlik nesnesinde bulunur.

Aşağıdaki tabloda, calendarEventObject sütununda bulunan alanlar listelenmiştir. alanında görünür. Kullanıcı tarafından oluşturulan veriler olarak işaretlenmiş alanlar Etkinlik nesnesinde, yalnızca veriler Takvim'de mevcutsa ve bu veriler etkinlik ve eklenti, addOns.calendar.currentEventAccess manifest alanı READ veya READ_WRITE.

Katılımcı

Katılımcı nesneleri, her bir katılımcıyla ilgili bilgileri Google Takvim'e taşır etkinlikler. Bu bilgi, yalnızca veri işlemenin gerçekleşmesi durumunda Takvim etkinliğinde mevcutsa eklenti, addOns.calendar.currentEventAccess. manifest alanı READ veya READ_WRITE.

Konferans verileri

Konferans veri nesneleri, ekli konferanslarla ilgili bilgileri içerir Google Takvim etkinliklerine hoş geldiniz. Bu çözümler arasında yer alan Google konferans çözümleri Google Meet veya üçüncü taraf konferanslar olabilir. Bu bilgiler, etkinlik nesnesidir. Yalnızca, verilerin Takvim etkinliğinde ve eklenti, addOns.calendar.currentEventAccess özelliğini ayarlar manifest alanı READ veya READ_WRITE.

Giriş noktası

Giriş noktası nesneleri, yaygın olarak kullanılan erişim yöntemleri hakkında bilgi taşır konferans üzerinden (ör. telefon veya video aracılığıyla) Bu bilgiler veri Takvim etkinliğinde mevcutsa etkinlik nesnesini ve yalnızca eklenti addOns.calendar.currentEventAccess özelliğini ayarlar manifest alanı READ veya READ_WRITE.

Drive etkinlik nesnesi

Drive etkinlik nesnesi, genel etkinlik nesnesinin, Kullanıcının Google Drive'ı ve içeriği hakkında bilgi içerir. Yalnızca ana makine uygulaması Google Drive ise bir etkinlik nesnesinde bulunur.

Drive öğesi

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

Gmail etkinlik nesnesi

Gmail etkinlik nesnesi, genel etkinlik nesnesinin Kullanıcının Gmail iletileriyle ilgili bilgiler. Yalnızca bir etkinlik nesnesinde var ana makine uygulaması Gmail ise.

Dokümanlar etkinlik nesnesi

Dokümanlar etkinlik nesnesi, genel etkinlik nesnesinin Kullanıcının dokümanı ve içeriği hakkındaki bilgiler. Yalnızca etkinlik nesnesini tanımlayın.

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

E-Tablolar etkinlik nesnesi

E-Tablolar etkinlik nesnesi, Kullanıcının dokümanı ve içeriği hakkındaki bilgiler. Yalnızca etkinlik nesnesini tanımlayın.

"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ındaki bilgiler. Yalnızca etkinlik nesnesini tanımlayın.

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