- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- พารามิเตอร์การค้นหา
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- จัดเรียง
- ลองใช้งาน
แสดงรายชื่อติดต่อของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
โทเค็นการซิงค์จะหมดอายุภายใน 7 วันหลังจากการซิงค์เต็มรูปแบบ คําขอที่มีโทเค็นการซิงค์ที่หมดอายุจะได้รับข้อผิดพลาด google.rpc.ErrorInfo ที่มีข้อความว่า "EXPIRED_SYNC_TOKEN" ในกรณีที่เกิดข้อผิดพลาดดังกล่าว ไคลเอ็นต์ควรส่งคําขอซิงค์แบบเต็มโดยไม่มี syncToken
หน้าแรกของคําขอซิงค์แบบเต็มมีโควต้าเพิ่มเติม หากเกินโควต้า ระบบจะแสดงข้อผิดพลาด 429 โควต้านี้จะคงที่และไม่สามารถเพิ่มได้
เมื่อระบุ
แล้ว ทรัพยากรที่ลบไปตั้งแต่การซิงค์ครั้งล่าสุดจะกลับไปเป็นบุคคลที่มีการตั้งค่า syncToken
เป็น "จริง"PersonMetadata.deleted
เมื่อระบุ
หรือ pageToken
แล้ว พารามิเตอร์คําขออื่นๆ ทั้งหมดต้องตรงกับการเรียกครั้งแรกsyncToken
การเขียนอาจมีความล่าช้าในการเผยแพร่หลายนาทีสําหรับคําขอซิงค์ การซิงค์ที่เพิ่มขึ้นไม่ได้มีไว้สําหรับกรณีการใช้งานแบบอ่านแล้วเขียน
ดูตัวอย่างการใช้งานที่แสดงรายการรายชื่อติดต่อของผู้ใช้ที่มีการเปลี่ยนแปลง
คำขอ HTTP
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
resourceName |
ต้องระบุ ชื่อทรัพยากรที่จะแสดงผลการเชื่อมต่อ เฉพาะ |
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
pageToken |
ไม่บังคับ โทเค็นหน้า ได้รับจากการตอบกลับก่อนหน้า เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ |
pageSize |
ไม่บังคับ จํานวนการเชื่อมต่อที่จะรวมในการตอบกลับ ค่าที่ใช้ได้จะอยู่ระหว่าง 1 ถึง 1, 000 ค่าเริ่มต้นจะเป็น 100 หากไม่ได้ตั้งค่าไว้หรือตั้งค่าเป็น 0 |
sortOrder |
ไม่บังคับ ลําดับที่ควรจัดเรียงการเชื่อมต่อ ค่าเริ่มต้นคือ |
requestSyncToken |
ไม่บังคับ การตอบกลับควรแสดง ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการทํางานของการซิงค์ที่ |
syncToken |
ไม่บังคับ โทเค็นการซิงค์ที่ได้รับจากการตอบกลับก่อนหน้า เมื่อซิงค์ พารามิเตอร์อื่นๆ ทั้งหมดที่ส่งไปยัง ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการทํางานของการซิงค์ที่ |
requestMask |
ไม่บังคับ เลิกใช้งานแล้ว (โปรดใช้ มาสก์เพื่อจํากัดผลการค้นหาไว้ในช่องบางช่องของผู้ใช้ |
personFields |
ต้องระบุ มาสก์ช่องเพื่อจํากัดช่องที่จะแสดงต่อคนแต่ละคน คุณระบุช่องหลายช่องได้โดยคั่นด้วยคอมมา ค่าที่ใช้ได้มีดังนี้
|
sources[] |
ไม่บังคับ มาสก์ประเภทต้นทางที่จะแสดงผล ค่าเริ่มต้นจะเป็น |
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
การตอบกลับคําขอการเชื่อมต่อของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว
การแสดง JSON |
---|
{
"connections": [
{
object ( |
ช่อง | |
---|---|
connections[] |
รายชื่อบุคคลที่ผู้ขอเชื่อมต่ออยู่ |
nextPageToken |
โทเค็น ซึ่งสามารถส่งเป็น |
nextSyncToken |
โทเค็นที่ส่งเป็น |
totalPeople |
เลิกใช้งานแล้ว (โปรดใช้ totalItems) จํานวนบุคคลทั้งหมดในรายการโดยไม่ใส่เลขหน้า |
totalItems |
จํานวนรายการทั้งหมดในรายการโดยไม่ต้องใส่เลขหน้า |
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ข้อใดข้อหนึ่งต่อไปนี้
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
สําหรับข้อมูลเพิ่มเติม โปรดดูคู่มือการให้สิทธิ์
SortOrder
ลําดับการจัดเรียงรายการการเชื่อมต่อ ซึ่งจะใช้ในกรณีที่ไม่ได้ขอการซิงค์เท่านั้น
Enum | |
---|---|
LAST_MODIFIED_ASCENDING |
จัดเรียงผู้คนตามเวลาที่มีการเปลี่ยนแปลง โดยเปลี่ยนรายการเก่าก่อน |
LAST_MODIFIED_DESCENDING |
จัดเรียงผู้คนตามเวลาที่มีการเปลี่ยนแปลง โดยให้แสดงรายการใหม่ก่อน |
FIRST_NAME_ASCENDING |
จัดเรียงผู้คนตามชื่อ |
LAST_NAME_ASCENDING |
จัดเรียงผู้คนตามนามสกุล |