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 "ซูลู" ที่มีความละเอียดระดับนาโนวินาทีและเป็นตัวเลขเศษส่วนไม่เกิน 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
deleted

boolean

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

ประเภทกลุ่ม

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

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

ข้อมูล Client Group

ข้อมูลของลูกค้าที่กําหนดเอง อนุญาตให้ใช้คีย์และค่าซ้ํากัน

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

string

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

string

ค่าที่ลูกค้าระบุของข้อมูลลูกค้า

วิธีการ

batchGet

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

create

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

delete

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

get

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

list

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

update

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