Setiap file, folder, dan drive bersama Google Drive memiliki resource
permissions
terkait. Setiap resource
mengidentifikasi izin untuk type
tertentu (user
, group
, domain
,
anyone
) dan role
(owner
, organizer
, fileOrganizer
, writer
,
commenter
, reader
). Misalnya, file mungkin memiliki izin yang memberikan
akses hanya baca (role=reader
) kepada pengguna tertentu (type=user
), sedangkan izin
lainnya memberikan kemampuan kepada anggota grup tertentu (type=group
) untuk menambahkan
komentar ke file (role=commenter
).
Untuk mengetahui daftar lengkap peran dan operasi yang diizinkan oleh masing-masing, lihat Peran dan izin.
Skenario untuk berbagi resource Drive
Ada lima jenis skenario berbagi yang berbeda:
Untuk membagikan file di Drive Saya, pengguna harus memiliki
role=writer
ataurole=owner
.Jika nilai boolean
writersCanShare
ditetapkan kefalse
untuk file, pengguna harus memilikirole=owner
.Jika pengguna dengan
role=writer
memiliki akses sementara yang diatur oleh tanggal dan waktu habis masa berlaku, mereka tidak dapat membagikan file. Untuk mengetahui informasi selengkapnya, lihat Menetapkan tanggal habis masa berlaku untuk membatasi akses file.
Untuk membagikan folder di Drive Saya, pengguna harus memiliki
role=writer
ataurole=owner
.Jika nilai boolean
writersCanShare
ditetapkan kefalse
untuk file, pengguna harus memilikirole=owner
yang lebih permisif.Akses sementara (diatur oleh tanggal dan waktu habis masa berlaku) tidak diizinkan di folder Drive Saya dengan
role=writer
. Untuk mengetahui informasi selengkapnya, lihat Menetapkan tanggal habis masa berlaku untuk membatasi akses file.
Untuk membagikan file di drive bersama, pengguna harus memiliki
role=writer
,role=fileOrganizer
, ataurole=organizer
.- Setelan
writersCanShare
tidak berlaku untuk item di drive bersama. Opsi ini diperlakukan seolah-olah selalu ditetapkan ketrue
.
- Setelan
Untuk membagikan folder di drive bersama, pengguna harus memiliki
role=organizer
.- Jika batasan
sharingFoldersRequiresOrganizerPermission
di drive bersama ditetapkan kefalse
, pengguna denganrole=fileOrganizer
dapat berbagi folder di drive bersama tersebut.
- Jika batasan
Untuk mengelola keanggotaan drive bersama, pengguna harus memiliki
role=organizer
. Hanya pengguna dan grup yang dapat menjadi anggota drive bersama.
Menetapkan tanggal habis masa berlaku untuk membatasi akses file
Saat bekerja sama dengan orang lain dalam project sensitif, Anda mungkin ingin membatasi akses mereka ke file tertentu di Drive setelah jangka waktu tertentu. Untuk file di Drive Saya, Anda dapat menetapkan tanggal habis masa berlaku untuk membatasi atau menghapus akses ke file tersebut.
Untuk menetapkan tanggal habis masa berlaku:
Gunakan metode
create()
di resourcepermissions
dan tetapkan kolomexpirationTime
(beserta kolom lain yang diperlukan). Untuk mengetahui informasi selengkapnya, lihat Membuat izin.Gunakan metode
update()
pada resourcepermissions
dan tetapkan kolomexpirationTime
(beserta kolom lain yang diperlukan). Untuk mengetahui informasi selengkapnya, lihat Mengubah izin.
Kolom expirationTime
menunjukkan kapan masa berlaku izin berakhir menggunakan waktu-tanggal
RFC 3339. Waktu habis masa berlaku memiliki
batasan berikut:
- Izin ini hanya dapat ditetapkan pada izin pengguna dan grup.
- Waktu harus di masa mendatang.
- Waktu tidak boleh lebih dari satu tahun ke depan.
Untuk mengetahui informasi selengkapnya tentang tanggal habis masa berlaku, lihat artikel berikut:
Penerusan izin
Daftar izin untuk folder diterapkan ke bawah, dan semua file dan folder turunan mewarisi izin dari induk. Setiap kali izin atau hierarki diubah, penyebaran terjadi secara rekursif melalui semua folder bertingkat. Misalnya, jika file ada dalam folder dan folder tersebut kemudian dipindahkan dalam folder lain, izin di folder baru akan diterapkan ke file. Jika folder baru memberikan peran baru kepada pengguna file, seperti "penulis", peran tersebut akan menggantikan peran lama mereka.
Sebaliknya, jika file mewarisi role=writer
dari folder, dan dipindahkan ke
folder lain yang menyediakan peran "pembaca", file tersebut kini mewarisi
role=reader
.
Izin yang diwariskan tidak dapat dihapus dari file atau folder di drive bersama. Sebagai gantinya, izin ini harus disesuaikan di induk langsung atau tidak langsung tempat izin tersebut diwarisi. Izin yang diwarisi dapat dihapus dari item di bagian "Drive Saya" atau "Dibagikan kepada saya".
Sebaliknya, izin yang diwarisi dapat diganti pada file atau folder di Drive
Saya. Jadi, jika file mewarisi role=writer
dari folder
My Drive, Anda dapat menetapkan role=reader
pada file untuk menurunkan
tingkat izinnya.
Kemampuan
Resource permissions
pada akhirnya tidak menentukan kemampuan pengguna saat ini untuk melakukan tindakan pada file atau folder. Sebagai gantinya, resource files
berisi
kumpulan kolom capabilities
boolean yang digunakan untuk menunjukkan apakah tindakan
dapat dilakukan pada file atau folder. Google Drive API menetapkan kolom ini berdasarkan
resource izin pengguna saat ini yang terkait dengan file atau folder.
Misalnya, saat Alex login ke aplikasi Anda dan mencoba membagikan file, peran Alex
akan diperiksa untuk mengetahui izin pada file. Jika peran mengizinkan mereka membagikan file,
capabilities
yang terkait dengan file, seperti canShare
, akan diisi
secara relatif terhadap peran. Jika Alex ingin membagikan file, aplikasi Anda akan memeriksa
capabilities
untuk memastikan canShare
disetel ke true
.
Untuk contoh pengambilan file capabilities
, lihat Memverifikasi izin
pengguna.
Membuat izin
Dua kolom berikut diperlukan saat membuat izin:
type
:type
mengidentifikasi cakupan izin (user
,group
,domain
, atauanyone
). Izin dengantype=user
berlaku untuk pengguna tertentu, sedangkan izin dengantype=domain
berlaku untuk semua orang di domain tertentu.role
: Kolomrole
mengidentifikasi operasi yang dapat dilakukantype
. Misalnya, izin dengantype=user
danrole=reader
memberikan akses hanya baca kepada pengguna tertentu ke file atau folder. Atau, izin dengantype=domain
danrole=commenter
memungkinkan semua orang di domain menambahkan komentar ke file. Untuk mengetahui daftar lengkap peran dan operasi yang diizinkan oleh masing-masing, lihat Peran dan izin.
Saat membuat izin dengan type=user
atau type=group
, Anda juga harus
memberikan emailAddress
untuk mengaitkan
pengguna atau grup tertentu ke izin.
Saat membuat izin dengan type=domain
, Anda juga harus memberikan
domain
untuk mengaitkan domain tertentu ke
izin.
Untuk membuat izin:
- Gunakan metode
create()
dengan parameter jalurfileId
untuk file atau folder terkait. - Dalam isi permintaan, tentukan
type
danrole
. - Jika
type=user
atautype=group
, berikanemailAddress
. Jikatype=domain
, berikandomain
.
Tampilkan contoh
Contoh kode berikut menunjukkan cara membuat izin. Respons menampilkan instance resource Permission
, termasuk permissionId
yang ditetapkan.
Permintaan
POST https://www.googleapis.com/drive/v3/files/FILE_ID
/permissions
{ "requests": [ { "type": "user", "role": "commenter", "emailAddress": "alex@altostrat.com" } ] }
Respons
{
"kind": "drive#permission",
"id": "PERMISSION_ID
",
"type": "user",
"role": "commenter"
}
Menggunakan audiens target
Audiens target adalah sekelompok orang—seperti departemen atau tim—yang dapat Anda rekomendasikan kepada pengguna untuk diajak berbagi item. Anda dapat mendorong pengguna untuk berbagi item dengan audiens yang lebih spesifik atau terbatas, bukan seluruh organisasi Anda. Audiens target dapat membantu Anda meningkatkan keamanan dan privasi data, serta memudahkan pengguna untuk berbagi dengan tepat. Untuk mengetahui informasi selengkapnya, lihat Tentang audiens target.
Untuk menggunakan audiens target:
Di konsol Google Admin, buka Menu > Direktori > Target audiens.
Anda harus login menggunakan akun dengan hak istimewa administrator super untuk tugas ini.
Di Daftar target audiens, klik nama target audiens. Untuk membuat audiens target, lihat Membuat audiens target
Salin ID unik dari URL target audiens:
https://admin.google.com/ac/targetaudiences/ID
.Buat izin dengan
type=domain
, dan tetapkan kolomdomain
keID.audience.googledomains.com
.
Untuk melihat cara pengguna berinteraksi dengan target audiens, lihat Pengalaman pengguna untuk berbagi link.
Mengambil semua izin untuk file, folder, atau drive bersama
Gunakan metode list()
pada resource permissions
untuk mengambil semua izin untuk file, folder, atau drive bersama.
Tampilkan contoh
Contoh kode berikut menunjukkan cara mendapatkan semua izin. Respons akan menampilkan daftar izin.
Permintaan
GET https://www.googleapis.com/drive/v3/files/FILE_ID
/permissions
Respons
{
"kind": "drive#permissionList",
"permissions": [
{
"id": "PERMISSION_ID
",
"type": "user",
"kind": "drive#permission",
"role": "commenter"
}
]
}
Memverifikasi izin pengguna
Saat membuka file, aplikasi Anda harus memeriksa kemampuan file dan merender
UI untuk mencerminkan izin pengguna saat ini. Misalnya, jika pengguna
tidak memiliki kemampuan canComment
pada file, kemampuan untuk memberikan komentar
harus dinonaktifkan di UI.
Untuk mengetahui informasi selengkapnya tentang capabilities
, lihat bagian
Kemampuan.
Untuk memeriksa kemampuan, panggil metode get()
di resource files
dengan parameter jalur fileId
dan parameter fields
yang ditetapkan ke kolom capabilities
. Untuk
mengetahui informasi lebih lanjut tentang cara menampilkan kolom menggunakan parameter fields
, lihat
Menampilkan kolom tertentu untuk file.
Tampilkan contoh
Contoh kode berikut menunjukkan cara memverifikasi izin pengguna. Respons akan menampilkan daftar kemampuan yang dimiliki pengguna pada file. Setiap kemampuan sesuai dengan tindakan terperinci yang dapat dilakukan pengguna. Beberapa kolom hanya diisi untuk item di drive bersama.
Permintaan
GET https://www.googleapis.com/drive/v3/files/FILE_ID
?fields=capabilities
Respons
{ "capabilities": { "canAcceptOwnership": false, "canAddChildren": false, "canAddMyDriveParent": false, "canChangeCopyRequiresWriterPermission": true, "canChangeSecurityUpdateEnabled": false, "canComment": true, "canCopy": true, "canDelete": true, "canDownload": true, "canEdit": true, "canListChildren": false, "canModifyContent": true, "canModifyContentRestriction": true, "canModifyLabels": true, "canMoveChildrenWithinDrive": false, "canMoveItemOutOfDrive": true, "canMoveItemWithinDrive": true, "canReadLabels": true, "canReadRevisions": true, "canRemoveChildren": false, "canRemoveMyDriveParent": true, "canRename": true, "canShare": true, "canTrash": true, "canUntrash": true } }
Menentukan sumber peran untuk file dan folder drive bersama
Untuk mengubah peran pada file atau folder, Anda harus mengetahui sumber peran tersebut. Untuk drive bersama, sumber peran dapat didasarkan pada keanggotaan ke drive bersama, peran di folder, atau peran di file.
Untuk menentukan sumber peran untuk drive bersama, atau item dalam drive tersebut, panggil metode get()
pada resource permissions
dengan parameter jalur fileId
dan permissionId
, serta parameter fields
yang ditetapkan ke kolom permissionDetails
.
Untuk menemukan permissionId
, gunakan metode
list()
pada resource permissions
dengan parameter jalur fileId
. Untuk mengambil kolom permissionDetails
pada permintaan list
, tetapkan parameter fields
ke
permissions/permissionDetails
.
Kolom ini mencantumkan semua izin file langsung dan yang diwarisi untuk pengguna, grup, atau domain.
Tampilkan contoh
Contoh kode berikut menunjukkan cara menentukan sumber peran. Respons menampilkan permissionDetails
dari resource permissions
. Kolom inheritedFrom
memberikan ID item tempat izin diwarisi.
Permintaan
GET https://www.googleapis.com/drive/v3/files/FILE_ID
/permissions/PERMISSION_ID
?fields=permissionDetails&supportsAllDrives=true
Respons
{
"permissionDetails": [
{
"permissionType": "member",
"role": "commenter",
"inheritedFrom": "INHERITED_FROM_ID
",
"inherited": true
},
{
"permissionType": "file",
"role": "writer",
"inherited": false
}
]
}
Ubah izin
Untuk mengubah izin pada file atau folder, Anda dapat mengubah peran yang ditetapkan:
Panggil metode
update()
pada resourcepermissions
dengan parameter jalurpermissionId
ditetapkan ke izin untuk diubah dan parameter jalurfileId
ditetapkan ke file, folder, atau drive bersama terkait. Untuk menemukanpermissionId
, gunakan metodelist()
pada resourcepermissions
dengan parameter jalurfileId
.Dalam permintaan, identifikasi
role
baru.
Anda dapat memberikan izin pada setiap file atau folder di drive bersama meskipun
pengguna atau grup sudah menjadi anggota. Misalnya, Alex memiliki role=commenter
sebagai bagian dari keanggotaannya ke drive bersama. Namun, aplikasi Anda dapat memberikan Alex
role=writer
untuk file di drive bersama. Dalam hal ini, karena peran baru
lebih permisif daripada peran yang diberikan melalui langganannya, izin
baru menjadi peran efektif untuk file atau folder.
Tampilkan contoh
Contoh kode berikut menunjukkan cara mengubah izin pada file atau folder dari pemberi komentar menjadi penulis. Respons menampilkan instance resource permissions
.
Permintaan
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
/permissions/PERMISSION_ID
{ "requests": [ { "role": "writer" } ] }
Respons
{
"kind": "drive#permission",
"id": "PERMISSION_ID
",
"type": "user",
"role": "writer"
}
Mencantumkan dan menyelesaikan proposal akses yang tertunda
Proposal akses adalah proposal dari pemohon kepada pemberi persetujuan untuk memberikan akses kepada penerima ke item Drive.
Pengajuan dapat meninjau dan menindaklanjuti semua proposal akses yang belum terselesaikan di seluruh file Drive. Artinya, Anda dapat mempercepat proses persetujuan dengan mengkueri proposal akses secara terprogram, lalu me-resolve-nya. Hal ini juga memungkinkan proposal dilihat secara gabungan oleh pemberi persetujuan.
Drive API menyediakan
resource accessproposals
sehingga Anda dapat melihat dan menyelesaikan proposal akses yang tertunda. Metode resource
accessproposals
berfungsi pada file, folder, file dalam drive bersama, tetapi tidak di drive bersama.
Istilah berikut khusus untuk proposal akses:
- Pemohon: Pengguna yang memulai proposal akses ke item Drive.
- Penerima: Pengguna yang menerima izin tambahan pada file jika proposal akses diberikan. Sering kali penerima sama dengan peminta, tetapi tidak selalu.
- Penyetuju: Pengguna yang bertanggung jawab untuk menyetujui (atau menolak) proposal akses. Hal ini biasanya karena mereka adalah pemilik dokumen atau mereka memiliki kemampuan untuk membagikan dokumen.
Mencantumkan proposal akses yang tertunda
Untuk mencantumkan semua proposal akses yang tertunda di item Drive, panggil
metode list()
pada
resource accessproposals
dan sertakan parameter jalur fileId
.
Hanya pemberi persetujuan di file yang dapat mencantumkan proposal yang tertunda di file. Pengajuan
adalah pengguna dengan kemampuan can_approve_access_proposals
pada file. Jika
peminta bukan merupakan pemberi persetujuan, daftar kosong akan ditampilkan. Untuk mengetahui informasi selengkapnya tentang capabilities
, lihat bagian Kemampuan.
Isi
respons
terdiri dari
objek
AccessProposal
yang mewakili daftar proposal akses yang belum terselesaikan pada file.
Objek AccessProposal
menyertakan info tentang setiap proposal seperti
peminta, penerima, dan pesan yang ditambahkan oleh pemohon. Objek ini juga
menyertakan
objek AccessProposalRoleAndView
yang mengelompokkan role
yang diusulkan pemohon dengan view
. Karena role
adalah kolom berulang, beberapa kolom dapat ada untuk setiap proposal. Misalnya, proposal mungkin memiliki objek AccessProposalRoleAndView
dari role=reader
dan
view=published
, ditambah objek AccessProposalRoleAndView
tambahan dengan
hanya nilai role=writer
. Untuk informasi selengkapnya, lihat
Tampilan.
Teruskan parameter kueri berikut untuk menyesuaikan penomoran halaman, atau memfilter, proposal akses:
pageToken
: Token halaman, diterima dari panggilan daftar sebelumnya. Berikan token ini untuk mengambil halaman berikutnya.pageSize
: Jumlah maksimum proposal akses yang akan ditampilkan per halaman.
Menyelesaikan proposal akses yang tertunda
Untuk menyelesaikan semua proposal akses yang tertunda di item Drive, panggil metode resolve()
di resource accessproposals
dan sertakan parameter jalur fileId
dan proposalId
.
Metode resolve()
menyertakan parameter kueri action
yang menunjukkan
tindakan yang akan dilakukan pada proposal. Objek
Action
melacak perubahan status proposal sehingga kita tahu apakah proposal tersebut disetujui
atau ditolak.
Metode resolve()
juga menyertakan parameter kueri opsional role
dan
view
. Satu-satunya peran yang didukung adalah writer
, commenter
, dan reader
. Jika
tidak ditentukan, peran akan ditetapkan secara default ke reader
. Parameter kueri opsional tambahan
send_notification
memungkinkan Anda mengirim notifikasi email kepada
peminta saat proposal diterima atau ditolak.
Sama seperti metode list()
, pengguna yang me-resolve proposal harus memiliki
kemampuan can_approve_access_proposals
pada file. Untuk mengetahui informasi selengkapnya tentang capabilities
, lihat bagian Kemampuan.
Proposal diselesaikan menggunakan pola yang sama yang tercantum di bagian Skenario untuk berbagi resource Drive. Jika ada beberapa proposal untuk pengguna yang sama, tetapi dengan peran yang berbeda, hal berikut berlaku:
- Jika satu proposal diterima dan satu ditolak, peran yang diterima akan berlaku untuk item Drive.
- Jika kedua proposal diterima secara bersamaan, proposal dengan izin yang lebih tinggi (misalnya,
role=writer
versusrole=reader
) akan diterapkan. Proposal akses lainnya akan dihapus dari item.
Setelah mengirimkan proposal ke metode resolve()
, tindakan berbagi
selesai. AccessProposal
tidak lagi ditampilkan melalui metode
list()
. Setelah proposal disetujui, pengguna harus menggunakan kumpulan permissions
untuk memperbarui izin pada file atau folder. Untuk mengetahui informasi selengkapnya, lihat bagian Mengubah
izin.
Mencabut akses ke file atau folder
Untuk mencabut akses ke file atau folder, panggil
metode delete()
pada
resource permissions
dengan
parameter jalur fileId
dan permissionId
yang ditetapkan untuk menghapus izin.
Untuk item di "Drive Saya", Anda dapat menghapus izin yang diwarisi. Menghapus izin yang diwariskan akan mencabut akses ke item dan item turunan, jika ada.
Untuk item di drive bersama, izin yang diwariskan tidak dapat dicabut. Perbarui atau cabut izin pada file atau folder induk.
Metode delete()
juga digunakan untuk menghapus izin yang langsung diterapkan ke
file atau folder drive bersama.
Tampilkan contoh
Contoh kode berikut menunjukkan cara mencabut akses dengan menghapus permissionId
. Jika berhasil, isi respons akan kosong. Untuk mengonfirmasi bahwa izin telah dihapus, gunakan metode list()
pada resource permissions
dengan parameter jalur fileId
.
Permintaan
DELETE https://www.googleapis.com/drive/v3/files/FILE_ID
/permissions/PERMISSION_ID
Mentransfer kepemilikan file ke akun Google Workspace lain di organisasi yang sama
Kepemilikan file yang ada di "Drive Saya" dapat ditransfer dari satu akun Google Workspace ke akun lain di organisasi yang sama. Organisasi yang memiliki drive bersama memiliki file di dalamnya. Oleh karena itu, transfer kepemilikan tidak didukung untuk file dan folder di drive bersama. Penyelenggara drive bersama dapat memindahkan item dari drive bersama tersebut ke "Drive Saya" miliknya sendiri, yang akan mentransfer kepemilikan kepada mereka.
Untuk mentransfer kepemilikan file di "Drive Saya", lakukan salah satu hal berikut:
Buat izin file yang memberikan akses pemilik (
role=owner
) kepada pengguna tertentu (type=user
).Perbarui izin file yang ada dengan
role=owner
dan transfer kepemilikan ke pengguna yang ditentukan (transferOwnership=true
).
Mentransfer kepemilikan file dari satu akun konsumen ke akun konsumen lainnya
Kepemilikan file dapat ditransfer dari satu akun konsumen ke akun konsumen lainnya. Namun, Drive tidak mentransfer kepemilikan file antara dua akun konsumen hingga calon pemilik secara eksplisit menyetujui transfer tersebut. Untuk mentransfer kepemilikan file dari satu akun konsumen ke akun lainnya:
Pemilik saat ini memulai transfer kepemilikan dengan membuat atau memperbarui izin file calon pemilik. Izin harus menyertakan setelan ini:
role=writer
,type=user
, danpendingOwner=true
. Jika pemilik saat ini membuat izin untuk calon pemilik, notifikasi email akan dikirim kepada calon pemilik yang menunjukkan bahwa mereka diminta untuk mengambil alih kepemilikan file.Calon pemilik menerima permintaan transfer kepemilikan dengan membuat atau memperbarui izin file mereka. Izin harus menyertakan setelan ini:
role=owner
dantransferOwnership=true
. Jika calon pemilik membuat izin baru, notifikasi email akan dikirim ke pemilik sebelumnya yang menunjukkan bahwa kepemilikan telah ditransfer.
Saat file ditransfer, peran pemilik sebelumnya akan diturunkan ke writer
.
Mengubah beberapa izin dengan permintaan batch
Sebaiknya gunakan permintaan batch untuk mengubah beberapa izin.
Berikut adalah contoh melakukan perubahan izin batch dengan library klien.
Java
Python
Node.js
PHP
.NET
Topik terkait
- Melindungi konten file
- Mengakses file Drive yang dibagikan dengan link menggunakan kunci resource
- Peran dan izin