La API de Avails de Prime Video forma parte de la suite Content API y te permite gestionar la disponibilidad de tus títulos en Prime Video mediante la integración directa con tus sistemas de gestión de derechos de contenido. Envía, actualiza, recupera o elimina periodos de disponibilidad con mayor precisión y control que las cargas de archivos tradicionales.
¿Por qué usar la API de Avails?
La API agiliza tu flujo de trabajo de gestión de contenido y te brinda más control sobre tu catálogo de Prime Video:
- Gestión automatizada: Elimina las cargas manuales y reduce los errores al automatizar el envío y la actualización de las ventanas de disponibilidad, liberando a tu equipo para que se concentre en tareas estratégicas.
- Mayor eficiencia: Actualiza ventanas de disponibilidad específicas sin tener que volver a enviar conjuntos de datos completos, lo que ahorra tiempo y reduce el procesamiento redundante.
- Retroalimentación directa: Valida tus datos en tiempo real y recibe mensajes de error inmediatos sin necesidad de iniciar sesión en Slate para realizar correcciones manuales.
- Interoperabilidad: Construida sobre una interfaz REST que es agnóstica al lenguaje, sistema y plataforma; accesible desde cualquier sistema con conexión a Internet.
Operaciones y puntos de enlace (endpoints) de la API
Todos los endpoints son independientes del lenguaje y accesibles a través de HTTP 1.1 desde cualquier sistema con conexión a Internet. Los endpoints de Avails no siguen un protocolo específico y pueden invocarse en cualquier orden según las necesidades de tu flujo de trabajo.
Acerca de los modelos de extracción (Extract Models)
Un modelo de extracción define cómo estructuras y envías los datos de disponibilidad a Prime Video. Piénsalo como una elección entre enviarnos la información completa de tu catálogo o enviar únicamente los cambios específicos que necesitas realizar.
Operación 1: Crear/Actualizar Avails
- Qué hace: Agrega nuevas ventanas de disponibilidad o actualiza las existentes para tus títulos.
- Por qué lo necesitas: Así es como le indicas a Prime Video cuándo y dónde debe estar disponible tu contenido para los clientes. Ya sea que estés lanzando contenido nuevo o extendiendo una licencia existente, esta operación garantiza que tus datos de disponibilidad estén al día.
Operación 2: Recuperar Avails
- Qué hace: Recupera la información de disponibilidad actual de los sistemas de Prime Video.
- Por qué lo necesitas: Permite verificar qué datos de disponibilidad tiene Prime Video en sus archivos, solucionar discrepancias o extraer datos para fines de elaboración de informes y conciliación.
Operación 3: Validar Avails
- Qué hace: Comprueba si hay errores en tus datos de disponibilidad antes de enviarlos a los sistemas de producción de Prime Video.
- Por qué lo necesitas: Permite detectar errores de formato, campos obligatorios faltantes o infracciones de reglas de negocio antes de que afecten la disponibilidad de tu contenido. Esto ahorra tiempo al eliminar la necesidad de enviar los datos, esperar el procesamiento, corregir errores y volver a enviarlos.
Operación 4: Eliminar Avails
- Qué hace: Elimina las ventanas de disponibilidad de los sistemas de Prime Video.
- Por qué lo necesitas: Permite gestionar escenarios excepcionales en los que la disponibilidad debe eliminarse por completo en lugar de simplemente esperar a que expire.
- Importante: Recomendamos encarecidamente que el contenido expire mediante el ajuste de la fecha de finalización en lugar de eliminarlo, excepto en casos de uso excepcionales. La expiración mantiene tus datos históricos y el rastro de auditoría.
Códigos de respuesta HTTP
Todos los endpoints de Avails devuelven códigos HTTP estándar que te indican si tu solicitud a la API tuvo éxito o falló, y si los errores son temporales (reintentables) o permanentes. Esto permite que tu sistema gestione automáticamente las respuestas sin intervención manual.
Código HTTP |
Descripción |
Reintentable |
200 |
La llamada a la API fue exitosa. Los usuarios deben revisar el objeto de respuesta para detalles adicionales. |
N/D |
400 |
Solicitud incorrecta, incluyendo fallos de validación. |
No |
401 |
No autorizado. |
No |
404 |
No encontrado. |
No |
500 |
Error interno. |
Sí |
503 |
Error de dependencia. |
Sí |
Nota: Para errores reintentables (500, 503), implementa una lógica de reintento con los retrasos adecuados entre cada intento. Los errores no reintentables (400, 401, 404) indican problemas con tu solicitud que requieren corrección antes de volver a enviarla.
Esquemas de la API
Los esquemas descritos en esta documentación están diseñados para ayudar a los desarrolladores a integrarse con la API de Avails. Todos los esquemas de carga útil (payload) cumplen con el estándar MDDF API v2.6. Si bien puedes incluir cualquier atributo de MDDF API v2.6 en tu payload, Prime Video solo procesa los atributos compatibles; los atributos no compatibles serán ignorados.
Nota: Para obtener una referencia completa de los atributos compatibles que coinciden con nuestra especificación de EMA Avails, consulta la columna EMA Avails en la tabla de Tipos de Datos Principales a continuación. Para obtener información sobre cómo se gestionan y utilizan las disponibilidades en Prime Video, consulta la página de Derechos de Contenido.
Conversión de MDDF XML a JSON
La API de Avails de MDDF define su esquema en formato XML, pero admite cargas útiles (payloads) tanto en XML como en JSON. Las APIs de Avails de Prime Video utilizan cargas útiles codificadas en JSON. El proceso para convertir XML de MDDF a JSON se describe a continuación:
Se omiten los espacios de nombres
<alice>bob</alice>
becomes
{ "alice": "bob" }
Los elementos anidados se convierten en propiedades anidadas
<alice><bob>charlie</bob><david>edgar</david></alice>
becomes
{ "alice": { "bob": "charlie", "david": "edgar" } }
Múltiples elementos con el mismo nombre se convierten en elementos de una matriz
<alice><bob>charlie</bob><bob>david</bob></alice>
becomes
{ "alice": { "bob": [ "charlie", "david" ] } }
Los atributos se colocan en propiedades y se les antepone un guion bajo
<alice charlie="david">bob</alice>
becomes
{ "alice": { "_charlie": "david", "value": "bob" } }
Tipos de datos comunes del esquema
El esquema de la API de Avails admite los siguientes tipos de datos:
| Tipo |
Descripción |
| Boolean |
Tipo booleano. Valores permitidos: true, false |
| Integer |
Entero con signo de 32 bits. |
| LongInteger |
Entero con signo de 64 bits. |
| Decimal |
Número de punto flotante. |
| String |
Una matriz de caracteres. |
| Timestamp |
Marca de tiempo ISO. |
| Enum |
Una cadena enumerada con un conjunto predefinido de valores permitidos. |
| Struct |
Estructura que sirve como agregador de otros atributos. |
| Array |
Colección de elementos del MISMO tipo. Designada por []. |
Nota: El número máximo de elementos permitidos en las solicitudes por lotes está limitado a 100.
Esquemas de solicitud y respuesta
Esta sección define las estructuras de datos para todas las operaciones de la API de Avails. Estos esquemas especifican el formato exacto de las solicitudes que envías a Prime Video y de las respuestas que recibes. Comprender estas estructuras es esencial para una integración exitosa de la API.
Esquema 1: Crear/Actualizar Avails
Estos esquemas definen la estructura para crear o actualizar ventanas de disponibilidad en el sistema de Prime Video. Utilízalos cuando necesites enviar nuevos derechos de contenido o modificar los existentes.
Tipo de PutAvailsAPIRequest
Este es el objeto de solicitud principal para enviar una única ventana de disponibilidad.
Atributo |
Tipo |
Es obligatorio |
Descripción |
avail |
Avail |
Sí |
Datos de disponibilidad. Este es el atributo de nivel superior de cualquier solicitud put o validate. |
Tipo de PutAvailsAPIResponse
La respuesta que recibirás tras enviar una ventana de disponibilidad. Verifica el campo success para confirmar que la operación se completó y revisa el campo errors si el envío falló.
Atributo |
Tipo |
Es obligatorio |
Descripción |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
Tipo de PutAvailsBatchAPIRequest
Utiliza este esquema cuando necesites enviar varias ventanas de disponibilidad en una única llamada a la API. Las operaciones por lotes mejoran la eficiencia al gestionar catálogos grandes o realizar actualizaciones masivas.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItems |
PutAvailsBatchAPIRequestItem[] |
Sí |
Lista de solicitudes individuales |
Tipo de PutAvailsBatchAPIResponse
La respuesta por lotes devuelve resultados individuales para cada elemento incluido en tu solicitud. Cada elemento de la respuesta corresponde a un elemento de la solicitud a través del campo requestItemId.
Atributo |
Tipo |
Es obligatorio |
Descripción |
responseItems |
PutAvailsBatchAPIResponseItem[] |
Sí |
Lista de elementos de respuesta |
Tipo de PutAvailsBatchAPIRequestItem
Cada elemento en una solicitud por lotes requiere un identificador único y una ruta que especifique el tipo de operación (Full Extract) y el recurso de destino.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes. Es una cadena única que utilizarás para identificar cada elemento del lote y que servirá para vincularlo con nuestra respuesta. |
path |
String |
Sí |
Ruta a un recurso para este elemento de solicitud. |
body |
PutAvailsBatchAPIRequestItemBody |
Sí |
Datos de disponibilidad |
Tipo de PutAvailsBatchAPIRequestItemBody
El cuerpo de cada elemento de la solicitud por lotes contiene los datos de disponibilidad reales que estás enviando.
Atributo |
Tipo |
Es obligatorio |
Descripción |
avail |
Avail |
Sí |
Datos de disponibilidad |
Tipo de PutAvailsBatchAPIResponseItem
Cada elemento de respuesta en el lote indica el éxito o el fallo de la solicitud correspondiente. Utiliza el requestItemId para emparejar las respuestas con tus solicitudes originales.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
Esquema 2: Recuperar Avails
Estos esquemas definen cómo recuperar ventanas de disponibilidad existentes del sistema de Prime Video. Utilízalos para consultar la información de los derechos actuales de tu contenido.
Tipo de GetAvailsAPIResponse
La respuesta contiene los datos de disponibilidad completos para el contenido solicitado, incluyendo todos los términos de licencia y derechos territoriales.
Atributo |
Tipo |
Es obligatorio |
Descripción |
avail |
Avail |
Sí |
Datos de disponibilidad |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
GetAvailsBatchAPIRequest
Recupera múltiples ventanas de disponibilidad en una única llamada a la API. Esto resulta eficiente cuando necesitas verificar los derechos de varios títulos o transacciones.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItems |
GetAvailsBatchAPIRequestItem[] |
Sí |
Lista de solicitudes individuales |
GetAvailsBatchAPIResponse
Devuelve los datos de disponibilidad para cada elemento solicitado. Cada respuesta se corresponde con una solicitud a través del requestItemId.
Atributo |
Tipo |
Es obligatorio |
Descripción |
responseItems |
GetAvailsBatchAPIResponseItem[] |
Sí |
Lista de elementos de respuesta |
GetAvailsBatchAPIRequestItem
Cada elemento de la solicitud de obtención especifica la ruta al recurso que deseas recuperar.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes |
path |
String |
Sí |
Ruta a un recurso para este elemento de solicitud. |
GetAvailsBatchAPIResponseItem
Cada elemento de la respuesta contiene los datos de disponibilidad si la recuperación fue exitosa, o los detalles del error si falló.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
avail |
Avail |
No |
Objeto Avail |
Esquema 3: Validar Avails
Estos esquemas permiten probar tus datos de disponibilidad antes de enviarlos al sistema de Prime Video. La validación detecta errores de forma anticipada sin crear ni modificar ventanas de disponibilidad reales.
Tipo de ValidateAvailsAPIRequest
La respuesta de validación indica si tus datos cumplen con todas las reglas de validación. Revisa cualquier error antes de enviar la solicitud real de creación o actualización.
Atributo |
Tipo |
Es obligatorio |
Descripción |
avail |
Avail |
Sí |
Datos de disponibilidad |
Tipo de ValidateAvailsAPIResponse
La respuesta de validación indica si tus datos cumplen con todas las reglas de validación. Revisa cualquier error antes de enviar la solicitud real de creación o actualización.
Atributo |
Tipo |
Es obligatorio |
Descripción |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
Tipo ValidateAvailsBatchAPIRequest
Valida múltiples ventanas de disponibilidad en una única llamada. Esto es especialmente útil al preparar envíos de lotes de gran tamaño.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItems |
ValidateAvailsBatchAPIRequestItem[] |
Sí |
Lista de solicitudes individuales |
Tipo de ValidateAvailsBatchAPIResponse
Devuelve los resultados de validación para cada elemento de tu lote. Cada respuesta se corresponde con un elemento de la solicitud a través del requestItemId.
Atributo |
Tipo |
Es obligatorio |
Descripción |
responseItems |
ValidateAvailsBatchAPIResponseItem[] |
Sí |
Lista de elementos de respuesta |
Tipo de ValidateAvailsBatchAPIRequestItem
Cada elemento de la solicitud de validación incluye la ruta del recurso con el sufijo /validate añadido para distinguirlo de las operaciones reales de creación o actualización.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes |
path |
String |
Sí |
Ruta a un recurso para la solicitud: |
body |
ValidateAvailsBatchAPIRequestItemBody |
Sí |
Cuerpo de la solicitud |
Tipo de ValidateAvailsBatchAPIRequestItemBody
Contiene los datos de la ventana de disponibilidad que se van a validar.
Atributo |
Tipo |
Es obligatorio |
Descripción |
avail |
Avail |
Sí |
Datos de disponibilidad |
Tipo de ValidateAvailsBatchAPIResponseItem
Cada elemento de la respuesta de validación indica si los datos correspondientes superaron las comprobaciones de validación.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
Esquema 4: Eliminar Avails
Estos esquemas definen cómo eliminar ventanas de disponibilidad del sistema de Prime Video.
Importante: Recomendamos encarecidamente que el contenido caduque mediante el ajuste de la fecha de finalización en lugar de eliminarlo, salvo en casos de uso específicos, como el cumplimiento de requisitos legales o normativos. Hacer que el contenido caduque permite conservar los datos históricos y el rastro de auditoría, lo cual es fundamental para la elaboración de informes y la conciliación de datos.
Tipo de DeleteAvailsAPIResponse
Confirma si la operación de eliminación se completó correctamente. Comprueba el campo success y revisa cualquier error que pueda haber.
Atributo |
Tipo |
Es obligatorio |
Descripción |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
Tipo de DeleteAvailsBatchAPIRequest
Elimina múltiples ventanas de disponibilidad en una única llamada a la API. Esto es útil para retiradas de contenido masivas o vencimientos de derechos.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItems |
DeleteAvailsBatchAPIRequestItem[] |
Sí |
Lista de solicitudes individuales |
Tipo de DeleteAvailsBatchAPIResponse
Devuelve los resultados de eliminación para cada elemento en tu solicitud por lotes.
Atributo |
Tipo |
Es obligatorio |
Descripción |
responseItems |
DeleteAvailsBatchAPIResponseItem[] |
Sí |
Lista de elementos de respuesta. |
Tipo de DeleteAvailsBatchAPIRequestItem
Cada elemento de solicitud de eliminación especifica la ruta al recurso que se va a eliminar.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes |
path |
String |
Sí |
Ruta a un recurso para este elemento de solicitud. |
Tipo de DeleteAvailsBatchAPIResponseItem
Cada elemento de respuesta confirma si la eliminación se realizó correctamente para la solicitud correspondiente.
Atributo |
Tipo |
Es obligatorio |
Descripción |
requestItemId |
String |
Sí |
Identificador único del elemento en la solicitud por lotes |
success |
Boolean |
Sí |
Estado de la operación |
errors |
Error[] |
No |
Lista de errores en caso de fallo |
Tipos de datos principales
Estos tipos de datos fundamentales se utilizan en todos los esquemas de la API. Comprender estas estructuras es esencial para trabajar con cualquier operación de avails. Para obtener más información, consulta la página de Derechos de contenido.
Tipo de Error
Estructura de error estándar devuelta cuando las operaciones fallan. El campo code identifica el tipo de error, mientras que message proporciona detalles legibles para humanos.
Atributo |
Tipo |
Es obligatorio |
Descripción |
code |
String |
Sí |
Una cadena que describe el tipo de error. |
message |
String |
Sí |
Descripción del error legible por humanos |
Tipo de Avail
La estructura de datos principal que representa una ventana de disponibilidad completa. Esta incluye toda la información sobre derechos de contenido, términos de licencia, territorios y condiciones comerciales.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
ALID |
String |
Sí |
Especifica el identificador del título. Debe coincidir con el ALID especificado en la contribución de metadatos. |
ALID |
Disposition |
AvailDisposition |
Sí |
Especifica la granularidad del modelo de extracción. |
N/D |
Licensor |
Publisher |
Sí |
Especifica información sobre la entidad que otorga la licencia a Prime Video. |
N/D |
Asset |
AvailAsset[] |
Sí |
Información sobre el recurso. Solo se debe especificar un único activo en la lista. |
N/D |
Transaction |
AvailTrans[] |
Sí |
Información sobre la transacción. |
N/D |
SharedEntitlement |
AvailSharedEntitlement[] |
No |
Información sobre los derechos a otros servicios. |
N/D |
Tipo de AvailDisposition
Define si se trata de una operación de extracción completa o de eliminación completa, y si se están creando/actualizando o eliminando datos.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
EntryType |
Enum |
Sí |
Valores permitidos: FullExtract, FullDelete |
Disposition |
Tipo de Publisher
Identifica a tu organización como el licensor del contenido. Este valor lo proporciona Prime Video durante el proceso de incorporación.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
DisplayName |
String |
Sí |
Especifica el nombre del socio de Prime Video. Prime Video proporcionará este valor a los socios. Debe tener el mismo valor que el utilizado en los archivos EMA. |
DisplayName |
Tipo de AvailAsset
Describe el activo de contenido que se está licenciando. La estructura varía según el WorkType (Movie, Episode, Season, etc.).
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
_contentID |
String |
Sí |
Especifica el identificador de contenido de este recurso. Por lo general, es lo mismo que ALID. |
ContentID |
WorkType |
Enum |
Sí |
Valores permitidos: Movie, Short, Episode, Season, Supplemental |
WorkType |
Metadata |
AvailUnitMetadata |
Condicional |
Describe los metadatos para Movie (película) o Short (cortometraje). Necesario cuando WorkType es Movie o Short. |
N/D |
EpisodeMetadata |
AvailEpisodeMetadata |
Condicional |
Describe los metadatos para Episode (episodio). Obligatorio cuando WorkType es Episode. |
N/D |
SeasonMetadata |
AvailSeasonMetadata |
Condicional |
Describe los metadatos para Season (temporada). Obligatorio cuando WorkType es Season. |
N/D |
Tipo de AvailSharedEntitlement
Especifica los derechos para otros ecosistemas digitales como DMA (Digital Movie Alliance)
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
_ecosystem |
Enum |
Sí |
Valores permitidos: DMA |
N/D |
EcosystemID |
String |
Sí |
Identificador de título específico del ecosistema |
DMA_ID |
Tipo de AvailUnitMetadata
Metadatos para contenido independiente como películas o cortometrajes.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
TitleInternalAlias |
String[] |
Sí |
Nombre del título. Solo se debe especificar un único nombre de título en la lista. |
TitleInternalAlias |
Tipo de AvailEpisodeMetadata
Metadatos específicos para episodios de TV, incluyendo el número de episodio e información de la temporada o serie principal.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
TitleInternalAlias |
String[] |
Sí |
Nombre del título del episodio. Solo se debe especificar un único nombre de título en la lista. |
EpisodeTitleInternalAlias |
EpisodeNumber |
ContentSequenceInfo |
Sí |
Número de este episodio dentro de la temporada. |
EpisodeNumber |
SeasonMetadata |
AvailSeasonMetadata |
Condicional |
Describe los metadatos para Season (temporada). Obligatorio cuando WorkType es Episode o Season. |
N/D |
SeriesMetadata |
AvailSeriesMetadata |
Condicional |
Describe los metadatos para Series. Obligatorio cuando WorkType es Episode o Season. |
N/D |
Tipo de AvailSeasonMetadata
Metadatos para temporadas de TV, incluyendo el número de temporada y el recuento de episodios.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
SeasonContentID |
String |
Sí |
ALID para la temporada. |
SeasonContentID |
SeasonTitleInternalAlias |
String[] |
No |
Nombre del título de la temporada. Solo se debe especificar un único nombre de título en la lista. |
SeasonTitleInternalAlias |
SeasonNumber |
ContentSequenceInfo |
Sí |
Número de esta temporada dentro de la serie. |
SeasonNumber |
NumberOfEpisodes |
Integer |
Sí |
Número de episodios de esta temporada. |
EpisodeCount |
SeriesMetadata |
AvailSeriesMetadata |
Condicional |
Describe los metadatos para Series. Obligatorio cuando WorkType es Season. |
N/D |
Tipo de AvailSeriesMetadata
Metadatos para series de TV, proporcionando la información de nivel superior de la serie.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
SeriesContentID |
String |
Sí |
ALID para series. |
SeriesContentID |
SeriesTitleInternalAlias |
String[] |
No |
Nombre del título de la serie. Solo se debe especificar un único nombre de título en la lista. |
SeriesTitleInternalAlias |
NumberOfSeasons |
Integer |
No |
Número de temporadas de esta serie. |
SeasonCount |
Tipo de AvailTrans
Define una transacción de licencia específica, incluyendo territorio, fechas, tipo de licencia y términos comerciales. Aquí es donde se especifican los derechos reales que se están otorgando.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
_TransactionID |
String |
No |
Identificador único para la ventana de disponibilidad. Opcional cuando se usa FullExtract. |
AvailID |
LicenseType |
Enum |
Sí |
Valores permitidos: SVOD, FVOD, EST, POEST, VOD |
LicenseType |
Territory |
Region[] |
Sí |
Territorio donde se permite la distribución. Solo se debe incluir un único elemento de territorio. Todas las transacciones dentro de un único objeto Avail deben tener el mismo territorio. |
Territory |
Start |
DateTime |
Sí |
Fecha y hora de inicio de la distribución en formato ISO. NOTA: Si no se incluye una zona horaria, utilizaremos la zona horaria más al este de la región. Sin embargo, puedes incluir cualquier zona horaria si deseas una hora de lanzamiento específica. |
Start |
End |
DateTime |
No |
Fecha y hora de finalización de la distribución en formato ISO. Si no se proporciona, la distribución tiene una duración ilimitada. NOTA: Si no se incluye una zona horaria, utilizaremos la zona horaria más al este de la región. Sin embargo, puedes incluir cualquier zona horaria si quieres una hora de eliminación específica. |
End |
AssetLanguage |
AssetLanguage[] |
No |
Idioma del activo expresado como código de idioma ISO con tipo de activo. Tipos de activos permitidos: subtitle, audio, subdub, sub, dub, ov, mta, any |
AssetLanguage |
AllowedLanguage |
AssetLanguage[] |
No |
Código de idioma ISO con tipo de activo. Tipos de activos permitidos: subtitle, audio, sub, dub, subdub, any |
AllowedLanguages |
HoldbackLanguage |
AssetLanguage[] |
No |
Código de idioma ISO con tipo de activo. Tipos de activos permitidos: subtitle, audio, sub, dub, subdub, any |
HoldbackLanguage |
LicenseRightsDescription |
String |
No |
Se usa para especificar la prioridad de publicación. |
LicenseRightsDescription |
FormatProfile |
AvailFormatProfile |
Sí |
Calidad del vídeo disponible. Valores permitidos: SD, HD, UHD |
FormatProfile |
ContractID |
String |
No |
Especifica la información contractual. Valores permitidos: |
ContractID |
Terms |
AvailTerms[] |
Sí |
Especifica la lista de términos comerciales para la ventana de disponibilidad. |
OtherTerms |
OtherInstructions |
String |
No |
Instrucciones de procesamiento adicionales para la ventana de disponibilidad. |
OtherInstructions |
Tipo de Region
Especifica un territorio geográfico mediante los códigos de país ISO.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
country |
String |
Sí |
Código de país ISO 3166-1 de 2 letras |
N/D |
Tipo de AssetLanguage
Define la disponibilidad de idioma para los recursos de audio y subtítulos.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
value |
String |
Sí |
Idioma del activo expresado como código de idioma RFC 5646 con el tipo de activo. |
N/D |
_asset |
String |
No |
Se permiten diferentes conjuntos de valores, según el atributo de idioma del tipo AvailTrans. |
N/D |
Tipo de AvailFormatProfile
Especifica el nivel de calidad de vídeo para la disponibilidad.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
value |
Enum |
Sí |
Calidad del vídeo disponible. Valores permitidos: SD, HD, UHD |
N/D |
Tipo de AvailTerms
Estructura flexible para especificar términos comerciales. Cada término tiene un nombre y un valor del tipo correspondiente (Money, Text, Event, Boolean, Duration o Number).
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
_termName |
String |
Sí |
Identifica el término. El valor no distingue entre mayúsculas y minúsculas. Para obtener una lista de los valores permitidos, consulta a continuación. |
N/D |
Money |
Money |
No |
Para obtener más información, consulta a continuación. |
N/D |
Text |
String |
No |
Para obtener más información, consulta a continuación. |
N/D |
Event |
DateTime |
No |
Para obtener más información, consulta a continuación. |
N/D |
Boolean |
Boolean |
No |
Para obtener más información, consulta a continuación. |
N/D |
Duration |
String |
No |
Para obtener más información, consulta a continuación. |
N/D |
Number |
Integer |
No |
Para obtener más información, consulta a continuación. |
N/D |
Tipo de Money
Representa valores monetarios con especificación de moneda.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
value |
Decimal |
No |
Valor monetario, requerido para algunos tipos de precios |
N/D |
_currency |
String |
Sí |
Código de moneda ISO |
N/D |
Tipo de ContentSequenceInfo
Especifica los números de secuencia de los episodios y las temporadas.
Atributo |
Tipo |
Requerido |
Notas |
Mapeo de archivos EMA |
Number |
Integer |
Sí |
Número de secuencia de contenido, como el número de episodio o el número de temporada |
N/D |
Términos de Avail compatibles
La siguiente tabla enumera todos los términos comerciales compatibles que se pueden incluir en la matriz AvailTerms. Cada término controla aspectos específicos de la licencia, el precio, la publicidad y la experiencia del cliente.
Nombre del término |
Atributo |
Requerido |
Notas |
Mapeo de archivos EMA |
ChannelIdentity |
Text |
Sí |
Identificador de un canal o suscripción. |
GroupIdentity |
Tier |
Text |
Condicional |
Nivel de precios. Obligatorio si el tipo de licencia es POEST. |
PriceType |
SRP |
Money |
Condicional |
Precio de venta sugerido. Obligatorio si el tipo de licencia es POEST. |
SRP |
WSP |
Money |
Condicional |
Precio al por mayor. Obligatorio si el tipo de licencia es POEST. |
PriceValue |
Category |
Text |
Condicional |
Categoría de precio. Obligatorio si el tipo de licencia es POEST. |
PriceValue |
AnnounceDate |
Event |
No |
Fecha en la que el minorista puede anunciar la fecha de inicio de la disponibilidad del título en el territorio disponible. |
AnnounceDate |
SuppressionLiftDate |
Event |
Condicional |
Primera fecha en la que se podría anunciar públicamente que un título estará disponible en una fecha futura específica en el territorio de disponibilidad. Obligatorio si el tipo de licencia es POEST. |
SuppressionLiftDate |
RentalDuration |
Duration |
Condicional |
Duración del período de alquiler en horas. Obligatorio si el tipo de licencia es SVOD. |
RentalDuration |
WatchDuration |
Duration |
Condicional |
Cuánto tiempo tiene el usuario para completar la visualización una vez iniciada, en horas. Obligatorio si el tipo de licencia es SVOD. |
WatchDuration |
Download |
Text |
No |
La licencia incluye el permiso para descargar. Los valores válidos son Yes y No. Cuando el tipo de licencia es SVOD, se deben especificar tanto la duración del alquiler como la de la visualización. |
Download |
Exclusive |
Boolean |
No |
Los activos son exclusivos dentro del alcance de la transacción. |
Exclusive |
ExclusiveAttributes |
Text |
No |
Especifica el tipo de exclusividad. Solo se tiene en cuenta cuando Exclusive es true. Se utilizará un valor predeterminado si no se proporciona cuando Exclusive sea true. |
ExclusiveAttributes |
BrandingRights |
Boolean |
No |
Indica la intención del socio de mostrar su marca. |
BrandingRights |
BrandingRightsAttributes |
Text |
No |
Especifica el texto de la marca. Solo se tiene en cuenta cuando BrandingRights es true. Se utilizará un valor predeterminado si no se proporciona cuando BrandingRights sea true. |
BrandingRightsAttributes |
allowAds |
Boolean |
No |
Determina si los anuncios están permitidos o prohibidos. Este término solo puede aparecer una vez. |
No disponible en EMA |
allowedAdPlacement |
Text |
Condicional |
Especifica la ubicación en el carrete (roll) donde se pueden insertar anuncios. Los valores permitidos son: PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks. |
No disponible en EMA |
prohibitedAdPlacement |
Text |
Condicional |
Especifica la ubicación del carrete en la que no se pueden insertar anuncios. Los valores permitidos son: PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks. |
No disponible en EMA |
cuepointDeliveryAndUsage |
Text |
No |
Especifica las obligaciones de entrega y uso del punto de referencia. Valores permitidos: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated. |
No disponible en EMA |
blindBasisSelling |
Text |
No |
Valores permitidos: GuaranteedImpressions, NoGuaranteedImpressions |
No disponible en EMA |
sponsorships |
Text |
No |
Valores permitidos: Permitted, Prohibited, PermittedWithRestrictions. |
No disponible en EMA |
sponsorshipsRestrictions |
Text |
Condicional |
Texto de formato libre |
No disponible en EMA |
talentAndAmazonAdGuidelines |
Text |
No |
Valores permitidos: NoRestrictions, ConsultationRequired |
No disponible en EMA |
talentRestrictions |
Text |
Condicional |
Texto de formato libre |
No disponible en EMA |
adLoadLimit |
Text |
No |
Número de minutos de anuncios por hora. El valor debe ser un entero válido. |
No disponible en EMA |
adKey |
Text |
No |
Texto de formato libre |
No disponible en EMA |
CompleteYourBundleDiscountPercentage |
Number |
No |
El porcentaje de descuento se aplica cuando los clientes completan un paquete comprando títulos restantes que aún no tienen. Por ejemplo, un descuento del 20 % significa que los clientes que tengan la temporada 1 de un paquete de 2 temporadas reciben un 20 % de descuento en la temporada 2. |
No disponible en EMA |
ExcludedFromBundleDiscount |
Boolean |
No |
Si se establece en true, este período de disponibilidad queda excluido de la elegibilidad para el descuento por paquete. Úsalo durante los períodos de precios premium (por ejemplo, nuevos lanzamientos) o para títulos que deberían mantener el precio completo. Si está ausente o es falso, el título es elegible para descuentos por paquetes. |
No disponible en EMA |
Enumeración BusinessLine
La enumeración BusinessLine especifica el modelo empresarial de Prime Video según el cual se licencia y se distribuye el contenido. Esto determina cómo los clientes acceden al contenido y cómo se generan los ingresos.
Valor |
Descripción |
TVOD |
TVOD significa compra o alquiler. Tipos de licencia relacionados: EST, VOD, POEST |
PRIME_SUBSCRIPTION |
Suscripción a Amazon Prime o Amazon Kids+. Tipos de licencia relacionados: SVOD |
CHANNELS |
Suscripción a canales de terceros. Tipos de licencia relacionados: SVOD |
FVOD |
Contenido gratuito. Tipos de licencia relacionados: FVOD |
Nota: El valor de BusinessLine determina qué modelo de negocio se aplica a la disponibilidad de tu contenido. Al enviar avails, asegúrate de que el campo BusinessLine coincida con tu acuerdo contractual con Prime Video. Si tienes dudas sobre qué valores de BusinessLine están disponibles para tu asociación, ponte en contacto con tu representante de Prime Video.
Ejemplos de carga útil de Avails
Los siguientes ejemplos demuestran cómo estructurar sus llamadas a la API para escenarios de integración comunes. Consulta los Ejemplos de carga útil para ver pares de solicitud/respuesta completos con JSON bien formateado que puedes usar como plantillas para tu integración.