Method: notes.list

يسرد الملاحظات.

تؤدي كل مكالمة قائمة إلى عرض صفحة نتائج تتضمّن pageSize كحدّ أقصى للعناصر المعروضة. إذا كانت قيمة pageSize صفرًا، يصبح بإمكان الخادم اختيار الحد العلوي.

تحتوي ListNotesResponse على pageSize إدخال كحدّ أقصى. في حال إضافة المزيد من العناصر إلى القائمة، يتم توفير قيمة nextPageToken. (الرموز المميزة للصفحة هي قيم مبهمة).

للحصول على الصفحة التالية من النتائج، انسخ nextPageToken الخاصة بالنتيجة إلى pageToken في الطلب التالي. كرِّر هذه السياسة إلى أن يتم عرض صفحة nextPageToken من النتائج فارغة.

تعرض Notes.list نتائج متسقة في مواجهة التغييرات المتزامنة أو إشارات لا يمكن أن تظهر مع خطأ ABORTED.

طلب HTTP

GET https://keep.googleapis.com/v1/notes

يستخدم عنوان URL بنية gRPC Transcode.

معامِلات طلب البحث

المَعلمات
pageSize

integer

الحد الأقصى لعدد النتائج المطلوب عرضها.

pageToken

string

الحقل nextPageToken في الصفحة السابقة.

filter

string

فلتر نتائج القائمة وفي حال عدم توفير أي فلتر، يتم تطبيق فلتر trashed تلقائيًا. الحقول الصالحة للفلترة حسب: createTime وupdateTime وtrashTime وtrashed.

تتبع بنية الفلتر مواصفات فلترة AIP في Google.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

الإجابة عند إدراج صفحة من الملاحظات.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل 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

لمزيد من المعلومات، اطّلِع على دليل التفويض.