Langkah-langkah untuk membuat Konektor Komunitas adalah:
- Buat project Apps Script baru.
- Tulis kode konektor.
- Lengkapi manifes proyek.
Membuat project Apps Script baru
Buka Google Apps Script untuk membuat project baru. Apps Script akan membuat
skrip default untuk Anda. Jangan ragu untuk menghapus fungsi myFunction
dan mengganti nama project. (Pelajari Apps Script lebih lanjut)
Tulis kode konektor
Setiap konektor diharuskan memiliki kumpulan fungsi tertentu. Aplikasi hosting (misalnya, Looker Studio) akan menjalankan fungsi ini. Konektor Anda diharapkan dapat menangani permintaan masuk dan merespons seperti yang dijelaskan dalam referensi Community Connector API. Jika Anda mengalami masalah saat mengembangkan kode, baca panduan proses debug untuk mendapatkan bantuan.
Menentukan jenis autentikasi di getAuthType()
Fungsi ini dipanggil untuk mengidentifikasi metode autentikasi yang digunakan untuk layanan pihak ketiga. Lihat referensi getAuthType() untuk mengetahui detailnya. Metode autentikasi yang saat ini 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 konektor, termasuk nilai yang disediakan 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 terkait konfigurasi kondisional atau dinamis, lihat konfigurasi bertahap.
Berikut adalah contoh konektor yang mengharuskan pengguna memasukkan kode nama paket npm. Info dan kolom input ditentukan dalam
fungsi getConfig()
:
Menentukan kolom dengan getSchema()
Fungsi ini dipanggil untuk mendapatkan skema bagi permintaan yang diberikan. Setiap 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 diberikan oleh pengguna, skema dapat diperbaiki atau Anda mungkin harus memberikannya secara dinamis pada waktu permintaan.
Misalnya, jika konektor mengambil data laporan berdasarkan ID Laporan, data yang ditampilkan untuk laporan tersebut dan karenanya skema 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 yang ditentukan. Setiap parameter konfigurasi yang ditentukan oleh fungsi getConfig()
akan diberikan dalam argumen request
. Lihat referensi getData()
untuk mengetahui detailnya.
Parameter berikut dari permintaan getData()
memerlukan perhatian tambahan:
lastRefresh
lastRefresh
mewakili stempel waktu yang menandai waktu permintaan terbaru untuk pembaruan data. Anda seharusnya dapat mengurai nilai dengannew Date(timestampString)
. Jika Anda menggunakan Apps Script Cache Service atau metode cache lainnya, stempel waktulastRefresh
dapat membantu Anda menentukan apakah akan membuat permintaan pengambilan baru ke sumber data atau menyalurkan data dari cache.dateRange
JikadateRangeRequired
ditetapkan ketrue
digetConfig()
, setiap panggilangetData()
akan berisi rentang tanggal yang dipilih dalam permintaan. Lihat Bekerja dengan Rentang Tanggal untuk detail selengkapnya.
Contoh berikut mengambil data berdasarkan permintaan masuk dan menampilkan statistik paket:
Melengkapi manifes proyek
File manifes berisi informasi tentang Konektor Komunitas Anda yang diperlukan untuk men-deploy dan menggunakan konektor di Looker Studio.
Untuk mengedit file manifes di lingkungan pengembangan Apps Script, klik
menu View, lalu klik Show manifest file. Tindakan ini akan membuat
file manifes appsscript.json
baru.
Update manifes agar menyertakan data berikut:
Untuk mengetahui detail tentang manifes Looker Studio, lihat referensi manifes referensi.
Langkah berikutnya
Langkah berikutnya adalah menerapkan Konektor Komunitas.