Method: notes.list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
يعرض الملاحظات.
تُرجِع كلّ طلب قائمة صفحة من النتائج مع pageSize كحدّ أقصى للعناصر المعروضة. يسمح القيمة pageSize بقيمة صفر للخادم باختيار الحد الأقصى.
يحتوي ListNotesResponse على pageSize إدخال بحد أقصى. إذا كان هناك المزيد من العناصر التي يجب إدراجها، يتم عرض القيمة nextPageToken. (الرموز المميّزة للصفحات هي قيم غير شفافة).
للحصول على الصفحة التالية من النتائج، انسخ nextPageToken للنتيجة إلى pageToken للطلب التالي. كرِّر الإجراء إلى أن يصبح nextPageToken الذي تم إرجاعه مع صفحة من النتائج فارغًا.
تُظهر دالة notes.list نتائج متسقة في حال حدوث تغييرات متزامنة، أو تشير إلى أنّها لا يمكنها ذلك من خلال عرض خطأ ABORTED.
طلب HTTP
GET https://keep.googleapis.com/v1/notes
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات طلب البحث
| المعلمات |
pageSize |
integer
الحد الأقصى لعدد النتائج التي سيتم عرضها
|
pageToken |
string
حقل nextPageToken في الصفحة السابقة
|
filter |
string
فلترة نتائج القائمة في حال عدم تقديم أي فلتر، يتم تطبيق الفلتر trashed تلقائيًا. الحقول الصالحة للفلترة حسبها هي: createTime وupdateTime وtrashTime وtrashed. تتّبع بنية الفلتر مواصفات فلترة "الوصول الواعي بالسياق" من Google.
|
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
الاستجابة عند إدراج صفحة من الملاحظات
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل 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 (حسب التوقيت العالمي المتفَّق عليه)
[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)."]]
