Method: notes.list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
แสดงรายการโน้ต
การเรียกใช้รายการทุกรายการจะแสดงผลลัพธ์ 1 หน้าโดยมี pageSize เป็นขีดจำกัดบนของรายการที่แสดง pageSize ที่เป็น 0 จะช่วยให้เซิร์ฟเวอร์เลือกขีดจำกัดบนได้
ListNotesResponse มีรายการได้สูงสุด pageSize รายการ หากยังมีรายการอื่นๆ เหลืออยู่ ระบบจะแสดงค่า nextPageToken (โทเค็นหน้าคือค่าแบบทึบ)
หากต้องการดูผลการค้นหาหน้าถัดไป ให้คัดลอก nextPageToken ของผลการค้นหาลงใน pageToken ของคําขอถัดไป ทำซ้ำจนกว่า nextPageToken ที่แสดงผลพร้อมกับหน้าผลการค้นหาจะว่างเปล่า
notes.list จะแสดงผลลัพธ์ที่สอดคล้องกันเมื่อเกิดการเปลี่ยนแปลงพร้อมกัน หรือจะแสดงสัญญาณว่าดำเนินการไม่ได้พร้อมข้อผิดพลาด "ยกเลิก"
คำขอ HTTP
GET https://keep.googleapis.com/v1/notes
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์การค้นหา
| พารามิเตอร์ |
pageSize |
integer
จำนวนผลลัพธ์สูงสุดที่จะแสดง
|
pageToken |
string
ช่อง nextPageToken ของหน้าก่อนหน้า
|
filter |
string
กรองผลการค้นหารายการ หากไม่ได้ระบุตัวกรอง ระบบจะใช้ตัวกรอง trashed โดยค่าเริ่มต้น ฟิลด์ที่ใช้กรองได้ ได้แก่ createTime, updateTime, trashTime และ trashed ไวยากรณ์ตัวกรองเป็นไปตามข้อกำหนดการกรอง AIP ของ Google
|
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
การตอบสนองเมื่อแสดงรายการโน้ต 1 หน้า
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
{
"notes": [
{
object (Note)
}
],
"nextPageToken": string
} |
| ช่อง |
notes[] |
object (Note)
หน้าโน้ต
|
nextPageToken |
string
ฟิลด์ pageToken ของหน้าถัดไป
|
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/keephttps://www.googleapis.com/auth/keep.readonly
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-25 UTC
[null,null,["อัปเดตล่าสุด 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)."]]
