La API de Estado de Activos te permite comprobar qué entregas son necesarias para publicar tu título y el estado actual de cada entrega (por ejemplo, correcta, faltante o faltante) y, de no ser así, por qué. Centraliza los datos de entrega de tus activos en tus propios sistemas en lugar de comprobar Slate manualmente, lo que te proporciona visibilidad en tiempo real de todas tus entregas y tipos de activos. Puedes usar la API de Estado de activos para ver cualquiera de los datos disponibles actualmente en la pestaña Activos de Slate.
¿Por qué usar la API de Estado de Activos?
- Operaciones centralizadas: extraiga los datos de entrega de activos directamente a sus propios sistemas junto con sus otros canales de distribución, sin necesidad de iniciar sesión en Slate para cada verificación de estado
- Resolución de problemas más rápida: detecta los problemas de entrega de forma inmediata y comprende qué es lo que impide que tus títulos se publiquen, lo que reduce el tiempo de resolución
- Gestión proactiva de activos: supervise todo su catálogo mediante programación en todos los territorios y tipos de activos, lo que le permitirá escalar las operaciones a medida que su empresa crezca
- Verificación de la entrega en tiempo real: sepa al instante si sus activos se han entregado correctamente o si hay errores que requieren una acción
Esquemas de solicitud y respuesta
En esta sección se proporcionan especificaciones técnicas para que los desarrolladores integren la API de Estado de los Activos en sus sistemas. Utilice esta referencia para comprender el formato de la solicitud, la estructura de respuesta y los tipos de datos que devuelve la API.
Formato de solicitud
La API de Estado de Activos utiliza una estructura de solicitud simple de recuperación mediante GET, en la que todos los parámetros de la consulta se pasan por la URL; no se requiere el cuerpo de la solicitud. Esto facilita la integración en sus sistemas y las pruebas con clientes HTTP estándar o herramientas de línea de comandos. Solo tiene que crear la URL con el identificador del título y los filtros opcionales y, a continuación, enviar una solicitud GET para recuperar el estado actual de sus entregas de activos.
https://partnerapi.primevideo.com/v1/assets/{licensor}/status/{ALID}?marketplace={marketplace}
En esta tabla se definen los parámetros que puede utilizar para consultar la información sobre el estado de los activos.
Parámetro |
Type |
Es obligatorio |
Description |
licenciante |
Cadena |
Sí |
El identificador de su organización proporcionado por Prime Video durante la incorporación |
VÁLIDO |
Cadena |
Sí |
Identificador del título (ALID o SKU) que coincide con tu contribución |
mercado |
Cadena |
No |
El Amazon Marketplace al que se envió el título. El valor predeterminado es GLOBAL y no es obligatorio proporcionarlo. Si buscas un título en tu catálogo de Classic Marketplace, indícalo como parámetro. Valores permitidos: GLOBAL, US, DE, JP, GB |
Solicitudes de ejemplo
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123?marketplace=global
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123
Nota: Cuanto más específicos sean los parámetros de tu solicitud, más específica será tu respuesta. Si omites el parámetro de mercado opcional, la API devolverá la información de estado de todos los ámbitos aplicables asociados a ese ALID.
Esquema de respuesta
El esquema de respuesta define la estructura de los datos devueltos por la API de Estado de los Activos. Comprender estos tipos de datos le ayudará a analizar la respuesta e integrar la información de estado en sus sistemas de manera eficaz.
ProductStatus
La respuesta de nivel superior que contiene información sobre el estado de los activos para el título solicitado. Cada respuesta incluye datos de estado filtrados según los parámetros de la solicitud, lo que le permite comprender el estado de la entrega en función de los diferentes tipos de activos y requisitos.
Nombre del campo |
Type |
Es obligatorio |
Description |
Fuente |
Plataforma de entrega |
Sí |
Plataforma de entrega de código fuente. Ten en cuenta que siempre debe ser Prime Video. |
Destino |
Publicador de entrega |
Sí |
El alias del socio del título que recibe los activos. |
Alcance |
Alcance de entrega |
Sí |
Información sobre el alcance de la entrega |
IDs de plataforma |
Identificadores de plataforma |
Sí |
Identificadores de plataforma |
Código de progreso general |
Código de progreso |
Sí |
Código de progreso general: Listo, emitido, en proceso, faltante |
Detalle del progreso |
Elemento detallado del progreso [] |
Sí |
Lista de detalles del progreso |
Estado de la pieza del título |
Título del producto Estado de la pieza [] |
Sí |
Información sobre el estado de la pieza de título |
Instrucciones |
Instrucción de entrega del producto [] |
No |
Instrucciones de entrega |
DeliveryPlatform Type
Información de la plataforma de entrega de código fuente.
Nombre del campo |
Type |
Es obligatorio |
Description |
Plataforma |
Cadena |
Sí |
Plataforma de entrega de código fuente. Ten en cuenta que siempre debe ser Prime Video. |
DeliveryPublisher Type
Información del editor de destino. Esto identifica a su organización como receptora del contenido.
Nombre del campo |
Type |
Es obligatorio |
Description |
Publicador |
Cadena |
Sí |
El alias del socio del título que recibe los activos. |
DeliveryScope Type
Información sobre el alcance de la entrega que define el contexto de la consulta de estado del activo.
Nombre del campo |
Type |
Es obligatorio |
Description |
VÁLIDO |
Cadena |
Sí |
Asset Logical Identifier o SKU |
Mercado |
Cadena |
Sí |
El Amazon Marketplace al que se envió el título. El valor predeterminado es GLOBAL y no es obligatorio proporcionarlo. |
Region |
Cadena |
No |
Region o territorio |
FormatProfile |
Cadena |
No |
Calidad del vídeo disponible. Valores permitidos: SD, HD, UHD, MAX |
LicenseType |
Cadena |
No |
Valores permitidos: SVOD, FVOD, EST, POEST, VOD |
ID de beneficio |
Cadena |
No |
Identificador de un canal o suscripción (obligatorio para las ofertas de SVOD) |
Tipo de identificador de plataforma
Estructura de identificadores de plataforma que contiene los identificadores de título.
Nombre del campo |
Type |
Necesario |
Description |
GTI |
Cadena |
Sí |
Identificador de título global |
ID de editor |
Identificador de editor [] |
Sí |
Identificadores de editor |
PublisherIdentifier Type
La lista de identificadores proporcionados por los socios.
Nombre del campo |
Type |
Necesario |
Description |
VÁLIDO |
Cadena |
Sí |
Identificador de título |
Mercado |
Cadena |
Sí |
El Amazon Marketplace al que se envió el título. El valor predeterminado es GLOBAL y no es obligatorio proporcionarlo. |
Tipo ProgressCode
Valores de enumeración de códigos de progreso que indican el estado general de la entrega de activos.
Value |
Description |
Listo |
Se han ingerido activos |
Problema |
Hay un problema con la entrega o el procesamiento de los activos |
En proceso |
Los activos se están entregando y procesando |
Falta |
Aún no se ha entregado un activo específico |
Progressiveness Type
Estructura de elementos de detalle de progreso que proporciona estadísticas resumidas.
Nombre del campo |
Type |
Necesario |
Description |
Progreso |
Código de progreso |
Sí |
Código de progreso |
Total |
Largo |
Sí |
Recuento total de activos |
Acción necesaria |
Largo |
Sí |
Number of assets from the total count that require action |
ProductTitlePartStatus Type
La estructura de datos principal que representa el estado de una única entrega de activos requerida. Esto incluye el estado de la entrega, los requisitos de acción y los datos detallados a nivel de la transacción.
Nombre del campo |
Type |
Es obligatorio |
Description |
Tipo principal |
Cadena |
Sí |
El tipo principal del activo |
Tipo secundario |
Cadena |
Sí |
Tipo secundario: por ejemplo, si el tipo principal era IMAGEN, el subtipo podría ser 2x3 o Poster |
FormatProfile |
Cadena |
No |
Formato, perfil o calidad |
Configuración regional |
Cadena |
No |
Configuración regional - ex en-US o es-419 |
Contextos de oferta |
Alcance de entrega [] |
Sí |
Cada OfferContext representa una configuración de oferta específica (región, tipo de licencia, perfil de formato, etc.) que utiliza el activo |
Partes condicionales del título |
Parte del título condicional del producto [] |
No |
Partes condicionales del título |
Tipo de regla |
Cadena |
Sí |
Tipo de regla: obligatoria, recomendada, condicional |
Tipo de acción |
Cadena |
Sí |
tipo de acción |
Fuentes de reglas |
Cadena [] |
Sí |
Fuentes de reglas |
Última entrega |
Entrega del producto |
No |
Información de la última entrega |
Entrega anterior exitosa |
Entrega del producto |
No |
Información previa sobre la entrega exitosa |
Fecha de la primera entrega |
Cadena |
No |
Primera fecha de entrega |
Progreso |
Código de progreso |
Sí |
Código de progreso: Listo, emitido, en proceso, faltante |
Fecha prevista |
Cadena |
No |
Fecha de entrega prevista |
Fecha de inicio más temprana |
Cadena |
No |
Fecha de inicio más temprana |
Valores de tipo principal comunes
Los tipos principales comunes identifica la categoría de activo que se entrega.
Value |
Description |
METADATOS |
Metadatos del título (descripciones, reparto, equipo, etc.) |
VÍDEO |
Archivos mezzanine de vídeo |
IMAGEN |
Obra de arte (arte de caja, portada, imágenes de héroes, pósters) |
AUDIO |
Pistas de audio |
TEXTO_CRONOMETRADO |
Subtítulos y subtítulos |
Valores comunes de ActionType
El campo ActionType indica si es necesario realizar alguna acción en relación con una entrega de activos específica.
Value |
Description |
ACCIÓN NECESARIA |
Falta el activo o tiene errores que deben resolverse para que el título se publique |
ACTION_RECOMMENDED |
El activo no es obligatorio, pero se recomienda para mejorar la experiencia del cliente |
NO ES NECESARIO REALIZAR NINGUNA ACCIÓN |
El activo se ha entregado correctamente, no es necesario realizar ninguna acción |
Valores de tipo de regla comunes
El campo RuleType define si la publicación de un activo es obligatoria u opcional para su título.
Value |
Description |
obligatorio |
Debe entregarse para que el título se publique |
recomendado |
No es obligatorio, pero mejora la experiencia del cliente |
condicional |
Necesario solo si se cumplen ciertas condiciones |
ProductConditionalTitlePart Type
Estructura de artículo de título condicional que define los requisitos condicionales para la entrega de activos.
Nombre del campo |
Type |
Es obligatorio |
Description |
Tipo de regla |
Cadena |
Sí |
tipo de regla |
Regiones |
Cadena [] |
Sí |
Lista de regiones o territorios |
Partes del título |
Descripción de la pieza del título del producto [] |
Sí |
Partes del título |
Valores de tipo de regla
El campo de tipo de regla define la relación lógica entre las partes condicionales del título.
Value |
Description |
ANIDADO |
Todos los elementos del título de la estructura deben cumplirse (lógica AND) |
INDIVIDUAL |
Cualquiera de las partes del título cumple con el requisito (o la lógica) |
ProductTitlePartDescriptor Type
Title Estructura descriptora de la parte que define un requisito específico de la parte del título.
Nombre del campo |
Type |
Es obligatorio |
Description |
Tipo principal |
Cadena |
Sí |
El tipo principal del activo |
Tipo secundario |
Cadena |
Sí |
Tipo secundario: por ejemplo, si el tipo principal era IMAGEN, el subtipo podría ser 2x3 o Poster |
FormatProfile |
Cadena |
No |
Formato, perfil o calidad |
Configuración regional |
Cadena |
No |
Configuración regional - ex en-US o es-419 |
Tipo de entrega del producto
Información de entrega del producto que proporciona información detallada sobre la entrega de un activo. Este campo será nulo si el activo aún no se ha entregado.
Nombre del campo |
Type |
Es obligatorio |
Description |
Estado |
Cadena |
No |
Estado de entrega: NOT_DELIVERED o SUCCESSFULLY_DELIVERED |
NOMBRE DE ARCHIVO |
Cadena |
No |
Nombre del archivo |
Hash |
Cadena |
No |
Hash o suma de comprobación del archivo |
Fecha de entrega |
Cadena |
No |
Fecha de entrega en formato ISO 8601 |
Locale |
Cadena |
No |
Locale |
ServiceProvider |
Cadena |
No |
Proveedor de servicios o cuenta de entrega |
Tipo de presentación |
Cadena |
No |
Presentation type |
Tipo de rango dinámico |
Cadena |
No |
tipo de rango dinámico |
Instrucciones |
Instrucción de entrega del producto [] |
No |
Instrucciones de entrega o errores |
Valores de estado comunes
El campo Estado indica si la entrega de un activo se recibió y procesó correctamente.
Value |
Description |
ENTREGADO SATISFACTORIAMENTE |
El activo se entregó y procesó correctamente |
NO SE HA ENTREGADO |
No se ha recibido el activo |
ProductDeliveryInstruction Type
Estructura de instrucciones de entrega del producto que proporciona códigos de error e información de estado. Las instrucciones pueden aparecer en la respuesta de nivel superior (resumiendo todos los problemas de entrega) o en los objetos de ProductDelivery (específicos de las entregas de activos individuales).
Nombre del campo |
Type |
Es obligatorio |
Description |
Parte del título |
Descriptor de la parte del título del producto |
No |
Descriptor de la parte del título |
Estado de la pieza del título |
Cadena |
No |
Estado de entrega de la pieza de título |
Código de error |
Cadena |
No |
Código de error |
Regiones |
Cadena [] |
No |
Lista de regiones o territorios |
Valores comunes de TitlePartStatus
El campo TitlePartStatus indica el estado de entrega de un activo en los mensajes de instrucciones.
Value |
Description |
NOT_DELIVERED |
El activo no se ha entregado |
¿ENTREGADO CORRECTAMENTE |
El activo se entregó correctamente |
Nota: Los esquemas anteriores representan la estructura de respuesta de la API actual y pueden mejorarse en versiones futuras.
Ejemplo 2: Faltan activos necesarios
En este ejemplo, se muestra una respuesta de la API cuando faltan los activos necesarios, y se muestra cómo la API indica el estado de ACTION_NEEDED y proporciona información sobre los errores.
{
"Destination": {
"Publisher": "1cendgametestpartner1"
},
"Instructions": [
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "HD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": {
"FormatProfile": null,
"Locale": "ja",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
"TitlePartStatus": "SUCCESSFULLY_DELIVERED"
}
],
"OverallProgressCode": "Issue",
"ProgressDetail": [
{
"ActionNeeded": 0,
"Progress": "Ready",
"Total": 8
},
{
"ActionNeeded": 2,
"Progress": "Missing",
"Total": 2
}
],
"Scope": {
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": null,
"FormatProfile": null,
"LicenseType": null,
"Marketplace": "GLOBAL",
"Region": null
},
"TitlePartStatus": [
{
"ActionType": "ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE", "PR", "AU", "JP", "GB", "US", "CA"],
"RuleType": "NESTED",
"TitleParts": [
{
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
}
]
}
],
"EarliestStartDate": "Thu Jan 09 15:00:00 UTC 2025",
"FormatProfile": "SD",
"LastDelivery": null,
"Locale": null,
"OfferContexts": [
{
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": "Prime",
"FormatProfile": "SD",
"LicenseType": "SVOD",
"Marketplace": "GLOBAL",
"Region": "US"
}
],
"PrimaryType": "VIDEO",
"PriorSuccessfulDelivery": null,
"Progress": "Missing",
"RuleSources": ["PUBLISHING_SPEC"],
"RuleType": "REQUIRED",
"SecondaryType": "MEZZ"
},
{
"ActionType": "NO_ACTION_NEEDED",
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "ja-jp",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "ja",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
},
{
"ActionType": "NO_ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE"],
"RuleType": "SINGLE",
"TitleParts": [
{
"FormatProfile": null,
"Locale": "de",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
{
"FormatProfile": null,
"Locale": "en",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
}
]
}
],
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "de-de",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "de",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
}
]
}