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)

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

  • ที่อยู่
  • ageRanges
  • ชีวประวัติ
  • วันเกิด
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • กิจกรรม
  • externalIds
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • miscKeywords
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • phoneNumbers
  • รูปภาพ
  • ความสัมพันธ์
  • sipAddresses
  • ทักษะ
  • URL
  • userDefined
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 จัดเรียงบุคคลตามนามสกุล