Triển khai: Phân trang

Ví dụ sau đây minh họa cách truy xuất tập hợp kết quả bổ sung cho truy vấn API dữ liệu YouTube (v3).

API sử dụng tham số maxResults để cho biết số lượng mục nên đưa vào phản hồi của API. Hầu hết phương thức list của API (videos.list, playlists.list, v.v.) đều hỗ trợ tham số đó.

Nếu có kết quả bổ sung cho một truy vấn, thì phản hồi API sẽ chứa một thuộc tính nextPageToken, một thuộc tính prevPageToken hoặc cả hai. Sau đó, bạn có thể dùng các giá trị của thuộc tính đó để đặt tham số pageToken nhằm truy xuất thêm một trang kết quả.

Ví dụ: cụm từ tìm kiếm sau đây sẽ truy xuất kết quả tìm kiếm về 10 video được xem nhiều nhất khớp với cụm từ tìm kiếm "chó trượt ván":

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

Phản hồi API chứa 10 kết quả phù hợp đầu tiên cho truy vấn cũng như một thuộc tính nextPageToken có thể dùng để truy xuất 10 kết quả tiếp theo:

Truy vấn dưới đây truy xuất 10 kết quả tiếp theo cho truy vấn:

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

Lưu ý: Bạn có thể cần cập nhật giá trị của tham số pageToken để hoàn tất yêu cầu này trong APIs Explorer. Thực thi truy vấn truy xuất 10 kết quả đầu tiên để lấy đúng giá trị tham số pageToken.