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