Method: notes.list

הצגת רשימה של הערות.

כל קריאה ל-list מחזירה דף תוצאות עם pageSize כגבול העליון של הפריטים המוחזרים. הערך pageSize של אפס מאפשר לשרת לבחור את הערך של הרף העליון.

התגובה ListNotesResponse מכילה עד pageSize רשומות. אם יש עוד פריטים שצריך להוסיף לרשימה, המערכת מספקת ערך nextPageToken. (אסור להציג טוקני דפים כערכים שקופים).

כדי לקבל את דף התוצאות הבא, מעתיקים את הערך של nextPageToken בתוצאה אל pageToken בבקשה הבאה. חוזרים על הפעולה עד שה-nextPageToken שהוחזר עם דף תוצאות יהיה ריק.

הפונקציה notes.list מחזירה תוצאות עקביות במקרה של שינויים בו-זמניים, או מסמנת שהיא לא יכולה לעשות זאת באמצעות שגיאת ABORTED.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של שאילתה

פרמטרים
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

מידע נוסף זמין במדריך ההרשאות.