Method: people.connections.list

แสดงรายชื่อติดต่อของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

โทเค็นการซิงค์จะหมดอายุภายใน 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
(deprecated)

string

ต้องระบุ ชื่อทรัพยากรที่จะแสดงผลการเชื่อมต่อ เฉพาะ people/me เท่านั้นที่ใช้ได้

พารามิเตอร์การค้นหา

พารามิเตอร์
pageToken

string

ไม่บังคับ โทเค็นหน้า ได้รับจากการตอบกลับก่อนหน้า nextPageToken ระบุหน้านี้เพื่อเรียกข้อมูลหน้าต่อไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ people.connections.list ต้องตรงกับการเรียกครั้งแรกที่ระบุโทเค็นหน้าเว็บ
pageSize

integer

ไม่บังคับ จํานวนการเชื่อมต่อที่จะรวมในการตอบกลับ ค่าที่ใช้ได้จะอยู่ระหว่าง 1 ถึง 1, 000 ค่าเริ่มต้นจะเป็น 100 หากไม่ได้ตั้งค่าไว้หรือตั้งค่าเป็น 0
sortOrder

enum (SortOrder)

ไม่บังคับ ลําดับที่ควรจัดเรียงการเชื่อมต่อ ค่าเริ่มต้นคือ LAST_MODIFIED_ASCENDING
requestSyncToken

boolean

ไม่บังคับ การตอบกลับควรแสดง nextSyncToken ในหน้าผลการค้นหาล่าสุดหรือไม่ สามารถใช้เพื่อรับการเปลี่ยนแปลงที่เพิ่มขึ้นนับตั้งแต่คําขอล่าสุดได้โดยการตั้งค่าในคําขอ syncToken

ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการทํางานของการซิงค์ที่ people.connections.list
syncToken

string

ไม่บังคับ โทเค็นการซิงค์ที่ได้รับจากการตอบกลับก่อนหน้า nextSyncToken ระบุไว้เพื่อเรียกเฉพาะทรัพยากรที่เปลี่ยนแปลงนับตั้งแต่คําขอล่าสุด

เมื่อซิงค์ พารามิเตอร์อื่นๆ ทั้งหมดที่ส่งไปยัง people.connections.list ต้องตรงกับการเรียกใช้ครั้งแรกที่ระบุโทเค็นการซิงค์

ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการทํางานของการซิงค์ที่ people.connections.list
requestMask
(deprecated)

object (RequestMask)

ไม่บังคับ เลิกใช้งานแล้ว (โปรดใช้ personFields แทน)

มาสก์เพื่อจํากัดผลการค้นหาไว้ในช่องบางช่องของผู้ใช้
personFields

string (FieldMask format)

ต้องระบุ มาสก์ช่องเพื่อจํากัดช่องที่จะแสดงต่อคนแต่ละคน คุณระบุช่องหลายช่องได้โดยคั่นด้วยคอมมา ค่าที่ใช้ได้มีดังนี้

  • ที่อยู่
  • ช่วงอายุ
  • ชีวประวัติ
  • วันเกิด
  • URL ของปฏิทิน
  • ClientData
  • รูปภาพปก
  • อีเมล
  • กิจกรรม
  • รหัสภายนอก
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • คีย์เวิร์ดเบ็ดเตล็ด
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • หมายเลขโทรศัพท์
  • รูปภาพ
  • ความสัมพันธ์
  • ที่อยู่ SIP
  • ทักษะ
  • URL
  • ผู้ใช้กําหนด
sources[]

enum (ReadSourceType)

ไม่บังคับ มาสก์ประเภทต้นทางที่จะแสดงผล ค่าเริ่มต้นจะเป็น READ_SOURCE_TYPE_CONTACT และ READ_SOURCE_TYPE_PROFILE หากไม่ได้ตั้งค่าไว้

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

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

การตอบกลับคําขอการเชื่อมต่อของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

การแสดง JSON 
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
ช่อง
connections[]

object (Person)

รายชื่อบุคคลที่ผู้ขอเชื่อมต่ออยู่
nextPageToken

string

โทเค็น ซึ่งสามารถส่งเป็น pageToken เพื่อดึงหน้าถัดไปได้ หากเว้นช่องนี้ไว้ จะไม่มีหน้าต่อๆ ไป
nextSyncToken

string

โทเค็นที่ส่งเป็น syncToken เพื่อเรียกการเปลี่ยนแปลงนับตั้งแต่คําขอล่าสุดได้ คําขอต้องตั้งค่า requestSyncToken จึงจะแสดงผลโทเค็นการซิงค์ได้ เมื่อมีการใส่เลขหน้าการตอบสนอง เฉพาะหน้าสุดท้ายเท่านั้นที่จะมี nextSyncToken
totalPeople
(deprecated)

integer

เลิกใช้งานแล้ว (โปรดใช้ totalItems) จํานวนบุคคลทั้งหมดในรายการโดยไม่ใส่เลขหน้า
totalItems

integer

จํานวนรายการทั้งหมดในรายการโดยไม่ต้องใส่เลขหน้า

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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 จัดเรียงผู้คนตามนามสกุล