Referensi Manifes

Manifes (appsscript.json) adalah file JSON di konektor Apps Script Anda proyek. File ini berisi informasi tertentu tentang Konektor Komunitas Anda yang diperlukan untuk men-deploy dan menggunakan konektor Anda 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 dibutuhkan adalah 40px kali 40px.
addOnUrl string (link) Link ke halaman khusus 'Pelajari Lebih Lanjut' halaman yang harus menjelaskan dilakukan konektor dan data yang diaksesnya. Anda harus menghosting dan mempertahankan kami.
Halaman ini harus berisi atau tertaut ke Persyaratan Layanan dan Privasi Anda Kebijakan.
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 memelihara halaman ini.
description string Deskripsi untuk konektor Anda.
Pengguna akan melihat deskripsi lengkap di konektor Anda halaman konfigurasi Google Cloud. 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 20%. Gunakan ini untuk menjelaskan secara singkat fungsi konektor Anda. Pengguna dapat melihatnya saat mereka menjelajahi konektor di galeri.
privacyPolicyUrl string (link) Link ke Kebijakan Privasi untuk konektor / organisasi developer.
termsOfServiceUrl string (link) Link ke Persyaratan Layanan untuk konektor / organisasi developer.
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 dengan konektor ini. Lihat Sumber di bawah.
templates Object Daftar template yang dapat digunakan dengan konektor ini. Hanya satu default template didukung, diidentifikasi dengan menetapkan Tombol default. Nilai harus berupa ID laporan untuk Looker Laporan Studio yang akan digunakan sebagai template. Lihat panduan tentang Menyediakan template laporan.
forceViewersCredentials boolean Apakah kredensial pelihat harus dipaksa untuk sumber data atau tidak yang dibuat dari konektor ini. Properti ini bersifat opsional dan defaultnya adalah false. Lihat Data kredensial sumber untuk mengetahui detail selengkapnya tentang kredensial pelihat.
useQueryConfig boolean TIDAK DIGUNAKAN LAGI: Apakah konektor ini akan menampilkan konfigurasi kueri untuk `getData()`. Sebagai gantinya, gunakan `advancedServices`.
advancedServices.data boolean Apakah konektor ini akan menampilkan konfigurasi kueri untuk `getData()`. Lihat lanjutan layanan Google.
advancedServices.schema boolean Apakah konektor ini akan menampilkan konfigurasi kueri untuk `getSchema()`. Lihat lanjutan layanan Google.
Opsional (Properti tingkat root)
urlFetchWhitelist list(string) Daftar awalan URL HTTPS yang digunakan konektor Anda. Endpoint URL apa pun yang diambil harus cocok dengan salah satu awalan dalam daftar ini. Hal ini dapat membantu melindungi data pengguna. Lihat Daftar aman URL untuk mengetahui detail selengkapnya.

AuthType

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

Nilai Enum Deskripsi
NONE Menunjukkan bahwa tidak diperlukan otentikasi untuk konektor 20%.
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 berikut ini:

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 untuk menggunakan konektor.

Sumber

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

Contoh manifes untuk Konektor Komunitas

Berikut adalah contoh manifes yang telah 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/"
  ]
}