Google Drive arayüzleri oluşturma

Google Workspace eklentileri, kullanıcı Drive'ı açtığında özelleştirilmiş arayüzler sağlayabilir. Bu sayede kullanıcıya ek alakalı bilgiler sağlayabilir, görevleri otomatikleştirebilir ve üçüncü taraf sistemlerini Drive'a bağlayabilirsiniz.

Google Workspace eklenti kullanıcı arayüzüne erişme

Eklentinin simgesi, Drive kullanıcı arayüzünün sağ tarafındaki simge sütununda görünüyorsa eklentiyi Drive'da açabilirsiniz. Eklentiler, ana sayfa arayüzü, öğe seçme arayüzü veya her ikisini de tanımlayabilir:

  • Kullanıcı Drive'dayken eklenti simgesini tıklarsa eklenti, varsa ilgili drive.homepageTrigger işlevini yürütür. Bu işlev, görüntüleme için Drive'a bir ana sayfa kartı oluşturup döndürür. drive.homepageTrigger işlevi tanımlanmamışsa bunun yerine genel bir ana sayfa kartı gösterilir.
  • Kullanıcı Drive'da bir veya daha fazla öğe seçip eklenti simgesini tıkladığında ya da eklenti açıkken öğeleri seçtiğinde eklenti, varsa ilgili drive.onItemsSelectedTrigger bağlamsal işlevini yürütür. Bu işlev, eklentinin Drive bağlamsal "seçili öğeler " arayüzünü oluşturur ve görüntülenmesi için Drive'a döndürür.

Eklenti Drive arayüzünü oluşturma

Aşağıdaki genel adımları uygulayarak Drive'ı genişleten arayüzler oluşturun:

  1. Eklentinizin Drive'a özel bir ana sayfası olmasını isteyip istemediğinize karar verin. Ayrıca, kullanıcı Drive öğelerini seçtiğinde bağlamsal bir arayüz sağlamak isteyip istemediğinize de karar verin.
  2. Eklenti komut dosyası projesinin addOns.common ve addOns.drive alanlarına, gerekli Drive kapsamları da dahil olmak üzere uygun manifest değerlerini ekleyin.
  3. Drive'a özel bir ana sayfa sağlıyorsanız bu arayüzü oluşturmak için drive.homepageTrigger işlevini uygulayın. Birden fazla Google Workspace ana makinesi için common.homepageTrigger arayüzünü de kullanabilirsiniz.
  4. Drive bağlamsal öğe seçimi arayüzü sağlıyorsanız bu arayüzü oluşturmak için drive.onItemsSelectedTrigger bağlamsal tetikleyici işlevini uygulamanız gerekir. Ayrıntılar için Seçili öğeler için Drive bağlamsal arayüzü konusuna bakın.
  5. Kullanıcının kullanıcı arayüzü etkileşimlerine (ör. düğme tıklamaları) yanıt vermek için gereken ilişkili geri çağırma işlevlerini uygulayın.

Drive ana sayfaları

Drive, eklenti ana sayfalarının gösterilmesini destekler. Eklentinizin ortak ana sayfasını Drive'da göstermek için eklentinin manifest dosyasında addOns.drive alanı olduğundan emin olun.

Alternatif olarak, Drive'a özel bir ana sayfa sağlamak için eklenti manifestine drive.homepageTrigger ekleyin.

Her iki durumda da eklentinizin komut dosyası projesinde bir ana sayfa tetikleyici işlevinin adını belirtin. Bu işlev, gerektiğinde Drive ana sayfasını oluşturmak için otomatik olarak çağrılır. Ana sayfayı oluşturan tek bir Card veya Card nesne dizisi oluşturup döndürmek için bu işlevi uygulayın. Ana sayfa tetikleyici işlevine, parametre olarak bir event object iletilir. Bu parametre, istemcinin platformu gibi bazı genel bilgileri içerir. Ana sayfayı oluşturmak için etkinlik nesnesi verilerini kullanın.

Seçilen öğeler için Drive bağlamsal arayüzü

Drive, kullanıcının bir veya daha fazla Drive öğesi seçtiğinde hangi arayüzün (varsa) gösterileceğini belirlemek için bağlamsal bir tetikleyici kullanır. Tetikleyici tetiklendiğinde, eklenti manifest dosyasındaki drive.onItemsSelectedTrigger.runFunction alanı tarafından belirtilen bağlamsal tetikleyici işlevi yürütülür.

Drive için bağlama dayalı öğe seçimi arayüzü oluşturmak istiyorsanız:

  1. Eklentinin manifest dosyasında https://www.googleapis.com/auth/drive.addons.metadata.readonly scope bulunduğundan emin olun.

  2. Manifest dosyasının bir drive.onItemsSelectedTrigger bölümü içerdiğinden emin olun.

  3. drive.onItemsSelectedTrigger alanında belirtilen işlevi uygulayın. Bu işlev, bağımsız değişken olarak bir etkinlik nesnesi kabul eder ve tek bir Card nesnesi veya Card nesneleri dizisi döndürmelidir.

  4. Diğer kartlarda olduğu gibi, arayüz için widget etkileşimi sağlamak üzere kullanılan tüm geri çağırma işlevlerini uygulayın. Örneğin, arayüze bir düğme eklediyseniz bu düğmeye bir Action eklenmeli ve düğme tıklandığında çalışan bir geri çağırma işlevi uygulanmalıdır.

Etkinlik nesneleri

Bir etkinlik nesnesi oluşturulur ve bu işlevler çağrıldığında drive.homepageTrigger veya drive.onItemsSelectedTrigger tetikleyici işlevine aktarılır. Tetikleyici işlevi, eklenti kartlarının nasıl oluşturulacağını veya eklenti davranışının nasıl kontrol edileceğini belirlemek için bu etkinlik nesnesindeki bilgileri kullanır.

Etkinlik nesnelerinin tam yapısı Etkinlik nesneleri bölümünde açıklanmaktadır. Eklentinin etkin ana makine uygulaması Drive olduğunda, bağlamsal etkinlik nesneleri, Drive'a özgü istemci bilgilerini taşıyan Drive etkinlik nesnesi alanını içerir.

Öğe seçimi tetikleyicileri için bağlamsal Drive etkinlik nesneleri, tetikleyici tetiklendiğinde kullanıcının seçtiği öğelerle ilgili bilgileri içerir. Kullanıcı Drive'da birden fazla öğe seçtiğinde öğelerden biri birincil ilgi alanı olarak kabul edilir. Bu öğeye etkin imleç öğesi adı verilir.

Eklentinin davranışı birden fazla seçili öğe için geçerli olacaksa bunların tümünü tanımlamak üzere etkinlik nesnesindeki drive.selectedItems dizisinde sağlanan bilgileri kullanın.

Bir eklentinin davranışı yalnızca tek bir seçili öğeye uygulanması gerektiğinde, tam seçimdeki öğeyi tanımlamak için etkinlik nesnesinin drive.activeCursorItem alanında sağlanan bilgileri kullanın. drive.selectedItems dizisinden hangi öğenin kullanılacağını tahmin etmeye çalışmayın.

Aşağıdaki örnekte, drive.onItemsSelectedTrigger işlevine iletilen bir Drive etkinliği nesnesi gösterilmektedir:

{
  "commonEventObject": { ... },
  "drive": {
    "activeCursorItem":{
      "addonHasFileScopePermission": true,
      "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
      "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
      "mimeType":"application/pdf",
      "title":"How to get started with Drive"
    },
    "selectedItems": [
      {
        "addonHasFileScopePermission": true,
        "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
        "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
        "mimeType":"application/pdf",
        "title":"How to get started with Drive"
      },
      ...
    ]
  },
  ...
}