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/keep
  • https://www.googleapis.com/auth/keep.readonly

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