Resultados de búsqueda de páginas

En este tema, aprenderá cómo implementar la paginación para los resultados de las CMS API solicitudes, cuando la solicitud coincide con más elementos de los que puede devolver al mismo tiempo. Esto le permite manejar grandes conjuntos de resultados en grupos más pequeños, lo que mejora el rendimiento. Se devolverá un máximo de 100 registros desde una sola solicitud a la API de CMS, pero para conjuntos de resultados grandes, recomendamos obtener 25 elementos por solicitud para un mejor rendimiento.

Procedimiento

Para gestionar la paginación de datos, siga estos pasos:

Obtener un recuento del número total de registros en el conjunto de resultados.
Calcule el número de páginas para el conjunto de resultados.
Recorre y llame al CMS API para cada página de datos.

Obtener el recuento de registros

En primer lugar, debe saber el número total de vídeos en su conjunto de resultados. La respuesta en el conjunto de resultados variará en función de los criterios de búsqueda. Utilice el counts recurso para devolver un recuento total de registros del conjunto de resultados.

Ejemplo: Obtén el recuento total de vídeos en tu cuenta:

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

Respuesta:

    {
        "count" : 74
    }

También puede limitar el recuento utilizando el q parámetro opcional. Para obtener más información sobre el uso de criterios de búsqueda con este parámetro, consulte Using the CMS API: Buscar documento Vídeos.

Ejemplo: Aquí obtenemos el número de videos que tienen un valor de etiqueta de vida silvestre.

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

Respuesta:

    {
        "count" : 6
    }

Calcular páginas

Para calcular el número de páginas, tome el número total de registros del conjunto de resultados y divídalo por el número de registros por página (tamaño de página).

Puede establecer un tamaño de página fijo, o si está mostrando datos de vídeo en una página web, puede permitir que el usuario establezca dinámicamente el tamaño de la página (es decir, el número de objetos de datos de vídeo por página).

Ejemplo JavaScript:

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

Recuperar páginas

Recorra el número de páginas que calculó en el paso anterior y llame al CMS API con el limit y offset parámetros para recuperar subconjuntos sucesivos de datos.

En este ejemplo se devuelven 10 vídeos empezando por el video 21 del conjunto de resultados.

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

También puede incluir el q parámetro opcional. Para obtener más información sobre el uso de criterios de búsqueda con este parámetro, consulte Using the CMS API: Buscar documento Vídeos.

Esta solicitud devuelve 2 vídeos comenzando por el quinto vídeo del conjunto de resultados de vídeos que tienen un valor de etiqueta de vida silvestre.

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