Implementacja: podział na strony

Ten przykład pokazuje, jak pobierać dodatkowe zestawy wyników w przypadku zapytań do interfejsu YouTube Data API (w wersji 3).

Interfejs API używa parametru maxResults, aby określić, ile elementów ma się znaleźć w odpowiedzi. Ten parametr jest obsługiwany przez prawie wszystkie metody interfejsu API list (videos.list, playlists.list itp.).

Jeśli w przypadku zapytania dostępne są dodatkowe wyniki, odpowiedź interfejsu API będzie zawierać usługę nextPageToken, usługę prevPageToken lub obie te usługi. Wartości tych właściwości można następnie wykorzystać do ustawienia parametru pageToken, aby pobrać kolejną stronę wyników.

Na przykład to zapytanie zwraca wyniki wyszukiwania 10 najbardziej oglądanych filmów pasujących do zapytania „skateboarding dog”:

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

Odpowiedź interfejsu API zawiera pierwsze 10 pasujących do zapytania wyników oraz właściwość nextPageToken, której można użyć do pobrania kolejnych 10 wyników:

Zapytanie poniżej zwraca 10 kolejnych wyników zapytania:

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

Uwaga: aby wykonać to żądanie w narzędzie APIs Explorer, konieczne może być zaktualizowanie wartości parametru pageToken. Aby uzyskać prawidłową wartość parametru pageToken, wykonaj zapytanie, które zwróci pierwsze 10 wyników.