Menampilkan aturan dalam daftar kontrol akses untuk kalender. Coba sekarang atau lihat contohnya.
Permintaan
Permintaan HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
Parameter
Nama parameter | Nilai | Deskripsi |
---|---|---|
Parameter jalur | ||
calendarId |
string |
ID kalender. Untuk mengambil ID kalender, panggil metode calendarList.list. Jika Anda ingin mengakses kalender utama pengguna yang saat ini login, gunakan kata kunci "primary ".
|
Parameter kueri opsional | ||
maxResults |
integer |
Jumlah maksimum entri yang ditampilkan di satu halaman hasil. Secara default, nilainya adalah 100 entri. Ukuran halaman tidak boleh lebih besar dari 250 entri. Opsional. |
pageToken |
string |
Token yang menentukan halaman hasil yang akan ditampilkan. Opsional. |
showDeleted |
boolean |
Apakah akan menyertakan ACL yang dihapus dalam hasil. ACL yang dihapus direpresentasikan oleh role yang sama dengan "none ". ACL yang dihapus akan selalu disertakan jika syncToken diberikan. Opsional. Default-nya adalah Salah.
|
syncToken |
string |
Token yang diperoleh dari kolom nextSyncToken yang ditampilkan di halaman hasil terakhir dari permintaan daftar sebelumnya. Hal ini membuat hasil permintaan daftar ini hanya berisi entri yang telah berubah sejak saat itu. Semua entri yang dihapus sejak permintaan daftar sebelumnya akan selalu ada dalam set hasil dan tidak diizinkan untuk menetapkan showDeleted ke Salah. Jika masa berlaku syncToken berakhir, server akan merespons dengan kode respons 410 GONE dan klien harus menghapus penyimpanannya serta melakukan sinkronisasi penuh tanpa syncToken . Pelajari lebih lanjut sinkronisasi inkremental. Opsional. Setelan defaultnya adalah menampilkan semua entri. |
Otorisasi
Permintaan ini memerlukan otorisasi dengan setidaknya salah satu cakupan berikut:
Cakupan |
---|
https://www.googleapis.com/auth/calendar |
https://www.googleapis.com/auth/calendar.acls |
https://www.googleapis.com/auth/calendar.acls.readonly |
Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.
Isi permintaan
Jangan berikan isi permintaan dengan metode ini.
Respons
Jika berhasil, metode ini akan menampilkan isi respons dengan struktur berikut:
{ "kind": "calendar#acl", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ acl Resource ] }
Nama properti | Nilai | Deskripsi | Catatan |
---|---|---|---|
kind |
string |
Jenis koleksi ("calendar#acl "). |
|
etag |
etag |
ETag koleksi. | |
nextPageToken |
string |
Token yang digunakan untuk mengakses halaman berikutnya dari hasil ini. Dihilangkan jika tidak ada hasil lebih lanjut yang tersedia, dalam hal ini nextSyncToken diberikan. |
|
items[] |
list |
Daftar aturan di daftar kontrol akses. | |
nextSyncToken |
string |
Token yang digunakan pada waktu berikutnya untuk mengambil hanya entri yang telah berubah sejak hasil ini ditampilkan. Dihilangkan jika hasil lebih lanjut tersedia, dalam hal ini nextPageToken diberikan. |
Contoh
Catatan: Contoh kode yang tersedia untuk metode ini tidak merepresentasikan semua bahasa pemrograman yang didukung (lihat halaman library klien untuk mengetahui daftar bahasa yang didukung).
Java
Menggunakan library klien Java.
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Acl; import com.google.api.services.calendar.model.AclRule; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over a list of access rules Acl acl = service.acl().list('primary').execute(); for (AclRule rule : acl.getItems()) { System.out.println(rule.getId() + ": " + rule.getRole()); }
Python
Menggunakan library klien Python.
acl = service.acl().list(calendarId='primary').execute() for rule in acl['items']: print '%s: %s' % (rule['id'], rule['role'])
PHP
Menggunakan library klien PHP.
$acl = $service->acl->listAcl('primary'); foreach ($acl->getItems() as $rule) { echo $rule->getId() . ': ' . $rule->getRole(); }
Ruby
Menggunakan library klien Ruby.
result = client.list_acls('primary') result.items.each do |e| print e.id + ": " + e.role + "\n" end
Cobalah!
Gunakan API Explorer di bawah untuk memanggil metode ini pada data langsung dan melihat responsnya.