Ana sayfalar

Ana sayfalar, bir veya daha fazla bağlam dışı kart tanımlama olanağı sağlayan bir Google Workspace eklentisi özelliğidir. Bağlam dışı kartlar, kullanıcı belirli bir bağlamın dışındayken (ör. açık bir ileti veya taslak olmadan Gmail gelen kutusunu görüntülerken) kullanıcı arayüzü gösterir.

Ana sayfalar, hızlı erişim yan panelindeki Google uygulamalarına (Google Keep, Google Takvim ve Google Görevler) benzer şekilde bağlam dışı içerik göstermenize olanak tanır. Ana sayfalar, bir kullanıcı eklentinizi ilk kez açtığında başlangıç noktası olarak da kullanılabilir ve yeni kullanıcılara eklentinizle nasıl etkileşimde bulunacaklarını öğretmek için faydalıdır.

Proje manifestinizde belirterek ve bir veya daha fazla homepageTriggerişlev uygulayarak eklentiniz için bir ana sayfa tanımlayın (bkz. Ana sayfa yapılandırması).

Eklentinizin genişlettiği her ana makine uygulaması için bir tane olmak üzere birden fazla ana sayfanız olabilir. Ayrıca, özel bir ana sayfa belirtmediğiniz ana makinelerde kullanılan tek bir ortak varsayılan ana sayfa da tanımlayabilirsiniz.

Eklenti ana sayfanız şu durumlarda gösterilir:

  • Eklenti, ana makinede ilk kez açıldığında (yetkilendirmeden sonra).
  • Kullanıcı, eklenti açıkken bağlamsal bir bağlamdan bağlamsal olmayan bir bağlama geçtiğinde. Örneğin, bir Takvim etkinliğini ana Takvim'de düzenleme.
  • Kullanıcı, diğer tüm kartları dahili yığınlardan çıkarmak için yeterli sayıda geri düğmesini tıkladığında.
  • Bağlam dışı bir karttaki kullanıcı arayüzü etkileşimi Navigation.popToRoot çağrısına neden olduğunda.

Ana sayfa tasarlamanız önerilir. Herhangi bir kart tanımlamazsanız kullanıcı ana sayfaya her gittiğinde eklenti adınızı içeren genel bir kart kullanılır.

Ana sayfa yapılandırması

Google Workspace eklentileri, eklenti manifestosundaki ana makine uygulamaları için varsayılan ana sayfa (bağlam dışı) eklenti içeriğini yapılandırmak üzere addOns.common.homepageTrigger alanını kullanır:

{
  "addOns": {
    "common": {
      "homepageTrigger": {
        "runFunction": "myFunction",
        "enabled": true
      }
    }
  }
}

  • runFunction: Google Workspace eklenti çerçevesinin, ana sayfa eklenti kartlarını oluşturmak için çağırdığı Google Apps Komut Dosyası işlevinin adı. Bu işlev, ana sayfa tetikleme işlevidir. Bu işlev, ana sayfa kullanıcı arayüzünü oluşturan Card nesnelerinden oluşan bir dizi oluşturup döndürmelidir. Birden fazla kart döndürülürse ana makine uygulaması, kart başlıklarını kullanıcının seçebileceği bir listede gösterir (bkz. Birden fazla kart döndürme).

  • enabled: Bu kapsam için ana sayfa kartlarının etkinleştirilip etkinleştirilmeyeceği. Bu alan isteğe bağlıdır ve varsayılan olarak true değerine ayarlanır. Bu ayarın false olarak belirlenmesi, ana sayfa kartlarının tüm ana makinelerde devre dışı bırakılmasına neden olur (söz konusu ana makine için geçersiz kılınmadığı sürece; ana makineye özel yapılandırmaya bakın).

Bir barındırıcının ortak ana sayfayı kullanabilmesi için hem addOns.common.homepageTrigger hem de barındırıcının üst düzey kaynağı, eklenti manifestinde bulunmalıdır. Örneğin, manifestte addOns.gmail yoksa eklenti Gmail'de devre dışı bırakılır ve bu ana makinede ana sayfa veya başka bir işlev gösterilmez.

Ortak yapılandırmaya ek olarak, her ana makine uygulamasının yapılandırmasında, addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger ve diğer ana makineye özel tetikleyicilerde, ana makine başına aynı şekilde yapılandırılmış geçersiz kılmalar bulunur.

Aşağıdaki örnekte, ortak bir ana sayfa tetikleyicisinin tanımlandığı ancak Takvim ve Drive için özel işlevlerle geçersiz kılındığı ve Gmail için devre dışı bırakıldığı bir manifest gösterilmektedir. Bu yapılandırmada, ortak buildHomePage işlevi geçersiz kılındığı veya ana makine devre dışı bırakıldığı için hiçbir zaman yürütülmez.

{
  ...
  "addOns": {
    ...
    "common": {
      "homepageTrigger": { "runFunction": "buildHomePage" }
    },
    "calendar": {
      "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "buildDriveHomepage" }
    },
    "gmail": {
      "homepageTrigger": { "enabled": false }
    },
    ...
  }
}

Aşağıdaki manifest alıntısı, varsayılan homepageTrigger ve Gmail yapılandırması atlanmış olsa bile önceki örneğe eşdeğerdir:

{
  "addOns": {
    "common": {},
    "calendar": {
      "homepageTrigger": { "runFunction": "myCalendarFunction" }
    },
    "drive": {
      "homepageTrigger": { "runFunction": "myDriveFunction" }
    },
    "gmail": {},
    ...
  }
}

homepageTrigger bölümlerinin hiçbiri zorunlu değildir. Bir ana makine ürününde eklenti için gösterilen kullanıcı arayüzü, ilgili manifest alanının varlığına ve ilişkili bir homepageTrigger olup olmadığına bağlıdır. Aşağıdaki örnekte, farklı manifest yapılandırmaları için ana sayfa kullanıcı arayüzü oluşturmak üzere hangi eklenti tetikleyici işlevlerinin yürütüldüğü gösterilmektedir:

Eklenti ana sayfası tetikleyici işlevinin yürütme akışını gösteren şema

Ana sayfa etkinlik nesneleri

Daha önce açıklanan ana sayfa tetikleyici işlevi (runFunction) çağrıldığında, çağırma bağlamındaki verileri içeren bir event object iletilir.

Ana sayfa etkinlik nesneleri, widget veya bağlamsal bilgiler içermez. Geçirilen bilgiler aşağıdaki ortak etkinlik nesnesi alanlarıyla sınırlıdır:

Daha fazla bilgi için Etkinlik nesnesi başlıklı makaleyi inceleyin.

Bağlamla ilgili olmayan diğer kartlar

Eklenti kullanıcı arayüzünüzde, ana sayfalar olmayan ek bağlam dışı kartlar bulunabilir. Örneğin, ana sayfanızda eklenti ayarlarını düzenlemek için bir "Ayarlar" kartı açan bir düğme olabilir (bu tür ayarlar genellikle bağlamdan bağımsızdır).

Bağlamsal olmayan kartlar, diğer kartlar gibi oluşturulur. Aralarındaki tek fark, kartı oluşturan ve görüntüleyen işlem veya etkinliktir. Kartlar arasında geçiş oluşturma hakkında ayrıntılı bilgi için Navigasyon yöntemleri başlıklı makaleyi inceleyin.