Manifest Referansı

Manifest (appsscript.json), Apps Komut Dosyası bağlayıcı projenizdeki bir JSON dosyasıdır. Bu dosya, 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ı'ndaki manifestler hakkında daha fazla bilgi edinin.

Manifest dosyanız aşağıdaki bilgileri içermelidir:

özellik 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 için bir simgenin URL'si.
Gereken boyutlar 40 x 40 piksel olmalıdır.
addOnUrl string (link) Bağlayıcınızın ne yaptığını ve eriştiği verileri açıklaması gereken özel bir "Daha Fazla Bilgi" sayfasına bağlantı verin. Bu sayfayı barındırmanız ve yönetmeniz gerekir.
Bu sayfa Hizmet Şartlarınızı ve Gizlilik Politikanızı içermeli ya da bunlara bağlantı vermelidir.
supportUrl string (link) Bu bağlayıcıyı desteklemek için destek sayfasının bağlantısı. Kullanıcılar, bu bağlantıdan bağlayıcınızla ilgili sorunları bildirebilmelidir. Bu sayfayı barındırmanız ve yönetmeniz gerekir.
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 olacak.
İsteğe bağlı (dataStudio özelliği 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österilir. Bağlayıcınızın işlevini kısaca açıklamak için bunu 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şu için Gizlilik Politikası bağlantısı.
termsOfServiceUrl string (link) Bağlayıcı / geliştirici kuruluşu için Hizmet Şartları bağlantısı.
authType list(AuthType) Bağlayıcınız için kimlik doğrulama yöntemi türü. Aşağıdaki AuthType konusuna 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üne bakın.
templates Object Bu bağlayıcıyla kullanılabilecek şablonların listesi. Yalnızca bir default anahtarı ayarlanarak tanımlanan tek bir varsayılan şablon desteklenir. 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 kılınıp kılınmayacağı. Bu özellik isteğe bağlıdır ve varsayılan olarak false değerine ayarlanır. Görüntüleyenin kimlik bilgileri hakkında daha ayrıntılı bilgi için Veri kaynağı kimlik bilgileri bölümüne bakın.
useQueryConfig boolean KULLANIMDAN KALDIRILDI: Bu bağlayıcının "getData()" için bir sorgu yapılandırması döndürüp döndürmeyeceğini belirtir. Bunun yerine "advancedServices" özelliğini 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ğini belirtir. Gelişmiş hizmetlere 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ğini belirtir. Gelişmiş hizmetlere bakın.
İsteğe bağlı (Kök düzey mülk)
urlFetchWhitelist list(string) Bağlayıcınızın kullandığı HTTPS URL'si öneklerinin listesi. Getirilen URL uç noktaları, bu listedeki ön eklerden biriyle eşleşmelidir. Bu, kullanıcı verilerinin korunmasına yardımcı olabilir. Daha fazla bilgi için URL'leri güvenli listeye ekleme bölümüne bakın.

AuthType

Kimlik doğrulama yöntemi türünün değerleri şunlardan biri olabilir:

Sıralama Değeri Açıklama
NONE Bağlayıcı için kimlik doğrulaması gerekmediğini belirtir.
OAUTH2 Bağlayıcının OAuth 2.0 kullandığını belirtir.
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ı belirtir.
USER_TOKEN Bağlayıcının kullanıcı adı/jeton kullandığını belirtir.
PATH_USER_PASS Bağlayıcının yol/kullanıcı adı/şifre kullandığını belirtir.
PATH_KEY Bağlayıcının yol/anahtar kullandığını belirtir.

FeeType

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

Sıralama Değeri Açıklama
FREE Bağlayıcının tamamen serbest olduğunu belirtir.
FREE_TRIAL Bağlayıcıda ücretsiz deneme seçeneğinin bulunduğunu belirtir.
PAID Kullanıcının bağlayıcıyı kullanmak için ödeme yapması gerektiğini belirtir.

Kaynaklar

Kaynaklar, kaynaklara ait enum listesidir. Mevcut kaynak listesini Veri Kaydı Depomuzda görüntüleyebilirsiniz. Bağlandığınız kaynak, depoda mevcut değilse kaynağı eklemek için Veri Kaydı Deposu'na bir çekme isteği gönderin. Kaynak adı yalnızca büyük harfli karakterler ve alt çizgiler içerebilir (ör. Google Analytics, GOOGLE_ANALYTICS olacaktır). Topluluk Bağlayıcısı manifestinizde veri kaynağı kimliği mülkünün value değerini kullanın (ör. GOOGLE_ANALYTICS).

Topluluk Bağlayıcı 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/"
  ]
}