Esquemas de carga útil de las API de Avails

Tipo

Descripción

Boolean (booleano)

Tipo de dato lógico. Valores permitidos: true (verdadero), false (falso)

Integer (entero)

Entero con signo de 32 bits.

LongInteger (entero largo)

Entero con signo de 64 bits.

Decimal

Números de punto flotante.

String (cadena)

Una secuencia de caracteres.

Timestamp (marca temporal)

Marca temporal en formato ISO.

Enum (enumeración)

Una cadena de números con una cantidad de valores permitidos predefinido.

Struct (estructura)

Los tipos de datos de estructura sirven como un agregador para otros atributos.

Array (arreglo)

Colección de elementos de tipo ASME. Designado por [].

Atributo

Tipo

¿Es obligatorio?

Descripción

avail

Avail

Sí

Datos de disponibilidad

Atributo

Tipo

¿Es obligatorio?

Descripción

success

Boolean

Sí

Estado de la operación

errors

Error[]

No

Lista de errores en caso de fallo

Atributo

Tipo

¿Es obligatorio?

Descripción

avail

Avail

Sí

Datos de disponibilidad

Atributo

Tipo

¿Es obligatorio?

Descripción

success

Boolean

Sí

Estado de la operación

errors

Error[]

No

Lista de errores en caso de fallo

Atributo

Tipo

¿Es obligatorio?

Descripción

success

Boolean

Sí

Estado de la operación

errors

Error[]

No

Lista de errores en caso de fallo

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

Atributo

Tipo

¿Es obligatorio?

Descripción

requestItems

PutAvailsBatchAPIRequestItem[]

Sí

Lista de solicitudes individuales

Atributo

Tipo

¿Es obligatorio?

Descripción

responseItems

PutAvailsBatchAPIResponseItem[]

Sí

Lista de elementos de respuesta

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.

Para el modo de extracción completa, el formato es:
/avails/{licensor}/full-extract/{ALID}

Para el modo de extracción parcial, el formato es:
/avails/{licensor}/partial-extract/transactions/{transactionID}

body

PutAvailsBatchAPIRequestItemBody

Sí

Datos de disponibilidad

Atributo

Tipo

¿Es obligatorio?

Descripción

avail

Avail

Sí

Datos de disponibilidad

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

Atributo

Tipo

¿Es obligatorio?

Descripción

requestItems

ValidateAvailsBatchAPIRequestItem[]

Sí

Lista de solicitudes individuales

Atributo

Tipo

¿Es obligatorio?

Descripción

responseItems

ValidateAvailsBatchAPIResponseItem[]

Sí

Lista de elementos de respuesta

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

Para el modo de extracción completa, el formato es: /avails/{licensor}/full-extract/{ALID}/validate

Para el modo de extracción parcial, el formato es: /avails/{licensor}/partial-extract/transactions/{transactionID}/validate

body

ValidateAvailsBatchAPIRequestItemBody

Sí

Request body

Atributo

Tipo

¿Es obligatorio?

Descripción

avail

Avail

Sí

Datos de disponibilidad

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

Atributo

Tipo

¿Es obligatorio?

Descripción

requestItems

DeleteAvailsBatchAPIRequestItem[]

Sí

Lista de solicitudes individuales

Atributo

Tipo

¿Es obligatorio?

Descripción

responseItems

DeleteAvailsBatchAPIResponseItem[]

Sí

Lista de elementos de respuesta

Atributo

Tipo

¿Es obligatorio?

Descripción

requestItemId

Cadena

Sí

Identificador único del elemento en la solicitud por lotes

path

String

Sí

Ruta a un recurso para este elemento de solicitud.

Para el modo de extracción completa, el formato es:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH|FIXED_FEE}&channelIdentity={Channel}

Para el modo de extracción parcial, el formato es:
/avails/{licensor}/partial-extract/transactions/{transactionID}

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

Atributo

Tipo

¿Es obligatorio?

Descripción

requestItems

GetAvailsBatchAPIRequestItem[]

Sí

Lista de solicitudes individuales

Atributo

Tipo

¿Es obligatorio?

Descripción

responseItems

GetAvailsBatchAPIResponseItem[]

Sí

Lista de elementos de respuesta

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.

Para el modo de extracción completa, el formato es:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

Para el modo de extracción parcial, el formato es:
/avails/{licensor}/partial-extract/transactions/{transactionID}

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

Atributo

Tipo

¿Es obligatorio?

Descripción

code

String

Sí

Una cadena que describe el tipo de error.

Códigos de validación de error: APIV{número}, CRMSV{número}
Códigos de error de servicio: APIE{número}, CRMSE{número}

Ejemplos: APIV400, CRMSE500

message

String

Sí

Descripción del error en lenguaje natural

Atributo

Tipo

¿Es obligatorio?

Descripción

ALID

String

Sí

Especifica el identificador del título. Debe coincidir con el ALID especificado en la contribución de metadatos.

Disposition

AvailDisposition

Sí

Especifica la granularidad del modelo de extracción.

Licensor

Publisher

Sí

Informa sobre la entidad que otorga la licencia a Prime Video.

Asset

AvailAsset[]

Sí

Información sobre el recurso. Solo se debe incluir un recurso en la lista.

Transaction

AvailTrans[]

Sí

Información sobre la transacción.

SharedEntitlement

AvailSharedEntitlement[]

No

Información sobre derechos de otros servicios.

Atributo

Tipo

¿Es obligatorio?

Descripción

EntryType

Enum

Sí

Valores permitidos: FullExtract, FullDelete, PartialExtract, PartialDelete

Atributo

Tipo

¿Es obligatorio?

Descripción

DisplayName

String

Sí

Indica 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.

Atributo

Tipo

¿Es obligatorio?

Descripción

_contentID

String

Sí

Indica el ID del contenido de este recurso. Prime Video proporcionará este valor a los socios. Debe tener el mismo valor que el utilizado en los archivos EMA. Debe ser igual al valor de ALID proporcionado en el Avail.

WorkType

Enum

Sí

Valores permitidos: Movie, Short, Episode, Season, Supplemental

Metadata

AvailUnitMetadata

No

Describe los metadatos de una película o cortometraje. Obligatorio cuando el WorkType (tipo de trabajo) es una película o un cortometraje.

EpisodeMetadata

AvailEpisodeMetadata

No

Describe los metadatos de un episodio. Obligatorio cuando el WorkType es un episodio.

SeasonMetadata

AvailSeasonMetadata

No

Describe los metadatos de una temporada. Obligatorio cuando el WorkType es una temporada.

Atributo

Tipo

¿Es obligatorio?

Descripción

_ecosystem

Enum

Sí

Valores permitidos: DMA

EcosystemID

String

Sí

Identificador del título específico del ecosistema

Atributo

Tipo

¿Es obligatorio?

Descripción

TitleInternalAlias

String[]

Sí

Nombre del título. Solo se debe incluir un nombre de título en la lista.

Atributo

Tipo

¿Es obligatorio?

Descripción

TitleInternalAlias

String[]

Sí

Nombre del título del episodio. Solo se debe incluir un nombre de título en la lista.

EpisodeNumber

ContentSequenceInfo

Sí

Número de este episodio dentro la temporada.

SeasonMetadata

AvailSeasonMetadata

Sí

Describe los metadatos de la temporada. Obligatorio cuando el WorkType es un episodio o una temporada.

SeriesMetadata

AvailSeriesMetadata

Sí

Describe los metadatos de una serie. Obligatorio cuando el WorkType es un episodio o una temporada.

Atributo

Tipo

¿Es obligatorio?

Descripción

SeasonContentID

String

Sí

ALID de la temporada.

SeasonTitleInternalAlias

String[]

No

Nombre del título de la temporada. Solo se debe incluir un nombre de título en la lista.

SeasonNumber

ContentSequenceInfo

Sí

Número de esta temporada dentro de la serie.

NumberOfEpisodes

Integer

Sí

Número de episodios de esta temporada.

SeriesMetadata

AvailSeriesMetadata

No

Describe los metadatos de la serie. Obligatorio cuando el WorkType es una temporada.

Atributo

Tipo

¿Es obligatorio?

Descripción

SeriesContentID

String

Sí

ALID de la serie.

SeriesTitleInternalAlias

String[]

No

Nombre del título de la serie. Solo se debe incluir un nombre de título en la lista.

NumberOfSeasons

Integer

No

Número de temporadas de esta serie.

Atributo

Tipo

¿Es obligatorio?

Descripción

_TransactionID

String

No

Identificador único de periodo de disponibilidad. Necesario cuando se usa PartialExtract. Opcional cuando se utiliza FullExtract.

LicenseType

Enum

Sí

Valores permitidos: SVOD, FVOD, EST, POEST, VOD

Territory

Region[]

Sí

Territorio donde está permitida la distribución. Solo se debe incluir un elemento de territorio. Todas las transacciones de un mismo objeto de Avail deben tener el mismo territorio.

Start

DateTime

Sí

La fecha y la hora de inicio de distribución deben indicarse en formato ISO.

End

DateTime

No

La fecha y la hora de finalización de distribución deben indicarse en formato ISO. Si no se proporciona, la distribución tendrá una disponibilidad ilimitada.

AssetLanguage

AssetLanguage[]

No

Idioma del recurso expresado como código de idioma ISO con el tipo de recurso. Tipos de recursos permitidos: subtítulos, audio, doblaje, VO, MTA o cualquiera

AllowedLanguage

AssetLanguage[]

No

Código de idioma ISO con el tipo de recurso. Tipos de recursos permitidos: subtítulos, audio, doblaje, VO, MTA o cualquiera

HoldbackLanguage

AssetLanguage[]

No

Código de idioma ISO con el tipo de recurso. Tipos de recursos permitidos: subtítulos, audio, doblaje, VO, MTA o cualquiera

LicenseRightsDescription

String

No

Se utiliza para especificar la prioridad de publicación.

FormatProfile

AvailFormatProfile

Sí

Calidad del video disponible. Valores permitidos: SD, HD, UHD

ContractID

String

No

Especifica la información contractual. Valores permitidos:
- CPH
- FIXED_FEE
- FIXED_FEE:{Deal ID}
Al enviar Avails, las opciones FIXED_FEE están restringidas por el licenciante.

Terms

AvailTerms[]

Yes

Especifica la lista de términos comerciales para el periodo de disponibilidad.

OtherInstructions

String

No

Instrucciones de procesos adicionales para el periodo de disponibilidad.

Atributo

Tipo

¿Es obligatorio?

Descripción

country

String

Sí

Código de país de 2 letras según ISO 3166-1

Atributo

Tipo

¿Es obligatorio?

Descripción

value

String

Sí

Idioma del recurso expresado como código de idioma RFC 5646 con el tipo de recurso.

_asset

String

No

Se permiten diferentes tipos de valores en función del atributo de idioma del tipo AvailTrans.

Valores permitidos para AvailTrans.AssetLanguage:
subtítulos, audio, doblaje, VO, MTA o cualquiera.
Este atributo requiere que se envíe el mismo recurso en todos los idiomas.

Valores permitidos para AvailTrans.AllowedLanguage y AvailTrans. HoldbackLanguage:
subtítulos, audio, doblaje, VO, MTA o cualquiera.
Cuando el valor del recurso sea “subdub” o “any”, o cuando no haya valor, se dispersará en dos recursos: “subtitle” y “audio”.

Los recursos “sub” y “dub” se convierten en sus equivalentes MDDF “subtitle” y “audio”.

Atributo

Tipo

¿Es obligatorio?

Descripción

value

Enum

Sí

Calidad del video disponible. Valores permitidos: SD, HD, UHD

Atributo

Tipo

¿Es obligatorio?

Descripción

_termName

String

Sí

Identifica el término. El valor no distingue entre mayúsculas y minúsculas. Para obtener una lista de valores permitidos, consulta más abajo.

Money

Money

No

Para más detalles, consulta más abajo.

Text

String

No

Para más detalles, consulta más abajo.

Event

DateTime

No

Para más detalles, consulta más abajo.

Boolean

Boolean

No

Para más detalles, consulta más abajo.

Duration

String

No

Para más detalles, consulta más abajo.

Number

Integer

No

Para más detalles, consulta más abajo.

Term name

Atributo

¿Es obligatorio?

Descripción

ChannelIdentity

Text

Sí

Identificador de un canal o suscripción.

Tier

Text

Condicional

Nivel de precios. Obligatorio si el tipo de licencia es POEST.

SRP

Money

Condicional

Precio de venta recomendado. Obligatorio si el tipo de licencia es POEST.

WSP

Money

Condicional

Precio mayorista. Obligatorio si el tipo de licencia es POEST.

Category

Text

Condicional

Categoría de precio. Obligatorio si el tipo de licencia es POEST.

AnnounceDate

Event

No

Fecha en la que se permite al minorista anunciar la fecha de inicio de disponibilidad del título dentro del territorio.

SuppressionLiftDate

Event

Condicional

Primera fecha en la que un título podría ser anunciado públicamente como disponible en una fecha futura específica en el territorio. Obligatorio si el tipo de licencia es POEST.

RentalDuration

Duration

Condicional

Duración del periodo de alquiler en horas. Obligatorio si el tipo de licencia es SVOD.

WatchDuration

Duration

Condicional

Cuánto tiempo tiene el usuario para completar la visualización una vez comenzada, en horas. Obligatorio si el tipo de licencia es SVOD.

Download

Text

No

La licencia incluye permiso de descarga. Los valores permitidos son Yes o No. Cuando el tipo de licencia es SVOD, tanto la duración de alquiler como la de visualización deben estar especificadas.

Exclusive

Boolean

No

Los recursos son exclusivos para el ámbito de la transacción.

ExclusiveAttributes

Text

No

Especifica el tipo de exclusividad. Solo se tiene en cuenta cuando Exclusive es true (verdadero). Se utilizará un valor predeterminado si no se proporciona uno cuando Exclusive es true (verdadero).

BrandingRights

Boolean

No

Indica la intención del socio de mostrar la marca.

BrandingRightsAttributes

Text

No

Especifica el texto de la marca. Solo se tiene en cuenta cuando BrandingRights es true (verdadero). Se utilizará un valor predeterminado si no se proporciona uno cuando BrandingRights es true (verdadero).

allowAds

Boolean

No

Determina si los anuncios están permitidos o prohibidos. Este término puede aparecer solo una vez.

allowedAdPlacement

Text

Condicional

Especifica la ubicación en la secuencia donde se pueden insertar anuncios. Los valores permitidos son PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks.
Solo se permite cuando allowAds es true (verdadero).

Este término puede aparecer más de una vez. Se puede especificar allowedAdPlacement o prohibitedAdPlacement, pero no ambos.

prohibitedAdPlacement

Text

Condicional

Especifica la ubicación en la secuencia donde está prohibido insertar anuncios. Los valores permitidos son PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks.
Este término puede aparecer más de una vez.

Solo se permite cuando allowAds es true (verdadero).

Se puede especificar allowedAdPlacement o prohibitedAdPlacement, pero no ambos.

cuepointDeliveryAndUsage

Text

No

Especifica las obligaciones de entrega y uso de los puntos de referencia. Valores permitidos: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated.

Solo se permite cuando allowAds es true (verdadero).

blindBasisSelling

Text

No

Valores permitidos: GuaranteedImpressions, NoGuaranteedImpressions

Este atributo solo debe estar presente si allowAds es true (verdadero).

sponsorships

Text

No

Valores permitidos: Permitted, Prohibited, PermittedWithRestrictions.

Este atributo solo debe estar presente si allowAds es true (verdadero).

sponsorshipsRestrictions

Text

Condicional

Free-form text

Este atributo solo debe estar presente si Sponsorships está configurado en modo AllowedWithRestrictions.

talentAndAmazonAdGuidelines

Text

No

Valores permitidos: NoRestrictions, ConsultationRequired

Este atributo solo debe estar presente si allowAds es true (verdadero).

talentRestrictions

Text

Condicional

Free-form text

Este atributo solo debe estar presente si talentAndAmazonAdGuidelines está configurado en modo ConsultationRequired.

adLoadLimit

Text

No

Número de minutos de anuncios por hora. El valor debe ser un entero válido.

Este atributo solo debe estar presente si allowAds es true (verdadero).

Atributo

Tipo

¿Es obligatorio?

Descripción

value

Decimal

No

Valor económico, obligatorio para algunos tipos de precios

_currency

String

Sí

Código ISO de la divisa

Atributo

Tipo

¿Es obligatorio?

Descripción

Number

Integer

Sí

Número de secuencia del contenido, como número de episodio o número de temporada

Valor Enumerated

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 de canales de terceros. Tipos de licencia relacionados: SVOD

FVOD

Contenido gratuito. Tipos de licencia relacionados: FVOD