Referensi Manifes

Manifes (appsscript.json) adalah file JSON dalam project konektor Apps Script Anda. Notifikasi ini berisi informasi tertentu tentang Konektor Komunitas Anda yang diperlukan untuk men-deploy dan menggunakan konektor di Looker Studio. Baca selengkapnya tentang manifes di Apps Script.

Manifes Anda harus berisi informasi berikut:

nama properti Jenis Deskripsi
Wajib (di bagian properti dataStudio)
name string Nama konektor Anda.
Dibatasi hingga 28 karakter
company string Nama organisasi atau developer.
companyUrl string (link) Link ke situs organisasi atau developer.
logoUrl string (image link) URL ke ikon untuk konektor Anda.
Dimensi yang diperlukan adalah 40x40 piksel.
addOnUrl string (link) Tautkan ke halaman 'Pelajari Lebih Lanjut' khusus yang akan menjelaskan fungsi konektor dan data yang diaksesnya. Anda harus menghosting dan mengelola halaman ini.
Halaman ini harus berisi atau tertaut ke Persyaratan Layanan dan Kebijakan Privasi Anda.
supportUrl string (link) Link ke halaman dukungan untuk mendukung konektor ini. Pengguna harus dapat melaporkan masalah terkait konektor Anda di link ini. Anda harus menghosting dan mengelola halaman ini.
description string Deskripsi untuk konektor Anda.
Pengguna akan melihat deskripsi lengkap di halaman konfigurasi konektor Anda. Link akan dapat diklik.
Opsional (di bagian properti dataStudio)
shortDescription string Batas: 114 karakter. Jika konektor Anda dipublikasikan, deskripsi singkat ini akan terlihat di kartu galeri untuk konektor Anda. Gunakan ini untuk menjelaskan secara singkat fungsi konektor Anda. Pengguna akan dapat melihat ini saat menjelajahi konektor di galeri.
privacyPolicyUrl string (link) Link ke Kebijakan Privasi untuk organisasi developer / konektor.
termsOfServiceUrl string (link) Link ke Persyaratan Layanan untuk organisasi developer / konektor.
authType list(AuthType) Jenis metode autentikasi untuk konektor Anda. Lihat AuthType di bawah.
feeType list(FeeType) Menunjukkan jenis biaya untuk konektor Anda. Lihat FeeType di bawah.
sources list(Sources) Daftar sumber data yang dapat dihubungkan ke konektor ini. Lihat Sumber di bawah.
templates Object Daftar template yang dapat digunakan dengan konektor ini. Hanya satu template default yang didukung, yang diidentifikasi dengan menetapkan kunci default. Nilainya harus berupa ID laporan untuk laporan Looker Studio yang akan digunakan sebagai template. Lihat panduan tentang Menyediakan template laporan.
forceViewersCredentials boolean Apakah kredensial pelihat harus dipaksa untuk sumber data yang dibuat dari konektor ini. Properti ini bersifat opsional dan defaultnya adalah false. Lihat Kredensial sumber data untuk mengetahui detail selengkapnya tentang kredensial pelihat.
useQueryConfig boolean TIDAK DIGUNAKAN LAGI: Apakah konektor ini akan menampilkan konfigurasi kueri untuk `getData()` atau tidak. Sebagai gantinya, gunakan `advancedServices`.
advancedServices.data boolean Apakah konektor ini akan menampilkan konfigurasi kueri untuk `getData()` atau tidak. Lihat layanan lanjutan.
advancedServices.schema boolean Apakah konektor ini akan menampilkan konfigurasi kueri untuk `getSchema()` atau tidak. Lihat layanan lanjutan.
Opsional (Properti tingkat root)
urlFetchWhitelist list(string) Daftar awalan URL HTTPS yang digunakan konektor Anda. Setiap endpoint URL yang diambil harus cocok dengan salah satu awalan dalam daftar ini. Hal ini dapat membantu melindungi data pengguna. Lihat URL daftar aman untuk detail selengkapnya.

AuthType

Nilai untuk jenis metode autentikasi dapat berupa salah satu dari berikut ini:

Nilai Enum Deskripsi
NONE Menunjukkan bahwa konektor tidak memerlukan autentikasi.
OAUTH2 Menunjukkan bahwa konektor menggunakan OAuth 2.0.
KEY Menunjukkan bahwa konektor menggunakan kunci API.
USER_PASS Menunjukkan bahwa konektor menggunakan nama pengguna/sandi.
USER_TOKEN Menunjukkan bahwa konektor menggunakan nama pengguna/token.
PATH_USER_PASS Menunjukkan bahwa konektor menggunakan jalur/nama pengguna/sandi.
PATH_KEY Menunjukkan bahwa konektor menggunakan jalur/kunci.

FeeType

Nilai untuk jenis biaya dapat berupa salah satu dari yang berikut:

Nilai Enum Deskripsi
FREE Menunjukkan bahwa konektor sepenuhnya bebas digunakan.
FREE_TRIAL Menunjukkan bahwa konektor memiliki opsi uji coba gratis.
PAID Menunjukkan bahwa pengguna harus membayar agar dapat menggunakan konektor.

Sumber

Sumber adalah daftar enum untuk sumber. Anda dapat melihat daftar sumber yang ada di Repositori Data Registry kami. Jika sumber yang ingin Anda hubungkan tidak ada di repositori, kirim permintaan pull ke Repositori Data Registry untuk menambahkan sumber. Nama sumber hanya boleh berisi karakter huruf besar dan garis bawah (misalnya, Google Analytics akan menjadi GOOGLE_ANALYTICS). Dalam manifes Konektor Komunitas, gunakan value dari properti ID sumber data, misalnya, GOOGLE_ANALYTICS.

Contoh manifes untuk Konektor Komunitas

Berikut adalah contoh manifes yang sudah selesai:

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/"
  ]
}