Mise en œuvre: pagination

L'exemple suivant montre comment extraire des ensembles de résultats supplémentaires pour les requêtes de l'API YouTube Data (v3).

L'API utilise le paramètre maxResults pour indiquer le nombre d'éléments à inclure dans une réponse d'API. Presque toutes les méthodes list de l'API (videos.list, playlists.list, etc.) sont compatibles avec ce paramètre.

Si des résultats supplémentaires sont disponibles pour une requête, la réponse de l'API contient soit une propriété nextPageToken, soit une propriété prevPageToken, soit les deux. Les valeurs de ces propriétés peuvent ensuite être utilisées pour définir le paramètre pageToken afin d'extraire une page de résultats supplémentaire.

Par exemple, la requête suivante récupère les résultats des 10 vidéos les plus regardées correspondant à la requête "skateboarding" :

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

La réponse de l'API contient les 10 premières correspondances de la requête, ainsi qu'une propriété nextPageToken permettant de récupérer les 10 résultats suivants:

La requête ci-dessous récupère les 10 résultats suivants:

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

Remarque:Vous devrez peut-être mettre à jour la valeur du paramètre pageToken pour terminer cette requête dans APIs Explorer. Exécutez la requête qui récupère les 10 premiers résultats pour obtenir la valeur correcte du paramètre pageToken.