Pilih cakupan Google Workspace Events API

Dokumen ini berisi informasi autentikasi dan otorisasi khusus Google Workspace Events API. Sebelum membaca dokumen ini, pastikan Anda membaca informasi autentikasi dan otorisasi umum Google Workspace di Pelajari 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 agar Anda dapat memublikasikannya nanti.

Cakupan Google Workspace Events API

Untuk menentukan tingkat akses yang diberikan ke aplikasi, 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 diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih cakupan yang paling sempit dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lebih mudah memberikan akses ke cakupan terbatas yang dijelaskan dengan jelas.

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

Jika aplikasi publik Anda menggunakan cakupan yang mengizinkan akses ke data pengguna tertentu, aplikasi tersebut harus menyelesaikan proses verifikasi. Jika Anda melihat aplikasi yang belum diverifikasi di layar saat menguji aplikasi, Anda harus mengirimkan permintaan verifikasi untuk menghapusnya. Cari tahu lebih lanjut tentang aplikasi yang belum diverifikasi dan dapatkan jawaban atas pertanyaan umum tentang verifikasi aplikasi di Pusat Bantuan.

Google Workspace Events API menggunakan cakupan dari aplikasi Google Workspace yang mendukung langganan. Jika aplikasi Anda sudah menggunakan cakupan yang diperlukan untuk langganan, 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	Memungkinkan aplikasi Google Chat melihat chat dan mengirim pesan. Memberikan akses ke semua fitur yang tersedia untuk aplikasi Chat. Catatan: Cakupan chat.bot: Hanya mendukung autentikasi aplikasi. Anda tidak dapat mengautentikasi kredensial pengguna menggunakan cakupan ini. Tidak mendukung delegasi tingkat domain.	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 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 cakupan akses otorisasi terkecil dan hanya memerlukan verifikasi aplikasi dasar. Untuk mengetahui informasi tentang persyaratan ini, lihat Langkah-langkah untuk mempersiapkan verifikasi.

• Sensitif—Cakupan ini memberikan akses ke Data Pengguna Google tertentu yang diotorisasi oleh pengguna untuk aplikasi Anda. Anda harus melalui verifikasi aplikasi tambahan. Untuk informasi tentang persyaratan ini, lihat Langkah-langkah untuk aplikasi yang meminta cakupan sensitif

• Dibatasi—Cakupan ini memberikan akses luas ke Data Pengguna Google dan mengharuskan Anda melalui proses verifikasi cakupan yang dibatasi. Untuk mengetahui 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 mengirimkannya), Anda harus melakukan penilaian keamanan.

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

Untuk 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 melalui proses verifikasi OAuth Google. Baca FAQ verifikasi OAuth API untuk menentukan kapan aplikasi Anda harus melalui verifikasi dan jenis verifikasi yang diperlukan. Lihat juga Persyaratan Layanan Tambahan Google Drive.

Jenis autentikasi yang diperlukan

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

Untuk langganan acara 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 meetings.space.created meetings.space.readonly
Mendapatkan langganan			Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung minimal 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 minimal 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 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 meetings.space.created meetings.space.readonly
Menghapus langganan			Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung minimal 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 peristiwa	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
Keanggotaan dibuat, diperbarui, atau dihapus, atau beberapa keanggotaan 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 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
Perekaman telah 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

Topik terkait

• Ringkasan autentikasi untuk Google Chat
• Ringkasan autentikasi untuk Google Meet