แสดงการตั้งค่าผู้ใช้ทั้งหมดสําหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ลองใช้เลยหรือดูตัวอย่าง
ส่งคำขอ
คำขอ 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 |
สําหรับข้อมูลเพิ่มเติม โปรดดูหน้าการตรวจสอบสิทธิ์และการให้สิทธิ์
เนื้อหาของคำขอ
อย่าให้เนื้อหาคําขอด้วยวิธีนี้
คำตอบ
หากสําเร็จ วิธีนี้จะแสดงผลเนื้อหาการตอบกลับที่มีโครงสร้างต่อไปนี้
{ "kind": "calendar#settings", "etag": etag, "nextPageToken": string, "nextSyncToken": string, "items": [ settings Resource ] }
ชื่อพร็อพเพอร์ตี้ | ค่า | คำอธิบาย | หมายเหตุ |
---|---|---|---|
kind |
string |
ประเภทคอลเล็กชัน ("calendar#settings ") |
|
etag |
etag |
แท็กคอลเล็กชัน | |
items[] |
list |
รายการการตั้งค่าผู้ใช้ | |
nextPageToken |
string |
โทเค็นที่ใช้ในการเข้าถึงหน้าถัดไปของผลการค้นหานี้ ไม่เข้าร่วมหากไม่มีผลลัพธ์เพิ่มเติม ซึ่งในกรณีนี้จะเป็น nextSyncToken |
|
nextSyncToken |
string |
ระบบจะใช้โทเค็นในภายหลังเพื่อดึงเฉพาะรายการที่มีการเปลี่ยนแปลงนับตั้งแต่ที่แสดงผลลัพธ์นี้ ไม่ต้องระบุหากมีผลลัพธ์เพิ่มเติม ซึ่งในกรณีนี้คือ nextPageToken |
ตัวอย่าง
หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)
Java
import com.google.api.services.calendar.Calendar; import com.google.api.services.calendar.model.Setting; import com.google.api.services.calendar.model.Settings; // ... // Initialize Calendar service with valid OAuth credentials Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials) .setApplicationName("applicationName").build(); // Iterate over all user settings Settings settings = service.settings().list().execute(); for (Setting setting : settings.getItems()) { System.out.println(setting.getId() + ": " + setting.getValue()); }
Python
settings = service.settings().list().execute() for setting in settings['items']: print '%s: %s' % (setting['id'], setting['value'])
PHP
$settings = $service->settings->listSettings(); foreach ($settings->getItems() as $setting) { echo $setting->getId() . ': ' . $setting->getValue(); }
Ruby
result = client.list_settings result.items.each do |e| print e.id + ": " + e.value + "\n" end
ลองใช้เลย
ใช้เครื่องมือสํารวจ API ด้านล่างเพื่อเรียกใช้วิธีการนี้สําหรับข้อมูลสดและดูการตอบกลับ