Implementierung: Paginierung

Das folgende Beispiel zeigt, wie Sie zusätzliche Ergebnisse für YouTube Data API-Abfragen (Version 3) abrufen.

Die API verwendet den Parameter maxResults, um anzugeben, wie viele Elemente in einer API-Antwort enthalten sein sollen. Fast alle list-Methoden der API (videos.list, playlists.list usw.) unterstützen diesen Parameter.

Wenn für eine Abfrage zusätzliche Ergebnisse verfügbar sind, enthält die API-Antwort entweder das Attribut nextPageToken, das Attribut prevPageToken oder beides. Die Werte dieser Properties können dann verwendet werden, um den Parameter pageToken festzulegen, um eine zusätzliche Seite mit Ergebnissen abzurufen.

Mit der folgenden Abfrage werden beispielsweise Suchergebnisse für die zehn am häufigsten angesehenen Videos abgerufen:

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

Die API-Antwort enthält die ersten zehn Übereinstimmungen für die Abfrage sowie eine nextPageToken-Property, mit der die nächsten zehn Ergebnisse abgerufen werden können:

Die folgende Abfrage ruft die nächsten zehn Ergebnisse ab:

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

Hinweis: Möglicherweise müssen Sie den Wert des Parameters pageToken aktualisieren, um diese Anfrage im APIs Explorer abzuschließen. Führen Sie die Abfrage aus, mit der die ersten zehn Ergebnisse abgerufen werden, um den richtigen pageToken-Parameterwert zu erhalten.