אפשר לקבוע את המספר המקסימלי של המשאבים שהשרת יחזיר בתגובה לבקשת רשימה על ידי הגדרת השדה 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