Method: notes.list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Liệt kê ghi chú.
Mỗi lệnh gọi danh sách sẽ trả về một trang kết quả với pageSize
là giới hạn trên của các mục được trả về. pageSize
bằng 0 cho phép máy chủ chọn giới hạn trên.
ListNotesResponse chứa tối đa pageSize
mục nhập. Nếu còn nhiều nội dung cần liệt kê, thì hàm này sẽ cung cấp giá trị nextPageToken
. (Mã thông báo trang là các giá trị mờ.)
Để nhận trang kết quả tiếp theo, hãy sao chép nextPageToken
của kết quả vào pageToken
của yêu cầu tiếp theo. Lặp lại cho đến khi nextPageToken
trả về một trang kết quả trống.
notes.list trả về kết quả nhất quán khi gặp các thay đổi đồng thời hoặc báo hiệu rằng không thể trả về kết quả với lỗi ABORTED.
Yêu cầu HTTP
GET https://keep.googleapis.com/v1/notes
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số truy vấn
Thông số |
pageSize |
integer
Số kết quả tối đa cần trả về.
|
pageToken |
string
Trường nextPageToken của trang trước.
|
filter |
string
Lọc kết quả danh sách. Nếu bạn không cung cấp bộ lọc nào, thì bộ lọc trashed sẽ được áp dụng theo mặc định. Các trường hợp lệ để lọc là: createTime , updateTime , trashTime và trashed . Cú pháp bộ lọc tuân theo thông số kỹ thuật lọc AIP của Google.
|
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Phản hồi khi liệt kê một trang ghi chú.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
Biểu diễn dưới dạng JSON |
{
"notes": [
{
object (Note )
}
],
"nextPageToken": string
} |
Trường |
notes[] |
object (Note )
Một trang ghi chú.
|
nextPageToken |
string
Trường pageToken của trang tiếp theo.
|
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau:
https://www.googleapis.com/auth/keep
https://www.googleapis.com/auth/keep.readonly
Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[],[],null,["# Method: notes.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListNotesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nLists notes.\n\nEvery list call returns a page of results with `pageSize` as the upper bound of returned items. A `pageSize` of zero allows the server to choose the upper bound.\n\nThe ListNotesResponse contains at most `pageSize` entries. If there are more things left to list, it provides a `nextPageToken` value. (Page tokens are opaque values.)\n\nTo get the next page of results, copy the result's `nextPageToken` into the next request's `pageToken`. Repeat until the `nextPageToken` returned with a page of results is empty.\n\nnotes.list return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.\n\n### HTTP request\n\n`GET https://keep.googleapis.com/v1/notes`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of results to return. |\n| `pageToken` | `string` The previous page's `nextPageToken` field. |\n| `filter` | `string` Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `createTime`, `updateTime`, `trashTime`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response when listing a page of notes.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------|\n| ``` { \"notes\": [ { object (/workspace/keep/api/reference/rest/v1/notes#Note) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------|\n| `notes[]` | `object (`[Note](/workspace/keep/api/reference/rest/v1/notes#Note)`)` A page of notes. |\n| `nextPageToken` | `string` Next page's `pageToken` field. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/keep`\n- `https://www.googleapis.com/auth/keep.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]