soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema

Gestionando listas de reproducción usando CMS API

Este tema describe cómo crear, actualizar o eliminar listas de reproducción utilizando el CMS API.

Introducción

Lista de reproducción de muestra

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

Autenticación

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

GET listas de reproducción

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

Solicitar

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

Respuesta

(Establecemos el limit en esta solicitud a 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 lista de reproducción

Hay uno EXPLICIT Tipo de lista de reproducción (manual) para la que especifica los videos que se incluirán como una serie de ID de video. También hay siete tipos de listas de reproducción inteligentes: los tipos de lista de reproducción inteligente 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.

Tipos de lista de reproducción
Tipo Descripción
EXPLICIT Una lista de reproducción manual. Los videos incluidos y el orden de su apariencia están definidos por una serie de identificadores de video.
ACTIVATED_OLDEST_TO_NEWEST Una lista de reproducción inteligente en la que los videos seleccionados se ordenan por fecha de activación (ascendente).
ACTIVATED_NEWEST_TO_OLDEST Una lista de reproducción inteligente en la que los videos seleccionados se ordenan por fecha de activación (descendente).
ALPHABETICAL Una lista de reproducción inteligente en la que los videos seleccionados se presentan en orden alfabético por nombre.
PLAYS_TOTAL Una lista de reproducción inteligente en la que los videos 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 videos seleccionados se ordenan por el número de reproducciones de la semana anterior (descendiendo).
START_DATE_OLDEST_TO_NEWEST Una lista de reproducción inteligente en la que los videos seleccionados se ordenan según la fecha de inicio programada (ascendente).
START_DATE_NEWEST_TO_OLDEST Una lista de reproducción inteligente en la que los videos seleccionados se ordenan según la fecha de inicio programada (descendente).

Campo de búsqueda

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

Cadenas de búsqueda de muestra
Cadena de búsqueda Descripción
+tags:bird Devuelve videos que tienen la etiqueta "pájaro"
+tags:bird,woodland Devuelve videos que tienen las etiquetas "pájaro" y "bosque"
tags:bird,woodland Devuelve videos que tienen ya sea de las etiquetas "pájaro" o "bosque" (nota: salir de + cerrar la sesión de la cadena de búsqueda hace la diferencia)

Obtén el recuento de videos

Puede obtener un recuento de los videos en 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 una lista de reproducción

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

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

Solicitar cuerpo

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

Para la lista de reproducción EXPLICIT

    {
      "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"
    }

ver el Referencia de la API para todos los campos que pueden usarse para crear listas de reproducción.

Actualiza una lista de reproducción

La actualización de una lista de reproducción es muy similar a la creación de 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 anexada a la URL. Los campos para el cuerpo de solicitud son exactamente los mismos.

URL de solicitud

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

Encuentra los detalles completos en Referencia de la API.

Eliminar una lista de reproducción

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

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

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

Encuentra los detalles completos en Referencia de la API.


Página actualizada por última vez el 27 jun 2020