Ana sayfalar

Ana sayfalar, Google Workspace eklentilerinin yeni bir özelliğidir. sağlayan bir veya daha fazla bağlamsal olmayan kart tanımlayabilirsiniz. Bağlamsal olmayan kartlar, kullanıcı şu anda kullanıcı arayüzü göstermek için kullanılır. Belirli bir bağlam dışında (ör. kullanıcı, Gmail gelen kutusunu görüntülerken) ancak iletiyi veya taslağı açmadı.

Ana sayfalar, tıpkı Google uygulamaları hızlı erişim yan paneli (Keep, Takvim ve Görevler). Ana sayfalar, aynı zamanda bir başlangıç Bu bölüm, kullanıcının eklentinizi ilk açtığı zamandır. Eğitim için faydalıdır. nasıl etkileşimde bulunacağını anlamanıza yardımcı olur.

Projenizde belirterek eklentiniz için bir ana sayfa tanımlayabilirsiniz manifest dosyası görüntüleme ve bir veya daha fazla homepageTrigger işlevini uygulama (bkz. Ana sayfa yapılandırması).

Eklentinizin yüklü olduğu her ana makine uygulaması için bir tane olmak üzere birden fazla ana sayfanız olabilir. uzatılır. Ayrıca, her bir iş parçacığı için bir değer olan tek bir ortak varsayılan ana sayfa Özel bir ana sayfa belirtmediğiniz ana makinelerde kullanılır.

Aşağıdaki koşullardan biri karşılandığında eklenti ana sayfanız görüntülenir:

  • Eklentinin ana makinede ilk kez açıldığında (yetkilendirme sonrasında).
  • Kullanıcı bağlamsal bir bağlamdan bağlam dışı bir bağlama geçtiğinde biraz kontrol edin. Örneğin, bir Takvim etkinliğini düzenlemekten ana Takvim'e dokunun.
  • Kullanıcı, geri düğmesini yeniden tıkladığında diğer tüm kartları dahili yığınlardan çıkarın.
  • Bağlamsal olmayan bir karttaki kullanıcı arayüzü etkileşimi Navigation.popToRoot() çağrısına bir tıklama URL'si eklemeniz gerekir.

Ana sayfa tasarlamak zorunlu değildir, ancak kesinlikle önerilir; tanımlamazsanız genel bir kart içeren bir ad, bir kullanıcı web sayfalarında gezindiğinde ana sayfaya geri dönelim.

Ana sayfa yapılandırması

Google Workspace Eklentileri, addOns.common.homepageTrigger alan adındaki kullanıcılar için varsayılan ana sayfa (bağlamsal olmayan) eklenti içeriğini eklentideki tüm ana makine uygulamalarını manifest:

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

  • runFunction: Google Workspace Eklentileri çerçevesi, ana sayfa eklenti kartlarını oluşturmak için çağrı yapar. Bu işlev, ana sayfa tetikleyici işlevidir. Bu işlev derlenmelidir ve Card dizisini döndürür. nesneleri içerir. Birden fazla kart iade edilirse ana makine uygulaması, kart başlıklarını kullanıcının seçebileceği bir listede gösterir (bkz. Birden fazla kartı iade etme).

  • enabled: Ana sayfa kartlarının bu kapsam için etkinleştirilip etkinleştirilmeyeceğini belirler. Bu alanı isteğe bağlıdır ve varsayılan olarak true değerine ayarlanır. Bunun false olarak ayarlanmasının nedenleri ana sayfa kartları tüm ana makineler için devre dışı bırakılır (bunun için geçersiz kılınmadığı sürece) host; (aşağıya bakın).

ziyaret edin.

Ortak yapılandırmaya ek olarak, her ana makine uygulamasının kendi kontrollerinde aynı şekilde yapılandırılmış ana makine başına geçersiz kılma işlemleri yapılandırma, addOns.gmail.homepageTrigger, addOns.calendar.homepageTrigger, ve benzeri:

    {
      ...
      "addOns": {
        ...
        "common": {
          // By default, call 'buildHomePage' to render homepage content
          // in all hosts. Since calendar.homepageTrigger below overrides
          // this in Calendar and Drive and the homepageTrigger is disabled
          // for Gmail, this homepage function never executes.
          "homepageTrigger": { "runFunction": "buildHomePage" }
        },
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "buildCalendarHomepage" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "buildDriveHomepage" }
        }
        "gmail": {
          // Disable homepage add-on content in Gmail.
          "homepageTrigger": { "enabled": false }
        },
        ...
      }
    }

Bunun, aşağıdaki manifest alıntısına eşdeğer olduğunu unutmayın:

    {
      ...
      "addOns": {
        ...
        "common": { /* ... */ }, // Omitted a default homepageTrigger specification.
        "calendar": {
          // Show customized homepage content for Calendar only.
          "homepageTrigger": { "runFunction": "myCalendarFunction" }
        },
        "drive": {
          // Show customized homepage content for Drive only.
          "homepageTrigger": { "runFunction": "myDriveFunction" }
        }
        "gmail": { /* ... */ },
        ...
      }
    }

homepageTrigger bölümlerinden hiçbiri gerekli değildir. Ancak, herhangi bir ana makine ürününde bir eklentinin varlığına ve ilişkili bir manifest alanı olup olmadığını ve homepageTrigger Aşağıdaki örnekte, hangi eklenti tetikleyici işlevleri farklı manifestler için bir ana sayfa kullanıcı arayüzü oluşturmak üzere yürütülür (varsa) yapılandırma:

Ana sayfa akışı

Ana sayfa etkinlik nesneleri

Çağrılduğunda, yukarıda açıklanan ana sayfa tetikleyici işlevi (runFunction) bir etkinlik nesnesi geçti çağrı bağlamındaki verileri içerir.

Ana sayfa etkinlik nesneleri widget veya bağlamsal bilgiler içermez; "the" aşağıdakilerle sınırlıdır ortak etkinlik nesnesi alanlar:

Daha fazla ayrıntı için Etkinlik nesnesi bölümüne bakın.

İçeriğe dayalı olmayan diğer kartlar

Eklenti kullanıcı arayüzünüz, ana sayfalar. Örneğin, ana sayfanızda "Ayarlar" Kullanıcının eklenti ayarlarını (ör. ayarlar) değiştirebileceği çoğu durumda içerikten bağımsızdır ve dolayısıyla bağlamsal değildir).

Bağlama dayalı olmayan kartlar diğer kartlar gibi oluşturulur; tek fark kartı oluşturur ve gösterir. Görüntüleyin Gezinme yöntemleri .