Method: otherContacts.list

ระบุ "รายชื่อติดต่ออื่นๆ" ทั้งหมดซึ่งเป็นรายชื่อติดต่อที่ไม่อยู่ในกลุ่มรายชื่อติดต่อ "รายชื่อติดต่ออื่นๆ" เป็นรายชื่อติดต่อที่สร้างขึ้นโดยอัตโนมัติจากการโต้ตอบ

โทเค็นการซิงค์จะหมดอายุใน 7 วันหลังจากการซิงค์เสร็จสมบูรณ์ คำขอที่มีโทเค็นการซิงค์ที่หมดอายุแล้วจะได้รับข้อผิดพลาดพร้อมด้วย google.rpc.ErrorInfo ที่มีเหตุผล "EXPIRED_SYNC_TOKEN" ในกรณีที่ไคลเอ็นต์มีข้อผิดพลาดเช่นนี้ ควรส่งคำขอซิงค์ทั้งหมดโดยไม่มี syncToken

หน้าแรกของคำขอซิงค์ทั้งหมดจะมีโควต้าเพิ่มเติม หากเกินโควต้าที่กำหนด ระบบจะแสดงข้อผิดพลาด 429 โควต้านี้คงที่และไม่สามารถเพิ่มได้

เมื่อระบุ syncToken ทรัพยากรที่ถูกลบตั้งแต่การซิงค์ครั้งล่าสุดจะส่งกลับในฐานะบุคคลที่ตั้งค่า PersonMetadata.deleted เป็น "จริง"

เมื่อระบุ pageToken หรือ syncToken แล้ว พารามิเตอร์คำขออื่นๆ ทั้งหมดต้องตรงกับการเรียกครั้งแรก

การเขียนอาจมีความล่าช้าในการนำไปใช้งานหลายนาทีสำหรับคำขอซิงค์ การซิงค์ที่เพิ่มขึ้นไม่ได้มีไว้สำหรับกรณีการใช้งานแบบอ่านหลังเขียน

ดูตัวอย่างการใช้งานได้ที่แสดงรายชื่อติดต่ออื่นๆ ของผู้ใช้ที่มีการเปลี่ยนแปลง

คำขอ HTTP

GET https://people.googleapis.com/v1/otherContacts

URL ใช้ไวยากรณ์การแปลง gRPC

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

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

string

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

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

integer

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

boolean

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

ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการซิงค์ได้ที่ otherContacts.list
syncToken

string

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

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

ดูรายละเอียดเพิ่มเติมเกี่ยวกับลักษณะการซิงค์ได้ที่ otherContacts.list
readMask

string (FieldMask format)

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

หากใช้ READ_SOURCE_TYPE_CONTACT ค่าที่ถูกต้องจะเป็นดังนี้

  • emailAddresses
  • ข้อมูลเมตา
  • ชื่อ
  • phoneNumbers
  • รูปภาพ

หากใช้ READ_SOURCE_TYPE_PROFILE ค่าที่ถูกต้องจะเป็นดังนี้

  • ที่อยู่
  • ageRanges
  • ชีวประวัติ
  • วันเกิด
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • กิจกรรม
  • externalIds
  • เพศ
  • imClients
  • ความสนใจ
  • ภาษา
  • สถานที่ตั้ง
  • ของช่อง
  • ข้อมูลเมตา
  • miscKeywords
  • ชื่อ
  • ชื่อเล่น
  • อาชีพ
  • องค์กร
  • phoneNumbers
  • รูปภาพ
  • ความสัมพันธ์
  • sipAddresses
  • ทักษะ
  • URL
  • userDefined
sources[]

enum (ReadSourceType)

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

ค่าที่เป็นไปได้สำหรับช่องนี้ ได้แก่

ไม่อนุญาตให้ระบุ READ_SOURCE_TYPE_PROFILE โดยไม่ระบุ READ_SOURCE_TYPE_CONTACT

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

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

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

การตอบกลับคำขอสำหรับ "รายชื่อติดต่ออื่นๆ" ของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์

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

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

object (Person)

รายการ "รายชื่อติดต่ออื่นๆ" แสดงผลเป็นทรัพยากรบุคคล "รายชื่อติดต่ออื่นๆ" รองรับชุดย่อยของช่องที่จำกัด โปรดดูรายละเอียดเพิ่มเติมที่ ListOtherContactsRequest.request_mask
nextPageToken

string

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

string

โทเค็นที่ส่งในฐานะ syncToken เพื่อเรียกข้อมูลการเปลี่ยนแปลงนับตั้งแต่คำขอล่าสุดได้ คำขอต้องตั้งค่า requestSyncToken เพื่อแสดงโทเค็นการซิงค์
totalSize

integer

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

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/contacts.other.readonly

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์