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

Introducción

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:

• Crear una lista de reproducción
• Actualizar una lista de reproducción
• Eliminar una lista 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.

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.

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.

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.