Acl: list

แสดงผลกฎในรายการควบคุมการเข้าถึงสําหรับปฏิทิน ลองใช้เลยหรือดูตัวอย่าง

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/calendar/v3/calendars/calendarId/acl

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์เส้นทาง
calendarId string ตัวระบุปฏิทิน หากต้องการเรียกรหัสปฏิทิน ให้เรียกใช้เมธอด calendarList.list หากต้องการเข้าถึงปฏิทินหลักของผู้ใช้ที่เข้าสู่ระบบอยู่ ให้ใช้คีย์เวิร์ด "primary"
พารามิเตอร์การค้นหาที่ไม่บังคับ
maxResults integer จํานวนสูงสุดของผลลัพธ์ที่แสดงในหน้าผลการค้นหา 1 รายการ โดยค่าเริ่มต้นจะเป็น 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

ใช้ไลบรารีของไคลเอ็นต์ 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

ใช้ไลบรารีของไคลเอ็นต์ Python

acl = service.acl().list(calendarId='primary').execute()

for rule in acl['items']:
  print '%s: %s' % (rule['id'], rule['role'])

PHP

ใช้ไลบรารีของไคลเอ็นต์ PHP

$acl = $service->acl->listAcl('primary');

foreach ($acl->getItems() as $rule) {
  echo $rule->getId() . ': ' . $rule->getRole();
}

Ruby

ใช้ไลบรารีของไคลเอ็นต์ Ruby

result = client.list_acls('primary')
result.items.each do |e|
  print e.id + ": " + e.role + "\n"
end

ลองใช้เลย

ใช้เครื่องมือสํารวจ API ด้านล่างเพื่อเรียกใช้วิธีการนี้สําหรับข้อมูลสดและดูการตอบกลับ