Video Central

A API de Status da Oferta permite verificar se seus títulos estão disponíveis na loja Prime Video e, caso não estejam, o motivo. Centralize os dados do seu catálogo nos seus próprios sistemas, em vez de verificar manualmente o Slate ou a loja, obtendo visibilidade em tempo real em todas as suas linhas de negócios e territórios.

Por que usar a API de Status da Oferta?

Operações centralizadas – importe dados do catálogo diretamente para seus próprios sistemas, juntamente com seus outros canais de distribuição, sem precisar fazer login no Slate para cada verificação de status
Resolução mais rápida de problemas – detecte imediatamente problemas de disponibilidade e entenda o que está impedindo seus títulos de serem lançados, reduzindo o tempo de resolução em até três dias
Gerenciamento proativo de catálogos – monitore todo o seu catálogo de acordo com a programação em todos os territórios e tipos de ofertas, permitindo que você amplie as operações à medida que sua empresa cresce
Verificação de lançamento em tempo real – saiba instantaneamente quando seu conteúdo é lançado com sucesso, sem verificações manuais na loja ou espera por atualizações de status

Essa API somente para leitura permite que você envie uma solicitação com seu identificador de título (ALID/SKU) e receba informações de status em tempo real para cada combinação de linha de negócios e território. Opcionalmente, você pode filtrar sua solicitação por tipo de licença, mercado (Global ou Clássico) e/ou território para segmentar ofertas específicas.

O que você receberá: informações de status de cada oferta, incluindo o status geral e informações detalhadas no nível da transação. Cada status indica a posição do seu livro no processo de publicação:

Ao vivo: sua oferta está disponível na vitrine com a caixa de compra presente
Em andamento: pelo menos um ou todos os ativos necessários foram entregues com sucesso e estão em processo de ingestão. A oferta ainda não foi criada.
Pronto: Todos os ativos e metadados foram ingeridos com sucesso. A oferta 1) foi criada, mas ainda não foi lançada (será lançada depois de publicada); 2) a oferta foi retirada ou removida; ou 3) a janela expirou.
Problema: Aguardando a entrega dos ativos necessários (a entrega não começou); ou pelo menos um ativo exigido foi rejeitado e precisa ser substituído.

Esquemas de solicitação e resposta

Esta seção fornece especificações técnicas para que os desenvolvedores integrem a API de Status da Oferta em seus sistemas. Use essa referência para entender o formato da solicitação, a estrutura de resposta e os tipos de dados retornados pela API.

Formato da solicitação

A API de Status da Oferta usa uma estrutura de solicitação GET simples para recuperação, na qual todos os parâmetros de consulta são passados pela URL, sem necessidade de corpo da solicitação. Isso facilita a integração em seus sistemas e o teste usando clientes HTTP padrão ou ferramentas de linha de comando. Basta criar a URL com seu identificador de título e filtros opcionais e, sem seguida, enviar uma solicitação GET para recuperar o status atual de suas ofertas:

Parâmetros
Essa tabela define os parâmetros que você pode usar para consultar informações sobre o status da oferta.

Parâmetro	Tipo	É obrigatório	Descrição
licenciante	String	Sim	O identificador da sua organização fornecido pela Prime Video durante a integração
ALID	String	Sim	Identificador do título (ALID ou SKU) correspondente à sua contribuição
marketplace	String	Não	A loja da Amazon ao qual o título foi enviado. O padrão é GLOBAL e não é necessário fornecer essa informação. Valores permitidos: GLOBAL, EUA, DE, JP, GB
território	String	Não	Código de território de duas letras (por exemplo, JP, GB, AU) para o qual você gostaria de verificar o status da oferta. O padrão é “todos os territórios” e não é obrigatório fornecer esse código. Todos os status das ofertas serão retornados se esse código não for fornecido

Exemplos de solicitações

Observação: Quanto mais específicos forem os parâmetros de sua solicitação, mais direcionada será sua resposta. Se você omitir parâmetros opcionais, como loja da Amazon e território, a API retornará informações de status para todos os escopos aplicáveis associados a esse ALID.

Esquema de resposta

O esquema de resposta define a estrutura dos dados retornados pela API de Status da Oferta. Compreender esses tipos de dados ajudará você a analisar a resposta e integrar as informações de status em seus sistemas de forma eficaz.

Obter resposta de status
A resposta de nível superior contendo informações sobre o status da oferta para o título solicitado. Cada resposta inclui dados de status filtrados pelos parâmetros da sua solicitação, permitindo que você entenda o estado de disponibilidade em diferentes linhas de negócios e territórios.

Atributo	Tipo	É obrigatório	Descrição
OfferStatuses	OfferStatus[]	Sim	Matriz de objetos de status da oferta, um por escopo (combinação de linha de negócios/território)
errors	string	Não	Lista de erros em caso de falha

Tipo de status da oferta: a estrutura de dados central que representa o status de uma única oferta. Isso inclui informações gerais sobre o status e dados detalhados sobre as transações para cada período de disponibilidade.

Atributo	Tipo	É obrigatório	Descrição
ALID	String	Sim	Identificador do título correspondente à sua contribuição de metadados
GroupingEntity	string	Condicional	Identificador de um canal ou assinatura (necessário para ofertas de SVOD)
Licenciante	Editora	Sim	Informações sobre a sua organização que concede licença ao Prime Video
OverallStatus	Status	Sim	Status geral de todo o contexto/escopo de disponibilidade atual
PlatformID	String[]	Sim	Lista de identificadores globais de títulos (GTI) para um título
Transação	Transaction[]	Sim	Uma lista dos períodos de disponibilidade e seus status

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

Atributo	Tipo	Obrigatório	Observações
DisplayName	String	Sim	Nome popular da sua organização
OrganizationID	String	Sim	O identificador da sua organização fornecido pela Prime Video durante a integração (deve corresponder ao valor usado em Avails)

Tipo de status
Fornece informações gerais sobre o status da oferta, incluindo o intervalo de datas e o código de progresso atual.

Atributo	Tipo	Obrigatório	Observações
Comentários	String	Não	Anotações legíveis da Amazon (atualmente nulas)
Início	Data	Sim	Data de início do período mais próximo para o contexto
Fim	Data	Sim	Última data de término do período para o contexto.
Código de progresso	ENUM	Sim	Código de progresso para o contexto
_timestamp	Data	Sim	Última vez que o status foi alterado ou atualizado

Tipo de transação
Representa um único período de disponibilidade com seus termos e status de licenciamento associados. Cada transação corresponde a uma combinação específica de tipo de licença, território e perfil de formato.

Atributo	Tipo	Obrigatório	Observações
ContractID	String	Sim	Contrato ao qual o título está associado
FeatureStatus	FeatureStatus	Sim	Status do período
Fim	Data	Sim	Última data de término do período para o contexto
Código de progresso	ENUM	Sim	Código de progresso para o contexto
_timestamp	Data	Sim	A última vez que o status foi alterado ou atualizado
FormatProfile	FormatProfile[]	Sim	Qualidade do vídeo disponibilizado. Valores permitidos: SD, HD, UHD, MAX
LicenseType	Enum	Sim	Valores permitidos: SVOD, FVOD, EST, POEST, VOD
Território	String[]	Sim	Território para o período
TransactionID	String	Não	Em breve: será disponibilizado o AvailID com extrações parciais (atualmente nulo).

Tipo FeatureStatus
Fornece informações detalhadas sobre o status de um período específico de disponibilidade, incluindo o intervalo de datas e o código de progresso.

Atributo	Tipo	Obrigatório	Observações
Comentários	String	Não	Anotações legíveis da Amazon (atualmente nulas)
Início	Data	Sim	Data de início do período
Fim	Data	Sim	Data de término do período
Código de progresso	ENUM	Sim	Código de progresso do período (atualmente nulo: use OverallStatus para determinar se o contexto está ativo)
_timestamp	Data	Sim	Última vez que o status foi alterado ou atualizado

Tipo FormatProfile
Especifica o nível de qualidade de vídeo para a disponibilidade. É possível incluir vários perfis de formato em uma única transação se você disponibilizou seu conteúdo em vários níveis de qualidade (por exemplo, HD e UHD).

Atributo	Tipo	Obrigatório	Observações
value[]	Enum	Sim	Qualidade do vídeo disponibilizado. Valores permitidos: SD, HD, UHD, MAX

Observação: Os esquemas acima representam a estrutura atual da resposta da API. Alguns campos (como Comments, ProgressCode em FeatureStatus e TransactionID) estão atualmente nulos, mas podem ser preenchidos em versões futuras.

Resposta de exemplo

Este exemplo demonstra uma resposta típica da API para um título SVOD com vários períodos de disponibilidade em diferentes territórios. A resposta mostra como as informações de status são estruturadas, incluindo status geral, dados da transação e perfis de formato.

Exemplo de SVOD:

Perguntas frequentes

As seções a seguir fornecem respostas para perguntas comuns sobre como trabalhar com a API de Status da Oferta.