Video Central

A API Prime Video Avails faz parte do pacote Content API 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. Enviar, atualizar, recuperar ou excluir janelas de disponibilidade com maior precisão e controle do que os carregamentos de arquivos tradicionais.

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 do Prime Video:

Gerenciamento automatizado - Elimine os carregamentos manuais e reduza os erros automatizando os envios e atualizações da janela de disponibilidade, liberando sua equipe para se concentrar em tarefas estratégicas
Maior eficiência — atualize janelas de disponibilidade específicas sem 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 fazer login no Slate para correções manuais.
Interoperabilidade - Construída em uma interface REST independente de linguagem, sistema e plataforma, acessível de qualquer sistema com conexão à Internet.

Operações e endpoints de API

Todos os endpoints são independentes do idioma e podem ser acessados via HTTP 1.1 de qualquer sistema com conexão à Internet. Os endpoints Avails não seguem um protocolo específico e podem ser chamados em qualquer ordem com base nas 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 catálogo ou enviar somente 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 - Create/Update Avails

O que ele faz: adiciona novas janelas de disponibilidade ou atualiza as existentes para seus livros.
Por que você precisa: é assim que você diz ao Prime Video quando e onde seu conteúdo deve estar disponível para os clientes. Se você está lançando um novo conteúdo ou estendendo uma licença existente, essa operação garante que seus dados de disponibilidade estejam atualizados.

Operação 2 - Retrieve Avails

O que ele faz: recupera as informações de disponibilidade atuais dos sistemas do Prime Video.
Por que você precisa disso: verifique quais dados de disponibilidade o Prime Video tem em arquivo, solucione discrepâncias ou extraia dados para fins de geração de relatórios e reconciliação.

Operação 3 - Validate Avails

O que ele faz: verifica se há erros nos dados de disponibilidade antes de enviá-los aos sistemas ao vivo do Prime Video.
Por que você precisa: detecte erros de formatação, campos obrigatórios ausentes ou violações de regras de negócios 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 - Delete Avails

O que faz: remove as janelas de disponibilidade dos sistemas do Prime Video.
Por que você precisa: Lide com cenários únicos em que a disponibilidade precisa ser completamente removida em vez de expirar.
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 sua trilha de auditoria.

Códigos de resposta HTTP

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

Código HTTP	Description	Tentável novamente
200	A chamada da API foi bem-sucedida. Os chamadores devem verificar o objeto de resposta para obter detalhes adicionais.	N/A
400	Solicitação incorreta, 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

Nota: Para erros que podem ser repetidos (500, 503), implemente a lógica de repetição com atrasos apropriados entre as tentativas. Erros que não podem ser repetidos (400, 401, 404) indicam problemas com sua solicitação que precisam ser corrigidos antes do reenvio.

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 o padrão MDDF API v2.6. Embora você possa incluir qualquer atributo da API MDDF v2.6 em sua carga, o Prime Video processa somente atributos compatíveis — atributos não suportados serão ignorados.

Nota: Para obter uma referência completa dos atributos suportados que correspondem à nossa especificação de disponibilidade de EMA, consulte a coluna de disponibilidade de 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.

Convertendo MDDF XML em JSON A API

MDDF Avails define seu esquema no formato XML, mas oferece suporte a cargas em XML e JSON. As APIs do Prime Video Avails usam cargas codificadas em JSON.
O processo de conversão de MDDF XML em JSON é descrito abaixo: Os namespaces são omitidos

Elementos aninhados se tornam propriedades aninhadas

Vários elementos com o mesmo nome se tornam elementos de matriz

Os atributos entram em propriedades e são prefixados com um sublinhado

Tipos de dados de esquema comuns O esquema

da API Avails é compatível com os seguintes tipos de dados:

Type

Description

booleano

Tipo booleano. Valores permitidos: verdadeiro, falso

Inteiro

Inteiro assinado de 32 bits.

Número inteiro longo

Número inteiro assinado de 64 bits.

Decimal

Número de ponto flutuante.

Cadeia

Uma matriz de caracteres.

Carimbo de data/hora

Carimbo de data/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 que você envia ao Prime Video e das respostas que você recebe de volta. Compreender essas estruturas é essencial para uma integração bem-sucedida da API.

Esquema 1 - Create/Update Avails

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

PutAvailsApiRequest
type Esse é o principal objeto de solicitação para enviar uma única janela de disponibilidade.

Atributo	Type	É obrigatório	Description
aproveitar	Aproveitar	Sim	Dados de disponibilidade - Esse é o atributo de nível superior de qualquer solicitação de venda ou validação

putAvailsApiResponse
type
A resposta que você receberá após enviar uma janela de disponibilidade. Verifique o campo de sucesso para confirmar a conclusão da operação e analise os erros se o envio falhar.

Atributo	Type	É obrigatório	Description
sucesso	booleano	Sim	Status da operação
erros	Erro []	Não	Lista de erros em caso de falha

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

Atributo	Type	É obrigatório	Description
Solicitar itens	Coloque o item de solicitação de API de lote disponível []	Sim	Lista de solicitações individuais

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

Atributo	Type	É obrigatório	Description
Itens de resposta	Coloque o item de resposta da API em lote disponível []	Sim	Lista de itens de resposta

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

Atributo	Type	É obrigatório	Description
Solicitar ID do Item	Corda	Sim	Identificador exclusivo do item na solicitação em lote. Essa é uma sequência de caracteres exclusiva que você usará para identificar cada item no lote e será vinculada à nossa resposta em lote.
caminho	Corda	Sim	Caminho para um recurso para esse item de solicitação. Para o modelo Full Extract, o formato é: /avails/ {licensor} /full-extract/ {ALID}
corpo	Colocar o corpo de solicitação de API de lote disponível	Sim	Dados de Disponibilidade

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

Atributo	Type	É obrigatório	Description
aproveitar	Aproveitar	Sim	Dados de Disponibilidade

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

Atributo	Type	É obrigatório	Description
Solicitar ID do Item	Corda	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	booleano	Sim	Status da operação
erros	Erro []	Não	Lista de erros em caso de falha

Esquema 2 - Retrieve Avails

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

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

Atributo	Type	É obrigatório	Description
aproveitar	Aproveitar	Sim	Dados de Disponibilidade
sucesso	booleano	Sim	Status da operação
erros	Erro []	Não	Lista de erros em caso de falha

GetAvailsBatchApiRequest Recupere várias janelas de disponibilidade em uma única chamada de API. Isso é eficiente quando você precisa verificar os direitos de vários títulos ou transações.

Atributo	Type	É obrigatório	Description
Solicitar itens	Obtenha o item de solicitação de API de lote disponível []	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	Type	É obrigatório	Description
Itens de resposta	Obtenha o item de resposta da API em lote disponível []	Sim	Lista de itens de resposta

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

Atributo	Type	É obrigatório	Description
Solicitar ID do Item	Corda	Sim	Identificador exclusivo do item na solicitação em lote
caminho	Corda	Sim	Caminho para um recurso para esse item de solicitação. Para o modelo Full Extract, o formato é: /avails/ {licensor} /full-extract/ {ALID}? território = {Território} &BusinessLine= {BusinessLine}

GetAvailsBatchApiResponseItem
Cada item de resposta contém os dados de disponibilidade, se a recuperação for bem-sucedida, ou os detalhes do erro, se falhar.

Atributo	Type	É obrigatório	Description
Solicitar ID do Item	Corda	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	booleano	Sim	Status da operação
erros	Erro []	Não	Lista de erros em caso de falha
aproveitar	Aproveitar	Não	Objeto de disponibilidade

Esquema 3 - Validate 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 janelas de disponibilidade reais.

validateAvailsApiRequest
type A resposta de validação indica se seus dados são aprovados em todas as regras de validação. Analise todos os erros antes de enviar a solicitação real de criação ou atualização.

Atributo	Type	É obrigatório	Description
aproveitar	Aproveitar	Sim	Dados de Disponibilidade

ValidateAvailsApiResponse
type A resposta de validação indica se seus dados são aprovados em todas as regras de validação. Analise todos os erros antes de enviar a solicitação real de criação ou atualização.

Atributo	Type	É obrigatório	Description
sucesso	booleano	Sim	Status da operação
erros	Erro []	Não	Lista de erros em caso de falha

ValidateAvailsBatchApiRequest
type Valide várias janelas de disponibilidade em uma única chamada. Isso é particularmente útil ao preparar envios de grandes lotes.

Atributo	Type	É obrigatório	Description
Solicitar itens	Validar item de solicitação de API de lote disponível []	Sim	Lista de solicitações individuais

ValidateAvailsBatchApiResponse
type 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	Type	É obrigatório	Description
Itens de resposta	Validar o item de resposta da API em lote disponível []	Sim	Lista de itens de resposta

ValidateAvailsBatchApiRequestItem
type 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	Type	É obrigatório	Description
Solicitar ID do Item	Cadeia	Sim	Identificador exclusivo do item na solicitação em lote
caminho	Cadeia	Sim	Caminho para um recurso para a solicitação: Full Extract model: /avails/ {licensor} /full-extract/ {ALID} /validate
corpo	Validar o corpo de solicitação de API de lote disponível	Sim	Corpo da solicitação

ValidateAvailsBatchApiRequestItemBody type
Contém os dados da janela de disponibilidade a serem validados.

Atributo	Type	É obrigatório	Description
aproveitar	Aproveitar	Sim	Dados de Disponibilidade

ValidateAvailsBatchApiResponseItem
type Cada item de resposta de validação mostra se os dados correspondentes foram aprovados nas verificações de validação.

Atributo	Type	É obrigatório	Description
Solicitar ID do Item	Cadeia	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	booleano	Sim	Status da operação
erros	Erro []	Não	Lista de erros em caso de falha

Esquema 4 - Delete Avails

Esses esquemas definem como remover as janelas 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 aos requisitos de conformidade. O conteúdo expirado mantém seus dados históricos e sua trilha de auditoria, o que é valioso para relatórios e reconciliação.

DeleteAvailsApiResponse
type Confirma se a operação de exclusão foi concluída com êxito. Verifique o campo de sucesso e analise os erros.

Atributo	Type	É obrigatório	Description
sucesso	booleano	Sim	Status da operação
erros	Erro []	Não	Lista de erros em caso de falha

DeleteAvailsBatchApiRequest
type Exclua várias janelas de disponibilidade em uma única chamada de API. Isso é útil para remoções em massa ou expiração de direitos.

Atributo	Type	É obrigatório	Description
Solicitar itens	Excluir item de solicitação de BatchAPI disponível []	Sim	Lista de solicitações individuais

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

Atributo	Type	É obrigatório	Description
Itens de resposta	Excluir item de resposta da API de lote disponível []	Sim	Lista de itens de resposta.

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

Atributo	Type	É obrigatório	Description
Solicitar ID do Item	Corda	Sim	Identificador exclusivo do item na solicitação em lote
caminho	Corda	Sim	Caminho para um recurso para esse item de solicitação. Para o modelo Full Extract, o formato é: /avails/ {licensor} /full-extract/ {ALID}? território = {Território} &BusinessLine= {BusinessLine} &ContractId= {CPH\|FIXED_FEE} &ChannelIdentity= {Canal}

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

Atributo	Type	É obrigatório	Description
Solicitar ID do Item	Corda	Sim	Identificador exclusivo do item na solicitação em lote
sucesso	booleano	Sim	Status da operação
erros	Erro []	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 obter mais referências, consulte a página Direitos de conteúdo.

Tipo de erro Estrutura de erro
padrão retornada quando as operações falham. O código identifica o tipo de erro, enquanto a mensagem fornece detalhes legíveis por humanos.

Atributo	Type	É obrigatório	Description
código	Cadeia	Sim	Uma string descrevendo o tipo de erro. Códigos de erro de validação: APIV {número}, CRMSV {número} Códigos de erro de serviço: APIE {número}, CRMSE {número} Exemplos: APIV400, CRMSE500
mensagem	Cadeia	Sim	Descrição do erro legível por humanos

Avail type
A estrutura de dados principal que representa uma janela de disponibilidade completa. Isso inclui todas as informações sobre direitos de conteúdo, termos de licenciamento, territórios e condições comerciais.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
ALID	Cadeia	Sim	Especifica o identificador do título. Deve corresponder ao ALID especificado na contribuição de metadados.	ALID
Disposição	Disposição disponível	Sim	Especifica a granularidade do modelo de extração.	N/A
Licenciador	Editora	Sim	Especifica informações sobre a entidade que concede licença ao Prime Video.	N/A
Ativo	Ativo disponível []	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
Direito compartilhado	Direito compartilhado disponível []	Não	Informações sobre direitos para outros serviços.	N/A

AvailDisposition type
Define se essa é uma operação Full Extract ou Full Delete e se está criando/atualizando ou excluindo dados.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
EntryType	Enum	Sim	Valores permitidos: fullExtract, fullDelete	Disposição

Publisher type
Identifica sua organização como licenciadora de conteúdo. Esse valor é fornecido pelo Prime Video durante a integração.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
DisplayName	Cadeia	Sim	Especifica o nome do parceiro Prime Video. Esse valor será fornecido aos parceiros pelo Prime Video. Deve ter o mesmo valor usado nos arquivos EMA.	DisplayName

availAsset type
descreve o ativo de conteúdo que está sendo licenciado. A estrutura varia de acordo com o WorkType (Filme, Episódio, Temporada etc.).

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
_ID do conteúdo	Cadeia	Sim	Especifica o ID do conteúdo desse ativo. Normalmente o mesmo que o ALID.	ContentID
WorkType	Enum	Sim	Valores permitidos: Filme, Curta, Episódio, Temporada, Suplementar	WorkType
Metadados	Metadados da unidade disponíveis	Condicional	Descreve os metadados para filme ou curta-metragem. Obrigatório quando WorkType é filme ou curta-metragem.	N/A
Metadados do episódio	Metadados de episódios disponíveis	Condicional	Descreve os metadados do Episódio. Obrigatório quando WorkType é Episódio.	N/A
Metadados da temporada	Metadados de temporada disponíveis	Condicional	Descreve os metadados da Temporada. Obrigatório quando WorkType é Temporada.	N/A

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

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
_ecossistema	Enum	Sim	Valores permitidos: DMA Nota: UVVU - Ultravioleta não suportado.	N/A
ID do ecossistema	Cadeia	Sim	Identificador de título específico do ecossistema	DMA_ID

AvailUnitMetadata type
Metadata para conteúdo independente, como filmes ou curtas-metragens.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
Título Internalalias	Cadeia de caracteres []	Sim	Nome do título. Somente um único nome de título deve ser especificado na lista.	TitleInternalAlias

AvailEpisodeMetadata
type Metadados específicos para episódios de TV, incluindo número do episódio e informações da temporada/série principal.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
Título Internalalias	Cadeia de caracteres []	Sim	Nome do título do episódio. Somente um único nome de título deve ser especificado na lista.	EpisodeTitleInternalAlias
EpisodeNumber	Informações sobre a sequência de conteúdo	Sim	Number desse episódio na temporada.	EpisodeNumber
Metadados da temporada	Metadados de temporada disponíveis	Condicional	Descreve os metadados da Temporada. Obrigatório quando WorkType é Episódio ou Temporada.	N/A
Metadados da série	Metadados da série disponíveis	Condicional	Descreve os metadados das Séries. Obrigatório quando WorkType é Episódio ou Temporada.	N/A

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

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
SeasonContenID	Cadeia	Sim	ALID para a temporada.	SeasonContentID
Título da temporada: SeasonTitleInternalalias	Cadeia de caracteres []	Não	Nome do Título da Temporada. Somente um único nome de título deve ser especificado na lista.	SeasonTitleInternalAlias
SeasonNumber	Informações sobre a sequência de conteúdo	Sim	Number desta temporada dentro da série.	SeasonNumber
Número de episódios	Inteiro	Sim	Number de episódios nesta temporada.	EpisodeCount
Metadados da série	Metadados da série disponíveis	Condicional	Descreve os metadados das Séries. Obrigatório quando WorkType é Temporada.	N/A

AvailSeriesMetadata type Metadata para séries de TV, fornecendo informações sobre séries de alto nível.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
ID de conteúdo da série	Cadeia	Sim	ALID para séries.	ID de conteúdo da série
Apelido interno do título da série	Cadeia de caracteres []	Não	Nome do Título das Séries. Somente um único nome de título deve ser especificado na lista.	Apelido interno do título da série
Número de temporadas	Inteiro	Não	Número de temporadas desta série.	SeasonCount

O 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	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
_ID da transação	Corda	Não	Identificador exclusivo para a janela de disponibilidade. Opcional ao usar o FullExtract.	AvailID
LicenseType	Enum	Sim	Valores permitidos: SVOD, FVOD, EST, POST, VOD	LicenseType
Território	Região []	Sim	Território onde a distribuição é permitida. Somente um único item do território deve ser fornecido. Todas as transações em um único objeto Avail devem ter o mesmo território.	Território
Start	Data/hora	Sim	Data e hora de início da distribuição no formato ISO. NOTA: Se nenhum fuso horário for incluído, usaremos o fuso horário mais oriental da região. No entanto, você pode incluir qualquer fuso horário se quiser um horário de lançamento específico.	Start
End	Data/hora	Não	End a data e a hora da distribuição no formato ISO. Se não for fornecida, a distribuição tem duração ilimitada. NOTA: Se nenhum fuso horário for incluído, usaremos o fuso horário mais oriental da região. No entanto, você pode incluir qualquer fuso horário se quiser um horário específico de remoção.	End
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, qualquer	AssetLanguage
AllowedLanguage	AssetLanguage []	Não	Código de idioma ISO com tipo de ativo. Tipos de ativos permitidos: legenda, áudio, sub, dub, subdub, qualquer	Idiomas permitidos
HoldbackLanguage	AssetLanguage []	Não	Código de idioma ISO com tipo de ativo. Tipos de ativos permitidos: legenda, áudio, sub, dub, subdub, qualquer	HoldbackLanguage
Descrição dos direitos de licença	Corda	Não	Usado para especificar a prioridade de publicação.	LicenseRightsDescription
FormatProfile	Perfil em formato disponível	Sim	Qualidade do vídeo disponível. Valores permitidos: SD, HD, UHD	FormatProfile
ID do contrato	Corda	Não	Especifica as informações contratuais. Valores permitidos: - CPH - FIXED_FEE - FIXED_FEE: {Deal ID } Ao enviar ofertas, as opções de FIXED_FEE são restringidas pelo licenciador.	ContractID
Termos	Termos disponíveis []	Sim	Especifica a lista de termos comerciais para a janela de disponibilidade.	OtherTerms
Other Instructions	Corda	Não	Instruções adicionais de processamento para a janela de disponibilidade.	OtherInstructions

Region type
Especifica um território geográfico usando códigos ISO de país.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
country	Corda	Sim	Código de país ISO 3166-1 de 2 letras	N/A

assetLanguage
type Define a disponibilidade de idioma para ativos de áudio e legendas.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
valor	Corda	Sim	Idioma do ativo expresso como código de idioma RFC 5646 com tipo de ativo.	N/A
_ativo	Corda	Não	Diferentes conjuntos de valores são permitidos, dependendo do atributo language do tipo AvailTrans. Valores permitidos para availtrans.assetLanguage: subtítulo, áudio, subdub, sub, dub, ov, mta, any. Esse atributo exige que o mesmo recurso seja enviado para todos os idiomas. Valores permitidos para AvailTrans.allowedLanguage e AvailTrans. HoldbackLanguage : legenda, áudio, sub, dub, subdub, qualquer um. Quando o valor do ativo for “subdub”, “any” ou o valor estiver ausente, ele se espalhará para dois ativos: “subtítulo” e “áudio”. Os ativos “sub” e “dub” são convertidos em seus equivalentes em MDDF, “subtítulo” e “áudio”.	N/A

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

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
valor	Enum	Sim	Qualidade do vídeo disponível. Valores permitidos: SD, HD, UHD	N/A

AvailTerms type Estrutura
flexível para especificar termos comerciais. Cada termo tem um nome e um valor do tipo apropriado (Money, Text, Event, Boolean, Duration ou Number).

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
_Nome do termo	Corda	Sim	Identifica o termo. O valor não diferencia maiúsculas de minúsculas. Para obter uma lista dos valores permitidos, veja abaixo.	N/A
Dinheiro	Dinheiro	Não	Para obter mais detalhes, veja abaixo.	N/A
Texto	Corda	Não	Para obter mais detalhes, veja abaixo.	N/A
Evento	Data/hora	Não	Para obter mais detalhes, veja abaixo.	N/A
booleano	booleano	Não	Para obter mais detalhes, veja abaixo.	N/A
Duração	Corda	Não	Para obter mais detalhes, veja abaixo.	N/A
Number	Inteiro	Não	Para obter mais detalhes, veja abaixo.	N/A

Money type
Representa valores monetários com especificação de moeda.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
valor	Decimal	Não	Valor monetário, necessário para alguns tipos de preço	N/A
_moeda	Cadeia	Sim	Código de moeda ISO	N/A

Duration type
Representa uma duração de tempo usando o formato de duração ISO 8601. Os valores devem ser especificados em horas inteiras.

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
valor	Cadeia	sim	Duração da ISO 8601 em horas inteiras. Formato: PT {N} H onde {N} é um número inteiro de horas. Por exemplo, PT48H por 48 horas ou PT720H por 30 dias.	N/A

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

Atributo	Type	Obrigatório	Notas	Mapeamento de arquivos EMA
Number	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 suportados (NOTA: role para a direita para ver o mapeamento completo do EMA)
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	Notas	Mapeamento de arquivos EMA
Identidade do canal	Texto	Sim	Identificador de um canal ou assinatura.	GroupIdentity
Nível	Texto	Condicional	Nível de preços. Obrigatório se o tipo de licença for POST.	PriceType
SRP	Dinheiro	Condicional	Preço de varejo sugerido. Obrigatório se o tipo de licença for POST.	SRP
WSP	Dinheiro	Condicional	Preço de atacado. Obrigatório se o tipo de licença for POST.	PriceValue
Categoria	Texto	Condicional	Categoria de preço. Obrigatório se o tipo de licença for POST.	PriceValue
AnnounceDate	Evento	Não	Data em que o varejista tem permissão para anunciar a data de início da disponibilidade do livro dentro do território disponível.	AnnounceDate
SuppressionLiftDate	Evento	Condicional	Primeira data em que um título pode ser anunciado publicamente como disponível em uma data futura específica em território de disponibilidade. Obrigatório se o tipo de licença for POST.	SuppressionLiftDate
Duração do aluguel	Duração	Condicional	Duração do período de locação em horas. Obrigatório se o tipo de licença for SVOD.	Duração do aluguel
WatchDuration	Duração	Condicional	Quanto tempo o usuário tem para concluir a visualização depois de iniciada, em horas. Obrigatório se o tipo de licença for SVOD.	WatchDuration
Baixar	Texto	Não	A licença inclui permissão para fazer o download. Os valores válidos são Sim e Não. Quando o tipo de licença é SVOD, tanto a duração do aluguel quanto a duração do relógio devem ser especificadas.	Baixar
Exclusivo	booleano	Não	Os ativos são exclusivos dentro do escopo da Transação.	Exclusivo
ExclusiveAttributes	Texto	Não	Especifica o tipo de exclusividade. Considerado apenas quando Exclusivo é verdadeiro. Um valor padrão será usado se não for fornecido quando Exclusivo for verdadeiro.	ExclusiveAttributes
BrandingRights	booleano	Não	Indica a intenção do parceiro de exibir a marca.	BrandingRights
Atributos de 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.	Atributos de BrandingRightsAttributes
Permitir anúncios	booleano	Não	Determina se os anúncios são permitidos ou proibidos. Esse termo só pode aparecer uma vez.	Não disponível na EMA
Posicionamento permitido do anúncio	Texto	Condicional	Especifica o local no rolo onde os anúncios 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. Tanto AllowedAdPlacement quanto ProhibitedAdPlacement podem ser especificados, mas não ambos.	Não disponível na EMA
Colocação proibida de anúncios	Texto	Condicional	Especifica o local no rolo em que os anúncios 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 somente quando allowAds é verdadeiro. Tanto AllowedAdPlacement quanto ProhibitedAdPlacement podem ser especificados, mas não ambos.	Não disponível na EMA
Entrega e uso do Cue Point	Texto	Não	Especifica as obrigações de entrega e uso do ponto de sinalização. Valores permitidos: o parceiro entregará e o PrimeVideo deve ser usado, o PrimeVideo usará se for entregue, nenhuma obrigação de entrega ou uso, o talento será obrigado. Permitido somente quando allowAds é verdadeiro.	Não disponível na EMA
Venda de bases cegas	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
patrocínios	Texto	Não	Valores permitidos: Permitido, Proibido, PermitidoWithRestrictions. Esse atributo só deve estar presente se allowAds estiver definido como verdadeiro.	Não disponível na EMA
Restrições de patrocínios	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
Diretrizes de talentos e anúncios da Amazon (** não deve ter quebra de linha)	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
Restrições de talentos	Texto	Condicional	Texto de formato livre Esse atributo só deve estar presente se TalentAndAmazonAdGuidelines estiver definido como ConsultationRequired.	Não disponível na EMA
Limite de carga	Texto	Não	Número de minutos de anúncio por hora. Value 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
Porcentagem de desconto do CompleteYourBundle (** não deve ter quebra de linha)	Number	Não	Desconto percentual aplicado quando os clientes completam um pacote comprando títulos restantes que ainda não possuem. Por exemplo, um desconto de 20% significa que os clientes que possuem a Temporada 1 de um pacote de 2 temporadas recebem 20% de desconto na Temporada 2.	Não disponível na EMA
ExcludedFrom BundleDiscount (** não deve ter quebra de linha)	boleano	Não	Quando definido como verdadeiro, exclui essa janela de disponibilidade da elegibilidade do desconto do pacote. Use durante períodos de preços premium (por exemplo, novos lançamentos) ou para títulos que devem manter o preço total. Quando ausente ou falso, o título está qualificado para descontos em pacotes.	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.

Value	Description
TVOD	TVOD significa compra ou aluguel. Tipos de licença relacionados: EST, VOD, POEST
ASSINATURA PRIME	Assinatura Amazon Prime ou Amazon Kids+. Tipos de licença relacionados: SVOD
CANAIS	Assinatura de canal de terceiros. Tipos de licença relacionados: SVOD
VOD	Conteúdo gratuito. Tipos de licença relacionados: FVOD

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

Sample Payload Avails

Os exemplos a seguir demonstram como estruturar suas chamadas de API para cenários de integração comuns. Consulte exemplos de carga útil para ver pares completos de solicitação/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

Avails API