Method: notes.list
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یادداشت ها را فهرست می کند.
هر فراخوانی فهرستی صفحه ای از نتایج را با pageSize به عنوان کران بالای آیتم های برگشتی برمی گرداند. pageSize صفر به سرور اجازه می دهد تا کران بالایی را انتخاب کند.
ListNotesResponse دارای بیشترین ورودی های pageSize است. اگر موارد بیشتری برای فهرست باقی مانده باشد، مقدار nextPageToken را ارائه می دهد. (توکن های صفحه مقادیری غیر شفاف هستند.)
برای دریافت صفحه بعدی نتایج، nextPageToken نتیجه را در pageToken درخواست بعدی کپی کنید. این کار را تا زمانی که nextPageToken بازگردانده شده با صفحه ای از نتایج خالی باشد، تکرار کنید.
notes.list در مواجهه با تغییرات همزمان، یا سیگنال هایی که نمی تواند با خطای ABORTED نتایج ثابتی را برگرداند.
درخواست HTTP
GET https://keep.googleapis.com/v1/notes
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای پرس و جو
| پارامترها |
|---|
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/keep -
https://www.googleapis.com/auth/keep.readonly
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],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)."]]
