Resultados de búsqueda de página

En este tema, aprenderá a implementar la paginación para los resultados de CMS API solicitudes, cuando la solicitud coincide con más elementos de los que puede devolver a la vez. 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 de 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 manejar la paginación de datos, deberá seguir estos pasos:

  • Obtenga un recuento del número total de registros en el conjunto de resultados.
  • Calcule el número de páginas de su conjunto de resultados.
  • Haz un bucle y llama al CMS API para cada página de datos.

Obtenga el recuento de registros

Primero, necesita saber la cantidad total de videos en su conjunto de resultados. La respuesta en el conjunto de resultados variará según sus criterios de búsqueda. Utilizar el counts recurso para devolver un recuento total de registros en su conjunto de resultados.

Ejemplo: Obtenga el recuento total de videos en su cuenta:

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

Respuesta:

    {
        "count" : 74
    }

También puede limitar el recuento utilizando el opcional q parámetro. Para obtener detalles sobre el uso de criterios de búsqueda con este parámetro, consulte la Usando la API de CMS: Buscar videos documento.

Ejemplo: Aquí obtenemos la cantidad de videos que tienen un valor de etiqueta de fauna 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 en su 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 video en una página web, puede permitir que el usuario establezca dinámicamente el tamaño de la página (es decir, número de objetos de datos de video por página).

Ejemplo de 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.

Este ejemplo devuelve 10 videos que comienzan con el video 21 en su conjunto de resultados.

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

También puede incluir el opcional q parámetro. Para obtener detalles sobre el uso de criterios de búsqueda con este parámetro, consulte la Usando la API de CMS: Buscar videos documento.

Esta solicitud devuelve dos videos, comenzando con el quinto video del conjunto de resultados de videos que tienen un valor de etiqueta de fauna silvestre.

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

Problemas conocidos

  • Resultados duplicados: en ciertos casos, algunos elementos de los resultados de la búsqueda pueden aparecer más de una vez.

    Solución alterna: para evitar resultados de búsqueda duplicados, utilice siempre un sort parámetro en sus solicitudes de búsqueda.