אפשר לקבוע את המספר המקסימלי של המשאבים שהשרת מחזיר בתגובה לבקשת רשימה על ידי הגדרת השדה maxResults
. בנוסף, בחלק מהאוספים (כמו 'אירועים') יש מגבלה קשיחה על מספר הרשומות המאוחזרות שהשרת לא יחרוג אף פעם. אם המספר הכולל של האירועים חורג מהמקסימום הזה, השרת מחזיר דף אחד של תוצאות.
חשוב לזכור שהפרמטר maxResults
לא מבטיח את מספר התוצאות בדף אחד.
אם רוצים לזהות תוצאות חלקיות, צריך למלא שדה nextPageToken
שאינו ריק בתוצאה. כדי לאחזר את הדף הבא, מבצעים את אותה בקשה בדיוק כמו קודם ומצרפים שדה pageToken
עם הערך nextPageToken
מהדף הקודם. בדפים הבאים יש nextPageToken
חדש, עד אחזור כל התוצאות.
לדוגמה, הנה שאילתה ואחריה השאילתה לאחזור דף התוצאות הבא ברשימה מחולקת:
GET /calendars/primary/events?maxResults=10&singleEvents=true
//Result contains
"nextPageToken":"CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA",
השאילתה הבאה לוקחת את הערך מ-nextPageToken
ושולחת אותו כערך של pageToken
:
GET /calendars/primary/events?maxResults=10&singleEvents=true&pageToken=CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA