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

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

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

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

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

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

پاسخ API شامل 10 تطبیق اول برای پرس و جو و همچنین ویژگی nextPageToken است که می تواند برای بازیابی 10 نتیجه بعدی استفاده شود:

پرس و جو زیر 10 نتیجه بعدی را برای پرس و جو بازیابی می کند:

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

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