Pilih cakupan Google Workspace Events API

Dokumen ini berisi informasi otorisasi dan autentikasi khusus Google Workspace Events API. Sebelum membaca dokumen ini, pastikan Anda membaca informasi autentikasi dan otorisasi umum Google Workspace di Mempelajari autentikasi dan otorisasi.

Mengonfigurasi OAuth 2.0 untuk otorisasi

Mengonfigurasi layar izin OAuth dan memilih cakupan untuk menentukan informasi yang ditampilkan kepada pengguna dan peninjau aplikasi, serta mendaftarkan aplikasi Anda agar dapat dipublikasikan nanti.

Cakupan Google Workspace Events API

Untuk menentukan tingkat akses yang diberikan ke aplikasi Anda, Anda perlu mengidentifikasi dan mendeklarasikan cakupan otorisasi. Cakupan otorisasi adalah string URI OAuth 2.0 yang berisi nama aplikasi Google Workspace, jenis data yang diakses, dan tingkat akses. Cakupan adalah permintaan aplikasi Anda untuk menggunakan data Google Workspace, termasuk data Akun Google pengguna.

Saat aplikasi Anda diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Secara umum, Anda harus memilih cakupan yang paling berfokus dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lebih bersedia memberikan akses ke cakupan terbatas yang dijelaskan dengan jelas.

Jika memungkinkan, sebaiknya gunakan cakupan tidak sensitif karena memberikan cakupan akses per file dan mempersempit akses ke fungsi tertentu yang diperlukan oleh aplikasi.

Google Workspace Events API menggunakan cakupan dari aplikasi Google Workspace yang mendukung langganan. Jika aplikasi Anda sudah menggunakan cakupan yang diperlukan untuk langganan Anda, Anda tidak perlu menambahkan cakupan tambahan untuk menggunakan Google Workspace Events API.

Tabel berikut menampilkan cakupan yang didukung untuk Google Workspace Events API:

Kode cakupan Deskripsi Penggunaan
Google Chat  
https://www.googleapis.com/auth/chat.bot Mengizinkan aplikasi Google Chat melihat percakapan dan mengirim pesan. Memberikan akses ke semua fitur yang tersedia untuk aplikasi Chat. Tidak sensitif
https://www.googleapis.com/auth/chat.memberships Melihat, menambahkan, dan menghapus anggota dari percakapan di Google Chat.
Sensitif
https://www.googleapis.com/auth/chat.memberships.readonly Melihat anggota di percakapan Google Chat.
Sensitif
https://www.googleapis.com/auth/chat.spaces Membuat percakapan dan ruang serta melihat atau memperbarui metadata (termasuk setelan histori) di Google Chat. Sensitif
https://www.googleapis.com/auth/chat.spaces.readonly Melihat chat dan ruang di Google Chat.
Sensitif
https://www.googleapis.com/auth/chat.messages.reaction dtk Melihat, menambahkan, dan menghapus reaksi pada pesan di Chat.
Sensitif
https://www.googleapis.com/auth/chat.messages.reactions.readonly Melihat reaksi pada pesan di Chat.
Sensitif
https://www.googleapis.com/auth/chat.messages Melihat, menulis, mengirim, memperbarui, dan menghapus pesan, serta menambahkan, melihat, dan menghapus reaksi terhadap pesan. Dibatasi
https://www.googleapis.com/auth/chat.messages.readonly Melihat pesan dan reaksi di Google Chat.
Dibatasi
Google Drive  
https://www.googleapis.com/auth/drive.file Membuat file Drive baru, atau mengubah file yang ada, yang Anda buka dengan aplikasi atau yang dibagikan pengguna dengan aplikasi saat menggunakan Google Picker API atau pemilih file aplikasi. Tidak sensitif
https://www.googleapis.com/auth/drive Melihat dan mengelola semua file Drive Anda. Dibatasi
https://www.googleapis.com/auth/drive.readonly Melihat dan mendownload semua file Drive Anda. Dibatasi
https://www.googleapis.com/auth/drive.metadata Melihat dan mengelola metadata file di Drive Anda. Dibatasi
https://www.googleapis.com/auth/drive.metadata.readonly Melihat metadata file di Drive Anda. Dibatasi
Google Meet  
https://www.googleapis.com/auth/meetings.space.created Mengizinkan aplikasi membuat, mengubah, dan membaca metadata tentang ruang rapat yang dibuat oleh aplikasi Anda.
Sensitif
https://www.googleapis.com/auth/meetings.space.readonly Mengizinkan aplikasi membaca metadata tentang ruang rapat yang dapat diakses pengguna.
Sensitif

Kolom Penggunaan dalam tabel sebelumnya menunjukkan sensitivitas setiap cakupan, sesuai dengan definisi berikut:

  • Tidak sensitif: Cakupan ini memberikan akses otorisasi dengan cakupan terkecil dan hanya memerlukan verifikasi aplikasi dasar. Untuk mengetahui informasi tentang persyaratan ini, lihat Persyaratan verifikasi.

  • Sensitif: Cakupan ini memberikan akses ke Data Pengguna Google tertentu yang diizinkan oleh pengguna untuk aplikasi Anda. Anda harus menjalani verifikasi aplikasi tambahan. Untuk mengetahui informasi tentang persyaratan ini, lihat Persyaratan Cakupan Sensitif dan Terlarang.

  • Dibatasi: Cakupan ini memberikan akses luas ke Data Pengguna Google dan mengharuskan Anda menjalani proses verifikasi cakupan yang dibatasi. Untuk informasi tentang persyaratan ini, lihat Layanan Google API: Kebijakan Data Pengguna dan Persyaratan Tambahan untuk Cakupan API Tertentu. Jika Anda menyimpan data cakupan terbatas di server (atau mengirimkan), Anda harus menjalani penilaian keamanan.

Jika aplikasi Anda memerlukan akses ke Google API lainnya, Anda juga dapat menambahkan cakupan tersebut. Untuk mengetahui informasi selengkapnya tentang cakupan Google API, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.

Untuk mengetahui informasi selengkapnya tentang cakupan OAuth 2.0 tertentu, lihat Cakupan OAuth 2.0 untuk Google API.

Verifikasi OAuth

Penggunaan cakupan OAuth tertentu mungkin mengharuskan aplikasi Anda melanjutkan proses melalui Pusat Bantuan Verifikasi Aplikasi OAuth. Baca FAQ aplikasi OAuth untuk menentukan kapan aplikasi Anda harus melalui verifikasi dan jenis verifikasi yang diperlukan. Lihat juga Persyaratan Layanan Google Drive.

Jenis autentikasi yang diperlukan

Bagian ini menjelaskan jenis autentikasi yang diperlukan atau didukung, dan menyediakan cakupan yang didukung untuk setiap metode Google Workspace Events API.

Untuk langganan ke peristiwa Google Chat, Google Workspace Events API mendukung autentikasi pengguna dan aplikasi untuk memanggil beberapa metodenya. Jika metode API mendukung kedua kredensial, jenis kredensial yang digunakan dalam panggilan akan memengaruhi hasil yang ditampilkan. Misalnya, jika Anda memanggil metode subscriptions.list dengan autentikasi pengguna, API akan menampilkan daftar langganan yang dapat diakses oleh pengguna terautentikasi. Jika Anda menggunakan autentikasi aplikasi, API akan menampilkan daftar langganan yang dapat diakses oleh aplikasi. Untuk mempelajari lebih lanjut jenis autentikasi Chat, lihat Mengautentikasi serta mengizinkan aplikasi Chat dan permintaan API Google Chat.

Tabel berikut menampilkan cakupan dan jenis autentikasi yang diperlukan atau didukung untuk setiap metode Google Workspace Events API:

Metode Autentikasi pengguna diperlukan atau didukung Autentikasi aplikasi didukung (khusus aplikasi Google Chat) Cakupan otorisasi yang didukung
Membuat langganan —

Memerlukan cakupan yang didukung untuk setiap jenis peristiwa:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly
Mendapatkan langganan Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.

Dengan autentikasi aplikasi (khusus aplikasi Google Chat):

  • chat.bot
Mencantumkan langganan Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.

Dengan autentikasi aplikasi (khusus aplikasi Google Chat):

  • chat.bot
Memperbarui langganan —

Memerlukan cakupan yang didukung untuk setiap jenis peristiwa:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly
Mengaktifkan kembali langganan —

Memerlukan cakupan yang didukung untuk setiap jenis peristiwa:

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly
Menghapus langganan Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.

Dengan autentikasi aplikasi (khusus aplikasi Google Chat):

  • chat.bot

Cakupan menurut jenis peristiwa

Saat memanggil Google Workspace Events API menggunakan autentikasi pengguna, Anda harus menentukan satu atau beberapa cakupan yang sesuai dengan jenis peristiwa langganan.

Tabel berikut menampilkan cakupan otorisasi yang didukung untuk setiap jenis peristiwa:

Peristiwa Jenis acara Cakupan otorisasi yang didukung
Google Chat  
Pesan diposting atau diperbarui.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
Reaksi ditambahkan atau dihapus, atau beberapa reaksi diubah.
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
Langganan dibuat, diperbarui, atau dihapus, atau beberapa langganan diubah.
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
Ruang diperbarui atau dihapus.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Drive  
File dibuat, diubah, dipindahkan, dihapus, dimasukkan ke sampah, atau dihapus dari sampah.
  • google.workspace.drive.file.v3.added
  • google.workspace.drive.file.v3.moved
  • google.workspace.drive.file.v3.contentChanged
  • google.workspace.drive.file.v3.deleted
  • google.workspace.drive.file.v3.trashed
  • google.workspace.drive.file.v3.untrashed
  • drive
  • drive.file
  • drive.metadata
Proposal Akses dibuat atau diselesaikan pada file.
  • google.workspace.drive.accessProposal.v3.created
  • google.workspace.drive.accessProposal.v3.resolved
  • drive
  • drive.file
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Google Meet  
Konferensi dimulai atau berakhir.
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
Peserta bergabung atau keluar dari konferensi.
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
Rekaman dibuat.
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
Transkrip telah dibuat.
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly