แสดงผลกฎในรายการควบคุมการเข้าถึงสำหรับปฏิทิน ลองเลยหรือดูตัวอย่าง
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl
พารามิเตอร์
ชื่อพารามิเตอร์ | ค่า | คำอธิบาย |
---|---|---|
พารามิเตอร์เส้นทาง | ||
calendarId |
string |
ตัวระบุปฏิทิน หากต้องการเรียกข้อมูลรหัสปฏิทิน ให้เรียกเมธอด calendarList.list หากคุณต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบในปัจจุบัน ให้ใช้ "primary " คีย์เวิร์ด
|
พารามิเตอร์การค้นหาที่ไม่บังคับ | ||
maxResults |
integer |
จำนวนรายการสูงสุดที่ส่งคืนในหน้าผลลัพธ์หนึ่งหน้า ค่าเริ่มต้นคือ 100 รายการ โดยขนาดของหน้าต้องไม่ใหญ่กว่า 250 รายการ ไม่บังคับ |
pageToken |
string |
โทเค็นที่ระบุหน้าผลลัพธ์ที่จะแสดงผล ไม่บังคับ |
showDeleted |
boolean |
รวม ACL ที่ถูกลบในผลลัพธ์หรือไม่ ACL ที่ถูกลบจะแสดงด้วย role เท่ากับ "none " ACL ที่ลบแล้วจะรวมอยู่ในเสมอหากระบุ syncToken ไม่บังคับ ค่าเริ่มต้นคือ "เท็จ"
|
syncToken |
string |
โทเค็นที่ได้รับจากฟิลด์ nextSyncToken แสดงผลในหน้าสุดท้ายของคำขอจากรายชื่อก่อนหน้า ซึ่งทำให้ผลลัพธ์ของคำขอรายการนี้มีเพียงรายการที่มีการเปลี่ยนแปลงนับจากวันนั้นเท่านั้น รายการทั้งหมดที่ถูกลบเนื่องจากคำขอรายการก่อนหน้าจะอยู่ในชุดผลลัพธ์เสมอ และไม่ได้รับอนุญาตให้ตั้งค่า showDeleted เป็น "เท็จ" หาก syncToken หมดอายุ เซิร์ฟเวอร์จะตอบกลับด้วยรหัสตอบกลับ 410 GONE และไคลเอ็นต์ควรล้างพื้นที่เก็บข้อมูลและดำเนินการซิงค์ทั้งหมดโดยไม่มี syncToken ดูข้อมูลเพิ่มเติมเกี่ยวกับการซิงค์ส่วนเพิ่ม (ไม่บังคับ) โดยค่าเริ่มต้นคือการแสดงผลรายการทั้งหมด |
การให้สิทธิ์
คำขอนี้ต้องได้รับการให้สิทธิ์ตามขอบเขตต่อไปนี้
ขอบเขต |
---|
https://www.googleapis.com/auth/calendar |
สำหรับข้อมูลเพิ่มเติม โปรดดูที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
โปรดอย่าให้เนื้อหาคำขอตามวิธีการนี้
คำตอบ
หากทำสำเร็จ เมธอดนี้จะแสดงเนื้อหาการตอบกลับพร้อมโครงสร้างต่อไปนี้
{ "kind": "calendar#acl", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ acl Resource ] }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | หมายเหตุ |
---|---|---|---|
kind |
string |
ประเภทของคอลเล็กชัน ("calendar#acl ") |
|
etag |
etag |
ETag ของคอลเล็กชัน | |
nextPageToken |
string |
โทเค็นที่ใช้ในการเข้าถึงหน้าถัดไปของผลการค้นหานี้ ละเว้นหากไม่มีผลลัพธ์เพิ่มเติม ซึ่งในกรณีนี้คือ nextSyncToken |
|
items[] |
list |
รายการกฎในรายการควบคุมการเข้าถึง | |
nextSyncToken |
string |
โทเค็นที่ใช้ในภายหลังเพื่อเรียกเฉพาะรายการที่มีการเปลี่ยนแปลงนับตั้งแต่ผลลัพธ์นี้ถูกส่งคืน ละเว้นหากมีผลลัพธ์เพิ่มเติม ซึ่งในกรณีนี้คือ nextPageToken |
ตัวอย่าง
หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)
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
acl = service.acl().list(calendarId='primary').execute() for rule in acl['items']: print '%s: %s' % (rule['id'], rule['role'])
PHP
$acl = $service->acl->listAcl('primary'); foreach ($acl->getItems() as $rule) { echo $rule->getId() . ': ' . $rule->getRole(); }
Ruby
result = client.list_acls('primary') result.items.each do |e| print e.id + ": " + e.role + "\n" end
ลองใช้งาน
ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบสดและดูการตอบกลับ