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)

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

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

enum (ReadSourceType)

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

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

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

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

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

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

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

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

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