Teropong senjata api

Pengguna harus mengizinkan add-on dan aplikasi lain yang mengakses data mereka atau bertindak atas nama mereka. Saat pengguna menjalankan add-on untuk pertama kalinya, UI add-on akan menampilkan permintaan otorisasi untuk memulai alur otorisasi.

Selama alur ini, perintah akan memberi tahu pengguna apa yang harus dilakukan oleh aplikasi. Misalnya, add-on mungkin meminta izin untuk membaca pesan email pengguna atau membuat acara di kalender mereka. Project skrip add-on menentukan izin individual ini sebagai cakupan OAuth.

Anda mendeklarasikan cakupan dalam manifes menggunakan string URL. Selama alur otorisasi, Apps Script akan menampilkan deskripsi cakupan yang dapat dibaca manusia kepada pengguna. Misalnya, Add-on Google Workspace Anda mungkin menggunakan cakupan "Baca pesan saat ini", yang ditulis dalam manifes sebagai https://www.googleapis.com/auth/gmail.addons.current.message.readonly. Selama alur otorisasi, add-on dengan cakupan ini akan meminta pengguna mengizinkan add-on untuk: Melihat pesan email saat add-on berjalan.

Melihat cakupan

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

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

Anda juga dapat melihat cakupan project skrip saat ini dalam manifes project, di kolom oauthScopes, tetapi hanya jika Anda telah menetapkan cakupan tersebut secara eksplisit.

Menetapkan cakupan eksplisit

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

Misalnya, Apps Script mungkin memberikan cakupan yang sangat permisif https://mail.google.com secara default ke project skrip add-on. Jika pengguna mengizinkan project skrip dengan cakupan ini, project tersebut diberi akses penuh ke akun Gmail pengguna. Untuk add-on yang dipublikasikan, Anda harus mengganti cakupan ini dengan kumpulan yang lebih terbatas yang mencakup kebutuhan add-on dan tidak lebih dari itu.

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

  1. Lihat cakupan yang saat ini digunakan add-on Anda. Tentukan perubahan apa yang perlu dilakukan, seperti menggunakan cakupan yang lebih sempit.
  2. Buka file manifes add-on.
  3. Temukan kolom tingkat teratas berlabel oauthScopes. Jika tidak ada, Anda dapat menambahkannya.
  4. Kolom oauthScopes menentukan array string. Untuk menetapkan cakupan yang digunakan project Anda, ganti konten array ini dengan cakupan yang ingin Anda gunakan. Misalnya, untuk Add-on Google Workspace yang memperluas Gmail, Anda mungkin memiliki hal berikut:

    {
      ...
      "oauthScopes": [
        "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
        "https://www.googleapis.com/auth/userinfo.email"
      ],
      ...
    }
    
  5. Simpan perubahan file manifes.

Verifikasi OAuth

Jika Anda menggunakan cakupan OAuth sensitif tertentu, add-on mungkin harus melalui verifikasi klien OAuth sebelum Anda dapat memublikasikannya. Untuk informasi selengkapnya, lihat panduan berikut:

Cakupan yang dibatasi

Cakupan tertentu dibatasi dan tunduk pada aturan tambahan yang membantu melindungi data pengguna. Jika Anda ingin memublikasikan Add-on Gmail atau Editor yang menggunakan satu atau beberapa cakupan yang dibatasi, add-on tersebut harus mematuhi semua batasan yang ditentukan sebelum dapat dipublikasikan.

Tinjau daftar lengkap cakupan yang dibatasi sebelum Anda mencoba melakukan publikasi. Jika add-on Anda menggunakan salah satunya, Anda harus mematuhi Persyaratan tambahan untuk cakupan API tertentu sebelum memublikasikannya.

Cakupan kalender

Berikut adalah cakupan yang sering digunakan untuk Add-on Google Workspace yang memperluas Google Kalender.

Cakupan
Mengakses metadata peristiwa https://www.googleapis.com/auth/calendar.addons.execute

Wajib jika add-on mengakses metadata acara Kalender. Mengizinkan add-on mengakses metadata peristiwa.

Membaca data peristiwa buatan pengguna https://www.googleapis.com/auth/calendar.addons.current.event.read

Wajib jika add-on perlu membaca data peristiwa yang dibuat pengguna. Mengizinkan add-on mengakses data peristiwa buatan pengguna. Data ini hanya tersedia jika kolom manifes addOns.calendar.eventAccess disetel ke READ atau READ_WRITE.

Menulis data peristiwa buatan pengguna https://www.googleapis.com/auth/calendar.addons.current.event.write

Wajib jika add-on perlu menulis data peristiwa yang dibuat pengguna. Mengizinkan add-on mengedit data peristiwa yang dibuat pengguna. Data ini hanya tersedia jika kolom manifes addOns.calendar.eventAccess disetel ke WRITE atau READ_WRITE.

Cakupan Drive

Berikut adalah cakupan yang sering digunakan untuk Add-on Google Workspace yang memperluas Google Drive.

Cakupan
Membaca metadata item yang dipilih https://www.googleapis.com/auth/drive.addons.metadata.readonly

Wajib jika add-on menerapkan antarmuka kontekstual yang dipicu saat pengguna memilih item di Drive. Mengizinkan add-on untuk membaca metadata terbatas tentang item yang telah dipilih pengguna di Google Drive. Metadata ini dibatasi pada ID item, judul, jenis MIME, URL ikon, dan apakah add-on memiliki izin untuk mengakses item tersebut.

Akses per file https://www.googleapis.com/auth/drive.file

Direkomendasikan jika add-on perlu mengakses setiap file Drive. Memberikan akses per file ke file yang dibuat atau dibuka oleh aplikasi, menggunakan Layanan Drive Lanjutan Apps Script. Namun, hal ini tidak memungkinkan penggunaan tindakan serupa menggunakan layanan Drive dasar. Otorisasi file diberikan per file dan dicabut saat pengguna membatalkan otorisasi aplikasi.

Lihat Contoh Meminta akses file untuk file yang dipilih.

Cakupan add-on Gmail

Ada beberapa cakupan yang dibuat khusus untuk Add-on Google Workspace guna membantu melindungi data Gmail pengguna. Anda harus menambahkan cakupan ini secara eksplisit ke manifes add-on, beserta cakupan lainnya yang diperlukan kode add-on.

Berikut adalah cakupan yang sering digunakan untuk Add-on Google Workspace yang memperluas Gmail; yang berlabel Diperlukan harus ditambahkan ke manifes Add-on Google Workspace jika add-on Anda memperluas Gmail.

Pastikan juga untuk mengganti cakupan https://mail.google.com yang sangat luas dalam add-on dengan kumpulan cakupan yang lebih sempit yang memungkinkan interaksi yang dibutuhkan add-on dan tidak lebih.

Cakupan
Membuat draf baru https://www.googleapis.com/auth/gmail.addons.current.action.compose

Wajib jika add-on menggunakan pemicu tindakan compose. Mengizinkan add-on untuk membuat balasan dan pesan draf baru untuk sementara. Lihat Menulis draf pesan untuk mengetahui detailnya; cakupan ini juga sering digunakan dengan tindakan tulis. Memerlukan token akses.

Membaca metadata pesan yang terbuka https://www.googleapis.com/auth/gmail.addons.current.message.metadata

Memberikan akses sementara ke metadata pesan terbuka (seperti subjek atau penerima). Tidak mengizinkan pembacaan konten pesan dan memerlukan token akses.

Wajib jika add-on menggunakan metadata dalam pemicu tindakan compose. Untuk tindakan compose, cakupan ini diperlukan jika pemicu compose memerlukan akses ke metadata. Dalam praktiknya, cakupan ini memungkinkan Compose memicu daftar penerima akses (to:, cc:, dan bcc:) draf email balasan.

Membaca konten pesan yang terbuka https://www.googleapis.com/auth/gmail.addons.current.message.action

Memberikan akses ke konten pesan yang terbuka setelah interaksi pengguna, seperti saat item menu add-on dipilih. Memerlukan token akses.

Membaca konten rangkaian pesan terbuka https://www.googleapis.com/auth/gmail.addons.current.message.readonly

Memberikan akses sementara ke metadata dan konten pesan terbuka. Juga memberikan akses ke konten pesan lain di thread terbuka. Memerlukan token akses.

Membaca konten dan metadata pesan https://www.googleapis.com/auth/gmail.readonly

Membaca metadata dan konten email apa pun, termasuk pesan yang terbuka. Wajib jika Anda perlu membaca informasi tentang pesan lain, seperti saat melakukan kueri penelusuran atau membaca seluruh rangkaian pesan email.

Token akses

Untuk melindungi data pengguna, cakupan Gmail yang digunakan di Add-on Google Workspace hanya memberikan akses sementara ke data pengguna. Untuk mengaktifkan akses sementara, Anda harus memanggil fungsi GmailApp.setCurrentMessageAccessToken(accessToken) menggunakan token akses sebagai argumen. Anda harus mendapatkan token akses dari objek peristiwa tindakan.

Berikut ini contoh penetapan token akses untuk mengizinkan akses ke metadata pesan. Satu-satunya cakupan yang diperlukan untuk contoh ini adalah https://www.googleapis.com/auth/gmail.addons.current.message.metadata.

function readSender(e) {
  var accessToken = e.gmail.accessToken;
  var messageId = e.gmail.messageId;

  // The following function enables short-lived access to the current
  // message in Gmail. Access to other Gmail messages or data isn't
  // permitted.
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  return mailMessage.getFrom();
}

Cakupan editor

Berikut adalah cakupan yang sering digunakan untuk Add-on Google Workspace yang memperluas Dokumen, Spreadsheet, dan Slide.

Cakupan
Akses file Dokumen saat ini https://www.googleapis.com/auth/documents.currentonly

Diperlukan jika add-on mengakses Apps Script Docs API. Memberikan akses sementara ke konten dokumen terbuka.

Akses file Spreadsheet saat ini https://www.googleapis.com/auth/spreadsheets.currentonly

Diperlukan jika add-on mengakses Apps Script Sheets API. Memberikan akses sementara ke konten spreadsheet yang terbuka.

Akses file Slide saat ini https://www.googleapis.com/auth/presentations.currentonly

Diperlukan jika add-on mengakses Apps Script Slides API. Memberikan akses sementara ke konten presentasi terbuka.

Akses per file https://www.googleapis.com/auth/drive.file

Diperlukan agar add-on dapat menggunakan onFileScopeGrantedTrigger dan jika add-on mengakses Dokumen, Spreadsheet, Slide, atau Drive API. Memberikan akses per file ke file yang dibuat atau dibuka oleh aplikasi, menggunakan Layanan Drive Lanjutan Apps Script. Namun, hal ini tidak memungkinkan penggunaan tindakan serupa menggunakan layanan Drive dasar. Otorisasi file diberikan per file dan dicabut saat pengguna membatalkan otorisasi aplikasi.

Cakupan lainnya

Add-on Anda mungkin memerlukan cakupan tambahan jika menggunakan layanan Apps Script lainnya. Pada umumnya, Anda dapat mengizinkan Apps Script mendeteksi cakupan ini dan mengupdate manifes secara otomatis. Saat mengedit daftar cakupan manifes, jangan hapus cakupan apa pun kecuali Anda menggantinya dengan alternatif yang lebih sesuai, seperti cakupan yang lebih sempit.

Sebagai referensi, berikut adalah daftar cakupan Apps Script yang sering digunakan bersama dengan Add-on Google Workspace:

Cakupan
Membaca alamat email pengguna https://www.googleapis.com/auth/userinfo.email

Mengizinkan project membaca alamat email pengguna saat ini.

Mengizinkan panggilan ke layanan eksternal https://www.googleapis.com/auth/script.external_request

Mengizinkan project membuat permintaan UrlFetch. Tindakan ini juga diperlukan jika project menggunakan library OAuth2 untuk Apps Script.

Membaca lokalitas dan zona waktu pengguna https://www.googleapis.com/auth/script.locale

Mengizinkan project mempelajari lokalitas dan zona waktu pengguna saat ini. Lihat Mengakses lokalitas dan zona waktu pengguna untuk mengetahui detailnya.

Membuat pemicu https://www.googleapis.com/auth/script.scriptapp

Mengizinkan project membuat pemicu.

Melihat pratinjau link pihak ketiga https://www.googleapis.com/auth/workspace.linkpreview

Wajib jika pratinjau add-on ditautkan dari layanan pihak ketiga. Mengizinkan project melihat link dalam aplikasi Google Workspace saat pengguna berinteraksi dengannya. Untuk mempelajari lebih lanjut, lihat Melihat pratinjau link dengan smart chip.

Membuat resource pihak ketiga https://www.googleapis.com/auth/workspace.linkcreate

Wajib diisi jika add-on membuat resource di layanan pihak ketiga. Mengizinkan project membaca informasi yang dikirim pengguna ke formulir pembuatan fasilitas dan menyisipkan link ke resource dalam aplikasi Google Workspace. Untuk mempelajari lebih lanjut, lihat Membuat resource pihak ketiga dari menu @.