پیاده‌سازی: صفحه‌بندی

مثال زیر نشان می‌دهد که چگونه مجموعه‌های اضافی نتایج را برای پُرسمان‌های YouTube Data API (v3) بازیابی کنید.

این API از پارامتر maxResults برای نشان دادن تعداد مواردی که باید در پاسخ API گنجانده شود استفاده می‌کند. تقریباً همه روش‌های list API (‏videos.list،‏ playlists.list، و غیره) از این پارامتر پشتیبانی می‌کنند.

اگر نتایج بیشتری برای پُرسمان دردسترس باشد، پاسخ میانای برنامه‌سازی کاربردی حاوی ویژگی nextPageToken، ویژگی prevPageToken، یا هر دو خواهد بود. سپس می‌توان از مقادیر آن ویژگی‌ها برای تنظیم پارامتر pageToken جهت بازیابی صفحه دیگری از نتایج استفاده کرد.

برای مثال، پرسمان زیر نتایج جستجو را برای ۱۰ ویدیو پربازدید منطبق با پرسمان «سگ اسکیت‌سوار» بازیابی می‌کند:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.search.list?
        part=snippet
        &maxResults=10
        &order=viewCount
        &q=skateboarding+dog
        &type=video

پاسخ API شامل ۱۰ مورد اول منطبق با پرسمان و همچنین دارایی nextPageToken است که می‌توان از آن برای بازیابی ۱۰ نتیجه بعدی استفاده کرد:

پُرسمان زیر ۱۰ نتیجه بعدی را برای این پُرسمان بازیابی می‌کند:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.search.list?
        part=snippet
        &maxResults=10
        &order=viewCount
        &pageToken=CAoQAA
        &q=skateboarding+dog
        &type=video

توجه: برای تکمیل این درخواست در APIs Explorer، ممکن است لازم باشد مقدار پارامتر pageToken را به‌روز کنید. پُرسمانی را که ۱۰ نتیجه اول را بازیابی می‌کند اجرا کنید تا مقدار پارامتر pageToken صحیح را به‌دست آورید.