Langkah-langkah untuk membuat Konektor Komunitas adalah:
- Buat project Apps Script baru.
- Tulis kode konektor.
- Lengkapi manifes project.
Membuat project Apps Script baru
Kunjungi Google Apps Script untuk membuat project baru. Apps Script akan membuat
default untuk Anda. Jangan ragu untuk menghapus fungsi myFunction
dan mengganti nama
menyelesaikan proyek tersebut. (Pelajari lebih lanjut Apps Script)
Menulis kode konektor
Setiap konektor harus memiliki sekumpulan fungsi tertentu yang ditentukan. Tujuan aplikasi hosting Anda (misalnya Looker Studio) akan menjalankan fungsi ini. Nama konektor diharapkan menangani permintaan yang masuk dan merespons seperti yang dijelaskan dalam referensi Community Connector API. Jika Anda menghadapi masalah saat mengembangkan kode Anda, baca panduan proses debug untuk mendapatkan bantuan.
Menentukan jenis autentikasi di getAuthType()
Fungsi ini dipanggil untuk mengidentifikasi
metode otentikasi yang digunakan untuk
Layanan pihak ketiga. Lihat referensi getAuthType() untuk mengetahui detailnya. Saat ini
metode autentikasi yang didukung tercantum dalam referensi AuthType
.
Misalnya, konektor berikut tidak memerlukan autentikasi:
Jika sumber data Anda memerlukan autentikasi OAuth 2.0, lihat Panduan autentikasi OAuth 2.0 dan tambahkan fungsi tambahan yang diperlukan ke konektor Anda.
Menentukan konfigurasi melalui getConfig()
Fungsi getConfig()
dipanggil untuk mendapatkan konfigurasi bagi
konektor, termasuk nilai yang diberikan pengguna yang diperlukan konektor Anda. Lihat
Referensi getConfig()
untuk mengetahui detailnya.
Berdasarkan respons yang diberikan oleh getConfig()
, Looker Studio akan merender
layar konfigurasi konektor. Elemen konfigurasi yang didukung tercantum
dalam referensi ConfigType
.
Jika sumber data Anda memerlukan tanggal sebagai parameter, panggil config.setDateRangeRequired(true). Jika Anda perlu mengajukan pertanyaan bersyarat atau dinamis pertanyaan konfigurasi, lihat konfigurasi bertahap.
Berikut adalah contoh konektor yang mengharuskan pengguna memasukkan
kode nama paket npm. Info dan isian {i>input <i}ditentukan dalam
Fungsi getConfig()
:
Menentukan kolom dengan getSchema()
Fungsi ini dipanggil untuk mendapatkan skema bagi permintaan yang diberikan. Apa saja
parameter konfigurasi yang ditentukan oleh fungsi getConfig()
akan diberikan
dalam argumen request
. Lihat referensi getSchema()
untuk mengetahui detailnya.
Bergantung pada sumber data konektor Anda dan konfigurasi yang disediakan oleh skema mungkin telah diperbaiki atau Anda mungkin harus menyediakannya secara dinamis di waktu permintaan.
Misalnya, jika konektor mengambil data laporan berdasarkan ID Laporan,
data yang ditampilkan untuk laporan tersebut sehingga skemanya mungkin tidak diketahui sebelumnya.
Dalam hal ini, getSchema()
mungkin memerlukan pengambilan data dan skema harus
dihitung.
Mengambil dan menampilkan data dengan getData()
Fungsi ini dipanggil untuk mendapatkan data permintaan tertentu. Konfigurasi apa pun
parameter yang ditentukan oleh fungsi getConfig()
akan disediakan di
Argumen request
. Lihat referensi getData()
untuk mengetahui detailnya.
Parameter berikut dari permintaan getData()
memerlukan tambahan
{i>attention<i} (perhatian):
lastRefresh
lastRefresh
mewakili stempel waktu yang menandai waktu terbaru meminta pembaruan data. Anda harus dapat mengurai nilai ini dengannew Date(timestampString)
. Jika Anda menggunakan Layanan Cache Apps Script atau metode penyimpanan dalam cache lainnya, stempel waktulastRefresh
akan membantu Anda menentukan apakah akan membuat permintaan pengambilan baru ke sumber data atau menyajikan data dari cache.dateRange
JikadateRangeRequired
disetel ketrue
dalamgetConfig()
, setiapgetData()
akan berisi rentang tanggal yang dipilih dalam permintaan. Lihat Menggunakan Rentang Tanggal untuk mengetahui detail selengkapnya.
Contoh berikut mengambil data berdasarkan permintaan masuk dan menampilkan statistik paket:
Menyelesaikan manifes project
File manifes berisi informasi tentang Konektor Komunitas Anda yang yang diperlukan untuk men-deploy dan menggunakan konektor Anda di Looker Studio.
Untuk mengedit file manifes di lingkungan pengembangan Apps Script, klik
menu View dan klik Show manifest file. Ini akan membuat
File manifes appsscript.json
.
Perbarui manifes untuk menyertakan data berikut:
Untuk mengetahui detail tentang manifes Looker Studio, lihat referensi referensi manifes.
Langkah berikutnya
Langkah selanjutnya adalah men-deploy Konektor Komunitas.