Video Central

A API Avails do Prime Video faz parte do pacote da API de conteúdo e permite que você gerencie a disponibilidade de seus títulos no Prime Video por meio da integração direta com seus sistemas de gerenciamento de direitos de conteúdo. Envie, atualize, recupere ou exclua períodos de disponibilidade com maior precisão e controle do que os carregamentos tradicionais de arquivos.

Por que usar a API Avails?

A API simplifica seu fluxo de trabalho de gerenciamento de conteúdo e oferece mais controle sobre seu catálogo Prime Video:

Gerenciamento automatizado – elimine carregamentos manuais e reduza erros automatizando envios e atualizações de períodos de disponibilidade, permitindo que sua equipe se concentre em tarefas estratégicas
Maior eficiência – atualize períodos de disponibilidade específicas sem precisar reenviar conjuntos de dados inteiros, economizando tempo e reduzindo o processamento redundante.
Feedback direto – valide seus dados em tempo real e receba mensagens de erro imediatas sem precisar fazer login no Slate para correções manuais.
Interoperabilidade – construído em uma interface REST independente de idioma, sistema e plataforma, acessível de qualquer sistema com conexão à Internet.

Operações e endpoints de API

Todos os endpoints são independentes de idioma e acessíveis via HTTP 1.1 a partir de qualquer sistema com conexão à internet. Os endpoints do Avails não seguem um protocolo específico e podem ser chamados em qualquer ordem, de acordo com as necessidades do seu fluxo de trabalho.

Sobre os modelos de extração
Um modelo de extração define como você estrutura e envia dados de disponibilidade para o Prime Video. Pense nisso como escolher entre nos enviar as informações completas do seu catálogo ou enviar apenas as alterações específicas que você precisa fazer.

Full Extract Model Enviar todas as janelas de disponibilidade para um escopo específico (Título + Território + Linha de Negócios) em uma única solicitação. Esse é o modelo padrão para todos os parceiros.

Quando usar: fornecer novos conteúdos, fazer atualizações abrangentes ou quando quiser garantir que todos os dados de disponibilidade de um livro sejam sincronizados.

Como funciona: você envia informações completas de disponibilidade e o Prime Video substitui todos os dados existentes desse escopo pelo seu envio.

Operação 1 - Criar/atualizar Avails

O que faz: Adiciona novos períodos de disponibilidade ou atualiza os existentes para seus títulos.
Por que você precisa disso: É assim que você informa ao Prime Video quando e onde seu conteúdo deve estar disponível para os clientes. Seja para lançar um novo conteúdo ou estender uma licença existente, esta operação garante que seus dados de disponibilidade estejam atualizados.

Operação 2 – Recuperar Avails

O que faz: Recupera informações de disponibilidade atual dos sistemas do Prime Video.
Por que você precisa disso: Para verificar quais dados de disponibilidade o Prime Video tem em arquivo, solucionar discrepâncias ou extrair dados para fins de relatórios e reconciliação.

Operação 3 – Validar Avails

O que faz: Verifica se há erros nos dados de disponibilidade antes de enviá-los aos sistemas ativos do Prime Video.
Por que você precisa disso: Detecta erros de formatação, campos obrigatórios ausentes ou violações das regras comerciais antes que eles afetem a disponibilidade do seu conteúdo. Isso economiza tempo ao eliminar a necessidade de enviar, aguardar o processamento, corrigir erros e reenviar.

Operação 4 – Excluir Avails

O que faz: Remove períodos de disponibilidade dos sistemas do Prime Video.
Por que você precisa disso: Para lidar com situações pontuais em que a disponibilidade precisa ser completamente removida, em vez de expirada.
Importante: É altamente recomendável que o conteúdo expire ajustando a data de término em vez de excluí-lo, exceto em casos de uso pontuais. A expiração mantém seus dados históricos e seu registro de auditoria.

Códigos de resposta HTTP

Todos os endpoints do Avails retornam códigos HTTP padrão que informam se a sua solicitação à API foi bem-sucedida ou falhou e se os erros são temporários (passíveis de nova tentativa) ou permanentes, permitindo que o seu sistema processe automaticamente com as respostas sem intervenção manual.

Código HTTP	Descrição	Possibilidade de repetição
200	A chamada de API foi bem-sucedida. Os solicitantes devem verificar o objeto de resposta para obter detalhes adicionais.	N/A
400	Solicitação inválida, incluindo falhas de validação.	Não
401	Não autorizado.	Não
404	Não encontrado.	Não
500	Erro interno.	Sim
503	Erro de dependência.	Sim

Observação: Para erros que permitem nova tentativa (500, 503), implemente uma lógica de repetição com intervalos apropriados entre as tentativas. Erros que não permitem nova tentativa (400, 401, 404) indicam problemas com sua solicitação que precisam ser corrigidos antes de reenviá-la.

Esquemas de API

Os esquemas descritos nesta documentação foram projetados para ajudar os desenvolvedores a se integrarem à API Avails. Todos os esquemas de carga útil seguem a norma MDDF API v2.6. Embora você possa incluir qualquer atributo da MDDF API v2.6 em sua carga útil, o Prime Video processa somente os atributos compatíveis. Os atributos não compatíveis serão ignorados.

Observação: Para obter uma referência completa dos atributos compatíveis que correspondem à nossa especificação Avails EMA, consulte a coluna Avails EMA na tabela de tipos de dados principais abaixo. Para obter informações sobre como as disponibilidades são gerenciadas e usadas no Prime Video, consulte a página de direitos de conteúdo.

Conversão de MDDF XML para JSON

A API MDDF Avails define seu esquema no formato XML, mas suporta cargas úteis em XML e JSON. As APIs Avails do Prime Video usam cargas úteis codificadas em JSON. O processo de conversão de MDDF XML em JSON é descrito abaixo:

Os namespaces são omitidos

Os elementos aninhados tornam-se propriedades aninhadas

Múltiplos elementos com o mesmo nome tornam-se elementos de matriz.

Atributos vão para propriedades e são precedidos por um sublinhado

Tipos de dados de esquema comuns

O esquema da API Avails suporta os seguintes tipos de dados:

Tipo

Descrição

Booleano

Tipo booleano. Valores permitidos: verdadeiro, falso

Número inteiro

Inteiro com sinal de 32 bits.

LongInteger

Inteiro com sinal de 64 bits.

Decimal

Número de ponto flutuante.

String

Uma matriz de caracteres.

Timestamp

Registro de data e hora ISO.

Enum

Uma string enumerada com um conjunto predefinido de valores permitidos.

Estrutura

A estrutura serve como um agregador para outros atributos.

Matriz

Coleção de itens do tipo ASME. Designado por [].

Observação: O número máximo de itens permitidos em solicitações em lote é limitado a 100.

Esquemas de solicitação e resposta

Esta seção define as estruturas de dados para todas as operações da API Avails. Esses esquemas especificam o formato exato das solicitações enviadas ao Prime Video e das respostas recebidas. Compreender essas estruturas é essencial para uma integração bem-sucedida da API.

Esquema 1 – Criar/atualizar Avails

Esses esquemas definem a estrutura para criar ou atualizar períodos de disponibilidade no sistema do Prime Video. Use-os quando precisar enviar novos direitos de conteúdo ou modificar os existentes.

Tipo PutAvailsAPIRequest
Este é o objeto de solicitação principal para enviar um período de disponibilidade.

Atributo	Tipo	É obrigatório	Descrição
avail	Avail	Sim	Dados de disponibilidade – esse é o atributo de nível superior de qualquer solicitação de envio ou validação

Tipo PutAvailsAPIResponse

A resposta que você receberá após enviar um período de disponibilidade. Verifique o campo sucessopara confirmar se a operação foi concluída e revise os erros se o envio falhar.

Atributo	Tipo	É obrigatório	Descrição
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha

Tipo PutAvailsBatchAPIRequest
Use esse esquema quando precisar enviar vários períodos de disponibilidade em uma única chamada de API. As operações em lote melhoram a eficiência ao gerenciar catálogos grandes ou fazer atualizações em massa.

Atributo	Tipo	É obrigatório	Descrição
requestItems	PutAvailsBatchAPIRequestItem[]	Sim	Lista de solicitações individuais

Tipo PutAvailsBatchAPIResponse
A resposta do lote retorna resultados individuais para cada item em sua solicitação de lote. Cada item de resposta corresponde a um item de solicitação por meio do requestItemId.

Atributo	Tipo	É obrigatório	Descrição
responseItems	PutAvailsBatchAPIResponseItem[]	Sim	Lista de itens de resposta

Tipo PutAvailsBatchAPIRequestItem
Cada item em uma solicitação em lote requer um identificador exclusivo e um caminho que especifique o tipo de operação (Full Extract) e o recurso de destino.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote. Essa é uma string exclusiva que você usará para identificar cada item no lote e será vinculada à nossa resposta em lote.
caminho	String	Sim	Caminho para um recurso para esse item de solicitação. Para o modelo Full Extract, o formato é: /avails/{licensor}/full-extract/{ALID}
corpo	PutAvailsBatchAPIRequestItemBody	Sim	Dados de disponibilidade

Tipo PutAvailsBatchAPIRequestItemBody
O corpo de cada item da solicitação em lote contém os dados reais de disponibilidade que você está enviando.

Atributo	Tipo	É obrigatório	Descrição
avail	Avail	Sim	Dados de disponibilidade

Tipo PutAvailsBatchAPIResponseItem
Cada item de resposta no lote indica sucesso ou falha na solicitação correspondente. Use o requestItemId para corresponder as respostas às suas solicitações originais.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha

Esquema 2 – Recuperar Avails

Esses esquemas definem como recuperar períodos de disponibilidade existentes do sistema do Prime Video. Use-os para consultar as informações de direitos atuais do seu conteúdo.

Tipo GetAvailsAPIResponse
A resposta contém os dados completos de disponibilidade do conteúdo solicitado, incluindo todos os termos de licenciamento e direitos territoriais.

Atributo	Tipo	É obrigatório	Descrição
avail	Avail	Sim	Dados de disponibilidade
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha

GetAvailsBatchAPIRequest
Recupere vários períodos de disponibilidade em uma única solicitação de API. Isso é eficiente quando você precisa verificar os direitos de vários títulos ou transações.

Atributo	Tipo	É obrigatório	Descrição
requestItems	GetAvailsBatchAPIRequestItem[]	Sim	Lista de solicitações individuais

GetAvailsBatchAPIResponse
Retorna os dados de disponibilidade de cada item solicitado. Cada resposta corresponde a uma solicitação por meio do requestItemId.

Atributo	Tipo	É obrigatório	Descrição
responseItems	GetAvailsBatchAPIResponseItem[]	Sim	Lista de itens de resposta

GetAvailsBatchAPIRequestItem
Cada item de solicitação get especifica o caminho para o recurso que você deseja recuperar.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote
caminho	String	Sim	Caminho para um recurso para esse item de solicitação. Para o modelo Full Extract, o formato é: /avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

GetAvailsBatchAPIResponseItem
Cada item de resposta contém os dados de disponibilidade se a recuperação foi bem-sucedida ou detalhes do erro se falhou.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha
avail	Avail	Não	Objeto disponível

Esquema 3 – Validar Avails

Esses esquemas permitem que você teste seus dados de disponibilidade antes de enviá-los ao sistema do Prime Video. A validação detecta erros antecipadamente sem criar ou modificar os períodos de disponibilidade reais.

Tipo ValidateAvailsAPIRequest
A resposta de validação indica se seus dados atendem a todas as regras de validação. Revise quaisquer erros antes de enviar a solicitação de criação ou atualização.

Atributo	Tipo	É obrigatório	Descrição
avail	Avail	Sim	Dados de disponibilidade

Tipo ValidateAvailsAPIResponse
A resposta de validação indica se seus dados atendem a todas as regras de validação. Revise quaisquer erros antes de enviar a solicitação de criação ou atualização.

Atributo	Tipo	É obrigatório	Descrição
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha

Tipo ValidateAvailsBatchAPIRequest
Valide vários períodos de disponibilidade em uma única chamada. Isso é particularmente útil ao preparar envios de grandes lotes.

Atributo	Tipo	É obrigatório	Descrição
requestItems	ValidateAvailsBatchAPIRequestItem[]	Sim	Lista de solicitações individuais

Tipo ValidateAvailsBatchAPIResponse
Retorna os resultados da validação de cada item em seu lote. Cada resposta corresponde a um item de solicitação por meio do requestItemId.

Atributo	Tipo	É obrigatório	Descrição
responseItems	ValidateAvailsBatchAPIResponseItem[]	Sim	Lista de itens de resposta

Tipo ValidateAvailsBatchAPIRequestItem
Cada item de solicitação de validação inclui o caminho do recurso com /validate anexado para diferenciá-lo das operações reais de criação ou atualização.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote
caminho	String	Sim	Caminho para um recurso para a solicitação: Modelo Full Extract: /avails/{licensor}/full-extract/{ALID}/validate
corpo	ValidateAvailsBatchAPIRequestItemBody	Sim	Corpo da solicitação

Tipo ValidateAvailsBatchAPIRequestItemBody
Contém os dados do período de disponibilidade a serem validados.

Atributo	Tipo	É obrigatório	Descrição
avail	Avail	Sim	Dados de disponibilidade

Tipo ValidateAvailsBatchAPIResponseItem
Cada item de resposta de validação mostra se os dados correspondentes passaram nas verificações de validação.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha

Esquema 4 – Excluir Avails

Esses esquemas definem como remover os períodos de disponibilidade do sistema do Prime Video.

Importante: É altamente recomendável que o conteúdo expire ajustando a data de término em vez de excluí-lo, exceto em casos de uso específicos, como atender a requisitos de conformidade. O conteúdo expirado mantém seus dados históricos e seu registro de auditoria, o que é valioso para relatórios e reconciliação.

Tipo DeleteAvailsAPIResponse
Confirma se a operação de exclusão foi concluída com sucesso. Verifique o campo sucesso e revise quaisquer erros.

Atributo	Tipo	É obrigatório	Descrição
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha

Tipo DeleteAvailsBatchAPIRequest
Exclua vários períodos de disponibilidade em uma única chamada de API. Isso é útil para remoções em massa ou expirações de direitos.

Atributo	Tipo	É obrigatório	Descrição
requestItems	DeleteAvailsBatchAPIRequestItem[]	Sim	Lista de solicitações individuais

Tipo DeleteAvailsBatchAPIResponse
Retorna os resultados da exclusão de cada item em sua solicitação em lote.

Atributo	Tipo	É obrigatório	Descrição
responseItems	DeleteAvailsBatchAPIResponseItem[]	Sim	Lista de itens de resposta.

Tipo DeleteAvailsBatchAPIRequestItem
Cada item de solicitação de exclusão especifica o caminho para o recurso a ser removido.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote
caminho	String	Sim	Caminho para um recurso para esse item de solicitação. Para o modelo Full Extract, o formato é: /avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH\|FIXED_FEE}&channelIdentity={Channel}

Tipo DeleteAvailsBatchAPIResponseItem
Cada item de resposta confirma se a exclusão foi bem-sucedida para a solicitação correspondente.

Atributo	Tipo	É obrigatório	Descrição
requestItemId	String	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	Booleano	Sim	Status da operação
errors	Error[]	Não	Lista de erros em caso de falha

Tipos de dados principais

Esses tipos de dados fundamentais são usados em todos os esquemas da API. Compreender essas estruturas é essencial para trabalhar com qualquer operação disponível. Para mais informações, consulte a página de Direitos de conteúdo.

Tipo Error
Estrutura de erro padrão retornada quando as operações falham. O código identifica o tipo de erro, enquanto a mensagem fornece os dados legíveis para o usuário.

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 do erro legível por usuários

Tipo Avail
A estrutura de dados central que representa um período de disponibilidade completo. Isso inclui todas as informações sobre direitos de conteúdo, termos de licenciamento, territórios e condições comerciais.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
ALID	String	Sim	Especifica o identificador do título. Deve corresponder ao ALID especificado na contribuição de metadados.	ALID
Disposição	AvailDisposition	Sim	Especifica a granularidade do modelo de extração.	N/A
Licenciante	Editora	Sim	Especifica informações sobre a entidade que concede licença ao Prime Video.	N/A
Ativo	AvailAsset[]	Sim	Informações sobre o ativo. Somente um único ativo deve ser especificado na lista.	N/A
Transação	AvailTrans[]	Sim	Informações sobre a transação.	N/A
SharedEntitlement	AvailSharedEntitlement[]	Não	Informações sobre direitos para outros serviços.	N/A

Tipo AvailDisposition
Define se esta é uma operação de Full Extract ou exclusão completa e se está criando/atualizando ou excluindo dados.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
EntryType	Enum	Sim	Valores permitidos: FullExtract, FullDelete	Disposição

Tipo de Editora
Identifica sua organização como licenciadora de conteúdo. Esse valor é fornecido pelo Prime Video durante o processo de integração.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
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 usado nos arquivos EMA.	DisplayName

Tipo AvailAsset
Descreve o conteúdo que está sendo licenciado. A estrutura varia de acordo com o WorkType (filme, episódio, temporada, etc.).

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
_contentID	String	Sim	Especifica a ID do conteúdo para este ativo. Normalmente é igual ao ALID.	ContentID
WorkType	Enum	Sim	Valores permitidos: Filme, Curta-metragem, Episódio, Temporada, Suplemento	WorkType
Metadados	AvailUnitMetadata	Condicional	Descreve os metadados para Filme ou Curtas-metragem. Obrigatório quando o WorkType é Filme ou Curta-metragem.	N/A
EpisodeMetadata	AvailEpisodeMetadata	Condicional	Descreve os metadados para Episódio. Obrigatório quando o WorkType é Episódio.	N/A
SeasonMetadata	AvailSeasonMetadata	Condicional	Descreve os metadados para Temporada. Obrigatório quando o WorkType é Temporada.	N/A

Tipo AvailSharedEntitlement
Especifica direitos para outros ecossistemas digitais, como a DMA (Digital Movie Alliance).

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
_ecosystem	Enum	Sim	Valores permitidos: DMA Observação: UVVU – Ultravioleta não suportado.	N/A
EcosystemID	String	Sim	Identificador de título específico do ecossistema	DMA_ID

Tipo AvailUnitMetadata
Metadados para conteúdo independente, como filmes ou curtas-metragens.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
TitleInternalAlias	String[]	Sim	Nome do título. Somente um único nome de título deve ser especificado na lista.	TitleInternalAlias

Tipo AvailEpisodeMetadata
Metadados específicos para episódios de séries, incluindo o número do episódio e informações sobre a temporada/série principal.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
TitleInternalAlias	String[]	Sim	Nome do título do episódio. Somente um único nome de título deve ser especificado na lista.	EpisodeTitleInternalAlias
EpisodeNumber	ContentSequenceInfo	Sim	Número desse episódio dentro da temporada.	EpisodeNumber
SeasonMetadata	AvailSeasonMetadata	Condicional	Descreve os metadados para Temporada. Obrigatório quando o WorkType é Episódio ou Temporada.	N/A
SeriesMetadata	AvailSeriesMetadata	Condicional	Descreve os metadados para Séries. Obrigatório quando o WorkType é Episódio ou Temporada.	N/A

Tipo AvailSeasonMetadata
Metadados para temporadas de TV, incluindo número da temporada e contagem de episódios.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
SeasonContentID	String	Sim	ALID para temporada.	SeasonContentID
SeasonTitleInternalAlias	String[]	Não	Nome do título para temporada. Somente um único nome de título deve ser especificado na lista.	SeasonTitleInternalAlias
SeasonNumber	ContentSequenceInfo	Sim	Número para esta temporada dentro da série.	SeasonNumber
NumberOfEpisodes	Número inteiro	Sim	Número de episódios nesta temporada.	EpisodeCount
SeriesMetadata	AvailSeriesMetadata	Condicional	Descreve os metadados para Séries. Obrigatório quando o WorkType é Temporada.	N/A

Tipo AvailSeriesMetadata
Metadados para séries de TV, fornecendo informações de alto nível sobre as séries.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
SeriesContentID	String	Sim	ALID para séries.	SeriesContentID
SeriesTitleInternalAlias	String[]	Não	Nome do título para séries. Somente um único nome de título deve ser especificado na lista.	SeriesTitleInternalAlias
NumberOfSeasons	Número inteiro	Não	Número de temporadas da série.	SeasonCount

Tipo AvailTrans
Define uma transação de licenciamento específica, incluindo território, datas, tipo de licença e termos comerciais. É aqui que você especifica os direitos reais que estão sendo concedidos.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
_TransactionID	String	Não	Identificador exclusivo para período de disponibilidade. Opcional ao usar FullExtract.	AvailID
LicenseType	Enum	Sim	Valores permitidos: SVOD, FVOD, EST, POEST, VOD	LicenseType
Território	Region[]	Sim	Território onde a distribuição é permitida. Somente um único item de território deve ser fornecido. Todas as transações dentro de um único objeto Avail devem ter o mesmo território.	Território
Início	DateTime	Sim	Data e hora de início da distribuição no formato ISO. OBSERVAÇÃO: Se nenhum fuso horário for incluído, será usado o fuso horário mais a leste da região. No entanto, é possível incluir qualquer fuso horário se desejar um horário de lançamento específico.	Início
Fim	DateTime	Não	Data e hora de término da distribuição no formato ISO. Se não forem fornecidas, a distribuição terá duração ilimitada. OBSERVAÇÃO: Se nenhum fuso horário for incluído, será usado o fuso horário mais a leste da região. No entanto, é possível incluir qualquer fuso horário se desejar um horário específico para a remoção do conteúdo.	Fim
AssetLanguage	AssetLanguage[]	Não	Idioma do ativo expresso como código de idioma ISO com tipo de ativo. Tipos de ativos permitidos: legenda, áudio, subdub, sub, dub, ov, mta, nenhum	AssetLanguage
AllowedLanguage	AssetLanguage[]	Não	Código de idioma ISO com tipo de ativo. Tipos de ativos permitidos: legenda, áudio, sub, dub, subdub, nenhum	AllowedLanguages
HoldbackLanguage	AssetLanguage[]	Não	Código de idioma ISO com tipo de ativo. Tipos de ativos permitidos: legenda, áudio, sub, dub, subdub, nenhum	HoldbackLanguage
LicenseRightsDescription	String	Não	Usado para especificar a prioridade de publicação.	LicenseRightsDescription
FormatProfile	AvailFormatProfile	Sim	Qualidade do vídeo disponibilizado. Valores permitidos: SD, HD, UHD	FormatProfile
ContractID	String	Não	Especifica informações contratuais. Valores permitidos: – CPH – FIXED_FEE – FIXED_FEE:{ID da oferta } Ao enviar Avails, as opções FIXED_FEE são restritas pelo licenciante.	ContractID
Termos	AvailTerms[]	Sim	Especifica a lista de termos comerciais para o período de disponibilidade.	OtherTerms
OtherInstructions	String	Não	Instruções adicionais de processamento para o período de disponibilidade.	OtherInstructions

Tipo de região
Especifica um território geográfico usando códigos de país ISO.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
país	String	Sim	Código de país ISO 3166-1 de 2 letras	N/A

Tipo AssetLanguage
Define a disponibilidade de idiomas para recursos de áudio e legendas.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
valor	String	Sim	Idioma do ativo expresso como código de idioma RFC 5646 com tipo de ativo.	N/A
_asset	String	Não	São permitidos diferentes conjuntos de valores, dependendo do atributo de idioma do tipo AvailTrans. Valores permitidos para AvailTrans.AssetLanguage: legenda, áudio, subdub, sub, dub, ov, mta, nenhum. Este atributo requer o mesmo recurso enviado para todos os idiomas. Valores permitidos para AvailTrans.AllowedLanguage e AvailTrans. HoldbackLanguage: legenda, áudio, sub, dub, subdub, nenhum. Quando o valor do recurso é “subdub”, “nenhum” ou o valor está ausente, ele será distribuído para dois recursos: “subtítulo” e “áudio”. Os ativos “sub” e “dub” são convertidos para seus equivalentes MDDF em “legenda” e “áudio”.	N/A

Tipo AvailFormatProfile
Especifica o nível de qualidade de vídeo para a disponibilidade.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
valor	Enum	Sim	Qualidade do vídeo disponibilizado. Valores permitidos: SD, HD, UHD	N/A

Tipo AvailTerms
Estrutura flexível para especificar termos comerciais. Cada termo tem um nome e um valor do tipo apropriado (dinheiro, texto, evento, booleano, duração ou número).

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
_termName	String	Sim	Identifica o termo. O valor não diferencia maiúsculas de minúsculas. Para obter uma lista dos valores permitidos, consulte abaixo.	N/A
Dinheiro	Dinheiro	Não	Para obter mais dados, consulte abaixo.	N/A
Texto	String	Não	Para obter mais dados, consulte abaixo.	N/A
Evento	DateTime	Não	Para obter mais dados, consulte abaixo.	N/A
Booleano	Booleano	Não	Para obter mais dados, consulte abaixo.	N/A
Duração	String	Não	Para obter mais dados, consulte abaixo.	N/A
Número	Número inteiro	Não	Para obter mais dados, consulte abaixo.	N/A

Tipo Dinheiro
Representa valores monetários com especificação da moeda.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
valor	Decimal	Não	Valor monetário, obrigatório para alguns tipos de preço	N/A
_currency	String	Sim	Código de moeda ISO	N/A

Tipo ContentSequenceInfo
Especifica números de sequência para episódios e temporadas.

Atributo	Tipo	Obrigatório	Observações	Mapeamento de arquivos EMA
Número	Número inteiro	Sim	Número de sequência de conteúdo, como número do episódio ou número da temporada	N/A

Termos de disponibilidade compatíveis
A tabela a seguir lista todos os termos comerciais compatíveis que podem ser incluídos na matriz AvailTerms. Cada termo controla aspectos específicos de licenciamento, preços, publicidade e experiência do cliente.

Nome do termo	Atributo	Obrigatório	Observações	Mapeamento de arquivos EMA
ChannelIdentity	Texto	Sim	Identificador de um canal ou assinatura.	GroupIdentity
Nível	Texto	Condicional	Faixa de preços. Obrigatório se o tipo de licença for POEST.	PriceType
SRP	Dinheiro	Condicional	Preço de venda sugerido. Obrigatório se o tipo de licença for POEST.	SRP
WSP	Dinheiro	Condicional	Preço de atacado. Obrigatório se o tipo de licença for POEST.	PriceValue
Categoria	Texto	Condicional	Categoria de preço. Obrigatório se o tipo de licença for POEST.	PriceValue
AnnounceDate	Evento	Não	Data em que o varejista está autorizado a anunciar a data de início da disponibilidade do título no território disponível.	AnnounceDate
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 de comercialização. Obrigatório se o tipo de licença for POEST.	SuppressionLiftDate
RentalDuration	Duração	Condicional	Duração do período de locação em horas. Obrigatório se o tipo de licença for SVOD.	RentalDuration
WatchDuration	Duração	Condicional	Quanto tempo o usuário tem para concluir a visualização após iniciá-la, em horas. Obrigatório se o tipo de licença for SVOD.	WatchDuration
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, tanto a duração da locação quanto a duração da exibição devem ser especificadas.	Download
Exclusivo	Booleano	Não	Os ativos são exclusivos dentro do âmbito da Transação.	Exclusivo
ExclusiveAttributes	Texto	Não	Especifica o tipo de exclusividade. Considerado somente quando Exclusive é verdadeiro. Um valor padrão será usado se não for fornecido quando Exclusive for verdadeiro.	ExclusiveAttributes
BrandingRights	Booleano	Não	Indica a intenção do parceiro de exibir a marca.	BrandingRights
BrandingRightsAttributes	Texto	Não	Especifica o texto da marca. Considerado apenas quando BrandingRights é verdadeiro. Um valor padrão será usado se não for fornecido quando BrandingRights for verdadeiro.	BrandingRightsAttributes
allowAds	Booleano	Não	Determina se os anúncios publicitários são permitidos ou proibidos. Este termo só pode aparecer uma vez.	Não disponível na EMA
allowedAdPlacement	Texto	Condicional	Especifica a localização no rolo onde os anúncios publicitários podem ser inseridos. Os valores permitidos são: PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks. Permitido apenas quando allowAds é verdadeiro. Esse termo pode aparecer mais de uma vez. É possível especificar allowedAdPlacement ou prohibitedAdPlacement, mas não ambos.	Não disponível na EMA
prohibitedAdPlacement	Texto	Condicional	Especifica a localização no rolo onde os anúncios publicitários não podem ser inseridos. Os valores permitidos são: PreRoll, MidRoll, PostRoll,Overlays, PauseAds, Squeezebacks. Esse termo pode aparecer mais de uma vez. Permitido apenas quando allowAds é verdadeiro. É possível especificar allowedAdPlacement ou prohibitedAdPlacement, mas não ambos.	Não disponível na EMA
cuepointDeliveryAndUsage	Texto	Não	Especifica as obrigações relativas à entrega e uso de pontos de sinalização. Valores permitidos: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated. Permitido apenas quando allowAds é verdadeiro.	Não disponível na EMA
blindBasisSelling	Texto	Não	Valores permitidos: GuaranteedImpressions, NoGuaranteedImpressions Esse atributo só deve estar presente se allowAds estiver definido como verdadeiro.	Não disponível na EMA
sponsorships	Texto	Não	Valores permitidos: Permitted, Prohibited, PermittedWithRestrictions. Esse atributo só deve estar presente se allowAds estiver definido como verdadeiro.	Não disponível na EMA
sponsorshipsRestrictions	Texto	Condicional	Texto de formato livre Esse atributo só deve estar presente se os patrocínios estiverem definidos como AllowedWithRestrictions.	Não disponível na EMA
talentAndAmazonAdGuidelines	Texto	Não	Valores permitidos: NoRestrictions, ConsultationRequired Esse atributo só deve estar presente se allowAds estiver definido como verdadeiro.	Não disponível na EMA
talentRestrictions	Texto	Condicional	Texto de formato livre Esse atributo só deve estar presente se talentAndAmazonAdGuidelines estiver definido como ConsultationRequired.	Não disponível na EMA
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. Esse atributo só deve estar presente se allowAds estiver definido como verdadeiro.	Não disponível na EMA
adKey	Texto	Não	Texto de formato livre Identificador exclusivo para mapear conteúdo para servidores de gerenciamento de anúncios.	Não disponível na EMA
CompleteYourBundleDiscountPercentage	Número	Não	Desconto percentual aplicado quando os clientes completam um combo comprando os títulos restantes que ainda não possuem. Por exemplo, um desconto de 20% significa que os clientes que possuem a 1ª Temporada de um combo de 2 temporadas recebem 20% de desconto na 2ª Temporada.	Não disponível na EMA
ExcludedFromBundleDiscount	Booleano	Não	Quando definido como verdadeiro, exclui esse período de disponibilidade da elegibilidade para descontos em combos. Use durante períodos de precificação especial (por exemplo, novos lançamentos) ou para títulos que devem manter o preço total. Quando ausente ou falso, o título é elegível para descontos em combos.	Não disponível na EMA

Enumeração BusinessLine
A enumeração BusinessLine especifica o modelo de negócios do Prime Video sob o qual o conteúdo é licenciado e distribuído. Isso determina como os clientes acessam o conteúdo e como a receita é gerada.

Valor	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
CANAIS	Assinatura de canais de terceiros. Tipos de licença relacionados: SVOD
FVOD	Conteúdo gratuito. Tipos de licença relacionados: FVOD

Observação: O valor BusinessLine determina qual modelo de negócios se aplica à disponibilidade do seu conteúdo. Ao enviar avails, certifique-se de que o campo BusinessLine esteja alinhado com o seu contrato com a Prime Video. Se você tiver dúvidas sobre quais valores BusinessLine estão disponíveis para a sua parceria, entre em contato com o seu representante da Prime Video.

Exemplos de cargas úteis Avails

Os exemplos a seguir demonstram como estruturar suas chamadas de API para cenários comuns de integração. Consulte Exemplos de carga útil para obter pares completos de solicitação e resposta com JSON formatado corretamente, que você pode usar como modelos para sua integração.

Perguntas frequentes

As seções a seguir fornecem respostas para perguntas comuns sobre como trabalhar com a API Avails.

Uso geral da API

Uma carga útil são os dados que você envia ou recebe da API. É o conteúdo real da sua solicitação ou resposta. Pense nisso como o pacote de informações que você está trocando com os sistemas do Prime Video. Cada exemplo demonstra a estrutura JSON correta e os campos obrigatórios para cenários comuns, ajudando você a formatar suas solicitações de API e interpretar as respostas do Prime Video.

O Content API Suite permite automatizar fluxos de trabalho de gerenciamento de conteúdo e receber visibilidade em tempo real do status do seu conteúdo no Prime Video. Esta suíte inclui:

API Avails — Enviar, atualizar, recuperar e excluir direitos de conteúdo (avails) de forma programática em todas as linhas de negócios e territórios
API de Status da Oferta — Verifique se seus títulos estão disponíveis na loja Prime Video e entenda o que está impedindo que os títulos sejam lançados
API de Status de Ativos — Monitore o status de entrega de ativos e receba feedback instantâneo sobre a disponibilidade do conteúdo

Ao se integrar ao Content API Suite, você receberá acesso às APIs solicitadas durante o processo de integração. Todos os APIs desse pacote usam autenticação baseada em certificado MTLS (Mutual Transport Layer Security) com chaves de API.

Remoção de conteúdo e alterações de data

Enviar disponibilidades