Method: people.get

ระบุข้อมูลเกี่ยวกับบุคคลด้วยการระบุชื่อทรัพยากร ใช้ people/me เพื่อระบุผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

คําขอจะแสดงข้อผิดพลาด 400 หากไม่ได้ระบุ "personFields"

คำขอ HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}

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

พารามิเตอร์เส้นทาง

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

string

ต้องระบุ ชื่อแหล่งข้อมูลของบุคคลที่ให้ข้อมูล

  • หากต้องการข้อมูลเกี่ยวกับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว ให้ระบุ people/me
  • หากต้องการข้อมูลเกี่ยวกับบัญชี Google ให้ระบุ people/{account_id}
  • หากต้องการข้อมูลเกี่ยวกับรายชื่อติดต่อ ให้ระบุชื่อทรัพยากรที่บ่งบอกว่ารายชื่อติดต่อส่งคืนมาโดย people.connections.list

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

พารามิเตอร์
requestMask
(deprecated)

object (RequestMask)

เลิกใช้งานแล้ว (โปรดใช้ personFields แทน)

มาสก์เพื่อจํากัดผลการค้นหาไว้ในช่องบางช่องของผู้ใช้
personFields

string (FieldMask format)

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

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

enum (ReadSourceType)

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

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

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

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

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

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

ไม่จําเป็นต้องให้สิทธิ์เพื่อเข้าถึงข้อมูลสาธารณะ สําหรับข้อมูลส่วนตัว คุณจําเป็นต้องกําหนดขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile

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