التنفيذ: التقسيم على صفحات

يوضّح المثال التالي كيفية استرداد مجموعات إضافية من النتائج لاستعلامات YouTube Data API (الإصدار 3).

تستخدِم واجهة برمجة التطبيقات المَعلمة maxResults للإشارة إلى عدد العناصر التي يجب تضمينها في استجابة واجهة برمجة التطبيقات. تتوافق هذه المَعلمة مع جميع طُرق list تقريبًا لواجهة برمجة التطبيقات (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

يحتوي ردّ واجهة برمجة التطبيقات على أوّل 10 مطابقات لطلب البحث بالإضافة إلى خاصيّة 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

ملاحظة: قد تحتاج إلى تعديل قيمة المَعلمة pageToken لإكمال هذا الطلب في "مستكشف واجهات برمجة التطبيقات". نفِّذ طلب البحث الذي يسترجع أوّل 10 نتائج للحصول على القيمة الصحيحة للمَعلمة pageToken.