REST Resource: groups

ทรัพยากร: กลุ่ม

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

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

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

การแสดง 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

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