Résultats de la recherche de pages

Dans cette rubrique, vous apprendrez comment implémenter la pagination pour les résultats des CMS API demandes, lorsque la demande correspond à plus d'éléments que vous ne pouvez renvoyer en même temps. Cela vous permet de gérer de grands ensembles de résultats dans des groupes plus petits, ce qui améliore les performances. Un maximum de 100 enregistrements seront renvoyés à partir d'une seule demande à l'API CMS, mais pour les grands ensembles de résultats, nous vous recommandons de récupérer 25 éléments par demande pour de meilleures performances.

Procédure

Pour gérer la pagination des données, vous suivrez ces étapes :

  • Obtenez un décompte du nombre total d'enregistrements dans l'ensemble de résultats.
  • Calculez le nombre de pages de votre ensemble de résultats.
  • Bouclez et appelez le CMS API pour chaque page de données.

Obtenez le nombre d'enregistrements

Tout d'abord, vous devez connaître le nombre total de vidéos dans votre ensemble de résultats. La réponse dans le jeu de résultats variera en fonction de vos critères de recherche. Utilisez le counts ressource pour renvoyer un nombre total d'enregistrements dans votre ensemble de résultats.

Exemple : Obtenez le nombre total de vidéos dans votre compte :

    https://cms.api.brightcove.com/v1/accounts/921483702001/counts/videos

Réponse:

    {
        "count" : 74
    }

Vous pouvez également limiter le nombre en utilisant l'option q paramètre. Pour plus d'informations sur l'utilisation des critères de recherche avec ce paramètre, consultez le Utilisation de l'API CMS : Rechercher des vidéos document.

Exemple : Ici, nous obtenons le nombre de vidéos qui ont une valeur de balise de faune.

    https://cms.api.brightcove.com/v1/accounts/921483702001/counts/videos?q=tags:wildlife

Réponse:

    {
        "count" : 6
    }

Calculer les pages

Pour calculer le nombre de pages, prenez le nombre total d'enregistrements dans votre ensemble de résultats et divisez-le par le nombre d'enregistrements par page (taille de la page).

Vous pouvez définir une taille de page fixe, ou si vous affichez des données vidéo sur une page Web, vous pouvez laisser l'utilisateur définir dynamiquement la taille de la page (c'est-à-dire le nombre d'objets de données vidéo par page).

Exemple JavaScript :

    var numberOfPages = Math.ceil(jsonData.count / pageSize);

Récupérer des pages

Parcourez le nombre de pages que vous avez calculé à l'étape précédente et appelez le CMS API avec le limit et offset paramètres pour récupérer des sous-ensembles successifs de données.

Cet exemple renvoie 10 vidéos en commençant par la 21e vidéo de votre ensemble de résultats.

    https://cms.api.brightcove.com/v1/accounts/921483702001/videos?limit=10&offset=20

Vous pouvez également inclure l'option q paramètre. Pour plus d'informations sur l'utilisation des critères de recherche avec ce paramètre, consultez le Utilisation de l'API CMS : Rechercher des vidéos document.

Cette demande renvoie 2 vidéos en commençant par la 5e vidéo de l'ensemble de résultats de vidéos dont la valeur de balise est faune.

    https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q=tags:wildlife&limit=2&offset=4

Problèmes connus

  • Résultats en double : dans certains cas, certains éléments des résultats de la recherche peuvent apparaître plusieurs fois.

    Solution de contournement: pour éviter les résultats de recherche en double, utilisez toujours un sort paramètre dans vos requêtes de recherche.