แสดงการตั้งค่าผู้ใช้ทั้งหมดสำหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ลองเลยหรือดูตัวอย่าง
ส่งคำขอ
คำขอ HTTP
GET https://www.googleapis.com/calendar/v3/users/me/settings
พารามิเตอร์
ชื่อพารามิเตอร์ | ค่า | คำอธิบาย |
---|---|---|
พารามิเตอร์การค้นหาที่ไม่บังคับ | ||
maxResults |
integer |
จำนวนรายการสูงสุดที่ส่งคืนในหน้าผลลัพธ์หนึ่งหน้า ค่าเริ่มต้นคือ 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 Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้กับข้อมูลแบบสดและดูการตอบกลับ