Layanan lanjutan di Apps Script memungkinkan developer berpengalaman terhubung ke Google API publik tertentu dengan penyiapan yang lebih sedikit daripada menggunakan antarmuka HTTP mereka. Layanan lanjutan pada dasarnya adalah wrapper tipis di sekitar Google API tersebut. Cara kerjanya mirip dengan layanan bawaan Apps Script—misalnya, layanan menawarkan pelengkapan otomatis, dan Apps Script menangani alur otorisasi secara otomatis. Namun, Anda harus mengaktifkan layanan lanjutan sebelum dapat menggunakannya dalam skrip.
Untuk melihat Google API yang tersedia sebagai layanan lanjutan, cari bagian Layanan Google Lanjutan di Referensi. Jika Anda ingin menggunakan Google API yang tidak tersedia sebagai layanan lanjutan, cukup hubungkan ke API tersebut seperti API eksternal lainnya.
Layanan lanjutan atau HTTP?
Setiap layanan Google lanjutan dikaitkan dengan Google API publik.
Di Apps Script, Anda dapat mengakses API ini melalui layanan lanjutan atau cukup dengan membuat permintaan API secara langsung menggunakan UrlFetch
.
Jika Anda menggunakan metode layanan lanjutan, Apps Script akan menangani alur otorisasi dan menawarkan dukungan pelengkapan otomatis. Namun, Anda harus mengaktifkan layanan lanjutan sebelum dapat menggunakannya. Selain itu, beberapa layanan lanjutan hanya menyediakan subset fungsi yang tersedia di API.
Jika Anda menggunakan metode UrlFetch
untuk mengakses API secara langsung, pada dasarnya Anda
memperlakukan Google API sebagai
API eksternal. Dengan metode ini, semua
aspek API dapat digunakan. Namun, Anda harus menangani sendiri otorisasi API tersebut. Anda juga harus membuat header yang diperlukan dan mengurai
respons API.
Secara umum, sebaiknya gunakan layanan lanjutan jika memungkinkan dan hanya
gunakan metode UrlFetch
saat layanan lanjutan tidak menyediakan
fungsi yang Anda perlukan.
Persyaratan
Sebelum dapat menggunakan layanan lanjutan, Anda harus memenuhi persyaratan berikut:
- Anda harus mengaktifkan layanan lanjutan di project skrip Anda.
Anda harus memastikan API yang sesuai dengan layanan lanjutan diaktifkan di project Cloud Platform (GCP) yang digunakan skrip Anda.
Jika project skrip Anda menggunakan project GCP default yang dibuat pada atau setelah 8 April 2019, API akan diaktifkan secara otomatis setelah Anda mengaktifkan layanan lanjutan dan menyimpan project skrip. Jika belum melakukannya, Anda juga dapat diminta untuk menyetujui Persyaratan Layanan Google Cloud dan Google API.
Jika project skrip Anda menggunakan project GCP standar atau project GCP default yang lebih lama, Anda harus mengaktifkan API yang sesuai dengan layanan lanjutan di project GCP secara manual. Anda harus memiliki akses edit ke project GCP untuk membuat perubahan ini.
Lihat project Cloud Platform untuk mengetahui informasi selengkapnya.
Aktifkan layanan lanjutan
Untuk menggunakan layanan Google lanjutan, ikuti petunjuk berikut:
- Buka project Apps Script.
- Di sebelah kiri, klik Editor .
- Di sebelah kiri, di samping Layanan, klik Tambahkan layanan .
- Pilih layanan Google lanjutan, lalu klik Add.
Setelah diaktifkan, layanan lanjutan akan tersedia di pelengkapan otomatis.
Cara tanda tangan metode ditentukan
Layanan lanjutan umumnya menggunakan objek, nama metode, dan parameter yang sama seperti API publik terkait, meskipun tanda tangan metode diterjemahkan untuk digunakan dalam Apps Script. Fungsi pelengkapan otomatis skrip aplikasi biasanya memberikan informasi yang cukup untuk memulai, tetapi aturan di bawah menjelaskan cara Apps Script membuat tanda tangan metode dari Google API publik.
Permintaan ke Google API dapat menerima berbagai jenis data, termasuk parameter jalur, parameter kueri, isi permintaan, dan/atau lampiran upload media. Beberapa layanan lanjutan juga dapat menerima header permintaan HTTP tertentu (misalnya, layanan lanjutan Kalender).
Tanda tangan metode yang sesuai di Google Apps Script memiliki argumen berikut:
- Isi permintaan (biasanya resource), sebagai objek JavaScript.
- Jalur atau parameter yang diperlukan, sebagai argumen individual.
- Lampiran upload media, sebagai argumen
Blob
. - Parameter opsional, sebagai objek JavaScript yang memetakan nama parameter ke nilai.
- Header permintaan HTTP, sebagai nama header pemetaan JavaScript ke nilai header.
Jika metode ini tidak memiliki item apa pun dalam kategori tertentu, bagian tanda tangan tersebut akan dihilangkan.
Ada beberapa pengecualian khusus yang perlu diperhatikan:
- Untuk metode yang menerima upload media, parameter
uploadType
ditetapkan secara otomatis. - Metode yang bernama
delete
di Google API diberi namaremove
di Apps Script, karenadelete
adalah kata yang dicadangkan dalam JavaScript. - Jika layanan lanjutan dikonfigurasi untuk menerima header permintaan HTTP, dan Anda menetapkan objek JavaScript header permintaan, Anda juga harus menetapkan objek JavaScript parameter opsional (ke objek kosong jika tidak menggunakan parameter opsional).
Dukungan untuk layanan lanjutan
Layanan lanjutan hanya berupa wrapper tipis yang memungkinkan penggunaan Google API dalam Apps Script. Dengan demikian, masalah apa pun yang ditemukan saat menggunakannya biasanya merupakan masalah dengan API yang mendasarinya, bukan dengan Apps Script itu sendiri.
Jika Anda mengalami masalah saat menggunakan layanan lanjutan, masalah tersebut harus dilaporkan menggunakan petunjuk dukungan untuk API dasar. Link ke petunjuk dukungan ini diberikan di setiap panduan layanan lanjutan di bagian Reference Apps Script.