Method: notes.list

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

تعرض كل طلب بيانات بالقائمة صفحة من النتائج تحتوي على pageSize كالحدّ الأقصى للعناصر التي يتم عرضها. تسمح القيمة pageSize على صفر للخادم باختيار الحد الأقصى.

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

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

Notes.list نتائج متسقة عند حدوث تغييرات متزامنة، أو إشارات إلى أنه لا يمكن إجراؤها مع خطأ تم إيقافه.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

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

المعلمات
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

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