Esquemas de carga útil da API Avails

Tipo

Descrição

Booleano

Tipo booleano. Valores permitidos: true, false

Integer

32-bit signed integer.

LongInteger

64-bit signed integer.

Decimal

Floating point number.

String

An array of characters.

Timestamp

ISO time stamp.

Enum

Uma string enumerada com um conjunto predefinido de valores permitidos.

Struct

A estrutura da estrutura serve como um agregador para outros atributos.

Array

A coletânea de itens do tipo ASME. Designado por [].

Atributo

Tipo

É obrigatório

Descrição

avail

Avail

Sim

Dados de disponibilidade

Atributo

Tipo

É obrigatório

Descrição

sucesso

Booleano

Sim

Status de operação

erros

Erro[]

Não

Lista de erros em caso de falha

Atributo

Tipo

É obrigatório

Descrição

avail

Avail

Sim

Dados de disponibilidade

Atributo

Tipo

É obrigatório

Descrição

sucesso

Booleano

Sim

Status da operação

erros

Erro[]

Não

Lista de erros em caso de falha

Atributo

Tipo

É obrigatório

Descrição

sucesso

Booleano

Sim

Status da operação

erros

Erro[]

Não

Lista de erros em caso de falha

Atributo

Tipo

É obrigatório

Descrição

avail

Avail

Sim

Dados de disponibilidade

sucesso

Booleano

Sim

Status da operação

erros

Erro[]

Não

Lista de erros em caso de falha

Atributo

Tipo

É obrigatório

Descrição

requestItems

PutAvailsBatchAPIRequestItem[]

Sim

Lista de solicitações individuais

Atributo

Tipo

É obrigatório

Descrição

responseItems

PutAvailsBatchAPIResponseItem[]

Sim

Lista de itens de resposta

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

caminho

String

Sim

Caminho para um recurso para esse item de solicitação.

Para o modelo de Full Extract, o formato é:
/avails/{licensor}/full-extract/{ALID}

Para o modelo de Extração Parcial, o formato é:
/avails/{licensor}/partial-extract/transactions/{transactionID}

body

PutAvailsBatchAPIRequestItemBody

Sim

Dados de disponibilidade

Atributo

Tipo

É obrigatório

Descrição

avail

Avail

Sim

Dados de disponibilidade

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

sucesso

Booleano

Sim

Status da operação

erros

Erro[]

Não

Lista de erros em caso de falha

Atributo

Tipo

É obrigatório

Descrição

requestItems

ValidateAvailsBatchAPIRequestItem[]

Sim

Lista de solicitações individuais

Atributo

Tipo

É obrigatório

Descrição

responseItems

ValidateAvailsBatchAPIResponseItem[]

Sim

Lista de itens de resposta

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

caminho

String

Sim

Caminho para um recurso para este item de solicitação

Para um modelo de Full Extract , o formato é: /avails/{licensor}/full-extract/{ALID}/validate

Para um modelo de Extração Parcial, o formato é: /avails/{licensor}/partial-extract/transactions/{transactionID}/validate

body

ValidateAvailsBatchAPIRequestItemBody

Sim

Body de solicitação

Atributo

Tipo

É obrigatório

Descrição

avail

Avail

Sim

Dados de disponibilidade

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

sucesso

Booleano

Sim

Status da operação

erros

Erro[]

Não

Lista de erros em caso de falha

Atributo

Tipo

É obrigatório

Descrição

requestItems

DeleteAvailsBatchAPIRequestItem[]

Sim

Lista de solicitações individuais

Atributo

Tipo

É obrigatório

Descrição

responseItems

DeleteAvailsBatchAPIResponseItem[]

Sim

Lista de itens de resposta.

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

caminho

String

Sim

Caminho a um recurso para este item de solicitação.

Para o modelo de Full Extract, o formato é:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH|FIXED_FEE}&channelIdentity={Channel}

Para o modelo de Partial Extract, o formato é:
/avails/{licensor}/partial-extract/transactions/{transactionID}

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

sucesso

Booleano

Sim

Status da operação

erros

Erro[]

Não

Lista de erros em caso de falha

Atributo

Tipo

É obrigatório

Descrição

requestItems

GetAvailsBatchAPIRequestItem[]

Sim

Lista de solicitações individuais

Atributo

Tipo

É obrigatório

Descrição

responseItems

GetAvailsBatchAPIResponseItem[]

Sim

Lista de itens de resposta

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

caminho

String

Sim

Caminho a um recurso para este item de solicitação.

Para o modelo de Full Extract, o formato é:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

Para o modelo de Partial Extract, o formato é:
/avails/{licensor}/partial-extract/transactions/{transactionID}

Atributo

Tipo

É obrigatório

Descrição

requestItemId

String

Sim

Identificador único do item em solicitação em lote

sucesso

Booleano

Sim

Status da operação

erros

Erro[]

Não

Lista de erros em caso de falha

avail

Avail

Não

Objeto de avail

Atributo

Tipo

É obrigatório

Descrição

código

String

Sim

Uma string que descreve o tipo de erro.

Códigos de erro de validação: APIV{number}, CRMSV{number}
Códigos de erro de serviço: APIE{number}, CRMSE{number}

Exemplos: APIV400, CRMSE500

mensagem

String

Sim

Descrição de erro legível a humanos

Atributo

Tipo

Obrigatório

Observações

ALID

String

Sim

Especifica o identificador do título. Deve corresponder ao ALID especificado na contribuição de metadados.

Disposição

AvailDisposition

Sim

Especifica a granularidade do modelo de extração.

Licenciante

Publicante

Sim

Especifica informações sobre a entidade concedendo uma licença ao Prime Video.

Ativo

AvailAsset[]

Sim

Informações sobre o ativo. Apenas um ativo deve ser especificado na lista.

Transação

AvailTrans[]

Sim

Informações sobre a transação.

SharedEntitlement

AvailSharedEntitlement[]

Não

Informações sobre direitos para outros serviços.

Atributo

Tipo

Obrigatório

Observações

EntryType

Enum

Sim

Valores permitidos: FullExtract, FullDelete, PartialExtract, PartialDelete

Atributo

Tipo

Obrigatório

Notes

DisplayName

String

Sim

Especifica o nome do parceiro do Prime Video. Esse valor será fornecido aos parceiros pelo Prime Video. Deve ser o mesmo valor que o usado em arquivos EMA.

Atributo

Tipo

Obrigatório

Observações

_contentID

String

Sim

Especifica a ID de conteúdo para este ativo. Esse valor será fornecido aos parceiros pelo Prime Video. Deve ter o mesmo valor usado nos arquivos EMA. Deve ser o mesmo que o valor de ALID fornecido no avail.

WorkType

Enum

Sim

Valores permitidos: filme, curta, episódio, temporada, suplementar

Metadados

AvailUnitMetadata

Não

Descreve os metadados para filme ou curta. Obrigatório quando o WorkType é filme ou episódio.

EpisodeMetadata

AvailEpisodeMetadata

Não

Descreve metadados para o episódio. Obrigatório quando o WorkType é episódio.

SeasonMetadata

AvailSeasonMetadata

Não

Descreve metadados para a temporada. Obrigatório quando o WorkType é temporada.

Atributo

Tipo

Obrigatório

Observações

_ecosystem

Enum

Sim

Valores permitidos: DMA

EcosystemID

String

Sim

Identificador de título específico de ecossistema

Atributo

Tipo

Obrigatório

Observações

TitleInternalAlias

String[]

Sim

Nome do título. Apenas um nome de título deve ser especificado na lista.

Atributo

Tipo

Obrigatório

Observações

TitleInternalAlias

String[]

Sim

Nome do título para episódio. Apenas um nome de título deve ser especificado na lista.

EpisodeNumber

ContentSequenceInfo

Sim

Número deste episódio na temporada.

SeasonMetadata

AvailSeasonMetadata

Sim

Descreve metadados para temporada. Obrigatório quando o WorkType é episódio ou temporada.

SeriesMetadata

AvailSeriesMetadata

Sim

Descreve metadados para série. Obrigatório quando o WorkType é episódio ou temporada.

Atributo

Tipo

Obrigatório

Observações

SeasonContentID

String

Sim

ALID para temporada.

SeasonTitleInternalAlias

String[]

Não

Nome do título para temporada. Apenas um nome de título deve ser especificado na lista.

SeasonNumber

ContentSequenceInfo

Sim

Número desta temporada na série.

NumberOfEpisodes

Número inteiro

Sim

Número de episódios nesta temporada.

SeriesMetadata

AvailSeriesMetadata

Não

Descreve os metadados da série. Obrigatório quando WorkType é Temporada.

Atributo

Tipo

Obrigatório

Observações

SeriesContentID

String

Sim

ALID para séries.

SeriesTitleInternalAlias

String[]

Não

Nome do título para séries. Apenas um nome de título deve ser especificado na lista.

NumberOfSeasons

Número inteiro

Não

Número de temporadas nesta série.

Atributo

Tipo

Obrigatório

Observações

_TransactionID

String

Não

Identificador único para a janela de disponibilidade. Obrigatório ao usar PartialExtract. Opcional ao usar FullExtract.

LicenseType

Enum

Sim

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

Território

Região[]

Sim

Território onde a distribuição foi permitida. Somente um único item de território deve ser fornecido. Todas as transações em um único objeto Avail devem ter o mesmo território.

Início

DateTime

Sim

A data e hora de início da distribuição em formato ISO.

Término

DateTime

Não

A data e hora de término da distribuição em formato ISO. Se não for fornecido, a distribuição tem duração ilimitada.

AssetLanguage

AssetLanguage[]

Não

O idioma para o ativo expressado como código de idioma ISO com tipo de ativo. Tipos de ativo permitidos: legenda, áudio, subdublagem, sub, dublagem, ov, mta, qualquer

AllowedLanguage

AssetLanguage[]

Não

Código de idioma ISO com tipo de ativo. Tipos de ativos permitidos: legenda, áudio, sub, dublagem, subdublagem, qualquer

HoldbackLanguage

AssetLanguage[]

Não

Código de idioma com tipo de ativo. Tipos de ativo permitidos: legenda, áudio, sub, dublagem, subdublagem, qualquer

LicenseRightsDescription

String

Não

Usado para especificar a prioridade de publicação.

FormatProfile

AvailFormatProfile

Sim

Qualidade do vídeo avaliado. Valores permitidos: SD, HD, UHD

ContractID

String

Não

Especifica as informações contratuais. Valores permitidos:
- CPH
- FIXED_FEE
- FIXED_FEE:{Deal ID}
Ao enviar avails, as opções FIXED_FEE são restritas pelo licenciante.

Termos

AvailTerms[]

Sim

Especifica a lista de termos de negócios para a janela de disponibilidade.

OtherInstructions

String

Não

Instruções de processamento adicionais para a janela de disponibilidade.

Atributo

Tipo

Obrigatório

Observações

país

String

Sim

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

Atributo

Tipo

Obrigatório

Observações

valor

String

Sim

O idioma para o ativo expressado como código de idioma RFC 5646 com tipo de ativo.

_asset

String

Não

Diferentes conjuntos de valores são permitidos, dependendo do atributo de idioma do tipo AvailTrans.

Valores permitidos para AvailTrans.AssetLanguage:
legenda, áudio, subdublagem, sub, dublagem, ov, mta, qualquer.
Este atributo requer o mesmo ativo enviado para todos os idiomas.

Valores permitidos para AvailTrans.AllowedLanguage e AvailTrans. HoldbackLanguage:
legenda, áudio, sub, dublagem, subdublagem, qualquer.
Quando um valor de ativo for “subdublagem”, “qualquer”, ou o valor estiver ausente, ele vai se espalhar para dois ativos: “legenda” and “áudio”.

Os ativos “sub” and “dublagem” são convertidos a seu equivalente MDDF “legenda” e “áudio”.

Atributo

Tipo

Obrigatório

Observações

valor

Enum

Sim

Qualidade do vídeo avaliado. Valores permitidos: SD, HD, UHD

Atributo

Tipo

Obrigatório

Observações

_termName

String

Sim

Identifica o termo. O valor não diferencia maiúsculas de minúsculas. Veja uma lista de valores permitidos a seguir.

Dinheiro

Dinheiro

Não

Para saber mais, veja a seguir.

Texto

String

Não

Para saber mais, veja a seguir.

Evento

DateTime

Não

Veja mais detalhes a seguir.

Booleano

Booleano

Não

Para saber mais, veja a seguir.

Duração

String

Não

Para saber mais, veja a seguir.

Número

Número inteiro

Não

Para saber mais, veja a seguir.

Nome do termo

Atributo

Obrigatório

Observações

ChannelIdentity

Texto

Sim

Identificador para um canal ou assinatura.

Camada

Texto

Condicional

Faixa de preço. Obrigatório se o tipo de licença é POEST.

SRP

Dinheiro

Condicional

Preço de venda sugerido. Obrigatório se o tipo de licença é POEST.

WSP

Dinheiro

Condicional

Preço de atacado. Obrigatório se o tipo de licença é POEST.

Categoria

Texto

Condicional

Categoria de preço. Obrigatório se o tipo de licença é POEST.

AnnounceDate

Evento

Não

Data quando o vendedor tem permissão de anunciar a data de início de disponibilidade do título no território disponível.

SuppressionLiftDate

Evento

Condicional

Primeira data em que um título poderia ser anunciado publicamente como disponível em uma data futura específica no território do avail. Obrigatório se o tipo de licença é POEST.

RentalDuration

Duração

Condicional

Duração do período do aluguel em horas. Obrigatório se o tipo de licença é SVOD.

WatchDuration

Duração

Condicional

Quanto tempo, em horas, o usuário precisa concluir a visualização depois de iniciada. Obrigatório se o tipo de licença é SVOD.

Download

Texto

Não

A licença inclui permissão para fazer download. Os valores válidos são Sim e Não. Quando o tipo de licença é SVOD, deve ser especificada tanto a duração de aluguel quanto a duração de reprodução.

Exclusivo

Booleano

Não

Os ativos são exclusivos dentro do escopo da transação.

ExclusiveAttributes

Texto

Não

Especifica o tipo de exclusividade. Considerado somente quando Exclusivo é verdadeiro. Se não for fornecido, um valor padrão será usado se Exclusivo for verdadeiro.

BrandingRights

Booleano

Não

Indica a intenção do parceiro de exibir a marca.

BrandingRightsAttributes

Texto

Não

Especifica o texto da marca. Considerado somente quando BrandingRights é verdadeiro. Se não for fornecido, um valor padrão será usado quando brandingRights for verdadeiro.

allowAds

Booleano

Não

Determina se anúncios publicitários são permitidos ou proibidos. Este termo pode aparecer apenas uma vez.

allowedAdPlacement

Texto

Condicional

Especifica o local no rolo em que os anúncios publicitários podem ser inseridos. Os valores permitidos são: PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks.
Permitido somente quando allowAds é verdadeiro.

Esse termo pode aparecer mais de uma vez. allowedAdPlacement ou prohibitedAdPlacement podem ser especificados, mas não ambos.

prohibitedAdPlacement

Texto

Condicional

Especifica o local no rolo em que anúncios publicitários não podem ser inseridos. Os valores permitidos são: PreRoll, MidRoll, PostRoll,Overlays, PauseAds, Squeezebacks.
Este termo pode aparecer mais de uma vez.

Permitido somente quando allowAds for verdadeiro.

allowedAdPlacement ou prohibitedAdPlacement podem ser especificados, mas não ambos.

cuepointDeliveryAndUsage

Texto

Não

Especifica as obrigações de entrega e uso do ponto de referência. Valores permitidos: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated.

Permitido quando allowAds for verdadeiro.

blindBasisSelling

Texto

Não

Valores permitidos: GuaranteedImpressions, NoGuaranteedImpressions

Este atributo só deve estar presente se allowAds for definido como verdadeiro.

patrocínios

Texto

Não

Valores permitidos: Permitted, Prohibited, PermittedWithRestrictions.

Este atributo só deve estar presente quando allowAds for definido como verdadeiro.

sponsorshipsRestrictions

Texto

Condicional

Texto de forma livre

Este atributo só deve estar presente se patrocínios forem definidos como AllowedWithRestrictions.

talentAndAmazonAdGuidelines

Texto

Não

Valores permitidos: NoRestrictions, ConsultationRequired

Este atributo só deve estar presente se allowAds for definido como verdadeiro.

talentRestrictions

Texto

Condicional

Texto de forma livre

Este atributo só deve estar presente se talentAndAmazonAdGuidelines for definido como ConsultationRequired.

adLoadLimit

Texto

Não

Número de minutos de anúncios publicitários por hora. O valor deve ser um número inteiro válido.

Este atributo só deve estar presente se allowAds for definido como verdadeiro.

Atributo

Tipo

Obrigatório

Observações

valor

Decimal

Não

Valor monetário obrigatório para alguns tipos de preço

_currency

String

Sim

Código da moeda ISO

Atributo

Tipo

Obrigatório

Observações

Número

Número inteiro

Sim

Número sequencial do episódio, como número do episódio ou número da temporada.

Valor numerado

Descrição

TVOD

TVOD significa compra ou aluguel. Tipos de licença relacionados: EST, VOD, POEST

PRIME_SUBSCRIPTION

Assinatura Amazon Prime ou Amazon Kids+. Tipos de licença relacionados: SVOD

CHANNELS

Assinatura de canal de terceiro. Tipos de licença relacionados: SVOD

FVOD

Conteúdo gratuito. Tipos de licença relacionados: FVOD