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
  • ประเภทกลุ่ม
  • จํานวนสมาชิก
  • ข้อมูลเมตา
  • name

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

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

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

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

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

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

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

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