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.

התחביר של המסנן תואם למפרט הסינון של 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

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