Method: notes.list
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Wyświetla listę notatek.
Każde wywołanie listy zwraca stronę wyników z pageSize jako górną granicą zwracanych elementów. Wartość pageSize równa 0 pozwala serwerowi wybrać górną granicę.
Odpowiedź ListNotesResponse zawiera maksymalnie pageSize wpisów. Jeśli pozostało jeszcze więcej elementów do wylistowania, wartość nextPageToken jest podana. (tokeny strony to wartości nieprzezroczyste).
Aby uzyskać kolejną stronę wyników, skopiuj nextPageToken z wyników do pageToken w następnym żądaniu. Powtarzaj, aż nextPageToken zwróci pustą stronę wyników.
notes.list zwraca spójne wyniki w przypadku jednoczesnych zmian lub sygnalizuje, że nie może tego zrobić, wyświetlając błąd ABORTED.
Żądanie HTTP
GET https://keep.googleapis.com/v1/notes
Adres URL używa składni transkodowania gRPC.
Parametry zapytania
| Parametry |
pageSize |
integer
Maksymalna liczba wyników do zwrócenia.
|
pageToken |
string
Pole nextPageToken na poprzedniej stronie.
|
filter |
string
Filtrowanie wyników listy. Jeśli nie podasz filtra, domyślnie zostanie zastosowany filtr trashed. Dozwolone pola do filtrowania to: createTime, updateTime, trashTime i trashed. Składnia filtra jest zgodna ze specyfikacją filtrowania AIP Google.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź podczas wyświetlania strony z notatkami.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"notes": [
{
object (Note)
}
],
"nextPageToken": string
} |
| Pola |
notes[] |
object (Note)
strona z notatkami,
|
nextPageToken |
string
Pole pageToken na następnej stronie.
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/keephttps://www.googleapis.com/auth/keep.readonly
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]
