Administrar listas de reproducción con la API de CMS

Introducción

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

• Crea una lista de reproducción
• Actualizar una lista de reproducción
• Eliminar una lista de reproducción

Autenticación

Solicitudes al CMS API requieren un encabezado de autorización que contenga sus tokens de acceso. Para obtener detalles sobre cómo obtener credenciales de cliente y usarlas para recuperar tokens de acceso, consulte la Descripción general de Brightcove OAuth.

Tipos de listas de reproducción

Hay uno EXPLICIT (manual) tipo de lista de reproducción para la que especificas los videos que se incluirán como una matriz de ID de video. También hay siete tipos de listas de reproducción inteligentes: los tipos de listas de reproducción inteligentes difieren en la forma en que ordenan un conjunto de videos 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 videos se ensambla dinámicamente según el search valor de campo para la lista de reproducción. El valor del campo de búsqueda debe ser un valor de cadena de búsqueda válido para la API de CMS. Esta validación depende de la search_syntax valor (ya sea v1 [predeterminado] o v2 ) configurado para la lista de reproducción; Las listas de reproducción v2 permitirán sintaxis de búsqueda v2 , mientras que las listas de reproducción v1 solo aceptarán cadenas de búsqueda de etiquetas. A continuación se muestran algunos ejemplos con explicaciones de los videos que devolverán.

Obtener videos en una lista de reproducción

Puede obtener un recuento de los videos en una lista de reproducción (ya sea inteligente o manual) usando el counts punto final:

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

Puede recuperar los videos mismos usando un Obtener videos en la lista de reproducción pedido. Tenga en cuenta que se pueden devolver un máximo de 100 videos para una solicitud, por lo que para obtener más de 100, deberá paginar los resultados usando el limit y offset parámetros Por ejemplo, para obtener los segundos 100, usaría:

Crea una lista de reproducción

Para crear una nueva lista de reproducción, crea una POST solicitud de:

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

Cuerpo de la solicitud

Puede incluir muchos (¡pero no todos!) De los campos de metadatos de video en su solicitud. Tú deber incluir al menos un name y type para la lista de reproducción. A continuación, se muestran dos ejemplos: uno crea una lista de reproducción EXPLÍCITA y el segundo crea una lista de reproducción inteligente del tipo ACTIVATED_NEWEST_TO_OLDEST, que incluye videos que tienen dos etiquetas:

Para una lista de reproducción EXPLÍCITA

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

Para la lista de reproducción inteligente v1

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

Para la lista de reproducción inteligente v2

{ 
  "type": "ACTIVATED_NEWEST_TO_OLDEST", 
  "name": "My smart playlist", 
  "search": "+name:bird", 
  "search_syntax": "v2" 
}

Ver el Referencia de API para todos los campos que se pueden utilizar para crear 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 la identificación de la lista de reproducción adjunta a la URL. Los campos del cuerpo de la solicitud son exactamente los mismos.

Solicitar URL

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

Encuentre los detalles completos en el Referencia de API.

Eliminar una lista de reproducción

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

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

(Esta es la misma URL que se usa para actualizar una lista de reproducción).

Encuentre los detalles completos en el Referencia de API.