Settings: list

แสดงผลการตั้งค่าผู้ใช้ทั้งหมดสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ลองใช้เลย

ส่งคำขอ

คำขอ HTTP

GET https://www.googleapis.com/calendar/v3/users/me/settings

พารามิเตอร์

ชื่อพารามิเตอร์ ค่า คำอธิบาย
พารามิเตอร์การค้นหาที่ไม่บังคับ
maxResults integer จำนวนรายการสูงสุดที่แสดงในหน้าผลการค้นหา 1 หน้า โดยค่าเริ่มต้นคือ 100 รายการ ขนาดหน้าต้องไม่เกิน 250 รายการ ไม่บังคับ
pageToken string โทเค็นที่ระบุหน้าผลลัพธ์ที่จะแสดงผล ไม่บังคับ
syncToken string โทเค็นที่ได้จากฟิลด์ nextSyncToken ซึ่งแสดงผลในหน้าสุดท้ายของผลลัพธ์จากคำขอรายการก่อนหน้า ซึ่งจะทำให้ผลลัพธ์ของคำขอรายการนี้มีเฉพาะรายการที่มีการเปลี่ยนแปลงตั้งแต่นั้นมา
หาก syncToken หมดอายุ เซิร์ฟเวอร์จะตอบกลับด้วยโค้ดตอบกลับ 410 GONE และไคลเอ็นต์ควรล้างพื้นที่เก็บข้อมูลและทำการซิงค์ข้อมูลทั้งหมดโดยไม่มี syncToken
ดูข้อมูลเพิ่มเติมเกี่ยวกับการซิงค์ข้อมูลส่วนเพิ่ม
ไม่บังคับ ค่าเริ่มต้นคือแสดงรายการทั้งหมด

การให้สิทธิ์

คำขอนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตอย่างน้อย 1 รายการต่อไปนี้

ขอบเขต
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.settings.readonly
https://www.googleapis.com/auth/calendar.settings

ดูข้อมูลเพิ่มเติมได้ที่หน้าการตรวจสอบสิทธิ์และการให้สิทธิ์

เนื้อความของคำขอ

อย่าระบุเนื้อหาคำขอด้วยเมธอดนี้

คำตอบ

หากทำสำเร็จ เมธอดนี้จะแสดงผลเนื้อหาการตอบกลับซึ่งมีโครงสร้างดังต่อไปนี้

{
  "kind": "calendar#settings",
  "etag": etag,
  "nextPageToken": string,
  "nextSyncToken": string,
  "items": [
    settings Resource
  ]
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
kind string ประเภทของคอลเล็กชัน ("calendar#settings")
etag etag Etag ของคอลเล็กชัน
items[] list รายการการตั้งค่าผู้ใช้
nextPageToken string โทเค็นที่ใช้เพื่อเข้าถึงหน้าถัดไปของผลลัพธ์นี้ ละเว้นหากไม่มีผลลัพธ์เพิ่มเติม ซึ่งในกรณีนี้จะมีการระบุ nextSyncToken
nextSyncToken string โทเค็นที่ใช้ในภายหลังเพื่อดึงข้อมูลเฉพาะรายการที่มีการเปลี่ยนแปลงนับตั้งแต่แสดงผลลัพธ์นี้ ละเว้นหากมีผลลัพธ์เพิ่มเติม ซึ่งในกรณีนี้จะมีการระบุ nextPageToken

ลองใช้งาน

ใช้โปรแกรมสำรวจ API ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบเรียลไทม์และดูการตอบกลับ