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 ค่าที่ถูกต้องคือ

  • อีเมล
  • ข้อมูลเมตา
  • ชื่อ
  • หมายเลขโทรศัพท์
  • รูปภาพ

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

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

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