Cakupan Otorisasi

Pengguna harus mengizinkan project skrip yang mengakses data atau bertindak atas nama mereka. Saat pengguna menjalankan skrip yang memerlukan otorisasi untuk pertama kalinya, UI menampilkan permintaan untuk memulai alur otorisasi.

Selama alur ini, UI memberi tahu pengguna apa yang perlu dilakukan skrip. Misalnya, skrip mungkin meminta izin untuk membaca pesan email pengguna atau membuat acara di kalender mereka. Project skrip menentukan izin individual ini sebagai cakupan OAuth.

Untuk sebagian besar skrip, Apps Script otomatis mendeteksi cakupan yang diperlukan untuk Anda; Anda dapat melihat cakupan yang digunakan skrip kapan saja. Anda juga dapat menetapkan cakupan secara eksplisit dalam manifes menggunakan string URL. Menyetel cakupan secara eksplisit terkadang diperlukan untuk aplikasi tertentu seperti add-on, karena aplikasi yang dipublikasikan harus selalu menggunakan cakupan sesempit mungkin.

Selama alur otorisasi, Apps Script menampilkan deskripsi cakupan wajib yang dapat dibaca pengguna kepada pengguna. Misalnya, jika skrip memerlukan akses hanya baca ke spreadsheet, manifes mungkin memiliki cakupan https://www.googleapis.com/auth/spreadsheets.readonly. Selama alur otorisasi, skrip dengan cakupan ini meminta pengguna mengizinkan aplikasi ini untuk "Melihat Google Spreadsheet Anda".

Beberapa cakupan bersifat inklusif untuk cakupan lainnya. Misalnya, jika diberi otorisasi, cakupan https://www.googleapis.com/auth/spreadsheets akan mengizinkan akses baca dan tulis ke spreadsheet.

Melihat cakupan

Anda dapat melihat cakupan yang saat ini diperlukan project skrip dengan melakukan hal berikut:

  1. Buka project skrip.
  2. Di sebelah kiri, klik Overview .
  3. Lihat cakupan di bagian Cakupan OAuth Project.

Menetapkan cakupan eksplisit

Apps Script secara otomatis menentukan cakupan yang diperlukan skrip dengan memindai kodenya untuk panggilan fungsi yang memerlukannya. Untuk sebagian besar skrip, hal ini sudah cukup dan menghemat waktu Anda, tetapi untuk add-on dan aplikasi web yang dipublikasikan, Anda harus menerapkan kontrol langsung atas cakupan.

Apps Script terkadang otomatis menetapkan cakupan project yang sangat permisif. Ini dapat berarti skrip Anda meminta lebih dari yang dibutuhkan pengguna, yang merupakan praktik yang buruk. Untuk skrip yang dipublikasikan, Anda harus mengganti cakupan yang luas dengan kumpulan yang lebih terbatas, yang mencakup kebutuhan skrip dan tidak lebih.

Anda dapat secara eksplisit menetapkan cakupan yang digunakan project skrip dengan mengedit file manifes. Kolom manifes oauthScopes adalah array dari semua cakupan yang digunakan oleh project. Untuk menetapkan cakupan project, lakukan langkah berikut:

  1. Buka project skrip.
  2. Di sebelah kiri, klik Project Settings .
  3. Centang kotak Tampilkan file manifes "appsscript.json" di editor.
  4. Di sebelah kiri, klik Editor .
  5. Di sebelah kiri, klik file appsscript.json.
  6. Temukan kolom tingkat atas berlabel oauthScopes. Jika tidak ada, Anda dapat menambahkannya.
  7. Kolom oauthScopes menentukan array string. Untuk menetapkan cakupan yang digunakan project Anda, ganti konten array ini dengan cakupan yang ingin Anda gunakan. Misalnya: 
          {
        ...
        "oauthScopes": [
          "https://www.googleapis.com/auth/spreadsheets.readonly",
          "https://www.googleapis.com/auth/userinfo.email"
        ],
       ...
      }
  8. Di bagian atas, klik Simpan .

Verifikasi OAuth

Cakupan OAuth tertentu bersifat sensitif karena memungkinkan akses ke Data Pengguna Google. Jika project skrip Anda menggunakan cakupan yang mengizinkan akses ke data pengguna, project tersebut harus melalui verifikasi klien OAuth sebelum Anda dapat memublikasikannya secara publik sebagai aplikasi web atau add-on. Untuk informasi selengkapnya, lihat panduan berikut:

Cakupan yang dibatasi

Selain cakupan sensitif, cakupan tertentu diklasifikasikan sebagai dibatasi dan tunduk pada aturan tambahan yang membantu melindungi data pengguna. Jika Anda ingin memublikasikan aplikasi web atau add-on yang menggunakan satu atau beberapa cakupan terbatas, aplikasi harus mematuhi semua batasan yang ditentukan sebelum dapat dipublikasikan.

Tinjau daftar lengkap cakupan yang dibatasi sebelum mencoba memublikasikannya. Jika aplikasi Anda menggunakan salah satunya, Anda harus mematuhi Persyaratan Tambahan untuk cakupan API Tertentu sebelum memublikasikan.