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

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

patch

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

update

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