Descripción general: API de distribución social

Error de mensajes

Si falla alguna solicitud de API, se devolverá un mensaje de error. Las respuestas de error tendrán el siguiente aspecto:

  [
    {
      "error_code" : "Application error code 1",
      "message" : "Application error message 1"
    }, {
      "error_code" : "Application error code 2",
      "message" : "Application error message 2"
    }
  ]

Crea una sindicación

Método: POST

Punto final: /accounts/{account_id}/mrss/syndications

Cuerpo de solicitud de muestra:

  {
    "name": "my mp4 feed",
    "type": "mp4"
  }

Tenga en cuenta que el name y type los campos son obligatorios. Otros son opcionales.

Actualizar una distribución

Método: PATCH

Punto final: /accounts/{account_id}/mrss/syndications/{syndication_id}

Cuerpo de solicitud de muestra:

  {
    "name": "my new name"
  }

Tenga en cuenta que el cuerpo de la solicitud para las solicitudes de PATCH debe no incluir los campos (type , id y syndication_url).

Eliminar una distribución

Método: DELETE

Punto final: /accounts/{account_id}/mrss/syndications/{syndication_id}

Obtenga todas las distribuciones para una cuenta

Método: GET

Punto final: /accounts/{account_id}/mrss/syndications

Obtenga una sindicación específica

Método: GET

Punto final: /accounts/{account_id}/mrss/syndications/{syndication_id}

Establecer la plantilla para una distribución universal

Método: PUT

Punto final: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Cuerpo de solicitud de muestra:

  <feed header>My Feed Header</feed header>
  

La plantilla anterior generaría un feed similar a:

  <feed header>My Feed Header</feed header>
    <item>
      <title>Title for Video 1</title>
      <video_info>Description for Video 1</video_info>
    </item>
    <item>
      <title>Title for Video 2</title>
      <video_info>Description for Video 2</video_info>
    </item>

Obtenga la plantilla para una distribución universal

Método: GET

Punto final: /accounts/{account_id}/mrss/syndications/{syndication_id}/template

Obtener el feed asociado con una distribución

La URL del feed se puede obtener de la distribución syndication_url campo, o construido manualmente. Tenga en cuenta que el API de feed de distribución también se puede utilizar para recuperar un feed sin autenticación.

Método: GET

Punto final: /accounts/{account_id}/mrss/syndications/{syndication_id}/feed

Propiedades de nivel superior

Derivado de los campos de distribución

• album_art_url
• author
• category
• description
• destination_url
• explicit
• keywords
• name
• owner_name
• owner_email
• subtitle
• syndication_id
• syndication_url
• title

ID de cuenta de Video Cloud

• account_id

Prefijo de URL de la página del reproductor predeterminado de VideoCloud

Úselo así:

  <media:player url="//default_default/index.html?videoId=">

• player_url

URL de la página siguiente del feed

• next_page

Colección de activos de video recuperados del catálogo (consulte los detalles a continuación)

• assets

Propiedades del activo

Los recursos de la colección de activos se derivan de los recursos de video devueltos por el método de API Obtener videos de CMS, y se admiten todas las mismas propiedades, incluidas, entre otras, las siguientes:

• created_at
• description
• duration
• id
• images
• images.thumbnail
• images.poster
• long_description
• name
• original_filename
• published_at
• schedule
• state
• tags
• text_tracks
• updated_at

Los recursos de activos también admiten las siguientes propiedades:

• sources(colección de fuentes para el video; consulte la siguiente sección para conocer las propiedades de las fuentes)
• digital_master(estará vacío si no existe ningún maestro digital; consulte a continuación las propiedades del maestro digital)
• best_mp4_source(la fuente MP4 de mayor calidad: puede estar vacía si no hay fuentes MP4. Las propiedades serán las mismas que los elementos devueltos en el sources)
• hls_source(devuelve la fuente de HLS; estará vacía si no existe)
• best_dynamic_rendition_quality(devuelve la calidad de video de la reproducción dinámica del video con el tamaño de fotograma más grande, si se han obtenido metadatos de reproducción dinámica para el video. Los valores permitidos son "SD", "HD", "FHD" y "UHD").

Propiedades de la fuente

Los recursos en la colección de fuentes para un activo se derivan de los recursos de fuente de video devueltos por el método de API Obtener fuentes de video de CMS. Se admiten las siguientes propiedades:

• app_name
• asset_id
• codec
• container
• created_at
• duration
• encoding_rate
• height
• size
• src
• stream_name
• type
• uploaded_at
• width

Propiedades maestras digitales

La digital_master El recurso para un activo se deriva del recurso maestro digital devuelto por el método de API Obtener información maestra digital de CMS. Se admiten las siguientes propiedades:

• duration
• encoding_rate
• height
• size
• url
• width

Propiedades de reproducción dinámica

La dynamic_renditions El recurso para un activo se deriva de las representaciones dinámicas devueltas por el método CMS Get Digital Master Info API. Se admiten las siguientes propiedades:

• rendition_id
• frame_height
• frame_width
• media_type
• encoding_rate
• created_at
• updated_at
• size
• duration
• audio_configuration
• language
• variant

Extensiones a Liquid

filtro TOUTC

Hemos ampliado nuestro analizador Liquid para admitir un filtro TOUTC que analizará la mayoría de los formatos de cadena de fecha y hora estándar ISO-8601 y los transformará en cadenas de fecha y hora UTC estándar. Este formato es aceptable para el filtro de fecha de Liquid, que luego se puede usar para reformatear las marcas de tiempo en cadenas de fecha y hora en cualquier formato deseado. Por ejemplo:

  <pubDate>{{asset.published_at | toUTC | date: "%a, %d %b %Y %H:%M:%S %Z"}}</pubDate>

Esto produce una salida como la siguiente si asset.published_at tiene un valor de 2019-08-09T13: 32: 52.031Z ::

  <pubDate>Fri, 09 Aug 2019 09:32:52 +0000</pubDate>

filtro toEpoch

El analizador Liquid que usamos no admite el token "% s" en los filtros de fecha para convertir fechas en marcas de tiempo de época de Unix. Para solucionar esto, se proporciona un filtro personalizado toEpoch que se puede utilizar para convertir especificaciones de fecha válidas al formato de época. El filtro devuelve un valor de datos numérico que representa milisegundos desde la época que es adecuado para ingresar a los filtros matemáticos. Por ejemplo:

  <toEpochMillis>{{"now" | toEpoch }}</toEpochMillis>
  <toEpochSeconds>{{"now" | toEpoch | divided_by : 1000 }}</toEpochSeconds>
  <thirtyDaysAgo>{{'now' | toEpoch | minus:2592000000 | fromEpoch }}</thirtyDaysAgo>

produce una salida como la siguiente:

  <toEpochMillis>1580917253024</toEpochMillis>
  <toEpochSeconds>1580917253</toEpochSeconds>
  <thirtyDaysAgo>2020-01-06T15:40:53.055Z</thirtyDaysAgo>

de filtro de época

El filtro fromEpoch convierte números que representan milisegundos desde la época en cadenas de fecha UTC. El filtro también aceptará una cadena que contenga los dígitos del valor de la época como entrada. La salida se puede pasar al filtro de fecha para reformatear si es necesario.

Por ejemplo:

  
  <fromEpochMillis>{{"now" | toEpoch | fromEpoch }}</fromEpochMillis>
  <thirtyDaysAgoAltFormat>{{1580917253024 | fromEpoch | date:"%Y-%m-%d" }}</thirtyDaysAgo>
  

produce una salida como la siguiente:

  
  <fromEpochMillis>2020-02-05T16:09:37.809Z</fromEpochMillis>
  <thirtyDaysAgoAltFormat>2020-02-05</thirtyDaysAgo>