- Tài nguyên: Ghi chú
- Tệp đính kèm
- Quyền
- Vai trò
- Người dùng
- Nhóm
- Gia đình
- Phần
- TextContent
- ListContent
- ListItem
- Phương thức
Tài nguyên: Ghi chú
Một ghi chú.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "createTime": string, "updateTime": string, "trashTime": string, "trashed": boolean, "attachments": [ { object ( |
Trường | |
---|---|
name |
Chỉ có đầu ra. Tên tài nguyên của ghi chú này. Xem ghi chú chung về giá trị nhận dạng trong KeepService. |
createTime |
Chỉ có đầu ra. Thời điểm tạo ghi chú này. |
updateTime |
Chỉ có đầu ra. Thời điểm sửa đổi lần gần đây nhất ghi chú này. |
trashTime |
Chỉ có đầu ra. Thời điểm chuyển ghi chú này vào thùng rác. Nếu là |
trashed |
Chỉ có đầu ra. |
attachments[] |
Chỉ có đầu ra. Các tệp đính kèm vào ghi chú này. |
permissions[] |
Chỉ có đầu ra. Danh sách quyền được đặt trên ghi chú. Chứa ít nhất một mục nhập cho chủ sở hữu ghi chú. |
title |
Tiêu đề của ghi chú. Độ dài phải dưới 1.000 ký tự. |
body |
Nội dung của ghi chú. |
Tệp đính kèm
Tệp đính kèm vào một ghi chú.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "mimeType": [ string ] } |
Trường | |
---|---|
name |
Tên tài nguyên; |
mimeType[] |
Loại MIME (loại nội dung đa phương tiện IANA) có tệp đính kèm. |
Quyền
Một quyền duy nhất trên ghi chú. Liên kết member
với role
.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "role": enum ( |
Trường | |
---|---|
name |
Chỉ có đầu ra. Tên tài nguyên. |
role |
Vai trò được cấp bằng quyền này. Vai trò này xác định khả năng đọc, viết và chia sẻ ghi chú của thực thể. |
email |
Email liên kết với thành viên. Nếu được đặt khi tạo, trường |
deleted |
Chỉ có đầu ra. Liệu thành viên này đã bị xoá hay chưa. Nếu thành viên được khôi phục, giá trị này được đặt thành false và thành viên được khôi phục vẫn giữ vai trò trên ghi chú. |
Trường kết hợp member . Chỉ định danh tính được cấp cho vai trò. Chưa đặt thành viên nếu thành viên đó đã bị xoá. member chỉ có thể là một trong những trạng thái sau đây: |
|
user |
Chỉ có đầu ra. Người dùng được áp dụng vai trò này. |
group |
Chỉ có đầu ra. Nhóm áp dụng vai trò này. |
family |
Chỉ có đầu ra. Nhóm gia đình trên Google mà vai trò này áp dụng. |
Vai trò
Xác định các vai trò khác nhau của một thực thể.
Enum | |
---|---|
ROLE_UNSPECIFIED |
Vai trò không xác định. |
OWNER |
Vai trò cấp toàn quyền truy cập. Không thể thêm hoặc xoá vai trò này. Do người tạo ghi chú xác định. |
WRITER |
Vai trò cấp khả năng đóng góp nội dung và sửa đổi quyền đối với ghi chú. |
Người dùng
Mô tả một người dùng duy nhất.
Biểu diễn dưới dạng JSON |
---|
{ "email": string } |
Trường | |
---|---|
email |
Email của người dùng. |
Nhóm
Mô tả một Nhóm duy nhất.
Biểu diễn dưới dạng JSON |
---|
{ "email": string } |
Trường | |
---|---|
email |
Email nhóm. |
Gia đình
Loại này không có trường nào.
Mô tả một Gia đình duy nhất trên Google.
Phần
Nội dung của ghi chú.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường kết hợp Content . Nội dung của mục phải thuộc một trong các loại giá trị này. Content chỉ có thể là một trong những trạng thái sau đây: |
|
text |
Được dùng nếu nội dung của phần này là khối văn bản. Độ dài của nội dung văn bản phải dưới 20.000 ký tự. |
list |
Được dùng nếu nội dung của phần này là một danh sách. |
TextContent
Khối văn bản cho một mục văn bản hoặc mục trong danh sách.
Biểu diễn dưới dạng JSON |
---|
{ "text": string } |
Trường | |
---|---|
text |
Văn bản ghi chú. Giới hạn đối với việc này sẽ khác nhau tuỳ theo trường cụ thể sử dụng loại này. |
ListContent
Danh sách các mục của một ghi chú trong danh sách.
Biểu diễn dưới dạng JSON |
---|
{
"listItems": [
{
object ( |
Trường | |
---|---|
listItems[] |
Các mục trong danh sách. Số lượng mục phải dưới 1.000. |
ListItem
Một mục trong danh sách của một ghi chú.
Biểu diễn dưới dạng JSON |
---|
{ "childListItems": [ { object ( |
Trường | |
---|---|
childListItems[] |
Nếu được đặt, danh sách các mục danh sách được lồng trong mục danh sách này. Chỉ cho phép một cấp độ lồng nhau. |
text |
Văn bản của mục này. Độ dài phải dưới 1.000 ký tự. |
checked |
Mặt hàng này đã được đánh dấu hay chưa. |
Phương thức |
|
---|---|
|
Tạo một ghi chú mới. |
|
Xoá một ghi chú. |
|
Nhận được một ghi chú. |
|
Liệt kê các ghi chú. |