Topluluk Bağlayıcısı oluşturma adımları şunlardır:
- Yeni bir Apps Komut Dosyası projesi oluşturun.
- Bağlayıcı kodunu yazın.
- Proje manifestini doldurun.
Yeni bir Apps Komut Dosyası projesi oluşturma
Yeni bir proje oluşturmak için Google Apps Komut Dosyası'nı ziyaret edin. Apps Komut Dosyası, sizin için
varsayılan bir komut dosyası oluşturur. myFunction
işlevini kaldırabilir ve projeyi yeniden adlandırabilirsiniz. (Apps Komut Dosyası hakkında daha fazla bilgi edinin)
Bağlayıcı kodunu yaz
Her bağlayıcının belirli bir işlev grubunun tanımlanması gerekir. Barındırma uygulaması (ör. Looker Studio) bu işlevleri yürütür. Bağlayıcınızın gelen istekleri işlemesi ve Community Connector API referansında açıklandığı gibi yanıt vermesi beklenir. Kodunuzu geliştirirken sorunlarla karşılaşırsanız yardım için hata ayıklama kılavuzunu okuyun.
getAuthType() fonksiyonunda kimlik doğrulama türünü tanımlayın
Bu işlev, üçüncü taraf hizmet için kullanılan kimlik doğrulama yöntemini tanımlamak amacıyla çağrılır. Ayrıntılar için getAuthType() referansına bakın. Şu anda desteklenen kimlik doğrulama yöntemleri AuthType
referansında listelenmiştir.
Örneğin, aşağıdaki bağlayıcı kimlik doğrulaması gerektirmez:
Veri kaynağınız OAuth 2.0 kimlik doğrulaması gerektiriyorsa OAuth 2.0 kimlik doğrulama kılavuzunu görüntüleyin ve gerekli diğer işlevleri bağlayıcınıza ekleyin.
Yapılandırmayı getConfig()
aracılığıyla tanımlayın
getConfig()
işlevi, bağlayıcınızın gerektirdiği kullanıcı tarafından sağlanan değerler dahil olmak üzere bağlayıcı yapılandırmasını almak için çağrılır. Ayrıntılar için getConfig()
referansına bakın.
Looker Studio, getConfig()
tarafından sağlanan yanıta göre bağlayıcı yapılandırma ekranını oluşturur. Desteklenen yapılandırma öğeleri ConfigType
referansında listelenmiştir.
Veri kaynağınız parametre olarak tarihi gerektiriyorsa config.setDateRangeRequired(true) yöntemini çağırın. Koşullu veya dinamik yapılandırma soruları sormanız gerekirse adımlı yapılandırma bölümüne bakın.
Aşağıda, kullanıcının npm paket adı kodu girmesini gerektiren bir bağlayıcı örneği verilmiştir. getConfig()
işlevinde bir bilgi ve giriş alanı tanımlanır:
Alanları getSchema() ile tanımlayın
Bu işlev, belirtilen isteğin şemasını almak için çağrılır. getConfig()
işlevi tarafından tanımlanan tüm yapılandırma parametreleri, request
bağımsız değişkeninde sağlanır. Ayrıntılar için getSchema()
referansını inceleyin.
Bağlayıcınızın veri kaynağına ve kullanıcı tarafından sağlanan yapılandırmaya bağlı olarak şema düzeltilebilir veya istek sırasında dinamik olarak bunu sağlamanız gerekebilir.
Örneğin, bir bağlayıcı Rapor Kimliği'ne göre rapor verileri getiriyorsa söz konusu rapor için döndürülen veriler ve dolayısıyla şema önceden bilinmeyebilir.
Bu durumda, getSchema()
veri getirme işlemini gerektirebilir ve şemanın hesaplanması gerekir.
getData() ile veri getirme ve döndürme
Bu işlev, belirtilen isteğin verilerini almak için çağrılır. getConfig()
işlevi tarafından tanımlanan tüm yapılandırma parametreleri, request
bağımsız değişkeninde sağlanır. Ayrıntılar için getData()
referansını inceleyin.
getData()
isteğindeki aşağıdaki parametrelere daha fazla dikkat edilmesi gerekir:
lastRefresh
lastRefresh
, verilerin yenilenmesi için en son isteğin zamanını işaret eden bir zaman damgasını temsil eder. Değerinew Date(timestampString)
ile ayrıştırabilirsiniz. Apps Komut Dosyası Önbellek Hizmeti veya başka bir önbelleğe alma yöntemi kullanıyorsanızlastRefresh
zaman damgası, veri kaynağına yeni bir getirme isteği göndermek mi yoksa önbellekten veri sunmak mı istediğinizi belirlemenize yardımcı olabilir.dateRange
dateRangeRequired
,getConfig()
içintrue
olarak ayarlanırsa hergetData()
çağrısı, istekte seçilen tarih aralığını içerir. Daha ayrıntılı bilgi için Tarih Aralıklarıyla Çalışma bölümüne bakın.
Aşağıdaki örnek, gelen isteğe bağlı olarak verileri getirir ve paket istatistiklerini döndürür:
Proje manifestini tamamlamak
Manifest dosyası, Looker Studio'da bağlayıcınızı dağıtmak ve kullanmak için gereken Topluluk Bağlayıcınızla ilgili bilgileri içerir.
Apps Komut Dosyası geliştirme ortamında manifest dosyasını düzenlemek için Görünüm menüsünü ve ardından Manifest dosyasını göster'i tıklayın. Bu işlem, yeni bir appsscript.json
manifest dosyası oluşturur.
Manifest'i aşağıdaki verileri içerecek şekilde güncelleyin:
Looker Studio manifest dosyasıyla ilgili ayrıntılar için referans manifest referansına bakın.
Sonraki adımlar
Bir sonraki adım Topluluk Bağlayıcınızı dağıtmak olacaktır.