בתיבת הדו-שיח הזו מופיעה רשימה של הערות.
כל קריאה לרשימה מחזירה דף תוצאות עם pageSize
כגבול העליון של פריטים שהוחזרו. הערך pageSize
של אפס מאפשר לשרת לבחור בגבול העליון.
ה-ListNotesResponse מכיל עד pageSize
רשומות. אם נשארו עוד דברים ברשימה, הוא יקבל ערך nextPageToken
. (אסימונים של דף הם ערכים אטומים).
כדי לקבל את דף התוצאות הבא, צריך להעתיק את nextPageToken
של התוצאה אל pageToken
של הבקשה הבאה. חוזרים על הפעולה עד שה-nextPageToken
שהוחזר עם דף תוצאות ריק.
הערות.list
בקשת HTTP
GET https://keep.googleapis.com/v1/notes
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
המספר המקסימלי של תוצאות שיש להחזיר. |
pageToken |
השדה |
filter |
סינון להצגת תוצאות הרשימה. אם לא תספקו מסנן, המסנן תחביר המסנן נקבע לפי מפרט הסינון של Google AIP. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
התשובה כשרושמים דף של הערות.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"notes": [
{
object ( |
שדות | |
---|---|
notes[] |
עמוד של הערות. |
nextPageToken |
השדה |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/keep
https://www.googleapis.com/auth/keep.readonly
מידע נוסף זמין במדריך להרשאות.