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
  • groupType
  • memberCount
  • ข้อมูลเมตา
  • ชื่อ

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

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

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

การตอบกลับคำขอรับกลุ่มรายชื่อติดต่อเป็นกลุ่ม

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

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

object (ContactGroupResponse)

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

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

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

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

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

ContactGroupResponse

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

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

string

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

object (Status)

สถานะของการตอบกลับ
contactGroup

object (ContactGroup)

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