Method: contactGroups.batchGet

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

คำขอ HTTP

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

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

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

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

string

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

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

maxMembers

integer

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

groupFields

string (FieldMask format)

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

  • ClientData
  • ประเภทกลุ่ม
  • จํานวนสมาชิก
  • ข้อมูลเมตา
  • name

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

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

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

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

การตอบกลับกลุ่มจะได้รับคําขอกลุ่มรายชื่อติดต่อ

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

object (ContactGroupResponse)

รายการการตอบสนองสําหรับทรัพยากรกลุ่มรายชื่อติดต่อแต่ละรายการที่ขอ

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

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

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

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

การตอบกลับกลุ่มรายชื่อติดต่อ

การตอบกลับสําหรับกลุ่มรายชื่อติดต่อที่เฉพาะเจาะจง

การแสดง JSON
{
  "requestedResourceName": string,
  "status": {
    object (Status)
  },
  "contactGroup": {
    object (ContactGroup)
  }
}
ช่อง
requestedResourceName

string

ชื่อทรัพยากรที่ขอเดิม

status

object (Status)

สถานะของคําตอบ

contactGroup

object (ContactGroup)

กลุ่มรายชื่อติดต่อ