REST Resource: groups

Tài nguyên: Nhóm

Google Groups cho phép người dùng gửi thư đến các nhóm người bằng địa chỉ email của nhóm. Để biết thêm thông tin về các tác vụ phổ biến, hãy xem Hướng dẫn dành cho nhà phát triển.

Để biết thông tin về các loại nhóm khác, hãy xem tài liệu về Cloud Identity Groups API.

Lưu ý: Người dùng gọi API (hoặc bị tài khoản dịch vụ mạo danh) phải có vai trò được chỉ định bao gồm các quyền đối với Nhóm API quản trị, chẳng hạn như Quản trị viên cấp cao hoặc Quản trị viên nhóm.

Biểu diễn dưới dạng JSON
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Trường
id

string

Chỉ có thể đọc. Mã nhận dạng duy nhất của một nhóm. Bạn có thể sử dụng id của nhóm làm groupKey của URI yêu cầu nhóm.

email

string

Địa chỉ email của nhóm. Nếu tài khoản của bạn có nhiều miền, hãy chọn miền phù hợp cho địa chỉ email. email phải là duy nhất. Thuộc tính này là bắt buộc khi tạo nhóm. Địa chỉ email nhóm tuân theo các quy tắc sử dụng ký tự giống như tên người dùng. Hãy xem trung tâm trợ giúp để biết thông tin chi tiết.

name

string

Tên hiển thị của nhóm.

description

string

Nội dung mô tả mở rộng để giúp người dùng xác định mục đích của một nhóm. Ví dụ: bạn có thể thêm thông tin về những người nên tham gia nhóm, loại tin nhắn cần gửi đến nhóm, đường liên kết đến các câu hỏi thường gặp về nhóm hoặc các nhóm có liên quan. Độ dài tối đa là 4,096 ký tự.

adminCreated

boolean

Chỉ có thể đọc. Giá trị là true nếu nhóm này do quản trị viên tạo thay vì người dùng.

directMembersCount

string (int64 format)

Số lượng người dùng là thành viên trực tiếp của nhóm. Nếu một nhóm là thành viên (con) của nhóm này (mẹ), thì các thành viên của nhóm con sẽ không được tính trong thuộc tính directMembersCount của nhóm mẹ.

kind

string

Loại tài nguyên API. Đối với tài nguyên Groups, giá trị là admin#directory#group.

etag

string

ETag của tài nguyên.

aliases[]

string

Chỉ có thể đọc. Danh sách địa chỉ email bí danh của một nhóm. Để thêm, cập nhật hoặc xoá bí danh của một nhóm, hãy sử dụng các phương thức groups.aliases. Nếu được chỉnh sửa trong yêu cầu POST hoặc PUT của một nhóm, nội dung chỉnh sửa sẽ bị bỏ qua.

nonEditableAliases[]

string

Chỉ có thể đọc. Danh sách địa chỉ email đại diện không chỉnh sửa được của nhóm nằm ngoài miền chính hoặc miền con của tài khoản. Đây là những địa chỉ email đang hoạt động mà nhóm sử dụng. Đây là thuộc tính chỉ có thể đọc được trả về trong phản hồi của API cho một nhóm. Nếu được chỉnh sửa trong yêu cầu POST hoặc PUT của một nhóm, thì nội dung chỉnh sửa sẽ bị bỏ qua.

Phương thức

delete

Xoá một nhóm.

get

Truy xuất các thuộc tính của một nhóm.

insert

Tạo một nhóm.

list

Truy xuất tất cả các nhóm của một miền hoặc của một người dùng dựa trên userKey (được phân trang).

patch

Cập nhật các thuộc tính của một nhóm.

update

Cập nhật các thuộc tính của một nhóm.