Method: people.searchContacts

ระบุรายการรายชื่อติดต่อในรายชื่อติดต่อที่จัดกลุ่มของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์แล้วที่ตรงกับคําค้นหา การค้นหาจะจับคู่ในช่อง names, nickNames, emailAddresses, phoneNumbers และ organizations ของรายชื่อติดต่อที่มาจาก CONTACT

สําคัญ: ก่อนค้นหา ไคลเอ็นต์ควรส่งคําขออุ่นเครื่องที่มีคําค้นหาว่างเปล่าเพื่ออัปเดตแคช ดู https://developers.google.com/people/v1/contacts#search_the_users_contacts

คำขอ HTTP

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

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

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

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

string

ต้องระบุ การค้นหาข้อความธรรมดาสําหรับคําขอ คําค้นหาจะใช้เพื่อจับคู่วลีคํานําหน้าของช่องในแต่ละรายการ เช่น คนที่มีชื่อ "foo name" ตรงกับคําค้นหา เช่น "f", "fo", "foo", "foo n", "nam" ฯลฯ แต่ไม่ตรงกับ "oo n"

pageSize

integer

ไม่บังคับ จํานวนผลการค้นหาที่จะแสดง ค่าเริ่มต้นจะเป็น 10 หากไม่ได้กําหนดค่าช่องไว้หรือตั้งค่าเป็น 0 ค่าที่มากกว่า 30 จะค่าสูงสุดเป็น 30

readMask

string (FieldMask format)

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

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

enum (ReadSourceType)

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

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

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

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ SearchResponse

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

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

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

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