Method: people.getBatchGet

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

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

คำขอ HTTP

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

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

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

พารามิเตอร์
resourceNames[]

string

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

resourceNames=<name1>&resourceNames=<name2>&...

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

มีชื่อทรัพยากรได้สูงสุด 200 ชื่อ
requestMask
(deprecated)

object (RequestMask)

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

มาสก์เพื่อจำกัดผลลัพธ์ในช่องบุคคลบางส่วน
personFields

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 และ READ_SOURCE_TYPE_PROFILE หากไม่ได้ตั้งค่าไว้

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

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

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

การตอบกลับคำขอรับรายชื่อบุคคลตามชื่อทรัพยากร

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

การแสดง JSON 
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
ช่อง
responses[]

object (PersonResponse)

การตอบกลับสำหรับชื่อทรัพยากรแต่ละรายการที่ขอ

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

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

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.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
  • https://www.googleapis.com/auth/profile.language.read

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