XML - campos de metadatos de películas
Referencia de campos XML para la entrega de películas.
Descripción general
Usa esta referencia para preparar los metadatos XML de películas. Descarga el esquema y la muestra anotada en la Descripción general de metadatos XML de Roku. La Descripción general de metadatos explica los tipos de contenido, las reglas para los ID y los períodos de disponibilidad que se aplican a todo el contenido.
Los campos se organizan en Información del paquete, Descriptores de contenido, Cortes publicitarios y puntos de referencia, Reparto y equipo de filmación, Localizaciones, Opciones de reproducción/Disponibilidad y Activos.
Información del paquete
package
Identifica la versión del esquema que utiliza el paquete.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/@version | film5.0 | Obligatorio |
<package version="film5.0">provider
Nombre del propietario del contenido, estudio o cadena.
| Xpath XML | Ejemplo | Obligatorio |
|---|---|---|
/package/provider | Roku Originals | Obligatorio |
<provider>Roku Originals</provider>language
Idioma principal de los metadatos del paquete. El valor debe usar un código de idioma admitido. Se recomienda incluir un código de región para distinguir variantes como el español de México (es-MX) y el de España (es-ES).
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/language | Valor de idioma válido (en, es, etc.); puede incluir código de región (en-US, es-MX, etc.) | Obligatorio |
<language>en</language>type
Define el tipo de contenido del paquete.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/type | film | Obligatorio |
<type>film</type>asset_id
Identificador único de una película 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>movieAssetIdHere</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 de la película tal como debe aparecer en la plataforma. No agregues datos entre paréntesis que no formen parte del título, como un indicador de versión original o nueva, el año de estreno, la temporada o el formato de video (por ejemplo, (Clásica), (1987), (Temporada 1), (HD)).
| Xpath XML | Ejemplo | Obligatorio |
|---|---|---|
/package/video/title | Título de la película | Obligatorio |
<title><![CDATA[Movie Title. Required.]]></title>brief_synopsis
Una sinopsis de la película. 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 movie 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 movie. 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 movie. 500 characters maximum. Optional.]]></long_synopsis>original_spoken_language
El idioma original de producción del título. Como mínimo, el valor debe ajustarse a un código de idioma admitido. Como práctica recomendada, incluye también un código de región (consulta language arriba para el ejemplo es-MX / es-ES).
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/original_spoken_language | Valor de idioma válido (en, es, etc.); 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 la película y donde están establecidos los principales creadores, el equipo de filmación y los productores. El valor debe ajustarse a un código de país de 2 caracteres admitido según ISO 3166-1 alfa-2.
| 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>120</runtime>genre
Clasificación por género del contenido. Cada película 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 película, una clasificación válida de cine o TV emitida por la autoridad de clasificación (ratingSystem) del territorio en el que estará disponible el contenido. Si el título no ha sido clasificado por la autoridad oficial de ese territorio, incluye en su lugar una clasificación válida del sistema USA_PR. No existe un organismo oficial de clasificación para USA_PR; usa las pautas de tvguidelines.org para asignar la clasificación adecuada.
| 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. Agregar etiquetas puede ofrecer más opciones para agrupar y recomendar un título. No hay límite en la cantidad de etiquetas ni una lista predefinida.
- Las etiquetas distinguen entre mayúsculas y minúsculas:
"Rom-Com"y"rom-com"son etiquetas distintas. Usa las mismas mayúsculas y minúsculas en todas las entregas.
| 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>Cortes publicitarios y puntos de referencia
adBreak start_time
Se utiliza para determinar los cortes publicitarios del contenido financiado con anuncios. Los valores deben tener una precisión de milisegundos. Si el video incluye negros comerciales, proporciona el código de tiempo en el punto medio del negro comercial. No es obligatorio para contenido SVOD, pero se pueden ingerir datos de adBreak con precisión de fotogramas si están disponibles.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/adBreaks/adBreak/start_time | HH:MM:SS.sss | Preferido para contenido AVOD |
<adBreaks>
<adBreak>
<start_time>00:03:15.000</start_time>
</adBreak>
<adBreak>
<start_time>00:07:45.425</start_time>
</adBreak>
<!-- Additional adBreaks here-->
</adBreaks>cuePoint start_time y end_time
Se utiliza para identificar los puntos de entrada/salida de los créditos iniciales, resúmenes de contenido, créditos finales y material detrás de cámaras. Las etiquetas cuePoint deben incluir el atributo type. Los valores deben tener una precisión de milisegundos.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/cuePoints/cuePoint/start_time | HH:MM:SS.sss | Preferido |
/package/video/cuePoints/cuePoint/end_time | HH:MM:SS.sss | Preferido |
<cuePoints>
<cuePoint type="ad overlay">
<start_time>00:09:10.456</start_time>
<end_time>00:09:12.678</end_time>
</cuePoint>
<cuePoint type="behind the scenes">
<start_time>00:07:08.123</start_time>
<end_time>00:07:59.123</end_time>
</cuePoint>
<cuePoint type="intro">
<start_time>00:01:08.123</start_time>
<end_time>00:01:59.123</end_time>
</cuePoint>
<cuePoint type="recap">
<start_time>00:21:08.123</start_time>
<end_time>00:21:59.123</end_time>
</cuePoint>
<cuePoint type="end">
<start_time>00:41:08.123</start_time>
<end_time>00:41:59.123</end_time>
</cuePoint>
</cuePoints>cuePoint atributo type
Define el tipo de un cuePoint dado. El nombre del atributo debe ser type, con uno de los siguientes valores. Todo cuePoint que se proporcione requiere start_time y end_time, sin importar el tipo.
| Valor del tipo | Descripción |
|---|---|
ad overlay | El punto dentro del video para anuncios de posicionamiento de productos dentro del programa. |
behind the scenes | Material detrás de cámaras, normalmente al final de un video. |
intro | Los créditos iniciales del programa. |
recap | Un resumen de contenido anterior, típico de la televisión por episodios. |
end | Los créditos finales del programa. |
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/cuePoints/cuePoint | Uno de los valores anteriores | Obligatorio si se proporcionan cuePoints |
<cuePoint type="intro">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 y 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.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/crew/crew_member/display_name | Nombre y apellido | Obligatorio si se proporciona crew_member |
<display_name><![CDATA[George Lucas]]></display_name>Entregas en Excel: Director es la única función de
crew_memberadmitida. XML admite la lista completa de funciones del equipo de filmación.
role
Función del miembro del equipo de filmación indicado en display_name. Todo miembro del equipo de filmación incluido 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 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
Identifica el idioma de los campos del bloque localization. El nombre del atributo debe ser name y su valor debe usar un código de idioma admitido. Se recomienda incluir un código de región; consulta language.
| 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 de la película, en el idioma especificado por el atributo name del bloque localization que lo contiene. 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 | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/localizations/localization/title | Título localizado de la película | Obligatorio |
<title><![CDATA[Localized Movie Title. Required.]]></title>localized brief_synopsis
Una sinopsis localizada de la película. 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 movie summary. 100 characters maximum. Required for Linear OTT distribution.]]></brief_synopsis>localized short_synopsis
Sinopsis breve localizada, en el idioma especificado por el bloque localization que la contiene. 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 movie. 250 characters maximum. Required]]></short_synopsis>localized long_synopsis
Opcional. Sinopsis larga localizada, en el idioma especificado por el bloque localization que la contiene. Admite CDATA. Límite de 500 caracteres. Si se proporciona, debe acompañar a title y short_synopsis localizados.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/localizations/localization/long_synopsis | 500 caracteres | Opcional |
<long_synopsis><![CDATA[Localized Long summary of movie. 500 characters maximum. Optional.]]></long_synopsis>Opciones de reproducción/Disponibilidad
playOptions
Contiene la información de disponibilidad del paquete: países o territorios, tipo de monetización y fechas de inicio y fin de disponibilidad.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/playOptions | - | Opcional |
<playOptions>country
Código de país del territorio en el que el contenido está disponible. Se permiten múltiples nodos country, siempre que vodType, licensePeriodStart y licensePeriodEnd sean 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 de la película. Se permiten múltiples nodos vodType, siempre que country, licensePeriodStart y licensePeriodEnd sean 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 para las personas usuarias de Roku Channel. Una licensePeriodStart 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 para las personas usuarias de Roku Channel. Una licensePeriodEnd 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 archivo individual se describe mediante un par asset/data_file, con atributos que identifican el tipo y la función del activo.
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. El atributo de la etiqueta asset debe ser type="full", y el atributo de la etiqueta data_file debe ser 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 (es decir, el audio original de la 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 (es decir, el audio original de la 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.
| Xpath XML | Valores aceptados | Obligatorio |
|---|---|---|
/package/video/assets/asset/data_file | asset type="artwork" | Obligatorio |
<asset type="artwork">
<file_name>
<asset type="artwork">
<file_name type="background_image">
<asset type="artwork">
<file_name type="boxcover">
<asset type="artwork">
<file_name type="poster">Un file_name sin atributo type representa el arte clave. Los valores explícitos de type solo son necesarios para background_image, boxcover y poster.
locale
Identifica el idioma del data_file. Como mínimo, el valor debe ajustarse a un código de idioma admitido; incluye un código de región como práctica recomendada. Aplica a las funciones de data_file source, captions, audio, subtitles, 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 de file_name distinguen entre mayúsculas y minúsculas y deben incluir la extensión de archivo adecuada.
| Tipo de activo | Obligatorio |
|---|---|
| Video/subtítulos descriptivos/audio/subtítulos/subtítulos forzados (activos fuente en general) | Obligatorio para cada activo entregado |
| Ilustración: predeterminada/sin etiquetar | Obligatorio |
Ilustración: type="background_image" | Preferido |
Ilustración: type="boxcover" (3:4 para películas) | Obligatorio para la distribución en Howdy |
Ilustración: type="poster" | Preferido |
<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>Updated about 5 hours ago