Method: notes.list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הצגת רשימה של הערות.
כל קריאה ל-list מחזירה דף תוצאות עם pageSize כגבול העליון של הפריטים המוחזרים. הערך pageSize של אפס מאפשר לשרת לבחור את הערך של הרף העליון.
התגובה ListNotesResponse מכילה עד pageSize רשומות. אם יש עוד פריטים שצריך להוסיף לרשימה, המערכת מספקת ערך nextPageToken. (אסור להציג טוקני דפים כערכים שקופים).
כדי לקבל את דף התוצאות הבא, מעתיקים את הערך של nextPageToken בתוצאה אל pageToken בבקשה הבאה. חוזרים על הפעולה עד שה-nextPageToken שהוחזר עם דף תוצאות יהיה ריק.
הפונקציה notes.list מחזירה תוצאות עקביות במקרה של שינויים בו-זמניים, או מסמנת שהיא לא יכולה לעשות זאת באמצעות שגיאת ABORTED.
בקשת HTTP
GET https://keep.googleapis.com/v1/notes
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
| פרמטרים |
pageSize |
integer
המספר המקסימלי של תוצאות להחזרה.
|
pageToken |
string
השדה nextPageToken בדף הקודם.
|
filter |
string
סינון תוצאות הרשימה. אם לא מציינים מסנן, המסנן trashed מוחל כברירת מחדל. השדות התקפים לסינון הם: createTime, updateTime, trashTime ו-trashed. תחביר המסנן עומד במפרט הסינון של Google AIP.
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התגובה שמופיעה כשמציגים דף של הערות.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
| ייצוג ב-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
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 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)."]]
