Method: contactGroups.get

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

คำขอ HTTP

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

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

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

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

string

ต้องระบุ ชื่อทรัพยากรของกลุ่มผู้ติดต่อที่จะรับ

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

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

integer

ไม่บังคับ ระบุจำนวนสมาชิกสูงสุดที่จะส่งคืน ค่าเริ่มต้นเป็น 0 หากไม่ได้ตั้งค่าไว้ ซึ่งจะทำให้สมาชิก 0 คนกลับมา

groupFields

string (FieldMask format)

ไม่บังคับ ฟิลด์มาสก์เพื่อจำกัดฟิลด์ในกลุ่มที่จะแสดงผล ค่าเริ่มต้นคือ metadata, groupType, memberCount และ name หากไม่ได้ตั้งค่าไว้หรือตั้งเป็นค่าว่าง ช่องที่ถูกต้องมีดังนี้

  • clientData
  • groupType
  • memberCount
  • ข้อมูลเมตา
  • ชื่อ

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

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

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

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

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

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

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

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