Pilih cakupan Google Workspace Events API

Dokumen ini berisi informasi otorisasi dan autentikasi khusus Google Workspace Events API. Sebelum membaca dokumen ini, pastikan untuk membaca informasi autentikasi dan otorisasi umum Google Workspace di Pelajari 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 Anda agar 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 Anda 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 yang terbatas dan dijelaskan dengan jelas.

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 untuk menggunakan Google Workspace Events API. Jika Anda menambahkan cakupan, pilih cakupan yang paling tidak sensitif yang masih memungkinkan aplikasi Anda berfungsi. Untuk mengetahui detail tentang kategori cakupan, lihat Kategori cakupan.

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

Kode cakupan Deskripsi Penggunaan
Google Chat  
https://www.googleapis.com/auth/chat.bot Memungkinkan aplikasi 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 Chat.
Sensitif
https://www.googleapis.com/auth/chat.memberships.readonly Melihat anggota di percakapan Chat.
Sensitif
https://www.googleapis.com/auth/chat.app.memberships

Melihat, menambahkan, memperbarui, dan menghapus anggota dari percakapan dan ruang di Chat sebagai aplikasi Chat.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.


Sensitif
https://www.googleapis.com/auth/chat.app.memberships.readonly

Melihat anggota dari percakapan dan ruang di Google Chat sebagai aplikasi Chat.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.


Sensitif
https://www.googleapis.com/auth/chat.spaces Membuat percakapan dan ruang serta melihat atau memperbarui metadata (termasuk setelan histori) di Chat. Sensitif
https://www.googleapis.com/auth/chat.spaces.readonly Melihat chat dan ruang di Chat.
Sensitif
https://www.googleapis.com/auth/chat.app.spaces

Membuat percakapan dan ruang serta melihat atau memperbarui metadata (termasuk setelan histori) di Chat sebagai aplikasi Chat.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.


Sensitif
https://www.googleapis.com/auth/chat.app.spaces.readonly

Melihat metadata (termasuk setelan histori) di Google Chat sebagai aplikasi Chat.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.


Sensitif
https://www.googleapis.com/auth/chat.messages.reactions 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 pada pesan. Dibatasi
https://www.googleapis.com/auth/chat.messages.readonly Melihat pesan dan reaksi di Chat.
Dibatasi
https://www.googleapis.com/auth/chat.app.messages.readonly

Melihat pesan dan reaksi di Chat sebagai aplikasi Chat.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.


Dibatasi
https://www.googleapis.com/auth/chat.users.readstate Melihat dan memperbarui status baca pengguna di Chat.
Sensitif
https://www.googleapis.com/auth/chat.users.readstate.readonly Melihat status baca pengguna di Chat.
Sensitif
https://www.googleapis.com/auth/chat.users.availability Melihat dan mengubah status ketersediaan di Chat.
Sensitif
https://www.googleapis.com/auth/chat.users.availability.readonly Melihat status ketersediaan di Chat.
Sensitif
https://www.googleapis.com/auth/chat.app.all.spaces.readonly

Melihat metadata tentang semua ruang dan percakapan di Google Chat di seluruh organisasi Google Workspace Anda, meskipun aplikasi Chat tersebut bukan anggota.

Cakupan ini hanya didukung dengan langganan pelanggan.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.

Dibatasi
https://www.googleapis.com/auth/chat.app.all.memberships.readonly

Melihat semua anggota di ruang dan percakapan Google Chat di seluruh organisasi Google Workspace Anda, meskipun aplikasi Chat tersebut bukan anggota.

Cakupan ini hanya didukung dengan langganan pelanggan.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.

Dibatasi
https://www.googleapis.com/auth/chat.app.all.messages.readonly

Melihat semua pesan dan reaksi di seluruh organisasi Google Workspace Anda, meskipun aplikasi Chat tersebut bukan anggota ruang atau percakapan.

Cakupan ini hanya didukung dengan langganan pelanggan.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.

Dibatasi
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly

Melihat waktu terakhir dibaca untuk semua pengguna di semua ruang dan percakapan di seluruh organisasi Google Workspace Anda, meskipun aplikasi Chat tersebut bukan anggota.

Cakupan ini hanya didukung dengan langganan pelanggan.

Memerlukan persetujuan administrator.

Cakupan ini hanya mendukung autentikasi aplikasi dengan akun layanan. Anda tidak dapat melakukan autentikasi dengan kredensial pengguna atau dengan delegasi seluruh domain menggunakan cakupan ini.

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 berbagai 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 apa pun yang dapat diakses pengguna.
Sensitif

Kolom Penggunaan dalam tabel sebelumnya menunjukkan sensitivitas setiap cakupan:

  • Tidak sensitif: Cakupan ini memberikan cakupan akses otorisasi 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. Cakupan ini mengharuskan Anda menjalani verifikasi aplikasi tambahan. Untuk mengetahui informasi tentang persyaratan ini, lihat Persyaratan Cakupan Sensitif dan Dibatasi.

  • Dibatasi: Cakupan ini memberikan akses luas ke Data Pengguna Google dan mengharuskan Anda menjalani 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 mengirimkannya), 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 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 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 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 ke peristiwa 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 yang diautentikasi. 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 memberi otorisasi aplikasi Chat dan permintaan API 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 Chat) Cakupan otorisasi yang didukung
Membuat langganan —

Dengan autentikasi pengguna, 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
  • chat.users.readstate
  • chat.users.readstate.readonly
  • chat.users.availability
  • chat.users.availability.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

Dengan autentikasi aplikasi dan persetujuan administrator (khusus aplikasi Google Chat), memerlukan cakupan yang didukung untuk setiap jenis peristiwa:

  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.messages.readonly
  • chat.app.all.memberships.readonly
  • chat.app.all.spaces.readonly
  • chat.app.all.messages.readonly
  • chat.app.all.users.readstate.readonly
Mendapatkan langganan Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.

Dengan autentikasi aplikasi (khusus aplikasi 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 Chat):

  • chat.bot
Memperbarui langganan —

Dengan autentikasi pengguna, 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
  • chat.users.readstate
  • chat.users.readstate.readonly
  • chat.users.availability
  • chat.users.availability.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

Dengan autentikasi aplikasi dan persetujuan administrator (khusus aplikasi Google Chat), memerlukan cakupan yang didukung untuk setiap jenis peristiwa:

  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.messages.readonly
  • chat.app.all.memberships.readonly
  • chat.app.all.spaces.readonly
  • chat.app.all.messages.readonly
  • chat.app.all.users.readstate.readonly
Mengaktifkan kembali langganan —

Dengan autentikasi pengguna, 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
  • chat.users.readstate
  • chat.users.readstate.readonly
  • chat.users.availability
  • chat.users.availability.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

Dengan autentikasi aplikasi dan persetujuan administrator (khusus aplikasi Chat), memerlukan cakupan yang didukung untuk setiap jenis peristiwa:

  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.messages.readonly
  • chat.app.all.memberships.readonly
  • chat.app.all.spaces.readonly
  • chat.app.all.messages.readonly
  • chat.app.all.users.readstate.readonly
Menghapus langganan Dengan autentikasi pengguna, metode ini memerlukan cakupan yang mendukung setidaknya satu jenis peristiwa untuk langganan.

Dengan autentikasi aplikasi (khusus aplikasi 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
Chat  
Pesan diposting atau diperbarui.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
Dengan Autentikasi pengguna:
  • chat.messages
  • chat.messages.readonly
Dengan Autentikasi aplikasi dan persetujuan administrator:
  • chat.app.messages.readonly
  • chat.app.all.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
Dengan Autentikasi pengguna:
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
Dengan Autentikasi aplikasi dan persetujuan administrator:
  • chat.app.messages.readonly
  • chat.app.all.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
Dengan Autentikasi pengguna:
  • chat.memberships
  • chat.memberships.readonly
Dengan Autentikasi aplikasi dan persetujuan administrator:
  • chat.app.memberships
  • chat.app.memberships.readonly
  • chat.app.all.memberships.readonly
Ruang diperbarui atau dihapus.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
Dengan Autentikasi pengguna:
  • chat.spaces
  • chat.spaces.readonly
Dengan Autentikasi aplikasi dan persetujuan administrator:
  • chat.app.spaces
  • chat.app.spaces.readonly
  • chat.app.all.spaces.readonly
Status baca ruang atau status baca rangkaian pesan pengguna diperbarui.
  • google.workspace.chat.spaceReadState.v1.updated
  • google.workspace.chat.threadReadState.v1.updated
  • google.workspace.chat.spaceReadState.v1.batchUpdated
  • google.workspace.chat.threadReadState.v1.batchUpdated
Dengan Autentikasi pengguna:
  • chat.users.readstate
  • chat.users.readstate.readonly
Dengan Autentikasi aplikasi dan persetujuan administrator:
  • chat.app.all.users.readstate.readonly
Ketersediaan diperbarui.
  • google.workspace.chat.availability.v1.updated
Dengan Autentikasi pengguna:
  • chat.users.availability
  • chat.users.availability.readonly
Drive  
File dibuat, diubah, dipindahkan, dihapus, diganti namanya, dipindahkan 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.renamed
  • google.workspace.drive.file.v3.trashed
  • google.workspace.drive.file.v3.untrashed
  • drive
  • drive.file
  • drive.readonly
  • 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.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Persetujuan dibatalkan, diselesaikan, dibuat, direset, peninjau diubah, atau peninjau merespons file.
  • google.workspace.drive.approval.v3.cancelled
  • google.workspace.drive.approval.v3.completed
  • google.workspace.drive.approval.v3.created
  • google.workspace.drive.approval.v3.reset
  • google.workspace.drive.approval.v3.reviewersChanged
  • google.workspace.drive.approval.v3.reviewerResponded
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Komentar dibuat, dihapus, diedit, dibuka kembali, atau diselesaikan pada file.
  • google.workspace.drive.comment.v3.created
  • google.workspace.drive.comment.v3.deleted
  • google.workspace.drive.comment.v3.edited
  • google.workspace.drive.comment.v3.reopened
  • google.workspace.drive.comment.v3.resolved
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Balasan dibuat, dihapus, atau diedit pada file.
  • google.workspace.drive.reply.v3.created
  • google.workspace.drive.reply.v3.deleted
  • google.workspace.drive.reply.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
Izin dibuat, dihapus, atau diedit pada file.
  • google.workspace.drive.permission.v3.created
  • google.workspace.drive.permission.v3.deleted
  • google.workspace.drive.permission.v3.edited
  • drive
  • drive.file
  • drive.readonly
  • drive.metadata
  • drive.metadata
  • drive.metadata.readonly
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 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