REST Resource: notes

Tài nguyên: Lưu ý

Một ghi chú đơn lẻ.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "trashTime": string,
  "trashed": boolean,
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "title": string,
  "body": {
    object (Section)
  }
}
Trường
name

string

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

string (Timestamp format)

Chỉ có đầu ra. Thời điểm tạo ghi chú này.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Lần gần đây nhất ghi chú này được sửa đổi.
trashTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm ghi chú này được chuyển vào thùng rác. Nếu là trashed, ghi chú sẽ bị xoá. Nếu ghi chú không được chuyển vào thùng rác, thì trường này sẽ không được đặt (và trường thùng rác sẽ là false).
trashed

boolean

Chỉ có đầu ra. true nếu ghi chú này đã bị chuyển vào thùng rác. Nếu bị chuyển vào thùng rác, ghi chú sẽ bị xoá sau cùng.
attachments[]

object (Attachment)

Chỉ có đầu ra. Tệp đính kèm của ghi chú này.
permissions[]

object (Permission)

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

string

Tiêu đề của ghi chú. Độ dài phải dưới 1.000 ký tự.
body

object (Section)

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

string

Tên tài nguyên;
mimeType[]

string

Các 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 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 (Role),
  "email": string,
  "deleted": boolean,

  // Union field member can be only one of the following:
  "user": {
    object (User)
  },
  "group": {
    object (Group)
  },
  "family": {
    object (Family)
  }
  // End of list of possible types for union field member.
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên.
role

enum (Role)

Vai trò được cấp theo quyền này. Vai trò xác định khả năng của thực thể trong việc đọc, ghi và chia sẻ ghi chú.
email

string

Email liên kết với thành viên. Nếu được đặt khi tạo, trường email trong thông báo User hoặc Group phải để trống hoặc khớp với trường này. Khi đọc, có thể không được đặt nếu thành viên không có email được liên kết.
deleted

boolean

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 sẽ được đặt thành false và thành viên được khôi phục sẽ giữ lại vai trò trên ghi chú.
Trường hợp hợp nhất member. Chỉ định danh tính được cấp vai trò. Thành viên sẽ bị huỷ thiết lập nếu thành viên đó đã bị xoá. member chỉ có thể là một trong những giá trị sau:
user

object (User)

Chỉ có đầu ra. Người dùng được áp dụng vai trò này.
group

object (Group)

Chỉ có đầu ra. Nhóm áp dụng vai trò này.
family

object (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 mà một thực thể có thể có.

Enum
ROLE_UNSPECIFIED Vai trò không xác định.
OWNER Vai trò cấp toàn quyền truy cập. Bạn 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 đối với ghi chú.

Người dùng

Mô tả một người dùng.

Biểu diễn dưới dạng JSON 
{
  "email": string
}
Trường
email

string

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

string

Email của nhóm.

Gia đình

Loại này không có trường nào.

Mô tả một Nhóm gia đình trên Google.

Phần

Nội dung của ghi chú.

Biểu diễn dưới dạng JSON 
{

  // Union field Content can be only one of the following:
  "text": {
    object (TextContent)
  },
  "list": {
    object (ListContent)
  }
  // End of list of possible types for union field Content.
}
Trường
Trường hợp hợp nhất Content. Nội dung của mục này phải là một trong các loại giá trị sau. Content chỉ có thể là một trong những giá trị sau:
text

object (TextContent)

Được dùng nếu nội dung của phần này là một 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

object (ListContent)

Được dùng nếu nội dung của phần này là danh sách.

TextContent

Khối văn bản cho một mục danh sách hoặc phần văn bản.

Biểu diễn dưới dạng JSON 
{
  "text": string
}
Trường
text

string

Văn bản của ghi chú. Giới hạn về điều này thay đổi tuỳ theo trường cụ thể sử dụng loại này.

ListContent

Danh sách các mục cho một ghi chú dạng danh sách.

Biểu diễn dưới dạng JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Trường
listItems[]

object (ListItem)

Các mục trong danh sách. Số lượng mặt hàng phải ít hơn 1.000.

ListItem

Một mục danh sách trong danh sách của ghi chú.

Biểu diễn dưới dạng JSON 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
Trường
childListItems[]

object (ListItem)

Nếu được đặt, danh sách các mục danh sách lồng trong mục danh sách này. Chỉ được phép lồng một cấp.
text

object (TextContent)

Văn bản của mục này. Độ dài phải dưới 1.000 ký tự.
checked

boolean

Liệu mục này đã được đánh dấu hay chưa.

Phương thức

create

 Tạo một ghi chú mới.

delete

 Xoá ghi chú.

get

 Nhận ghi chú.

list

 Liệt kê ghi chú.