XML - metadatos de clips de formato corto
Referencia de campos XML para la entrega de clips.
Descripción general
Usa esta referencia para preparar los metadatos XML de clips de formato corto, ya sean independientes o relacionados con otro programa. Consulta las Definiciones de tipo de contenido. Descarga el esquema y la muestra anotada en la Descripción general de metadatos XML de Roku.
Los clips también admiten campos que no están disponibles para Película o TV: subType y parentInfo describen la relación del clip con un programa principal, y los metadatos deportivos (sportType, sportLeague, teams) describen clips deportivos. Los metadatos deportivos son opcionales para los clips en general y obligatorios al entregar clips deportivos. Los requisitos de cada campo se indican a continuación.
Los campos se organizan en Información del paquete, Descriptores de contenido, Reparto y equipo de filmación, Localizaciones, Opciones de reproducción/Disponibilidad, Activos, Información principal y Metadatos deportivos.
Información del paquete
package
Identifica la versión del esquema que utiliza el paquete.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/@version | clip1.0 | Obligatorio |
<package version="clip1.0">provider
Nombre del propietario del contenido, estudio o cadena.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/provider | Roku Originals | Obligatorio |
<provider>Roku Originals</provider>language
Idioma principal de los metadatos del paquete. Como mínimo, debe ajustarse a un código de idioma admitido. Se recomienda incluir un código de región, por ejemplo, es-MX o es-ES.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/language | Código de idioma válido | Obligatorio |
<language>en</language>type
Define el tipo de contenido del paquete.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/type | clip | Obligatorio |
<type>clip</type>subType
Identifica el subtipo del clip. Usa uno de los valores siguientes para describir contenido auxiliar o relacionado. Roku no crea un vínculo de sistema entre el clip y su programa principal. Puedes proporcionar metadatos descriptivos de ese programa en Información principal.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/subType | trailer, highlight, making_of, behind_scenes, interview, related, recap, extra | Opcional |
<subType>trailer</subType>asset_id
Identificador único de un clip de formato corto que debe permanecer sin cambios. La empresa socia genera y proporciona el ID. El ID de los metadatos de ingesta debe coincidir con el ID de título (Title ID) del documento de Avails para facilitar el seguimiento desde el envío de Avails hasta la publicación. Límite de 50 caracteres.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/asset_id | Solo caracteres alfanuméricos, guiones y guiones bajos. 50 caracteres como máximo. | Obligatorio |
<asset_id>clipAssetIdHere</asset_id>eidr
ID de EIDR, si existe uno.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/eidr | Cualquier ID de EIDR válido | Opcional |
<eidr></eidr>tmsId
ID de Gracenote, si existe uno.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/tmsId | Cualquier ID de TMS válido | Opcional |
<tmsId></tmsId>Descriptores de contenido
title
Título del clip de formato corto. Incluye solo el nombre tal como debe aparecer en la plataforma. No agregues datos entre paréntesis que no formen parte del título (por ejemplo, (Clásica), (1987), (Temporada 1), (HD)).
| Xpath XML | Ejemplo | Obligatorio |
|---|---|---|
/package/video/title | Título del clip | Obligatorio |
<title><![CDATA[Clip Title. Required.]]></title>brief_synopsis
Una sinopsis del clip. Admite CDATA. Límite de 100 caracteres. Obligatorio para la distribución en Linear OTT.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/brief_synopsis | Hasta 100 caracteres | Obligatorio para la distribución en Linear OTT |
<brief_synopsis><![CDATA[Brief clip summary. 100 characters maximum. Required for Linear OTT distribution.]]></brief_synopsis>short_synopsis
Sinopsis breve del contenido. Admite CDATA. Límite de 250 caracteres.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/short_synopsis | Sinopsis de 250 caracteres | Obligatorio |
<short_synopsis><![CDATA[Short summary of clip. 250 characters maximum. Required]]></short_synopsis>long_synopsis
Opcional. Sinopsis larga del contenido. Admite CDATA. Límite de 500 caracteres.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/long_synopsis | Sinopsis de 500 caracteres | Opcional |
<long_synopsis><![CDATA[Long summary of clip. 500 characters maximum. Optional.]]></long_synopsis>original_spoken_language
Idioma original de producción del título. Como mínimo, debe ajustarse a un código de idioma admitido (se recomienda incluir un código de región).
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/original_spoken_language | Código de idioma válido; puede incluir código de región | Obligatorio |
<original_spoken_language>en</original_spoken_language>country_of_origin
El país principal donde se produjo el clip, y donde están establecidos los principales creadores, el equipo de filmación y los productores. Debe ajustarse a un código ISO 3166-1 alfa-2 admitido.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/country_of_origin | Código de país válido de 2 caracteres según ISO 3166-1 alfa-2 | Preferido |
<country_of_origin>US</country_of_origin>closedCaptions
Este campo Y/N es obligatorio para todo el contenido destinado a Roku Channel en EE. UU. Indica si se incluyen subtítulos descriptivos; consulta la entrega de subtítulos descriptivos para los requisitos del archivo.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/closedCaptions | Y o N | Obligatorio para contenido en EE. UU. |
<closedCaptions>Y</closedCaptions>closedCaptionsExemption
Código de exención de la FCC para el requisito de subtítulos descriptivos. Obligatorio si closedCaptions = N.
| Código | Definición |
|---|---|
| 1 | El contenido nunca se emitió por televisión en Estados Unidos. |
| 2 | El contenido solo se emitió por televisión en Estados Unidos sin subtítulos descriptivos. |
| 3 | El contenido no se ha emitido por televisión en Estados Unidos con subtítulos descriptivos desde el 30 de septiembre de 2012. |
| 4 | El contenido no consiste en programación de video de larga duración. |
| 5 | El contenido no pertenece a una categoría de programación en línea que requiere subtítulos descriptivos según las normas de la FCC (47 C.F.R. § 79.4(b)). |
| 6 | La FCC o el Congreso de EE. UU. concedieron una exención de los requisitos de subtítulos descriptivos para este contenido. |
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/closedCaptionsExemption | 1, 2, 3, 4, 5, 6 | Obligatorio si closedCaptions = N |
<closedCaptionsExemption>1</closedCaptionsExemption>release_date
Fecha original en la que el contenido estuvo disponible por primera vez en cualquier presentación. Debe incluir, como mínimo, un año de estreno correcto.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/release_date | Formato ISO 8601: YYYY-MM-DD | Obligatorio |
<release_date>YYYY-MM-DD</release_date>runtime
Duración total del contenido, en minutos enteros.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/runtime | Solo números enteros | Obligatorio |
<runtime>3</runtime>genre
Clasificación por género del contenido. Cada clip de formato corto debe entregarse con al menos un género admitido. Consulta la lista enumerada de géneros.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/genres/genre | Consulta la lista enumerada. No más de 10 géneros por título. | Obligatorio |
<genres>
<genre>drama</genre>
<!-- Additional genres here-->
</genres>rating
Clasificación de contenido/edades de una fuente de clasificación. Se debe proporcionar, para cada clip de formato corto, una clasificación válida de cine o TV de la autoridad de clasificación (ratingSystem) del territorio en el que estará disponible el contenido. Si no está clasificado por la autoridad oficial de ese territorio, usa en su lugar una clasificación válida de USA_PR, según las pautas de tvguidelines.org (no existe un organismo oficial de clasificación para USA_PR).
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/ratings/rating (debe incluir el atributo system) | Consulta valores de clasificación por sistema y país. Se permiten múltiples pares de clasificación/sistema. | Obligatorio |
<ratings>
<rating system="MPAA" reason="For drug content, some sensuality and war violence.">PG-13</rating>
<rating system="BBFC">12A</rating>
<rating system="CHVRS">14A</rating>
</ratings>tag
Las etiquetas permiten clasificar el contenido más allá de su género. El equipo editorial y el motor de recomendaciones de Roku las usan para ayudar a los usuarios a encontrar contenido. No hay límite en la cantidad de etiquetas ni una lista predefinida. Las etiquetas distinguen entre mayúsculas y minúsculas; úsalas de manera consistente.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/tags/tag | Cualquier cadena de menos de 50 caracteres | Opcional, pero muy recomendable |
<tags>
<tag>energy</tag>
<tag>dance</tag>
<!-- Additional tags here-->
</tags>Reparto y equipo de filmación
cast display_name
Nombre de un miembro del reparto. Admite CDATA.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/cast/cast_member/display_name | Nombre Apellido | Opcional |
<cast>
<cast_member>
<display_name><![CDATA[Harrison Ford]]></display_name>
</cast_member>
<!-- Additional cast members here-->
</cast>crew display_name
Nombre de un miembro del equipo de filmación. Admite CDATA.
Entregas en Excel: Director es la única función de
crew_memberadmitida. XML admite la lista completa de funciones del equipo de filmación.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/crew/crew_member/display_name | Nombre Apellido | Obligatorio si se proporciona un crew_member |
<display_name><![CDATA[George Lucas]]></display_name>role
Función del miembro del equipo de filmación indicado en display_name. Todo miembro del equipo de filmación debe incluir también su función. Consulta la lista enumerada de funciones del equipo de filmación. Las funciones distinguen entre mayúsculas y minúsculas.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/crew/crew_member/roles/role | Consulta la lista enumerada | Obligatorio si se proporciona un crew_member |
<role>Director</role>Localizaciones
localizations
Contiene los metadatos localizados de paquetes multilingües: idioma, título traducido, brief_synopsis, short_synopsis y long_synopsis.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/localizations | - | Obligatorio |
<localizations>localization atributo name
Define el idioma de los campos localizados dentro de un bloque localization. El nombre del atributo debe ser name; el valor debe, como mínimo, ajustarse a un código de idioma admitido (se recomienda incluir un código de región).
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/localizations/localization | Código de idioma válido; puede incluir código de región | Obligatorio |
<localization name="es">localized title
Título localizado del clip de formato corto. También se aplican las restricciones sobre datos entre paréntesis indicadas en title. Debe ir acompañado de una short_synopsis localizada. La long_synopsis localizada es opcional.
| Xpath XML | Ejemplo | Obligatorio |
|---|---|---|
/package/video/localizations/localization/title | Título localizado del clip | Obligatorio |
<title><![CDATA[Localized Clip Title. Required.]]></title>localized brief_synopsis
Una sinopsis localizada del clip. Admite CDATA. Límite de 100 caracteres. Obligatorio para la distribución en Linear OTT. El idioma se define en el atributo name del bloque localization que la contiene.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/localizations/localization/brief_synopsis | Hasta 100 caracteres | Obligatorio para la distribución en Linear OTT |
<brief_synopsis><![CDATA[Localized brief clip summary. 100 characters maximum. Required for Linear OTT distribution.]]></brief_synopsis>localized short_synopsis
Admite CDATA. Límite de 250 caracteres. Debe ir acompañada de un title localizado. La long_synopsis localizada es opcional.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/localizations/localization/short_synopsis | 250 caracteres | Obligatorio |
<short_synopsis><![CDATA[Localized Short summary of clip. 250 characters maximum. Required]]></short_synopsis>localized long_synopsis
Opcional. Admite CDATA. Límite de 500 caracteres.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/localizations/localization/long_synopsis | 500 caracteres | Opcional |
<long_synopsis><![CDATA[Localized Long summary of clip. 500 characters maximum. Optional.]]></long_synopsis>Opciones de reproducción/Disponibilidad
playOptions
Contiene la información de disponibilidad: países o territorios, tipo de monetización y fechas de inicio y fin de disponibilidad.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/playOptions | - | Obligatorio |
<playOptions>country
Código de país del territorio en el que el contenido está disponible. Se permiten múltiples nodos country si vodType, licensePeriodStart y licensePeriodEnd son idénticos entre ellos.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/playOptions/playOption/country | US, CA, GB, MX | Preferido |
<playOption>
<country>US</country>
<!-- Additional country nodes here -->
</playOption>vodType
Tipo de monetización del clip de formato corto. Se permiten múltiples nodos vodType si country, licensePeriodStart y licensePeriodEnd son idénticos entre ellos.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/playOptions/playOption/vodType | AVOD, SVOD | Preferido |
<playOption>
<vodType>AVOD</vodType>
<!-- Additional vodType nodes here -->
</playOption>licensePeriodStart
Fecha de inicio de la disponibilidad del contenido. Una por playOption. Debe ser cronológicamente anterior a licensePeriodEnd; ambas no deben ser idénticas.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/playOptions/playOption/licensePeriodStart | Formato ISO 8601: YYYY-MM-DDTHH:MM:SS | Opcional |
<playOption>
<licensePeriodStart>YYYY-MM-DDTHH:MM:SS</licensePeriodStart>
</playOption>licensePeriodEnd
Fecha de finalización de la disponibilidad del contenido. Una por playOption. Debe ser cronológicamente posterior a licensePeriodStart; ambas no deben ser idénticas.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/playOptions/playOption/licensePeriodEnd | Formato ISO 8601: YYYY-MM-DDTHH:MM:SS | Opcional |
<playOption>
<licensePeriodEnd>YYYY-MM-DDTHH:MM:SS</licensePeriodEnd>
</playOption>Activos
El bloque assets hace referencia a todos los archivos entregados como parte del paquete (video, subtítulos descriptivos, audio, subtítulos, ilustraciones), cada uno descrito mediante un par asset/data_file.
assets
Inicia el bloque de activos.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets | media_type="video" | Obligatorio |
<assets media_type="video">Full Source (Video)
Describe el archivo de video fuente. asset type="full"; data_file role="source". <locale> y <file_name> también son obligatorios.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file | asset type="full"; data_file role="source" | Obligatorio |
<asset type="full">
<data_file role="source">Full Captions
Describe los subtítulos descriptivos del archivo de video fuente. asset type="full"; data_file role="captions". Si se entrega un archivo de subtítulos descriptivos separado del video (sidecar), <locale> y <file_name> son obligatorios.
Los subtítulos descriptivos son muy recomendables para todas las entregas. La empresa socia determina si son obligatorios para la entrega específica.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file | asset type="full"; data_file role="captions" | Muy recomendable |
<asset type="full">
<data_file role="captions">Full Audio
Describe el audio que se entrega en un archivo separado del video fuente (audio sidecar): un doblaje completo a otro idioma o una pista de audio descriptivo para accesibilidad. asset type="full"; data_file role="audio" (doblaje de traducción) o role="audio description" (accesibilidad). <locale> y <file_name> también son obligatorios.
El audio sidecar puede requerirse cuando se necesitan activos localizados (el audio fuente no es nativo del territorio de distribución) o para cumplir con las regulaciones de la FCC.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file | asset type="full"; data_file role="audio" o role="audio description" | Opcional*; se recomienda ampliamente el audio descriptivo |
<asset type="full">
<data_file role="audio">Full Subtitles
Describe los subtítulos sidecar del archivo de video fuente. asset type="full"; data_file role="subtitles". <locale> y <file_name> también son obligatorios.
Los subtítulos sidecar pueden requerirse cuando se necesitan activos localizados (el audio fuente no es nativo del territorio de distribución).
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file | asset type="full"; data_file role="subtitles" | Opcional* |
<asset type="full">
<data_file role="subtitles">Forced Subtitles
Describe los subtítulos narrativos forzados sidecar del archivo de video fuente. asset type="full"; data_file role="forced subtitles". <locale> y <file_name> también son obligatorios.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file | asset type="full"; data_file role="forced subtitles" | Opcional* |
<asset type="full">
<data_file role="forced subtitles">Artwork
Describe los archivos de ilustración. asset type="artwork". <locale> y <file_name> también son obligatorios. Consulta Ilustraciones para las especificaciones completas de entrega de imágenes.
Los clips requieren un solo tipo de imagen de arte clave 16:9, como se indica en la Especificación de ilustraciones. Las ilustraciones de clips no usan variantes separadas de background_image, boxcover o poster.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file | asset type="artwork" | Obligatorio |
<asset type="artwork">
<data_file>locale
Identifica el idioma del data_file. Como mínimo, debe ajustarse a un código de idioma admitido (se recomienda incluir un código de región). Aplica a las funciones source, captions, audio y subtitles de data_file, y al tipo de activo artwork.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file/locale | Código de idioma admitido | Obligatorio |
<locale name="en"/>file_name
Nombre de archivo del activo indicado en el atributo role o type del data_file que lo contiene. Todos los valores distinguen entre mayúsculas y minúsculas y deben incluir la extensión de archivo adecuada.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file/file_name | Consulta las pautas anteriores para las especificaciones de entrega de activos | Obligatorio para cada activo entregado |
<file_name>VideoFilename.mxf</file_name>audio
Descriptor de distribución de canales de audio para el archivo de video entregado.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file/audio | stereoOnly, surroundOnly, stereoPlusSurround, surroundPlusStereo | Opcional |
<audio>stereoOnly</audio>Información principal
parentInfo describe el programa del que proviene un clip o con el que está relacionado. Úsalo con un valor subType válido. Estos metadatos no crean un vínculo navegable ni una relación en la plataforma entre el clip y su programa principal.
parentInfo
Contiene la información del programa principal del clip.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo | - | Opcional |
<parentInfo>contentType principal
Tipo de contenido del programa principal del cual se deriva o al cual describe el clip.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/contentType | episode, movie, series | Opcional |
<parentInfo>
<contentType>episode</contentType>
</parentInfo>title principal
Título del programa principal, si el programa principal es una película o una serie.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/title | Título de la película o serie principal | Opcional |
<parentInfo>
<title>Title of Parent Movie or Series</title>
</parentInfo>runtime principal
Duración del programa principal, si el programa principal es una película o un episodio.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/runtime | Número entero | Opcional |
<parentInfo>
<runtime>45</runtime>
</parentInfo>releaseDate principal
Fecha de estreno de la película, el episodio o la serie principal.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/releaseDate | Formato ISO 8601: YYYY-MM-DD | Opcional |
<parentInfo>
<releaseDate>YYYY-MM-DD</releaseDate>
</parentInfo>tmsId principal
ID de TMS de la película, el episodio o la serie principal.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/tmsId | ID de TMS válido | Opcional |
<parentInfo>
<tmsId>TMSID</tmsId>
</parentInfo>seriesTitle principal
Título de la serie del programa principal, si el programa principal es un episodio.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/seriesTitle | Título de la serie principal | Opcional |
<parentInfo>
<seriesTitle>Parent Series Title</seriesTitle>
</parentInfo>seasonNumber principal
Número de temporada del programa principal, si el programa principal es un episodio.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/seasonNumber | Número entero mayor que 0 | Opcional |
<parentInfo>
<seasonNumber>2</seasonNumber>
</parentInfo>episodeNumber principal
Número de episodio del programa principal, si el programa principal es un episodio.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/parentInfo/episodeNumber | Número entero | Opcional |
<parentInfo>
<episodeNumber>14</episodeNumber>
</parentInfo>Metadatos deportivos
Los metadatos deportivos son opcionales para los clips en general. Al entregar un clip deportivo, todos los campos siguientes son obligatorios.
sportType
Nombre del deporte que aparece en el clip/momento destacado.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/sportType | Nombre del deporte | Obligatorio para clips deportivos |
<sportType>Baseball</sportType>sportLeague
Nombre de la liga deportiva que aparece en el clip/momento destacado.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/sportLeague | Nombre de la liga deportiva | Obligatorio para clips deportivos |
<sportLeague>MLB</sportLeague>teams
Equipos que aparecen en el clip/momento destacado deportivo. Los equipos local y visitante se definen mediante el atributo location.
[!NOTE]
Roku actualmente solo admite metadatos de participantes en deportes de equipo. La compatibilidad con deportes individuales, como tenis y golf, está prevista para una fecha posterior.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/teams/team | team location="away"; team location="home" | Obligatorio para clips deportivos |
<teams>
<team location="away">Chicago Cubs</team>
<team location="home">St. Louis Cardinals</team>
</teams>Updated about 5 hours ago