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 ถึง 1000 ค่าเริ่มต้นคือ 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
  • ความสนใจ
  • locales
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • miscKeywords
  • names
  • ชื่อเล่น
  • อาชีพ
  • organizations
  • phoneNumbers
  • ภาพถ่าย
  • ความสัมพันธ์
  • sipAddresses
  • ทักษะ
  • urls
  • 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 จัดเรียงบุคคลตามนามสกุล