REST Resource: contactGroups

แหล่งข้อมูล: ContactGroup

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

การแสดง JSON 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
ช่อง
resourceName

string

ชื่อทรัพยากรสำหรับกลุ่มรายชื่อติดต่อที่เซิร์ฟเวอร์กำหนด สตริง ASCII ในรูปแบบ contactGroups/{contactGroupId}
etag

string

แท็กเอนทิตี HTTP ของทรัพยากร ใช้สําหรับการตรวจสอบเว็บแคช
metadata

object (ContactGroupMetadata)

เอาต์พุตเท่านั้น ข้อมูลเมตาเกี่ยวกับกลุ่มรายชื่อติดต่อ
groupType

enum (GroupType)

เอาต์พุตเท่านั้น ประเภทกลุ่มรายชื่อติดต่อ
name

string

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

สำหรับ contactGroups.create หรือ contactGroups.update ชื่อต้องไม่ซ้ำกับกลุ่มรายชื่อติดต่อของผู้ใช้ การพยายามสร้างกลุ่มที่มีชื่อซ้ำจะแสดงข้อผิดพลาด HTTP 409
formattedName

string

เอาต์พุตเท่านั้น ชื่อจะแปลและจัดรูปแบบในภาษาของบัญชีหรือภาษาของส่วนหัว HTTP Accept-Language สำหรับชื่อกลุ่มระบบ ชื่อกลุ่มที่เจ้าของตั้งเหมือนกับชื่อ
memberResourceNames[]

string

เอาต์พุตเท่านั้น รายชื่อทรัพยากรบุคคลที่ติดต่อที่เป็นสมาชิกของกลุ่มรายชื่อติดต่อ ช่องนี้มีไว้สำหรับคำขอ GET เท่านั้น และจะแสดงผลสมาชิกมากถึง maxMembers ในคำขอรับ
memberCount

integer

เอาต์พุตเท่านั้น จำนวนรายชื่อติดต่อทั้งหมดในกลุ่มโดยไม่คำนึงถึงจำนวนสมาชิกสูงสุดที่ระบุไว้ในคำขอ
clientData[]

object (GroupClientData)

ข้อมูลไคลเอ็นต์ของกลุ่ม

ContactGroupMetadata

ข้อมูลเมตาเกี่ยวกับกลุ่มรายชื่อติดต่อ

การแสดง JSON 
{
  "updateTime": string,
  "deleted": boolean
}
ช่อง
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่อัปเดตกลุ่มครั้งล่าสุด

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
deleted

boolean

เอาต์พุตเท่านั้น เป็นจริงหากทรัพยากรของกลุ่มรายชื่อติดต่อถูกลบออก ป้อนข้อมูลสําหรับคําขอ contactGroups.list ที่มีโทเค็นการซิงค์เท่านั้น

GroupType

ประเภทกลุ่มรายชื่อติดต่อ

Enum
GROUP_TYPE_UNSPECIFIED ไม่ระบุ
USER_CONTACT_GROUP กลุ่มรายชื่อติดต่อที่ผู้ใช้กำหนด
SYSTEM_CONTACT_GROUP กลุ่มรายชื่อติดต่อที่ระบบกำหนด

GroupClientData

ข้อมูลไคลเอ็นต์ที่กำหนดเองที่ไคลเอ็นต์สร้างขึ้น อนุญาตให้มีคีย์และค่าซ้ำกัน

การแสดง JSON 
{
  "key": string,
  "value": string
}
ช่อง
key

string

คีย์ของข้อมูลไคลเอ็นต์ที่ระบุ
value

string

ค่าข้อมูลไคลเอ็นต์ที่ระบุ

เมธอด

batchGet

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

create

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

delete

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

get

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

list

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

update

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