Manifest Referansı

Manifest (appsscript.json), Apps Komut Dosyası bağlayıcısı projenizdeki bir JSON dosyasıdır. Topluluk bağlayıcınızla ilgili, bağlayıcınızı Looker Studio'da dağıtmak ve kullanmak için gerekli olan belirli bilgileri içerir. Apps Komut Dosyası'ndaki manifestler hakkında daha fazla bilgi edinin.

Manifestiniz aşağıdaki bilgileri içermelidir:

mülk adı Tür Açıklama
Zorunlu (dataStudio özelliği altında)
name string Bağlayıcınızın adı.
28 karakterle sınırlıdır.
company string Kuruluşun veya geliştiricinin adı.
companyUrl string (link) Kuruluşun veya geliştiricinin web sitesinin bağlantısı.
logoUrl string (image link) Bağlayıcınızın simgesinin URL'si.
Gerekli boyutlar 40 x 40 pikseldir.
addOnUrl string (link) Bağlayıcınızın ne yaptığı ve hangi verilere eriştiği açıklanması gereken özel bir "Daha Fazla Bilgi" sayfasına bağlantı. Bu sayfayı barındırmalı ve bakımını yapmalısınız.
Bu sayfada Hizmet Şartlarınız ve Gizlilik Politikanız yer almalı veya bu dokümanlara bağlantı verilmelidir.
supportUrl string (link) Bu bağlayıcıyı destekleyen destek sayfasının bağlantısı. Kullanıcılar, bu bağlantıyı kullanarak bağlayıcınızla ilgili sorunları bildirebilmelidir. Bu sayfayı barındırmalı ve bakımını yapmalısınız.
description string Bağlayıcınızın açıklaması.
Kullanıcılar, bağlayıcı yapılandırma sayfanızda tam açıklamayı görür. Bağlantılar tıklanabilir olur.
İsteğe bağlıdır (dataStudio mülkü altında)
shortDescription string Sınır: 114 karakter. Bağlayıcınız yayınlandıysa bu kısa açıklama, bağlayıcınızın galeri kartında görünür. Bağlayıcınızın ne yaptığını kısaca açıklamak için bu alanı kullanın. Kullanıcılar, galerideki bağlayıcılara göz atarken bunu görüntüleyebilir.
privacyPolicyUrl string (link) Bağlayıcı / geliştirici kuruluşun gizlilik politikasının bağlantısı.
termsOfServiceUrl string (link) Bağlayıcı / geliştirici kuruluşun Hizmet Şartları'nın bağlantısı.
authType list(AuthType) Konnektörünüzün kimlik doğrulama yöntemi türü. Aşağıdaki AuthType bölümüne bakın.
feeType list(FeeType) Bağlayıcınızın ücret türünü belirtir. Aşağıdaki FeeType'a bakın.
sources list(Sources) Bu bağlayıcının bağlanabileceği veri kaynaklarının listesi. Aşağıdaki Kaynaklar bölümünü inceleyin.
templates Object Bu bağlayıcıyla kullanılabilecek şablonların listesi. Yalnızca bir varsayılan şablon desteklenir. Bu şablon, default anahtarı ayarlanarak tanımlanır. Değer, şablon olarak kullanılacak Looker Studio raporunun rapor kimliği olmalıdır. Rapor şablonları sağlama ile ilgili kılavuza bakın.
forceViewersCredentials boolean Bu bağlayıcıdan oluşturulan veri kaynakları için görüntüleyenin kimlik bilgilerinin zorunlu olup olmayacağı. Bu özellik isteğe bağlıdır ve varsayılan olarak false değerine ayarlanır. Görüntüleyicinin kimlik bilgileri hakkında daha fazla bilgi için Veri kaynağı kimlik bilgileri başlıklı makaleyi inceleyin.
useQueryConfig boolean DESTEĞİ SONLANDIRILDI: Bu bağlayıcının, `getData()` için bir sorgu yapılandırması döndürüp döndürmeyeceği. Bunun yerine `advancedServices` kullanın.
advancedServices.data boolean Bu bağlayıcının, `getData()` için bir sorgu yapılandırması döndürüp döndürmeyeceği. Gelişmiş hizmetler bölümüne bakın.
advancedServices.schema boolean Bu bağlayıcının, `getSchema()` için bir sorgu yapılandırması döndürüp döndürmeyeceği. Gelişmiş hizmetler bölümüne bakın.
İsteğe bağlı (Kök düzeyinde özellik)
urlFetchWhitelist list(string) Bağlayıcınızın kullandığı HTTPS URL ön eklerinin listesi. Getirilen tüm URL uç noktaları bu listedeki öneklerden biriyle eşleşmelidir. Bu, kullanıcı verilerinin korunmasına yardımcı olabilir. Daha fazla bilgi için URL'leri güvenli listeye alma bölümüne bakın.

AuthType

Kimlik doğrulama yöntemi türü değerleri aşağıdakilerden biri olabilir:

Enum Değeri Açıklama
NONE Bağlayıcı için kimlik doğrulama gerekmediğini gösterir.
OAUTH2 Bağlayıcının OAuth 2.0 kullandığını gösterir.
KEY Bağlayıcının API anahtarı kullandığını gösterir.
USER_PASS Bağlayıcının kullanıcı adı/şifre kullandığını gösterir.
USER_TOKEN Bağlayıcının kullanıcı adı/jeton kullandığını gösterir.
PATH_USER_PASS Bağlayıcının yol/kullanıcı adı/şifre kullandığını gösterir.
PATH_KEY Bağlayıcının yol/anahtar kullandığını gösterir.

FeeType

Ücret türü değerleri aşağıdakilerden herhangi biri olabilir:

Enum Değeri Açıklama
FREE Bağlayıcının tamamen ücretsiz olduğunu gösterir.
FREE_TRIAL Bağlayıcının ücretsiz deneme seçeneği olduğunu gösterir.
PAID Kullanıcının bağlayıcıyı kullanmak için ödeme yapması gerektiğini gösterir.

Kaynaklar

Kaynaklar, kaynaklar için bir enum listesidir. Mevcut kaynak listesini Veri Kayıt Defteri Depomuzda inceleyebilirsiniz. Bağlandığınız kaynak, depoda yoksa kaynağı eklemek için Veri Kayıt Defteri Deposu'na çekme isteği gönderin. Kaynak adı yalnızca büyük harfler ve alt çizgiler içerebilir (ör. Google Analytics GOOGLE_ANALYTICS olur). Topluluk Bağlayıcı manifestinizde, veri kaynağı kimliği özelliğinin değerini kullanın (ör. GOOGLE_ANALYTICS).

Topluluk Bağlayıcısı için örnek manifest

Aşağıda, tamamlanmış bir manifest örneği verilmiştir:

data-studio/appsscript.json
{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}