soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Administración de listas de reproducción mediante la API de CMS

    En este tema se describe cómo crear, actualizar o eliminar listas de reproducción mediante la API de CMS.

    Introducción

    Lista de reproducción de muestra

    Las listas de reproducción permiten agrupar un conjunto de vídeos relacionados para que puedan cargarse en un reproductor y verse como grupo. El CMS API contiene un conjunto de métodos de escritura que puede utilizar para crear, actualizar o eliminar listas de reproducción:

    Autenticación

    Las solicitudes a la requieren un encabezado de autorización que contenga sus tokens de acceso.CMS API Para obtener información detallada sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la descripción general de OAuth de Brightcove.

    GET listas de reproducción

    Antes de empezar a crear listas de reproducción, veamos cómo podemos recuperar los datos de las listas de reproducción existentes en su cuenta de Video Cloud.

    Solicitud

        https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists

    Respuesta

    (Configuramos el limit en esta solicitud 1 para mantener la respuesta pequeña.)

        [
          {
            "id": "5282200243001",
            "account_id": "1752604059001",
            "created_at": "2017-01-15T15:30:09.847Z",
            "description": "Do not delete",
            "favorite": true,
            "name": "Playlist for Alltime Views Sample",
            "reference_id": null,
            "type": "EXPLICIT",
            "updated_at": "2017-01-15T17:49:07.633Z",
            "video_ids": [
              "4825279519001",
              "4845831078001",
              "4825296720001",
              "4454620115001",
              "5141730843001",
              "4793962133001",
              "4454620113001",
              "4511340777001",
              "5045678909001"
            ]
          }
        ]

    Tipos de listas de reproducción

    Hay un tipo de lista de reproducción EXPLICIT (manual) para el que se especifican los vídeos que se incluirán como una matriz de identificadores de vídeo. También hay siete tipos de listas de reproducción inteligentes: los tipos de listas de reproducción inteligentes difieren en cómo ordenan un conjunto de vídeos que se seleccionan dinámicamente mediante una cadena de búsqueda. La siguiente tabla muestra todos los tipos de listas de reproducción.

    Tipos de listas de reproducción
    Tipo Descripción
    EXPLICIT Una lista de reproducción manual. Los vídeos incluidos y el orden de su aparición están definidos por una matriz de identificadores de vídeo.
    ACTIVATED_OLDEST_TO_NEWEST Una lista de reproducción inteligente en la que los vídeos seleccionados se ordenan por fecha de activación (ascendente).
    ACTIVATED_NEWEST_TO_OLDEST Una lista de reproducción inteligente en la que los vídeos seleccionados se ordenan por fecha de activación (descendente).
    ALPHABETICAL Lista de reproducción inteligente en la que los vídeos seleccionados se presentan en orden alfabético por nombre.
    PLAYS_TOTAL Una lista de reproducción inteligente en la que los vídeos seleccionados se ordenan por el número de reproducciones de todos los tiempos (descendente).
    PLAYS_TRAILING_WEEK Una lista de reproducción inteligente en la que los vídeos seleccionados se ordenan por el número de reproducciones de la semana anterior (descendente).
    START_DATE_OLDEST_TO_NEWEST Una lista de reproducción inteligente en la que los vídeos seleccionados se ordenan por la fecha de inicio programada (ascendente).
    START_DATE_NEWEST_TO_OLDEST Una lista de reproducción inteligente en la que los vídeos seleccionados se ordenan por la fecha de inicio programada (descendente).

    Campo de búsqueda

    Para todos los tipos de listas de reproducción inteligentes, la colección de vídeos se monta dinámicamente en función del valor del search campo de la lista de reproducción. El valor del campo de búsqueda debe ser una cadena de búsqueda válida para una cadena de búsqueda de etiquetas para la API de CMS. A continuación se muestran algunos ejemplos con explicaciones de los vídeos que devolverán.

    Cadenas de búsqueda de ejemplo
    Cadena de búsqueda Descripción
    +tags:bird Devuelve vídeos que tienen la etiqueta «pájaro»
    +tags:bird,woodland Devuelve vídeos que tienen las etiquetas «pájaro» y «bosque»
    tags:bird,woodland Devuelve vídeos que tienen cualquiera de las etiquetas «pájaro» o «bosque» (nota: dejar el + signo fuera de la cadena de búsqueda hace la diferencia)

    Obtener el recuento de vídeos

    Puede obtener un recuento de los vídeos de una lista de reproducción (ya sea inteligente o manual) utilizando el counts punto final:

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos

    Crear listas de reproducción

    Para crear una nueva lista de reproducción, debe realizar una POST solicitud para:

        https://cms.api.brightcove.com/v1/accounts/{account_id}/playlists

    Cuerpo de solicitud

    Puede incluir muchos (¡pero no todos!) de los campos de metadatos de vídeo de su solicitud. Debe incluir al menos un name y type para la lista de reproducción. A continuación se presentan dos ejemplos, uno creando una lista de reproducción EXPLÍCITA y el segundo crear una lista de reproducción inteligente de tipo ACTIVATED_NEWEST_TO_ANTIGUO, incluidos los vídeos que tienen dos etiquetas:

    Para lista de reproducción EXPLÍCITA

        {
          "type": "EXPLICIT",
          "name": "My manual playlist",
          "video_ids": [
            "5289680419001",
            "5289693763001",
            "5289680417001",
            "5288472314001"
          ]
        }

    Para lista de reproducción inteligente

        {
          "type": "ACTIVATED_NEWEST_TO_OLDEST",
          "name": "My smart playlist",
          "search": "+tags:bird-tags:sea"
        }

    Consulte la API Reference para ver todos los campos que se pueden utilizar en la creación de listas de reproducción.

    Actualizar una lista de reproducción

    Actualizar una lista de reproducción es muy similar a crear una. Las únicas diferencias son el método de solicitud ( PATCH en lugar de POST) y el id de la lista de reproducción anexado a la URL. Los campos para el cuerpo de la solicitud son exactamente los mismos.

    URL de solicitud

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id

    Encuentre los detalles completos en la API Reference.

    Eliminar listas de reproducción

    Para eliminar una lista de reproducción, realice una solicitud utilizando el DELETE método para:

        https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id

    (Ésta es la misma URL utilizada para actualizar una lista de reproducción).

    Encuentre los detalles completos en la API Reference.


    Última actualización de la página el 28-09-2020