Dokumen ini berisi otorisasi khusus Google Workspace Events API dan informasi autentikasi. Sebelum membaca dokumen ini, pastikan Anda membaca Informasi autentikasi umum dan otorisasi Google Workspace di Pelajari autentikasi dan otorisasi.
Mengonfigurasi OAuth 2.0 untuk otorisasi
Mengonfigurasi layar izin OAuth dan memilih cakupan untuk menentukan informasi yang akan ditampilkan kepada pengguna dan peninjau aplikasi, dan mendaftarkan aplikasi Anda sehingga 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 level akses. Cakupan adalah permintaan aplikasi Anda untuk bekerja dengan data Google Workspace, termasuk pengguna data Akun Google.
Saat aplikasi Anda diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih ruang lingkup dengan fokus yang paling sempit mungkin dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lainnya langsung memberikan akses ke cakupan yang terbatas dan dijelaskan dengan jelas.
Jika memungkinkan, sebaiknya gunakan cakupan yang tidak sensitif karena cakupan tersebut memberikan per file mengakses ruang lingkup dan mempersempit akses ke fungsionalitas tertentu yang dibutuhkan oleh aplikasi.
Google Workspace Events API menggunakan cakupan dari Google Workspace aplikasi yang mendukung langganan. Jika aplikasi Anda sudah menggunakan cakupan tersebut yang diperlukan untuk langganan, Anda tidak perlu menambahkan cakupan 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 chat dan mengirim pesan. Memberi 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 terhadap 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 |
Izinkan 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 apa pun yang dapat diakses pengguna. | Sensitif |
||
Kolom {i> Usage<i} di tabel sebelumnya menunjukkan sensitivitas setiap ruang lingkup, menurut definisi berikut:
Tidak sensitif—Cakupan ini memberikan cakupan terkecil dari akses otorisasi dan hanya membutuhkan verifikasi aplikasi dasar. Sebagai informasi tentang persyaratan ini, lihat Langkah-langkah yang harus dipersiapkan untuk verifikasi.
Sensitif—Cakupan ini memberikan akses ke Data Pengguna Google tertentu yang diotorisasi oleh pengguna untuk aplikasi Anda. Ini mengharuskan Anda untuk melalui verifikasi aplikasi tambahan. Untuk informasi tentang persyaratan ini, lihat Langkah-langkah untuk aplikasi yang meminta informasi cakupan
Dibatasi—Cakupan ini memberikan akses luas ke Data Pengguna Google dan mengharuskan Anda melalui proses verifikasi cakupan yang dibatasi. Sebagai informasi tentang persyaratan ini, lihat Layanan Google API: Data Pengguna Kebijakan dan Persyaratan Tambahan untuk API Tertentu Cakupan. Jika Anda menyimpan data cakupan terbatas di server (atau mentransmisikan), Anda harus melakukan penilaian keamanan.
Jika aplikasi Anda memerlukan akses ke Google API lainnya, Anda dapat menambahkan cakupan tersebut juga. Untuk informasi selengkapnya tentang cakupan Google API, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.
Untuk informasi selengkapnya tentang cakupan OAuth 2.0 spesifik, lihat Cakupan OAuth 2.0 untuk Google API.
Verifikasi OAuth
Penggunaan cakupan OAuth tertentu mungkin mengharuskan aplikasi Anda melalui Verifikasi OAuth {i>checkout<i}. Baca verifikasi OAuth API FAQ untuk menentukan kapan aplikasi Anda harus menjalani verifikasi dan jenis verifikasi diperlukan. Lihat juga Persyaratan Tambahan Google Drive Layanan.
Jenis autentikasi yang diperlukan
Bagian ini menjelaskan jenis otentikasi yang diperlukan atau didukung, serta menyediakan cakupan yang didukung untuk setiap metode Google Workspace Events API.
Untuk langganan peristiwa Google Chat, Google Workspace Events API
mendukung autentikasi pengguna dan aplikasi untuk memanggil beberapa metodenya. Jika API
mendukung kedua kredensial, yaitu jenis kredensial yang digunakan dalam panggilan
memengaruhi hasil yang ditampilkan. Misalnya, jika Anda memanggil
subscriptions.list()
dengan autentikasi pengguna, API akan mengembalikan daftar langganan yang
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 tentang
jenis autentikasi Chat, lihat Mengautentikasi dan memberi otorisasi
Aplikasi Chat dan Google Chat API
permintaan.
Tabel berikut menampilkan cakupan dan jenis autentikasi diperlukan atau didukung untuk setiap Google Workspace Events API berikut:
| Metode | Perlu atau didukung autentikasi pengguna | Autentikasi aplikasi didukung (khusus aplikasi Google Chat) | Cakupan otorisasi yang didukung | |
|---|---|---|---|---|
| Membuat langganan | — |
Memerlukan cakupan yang didukung untuk setiap jenis peristiwa:
|
||
| Mendapatkan langganan |
Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.
Dengan autentikasi aplikasi (khusus aplikasi Google Chat):
|
|||
| Mencantumkan langganan |
Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.
Dengan autentikasi aplikasi (khusus aplikasi Google Chat):
|
|||
| Memperbarui langganan | — |
Memerlukan cakupan yang didukung untuk setiap jenis peristiwa:
|
||
| Mengaktifkan kembali langganan | — |
Memerlukan cakupan yang didukung untuk setiap jenis peristiwa:
|
||
| Menghapus langganan |
Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.
Dengan autentikasi aplikasi (khusus aplikasi Google Chat):
|
|||
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 Anda.
Tabel berikut menampilkan cakupan otorisasi mana yang didukung untuk masing-masing cakupan jenis peristiwa:
| Peristiwa | Jenis acara | Cakupan otorisasi yang didukung | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Pesan akan diposting atau diperbarui. |
|
|
||||||
| Reaksi ditambahkan atau dihapus, atau beberapa reaksi diubah. |
|
|
||||||
| Langganan dibuat, diperbarui, atau dihapus, atau beberapa keanggotaan diubah. |
|
|
||||||
| Ruang diperbarui atau dihapus. |
|
|
||||||
| Google Meet | ||||||||
| Konferensi dimulai atau berakhir. |
|
|
||||||
| Peserta bergabung atau keluar dari konferensi. |
|
|
||||||
| Rekaman dibuat. |
|
|
||||||
| Transkrip telah dibuat. |
|
|
||||||