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 bằng địa chỉ email của nhóm. Để biết thêm thông tin về các thao tác 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ề API Cloud Identity Groups.

Lưu ý: Người dùng gọi API (hoặc bị một tài khoản dịch vụ mạo danh) phải được chỉ định một vai trò bao gồm cả các quyền của 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ể dùng id 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 thích hợp cho địa chỉ email đó. email phải là duy nhất. Bạn phải cung cấp thuộc tính này khi tạo nhóm. Địa chỉ email nhóm phải tuân theo cùng quy tắc sử dụng ký tự như tên người dùng, xem trung tâm trợ giúp để biết 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 nhóm. Ví dụ: bạn có thể thêm thông tin về người nên tham gia nhóm, loại thư gửi cho 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 chứ không phải 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 (nhóm mẹ), thì các thành viên của nhóm con không được tính trong tài sản directMembersCount của nhóm mẹ.

kind

string

Loại tài nguyên API. Đối với tài nguyên của 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 đại diện của một nhóm. Để thêm, cập nhật hoặc xoá email đại diện 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 nhóm, chỉnh sửa sẽ bị bỏ qua.

nonEditableAliases[]

string

Chỉ có thể đọc. Danh sách các địa chỉ email đại diện không thể chỉnh sửa 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à các địa chỉ email còn 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 nhóm, 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 được cấp một 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.