Dokumen ini berisi informasi autentikasi dan otorisasi khusus Google Workspace Events API. Sebelum membaca dokumen ini, pastikan Anda membaca informasi autentikasi umum dan otorisasi Google Workspace di artikel Mempelajari autentikasi dan otorisasi.
Mengonfigurasi OAuth 2.0 untuk otorisasi
Konfigurasikan layar izin OAuth dan pilih cakupan untuk menentukan informasi yang ditampilkan kepada pengguna dan peninjau aplikasi, serta daftarkan 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 diaksesnya, dan tingkat akses. Cakupan adalah permintaan aplikasi Anda untuk menangani data Google Workspace, termasuk data Akun Google pengguna.
Saat aplikasi Anda diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih cakupan yang paling difokuskan dan menghindari permintaan cakupan yang tidak diperlukan aplikasi. Pengguna dapat lebih mudah memberikan akses ke cakupan yang terbatas dan dijelaskan dengan jelas.
Jika memungkinkan, sebaiknya gunakan cakupan yang tidak sensitif karena akan memberikan cakupan akses per file dan mempersempit akses ke fungsi tertentu yang dibutuhkan 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 tidak perlu menambahkan cakupan lain 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. 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 |
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 |
||
https://www.googleapis.com/auth/chat.messages.reaction dtk |
Melihat, menambahkan, dan menghapus reaksi terhadap pesan di Chat. | Dibatasi |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Melihat reaksi terhadap pesan dalam 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 |
Izinkan aplikasi membaca metadata tentang ruang rapat apa pun yang dapat diakses pengguna. | Sensitif |
||
Kolom Usage pada 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 menyiapkan verifikasi.
Sensitif—Cakupan ini memberikan akses ke Data Pengguna Google tertentu yang diizinkan oleh pengguna untuk aplikasi Anda. Cakupan ini mengharuskan Anda melakukan verifikasi aplikasi tambahan. Untuk mengetahui informasi tentang persyaratan ini, lihat 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 yang dibatasi di server (atau mentransmisikan), Anda harus melalui 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 proses verifikasi OAuth Google. Baca FAQ verifikasi OAuth API untuk menentukan kapan aplikasi Anda harus menjalani verifikasi dan jenis verifikasi apa 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 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 dan mengizinkan aplikasi Chat dan permintaan Google Chat API.
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:
|
||
| Mendapatkan langganan |
Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.
Dengan autentikasi aplikasi (khusus aplikasi Google Chat):
|
|||
| Daftar 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.
Tabel berikut menampilkan cakupan otorisasi yang didukung untuk setiap jenis peristiwa:
| Peristiwa | Jenis peristiwa | Cakupan otorisasi yang didukung | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Pesan diposting atau diperbarui. |
|
|
||||||
| Reaksi ditambahkan atau dihapus, atau beberapa reaksi diubah. |
|
|
||||||
| Keanggotaan dibuat, diperbarui, atau dihapus, atau beberapa keanggotaan diubah. |
|
|
||||||
| Ruang diperbarui atau dihapus. |
|
|
||||||
| Google Meet | ||||||||
| Konferensi dimulai atau diakhiri. |
|
|
||||||
| Peserta bergabung atau keluar dari konferensi. |
|
|
||||||
| Rekaman telah dibuat. |
|
|
||||||
| transcript telah dibuat. |
|
|
||||||