REST Resource: groups

แหล่งข้อมูล: กลุ่ม

Google Groups ช่วยให้ผู้ใช้สามารถส่งข้อความถึงกลุ่มบุคคลโดยใช้อีเมลของกลุ่ม ดูข้อมูลเพิ่มเติมเกี่ยวกับงานทั่วไปได้ในคู่มือนักพัฒนาซอฟต์แวร์

โปรดดูข้อมูลเกี่ยวกับกลุ่มประเภทอื่นๆ ในเอกสารประกอบ Cloud Identity Groups API

หมายเหตุ: ผู้ใช้ที่เรียกใช้ API (หรือถูกบัญชีบริการแอบอ้างเป็นบุคคลอื่น) ต้องได้รับบทบาทที่ได้รับมอบหมาย ซึ่งรวมถึงสิทธิ์ของกลุ่ม API การดูแลระบบ เช่น ผู้ดูแลระบบขั้นสูงหรือผู้ดูแลระบบ Groups

การแสดง JSON 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
ช่อง
id

string

อ่านอย่างเดียว รหัสที่ไม่ซ้ำกันของกลุ่ม คุณสามารถใช้ id เป็น groupKey ของ URI คำขอของกลุ่มได้
email

string

อีเมลของกลุ่ม หากบัญชีของคุณมีหลายโดเมน ให้เลือกโดเมนที่เหมาะสมสำหรับอีเมล email ต้องไม่ซ้ำกัน จำเป็นต้องใช้พร็อพเพอร์ตี้นี้เมื่อสร้างกลุ่ม อีเมลของกลุ่มจะอยู่ภายใต้กฎการใช้อักขระเดียวกันกับชื่อผู้ใช้ โปรดดูรายละเอียดที่ศูนย์ช่วยเหลือ
name

string

ชื่อที่แสดงของกลุ่ม
description

string

คำอธิบายเพิ่มเติมเพื่อช่วยให้ผู้ใช้พิจารณาวัตถุประสงค์ของกลุ่ม ตัวอย่างเช่น คุณสามารถระบุข้อมูลเกี่ยวกับผู้ที่ควรเข้าร่วมกลุ่ม ประเภทข้อความที่จะส่งให้กลุ่ม ลิงก์ไปยังคําถามที่พบบ่อยเกี่ยวกับกลุ่ม หรือกลุ่มที่เกี่ยวข้อง ความยาวสูงสุดคือ 4,096 อักขระ
adminCreated

boolean

อ่านอย่างเดียว ค่าคือ true ถ้ากลุ่มนี้สร้างโดยผู้ดูแลระบบ ไม่ใช่ผู้ใช้
directMembersCount

string (int64 format)

จำนวนผู้ใช้ที่เป็นสมาชิกโดยตรงของกลุ่ม หากกลุ่มเป็นสมาชิก (ย่อย) ของกลุ่มนี้ (หลัก) ระบบจะไม่นับรวมสมาชิกของกลุ่มย่อยในพร็อพเพอร์ตี้ directMembersCount ของกลุ่มหลัก
kind

string

ประเภทของทรัพยากร API สำหรับทรัพยากรของ Groups ค่าคือ admin#directory#group
etag

string

ETag ของทรัพยากร
aliases[]

string

อ่านอย่างเดียว รายการที่อยู่อีเมลแทนของกลุ่ม หากต้องการเพิ่ม อัปเดต หรือนำชื่อแทนของกลุ่มออก ให้ใช้เมธอด groups.aliases หากแก้ไขในคำขอ POST หรือ PUT ของกลุ่ม ระบบจะไม่สนใจการแก้ไข
nonEditableAliases[]

string

อ่านอย่างเดียว รายการที่อยู่อีเมลแทนที่แก้ไขไม่ได้ของกลุ่มซึ่งอยู่นอกโดเมนหลักหรือโดเมนย่อยของบัญชี อีเมลเหล่านี้คืออีเมลที่ใช้งานได้ซึ่งกลุ่มใช้ นี่คือพร็อพเพอร์ตี้แบบอ่านอย่างเดียวที่แสดงผลในคำตอบของ API สำหรับกลุ่ม หากแก้ไขในคำขอ POST หรือ PUT ของกลุ่ม ระบบจะไม่สนใจการแก้ไข

เมธอด

delete

 ลบกลุ่ม

get

 เรียกข้อมูลพร็อพเพอร์ตี้ของกลุ่ม

insert

 สร้างกลุ่ม

list

 เรียกข้อมูลกลุ่มทั้งหมดของโดเมนหรือผู้ใช้ที่ระบุ userKey (ใส่เลขหน้า)

patch

 อัปเดตพร็อพเพอร์ตี้ของกลุ่ม

update

 อัปเดตพร็อพเพอร์ตี้ของกลุ่ม