Video Central

A API de Status de Ativos permite verificar quais entregas são necessárias para publicar seu título e o status atual de cada entrega (por exemplo, sucesso, falha, ausente) e, caso contrário, o motivo. Centralize os dados de entrega de ativos em seus próprios sistemas, em vez de verificar manualmente o Slate, obtendo visibilidade em tempo real de todas as suas entregas e tipos de ativos. Você pode usar a API de Status de Ativos para visualizar qualquer um dos dados atualmente disponíveis na guia Ativos do Slate.

Por que usar a API de Status de Ativos?

Operações centralizadas – importe dados de entrega de ativos 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 problemas de entrega imediatamente e entenda o que está impedindo que seus títulos sejam publicados, reduzindo o tempo de resolução
Gerenciamento proativo de ativos – monitore todo o seu catálogo de acordo com a programação em todos os territórios e tipos de ativos, permitindo que você dimensione as operações à medida que sua empresa cresce
Verificação de entrega em tempo real – saiba instantaneamente quando seus ativos foram entregues com sucesso ou se há erros que exigem ação

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 entrega de ativo necessária. Opcionalmente, você pode filtrar sua solicitação por mercado para atingir requisitos de entrega específicos.

O que você receberá:
informações de status de cada ativo necessário, incluindo o tipo de ação e informações detalhadas de entrega. Cada status indica onde você precisa focar sua atenção:

Ação necessária: É necessária uma ação nesse ativo específico para que o livro seja publicado. Isso pode significar que o ativo foi entregue, mas está errado, ou não foi entregue de todo.
Ação recomendada: não é necessária uma ação para que o livro seja publicado, mas recomendamos que o parceiro tome medidas para aumentar o desempenho do título, por exemplo, arte localizada.
Nenhuma ação necessária: Nenhuma ação adicional é necessária.

Esquemas de solicitação e resposta

Esta seção fornece especificações técnicas para que os desenvolvedores integrem a API de Status de Ativos 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 de Ativos usa uma estrutura de solicitação GET simples para recuperação de dados, 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, em seguida, enviar uma solicitação GET para recuperar o status atual de suas entregas de ativos.

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

Parâmetro	Tipo	É obrigatório	Descrição
licenciante	String	Sim	O identificador da sua organização fornecido pelo Prime Video durante a integração
ALID	String	Sim	Identificador de 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. Se você estiver procurando um título no catálogo clássico de comércio eletrônico, indique qual deles como parâmetro. Valores permitidos: GLOBAL, EUA, DE, JP, GB

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 o parâmetro opcional loja da Amazon, 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 de Ativos. Compreender esses tipos de dados ajudará você a analisar a resposta e integrar as informações de status em seus sistemas de forma eficaz.

ProductStatus
A resposta de nível superior contendo informações de status do ativo para o título solicitado. Cada resposta inclui dados de status filtrados pelos parâmetros de sua solicitação, permitindo que você entenda o estado de entrega em diferentes tipos e requisitos de ativos.

Nome do campo	Tipo	É obrigatório	Descrição
Origem	DeliveryPlatform	Sim	Plataforma de distribuição de origem. Observe que deve ser sempre o Prime Video.
Destino	DeliveryPublisher	Sim	O alias do parceiro para o título que recebe os ativos.
Escopo	DeliveryScope	Sim	Informações sobre o escopo de entrega
PlatformIDs	PlatformIdentifiers	Sim	Identificadores de plataforma
OverallProgressCode	ProgressCode	Sim	Código de progresso geral: Pronto, Emitido, Em Andamento, Ausente
ProgressDetail	ProgressDetailItem[]	Sim	Lista de detalhes do progresso
TitlePartStatus	ProductTitlePartStatus[]	Sim	Informações sobre o status da peça do título
Instruções	ProductDeliveryInstruction[]	Não	Instruções de entrega

Tipo DeliveryPlatform
Informações da plataforma de distribuição de origem.

Nome do campo	Tipo	É obrigatório	Descrição
Plataforma	String	Sim	Plataforma de distribuição de origem. Observe que deve ser sempre o Prime Video.

Tipo DeliveryPublisher
Informações sobre a editora de destino. Isso identifica sua organização como destinatária do conteúdo.

Nome do campo	Tipo	É obrigatório	Descrição
Editora	String	Sim	O alias do parceiro para o título que recebe os ativos.

Tipo DeliveryScope
Informações sobre o escopo de entrega que definem o contexto da consulta sobre o status do ativo.

Nome do campo	Tipo	É obrigatório	Descrição
ALID	String	Sim	Identificador lógico do ativo ou SKU
Comércio eletrônico	String	Sim	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
Região	String	Não	Região ou território
FormatProfile	String	Não	Qualidade do vídeo disponibilizado. Valores permitidos: SD, HD, UHD, MAX
LicenseType	String	Não	Valores permitidos: SVOD, FVOD, EST, POEST, VOD
BenefitID	String	Não	Identificador de um canal ou assinatura (necessário para ofertas de SVOD)

Tipo PlatformIdentifiers
Estrutura de identificadores de plataforma contendo identificadores de título.

Nome do campo	Tipo	Obrigatório	Descrição
GTI	String	Sim	Identificador Global de Título
PublisherIDs	PublisherIdentifier[]	Sim	Identificadores da editora

Tipo PublisherIdentifier
A lista de IDs fornecidos pelos parceiros.

Nome do campo	Tipo	Obrigatório	Descrição
ALID	String	Sim	Identificador do título
Comércio eletrônico	String	Sim	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

Tipo ProgressCode
Valores de enumeração do código de progresso que indicam o status geral da entrega do ativo.

Valor	Descrição
Pronto	Os ativos foram incorporados
Problema	Ocorreu um problema com a entrega ou o processamento de ativos
Em andamento	Os ativos estão sendo entregues e processados
Ausente	Um ativo específico ainda não foi entregue

Tipo ProgressDetailItem
Estrutura detalhada do item de progresso fornecendo estatísticas resumidas.

Nome do campo	Tipo	Obrigatório	Descrição
Progresso	ProgressCode	Sim	Código de progresso
Total	Long	Sim	Contagem total de ativos
ActionNeeded	Long	Sim	Número de ativos da contagem total que requerem ação

Tipo ProductTitlePartStatus
A estrutura de dados central que representa o status de uma única entrega de ativos necessária. Isso inclui status de entrega, requisitos de ação e dados detalhados em nível de transação.

Nome do campo	Tipo	É obrigatório	Descrição
PrimaryType	String	Sim	O tipo primário do ativo
SecondaryType	String	Sim	Tipo secundário: por exemplo, se o tipo primário fosse IMAGEM, o subtipo poderia ser 2x3 ou Pôster.
FormatProfile	String	Não	Perfil ou qualidade do formato
Localidade	String	Não	Localidade: por exemplo, en-US ou es-419
OfferContexts	DeliveryScope[]	Sim	Cada OfferContext representa uma configuração de oferta específica (região, tipo de licença, perfil de formato etc.) que usa o ativo
ConditionalTitleParts	ProductConditionalTitlePart[]	Não	Partes do título condicional
RuleType	String	Sim	Tipo de regra: obrigatório, recomendado, condicional
ActionType	String	Sim	Tipo de ação
RuleSources	String[]	Sim	Fontes de regras
LastDelivery	ProductDelivery	Não	Informações sobre a última entrega
PriorSuccessfulDelivery	ProductDelivery	Não	Informações sobre entregas bem-sucedidas anteriores
FirstDeliveryDate	String	Não	Data da primeira entrega
Progresso	ProgressCode	Sim	Código de progresso: Pronto, Emitido, Em Andamento, Ausente
ExpectedDate	String	Não	Data prevista de entrega
EarliestStartDate	String	Não	Data de início mais próxima

Valores comuns PrimaryType
O campo PrimaryType identifica a categoria do ativo que está sendo fornecido.

Valor	Descrição
METADADOS	Metadados do título (descrições, elenco, equipe, etc.)
VÍDEO	Arquivos mezanino de vídeo
IMAGEM	Arte (arte da caixa, arte da capa, imagens de heróis, pôsteres)
ÁUDIO	Faixas de áudio
TIMED_TEXT	Legendas e subtítulos

Valores comuns de ActionType
O campo ActionType indica se você precisa tomar alguma medida em relação a um determinado envio de ativos.

Valor	Descrição
ACTION_NEEDED	O ativo está ausente ou contém erros que precisam ser resolvidos para que o título seja publicado
ACTION_RECOMMENDED	O ativo não é obrigatório, mas é recomendado para uma melhor experiência do cliente
NO_ACTION_NEEDED	O ativo foi entregue com sucesso, nenhuma ação é necessária

Valores comuns de RuleType
O campo RuleType define se um ativo é obrigatório ou opcional para a publicação do seu título.

Valor	Descrição
obrigatório	Deve ser entregue para publicação do título
recomendado	Não é obrigatório, mas melhora a experiência do cliente
condicional	Exigido somente se determinadas condições forem atendidas

Tipo ProductConditionalTitlePart
Estrutura da parte do título condicional que define os requisitos condicionais para a entrega do ativo.

Nome do campo	Tipo	É obrigatório	Descrição
RuleType	String	Sim	Tipo de regra
Regiões	String[]	Sim	Lista de regiões ou territórios
TitleParts	ProductTitlePartDescriptor[]	Sim	Partes do título

Valores RuleType
O campo RuleType define a relação lógica entre as partes condicionais do título.

Valor	Descrição
ANINHADO	Todas as partes do título na estrutura devem ser satisfeitas (lógica E)
ÚNICO	Qualquer uma das partes do título satisfaz o requisito (lógica OU)

Tipo ProductTitlePartDescriptor
Estrutura descritiva da parte do título que define um requisito específico para a parte do título.

Nome do campo	Tipo	É obrigatório	Descrição
PrimaryType	String	Sim	O tipo primário do ativo
SecondaryType	String	Sim	Tipo secundário: por exemplo, se o tipo primário fosse IMAGEM, o subtipo poderia ser 2x3 ou Pôster.
FormatProfile	String	Não	Perfil ou qualidade do formato
Localidade	String	Não	Localidade: por exemplo, en-US ou es-419

Tipo ProductDelivery
Informações sobre a entrega do produto, fornecendo detalhes sobre a entrega de um ativo. Este campo estará vazio se o ativo ainda não tiver sido entregue.

Nome do campo	Tipo	É obrigatório	Descrição
Status	String	Não	Status da entrega: NOT_DELIVERED ou SUCCESSFULLY_DELIVERED
FileName	String	Não	Nome do arquivo
Hash	String	Não	Hash de arquivo ou soma de verificação
DeliveredDate	String	Não	Data de entrega no formato ISO 8601
Localidade	String	Não	Localidade
ServiceProvider	String	Não	Prestador de serviços ou conta de entrega
PresentationType	String	Não	Tipo de apresentação
DynamicRangeType	String	Não	Tipo de faixa dinâmica
Instruções	ProductDeliveryInstruction[]	Não	Instruções de entrega ou erros

Valores comuns de Status
O campo Status indica se uma entrega de ativo foi recebida e processada com sucesso.

Valor	Descrição
SUCCESSFULLY_DELIVERED	O ativo foi entregue e processado com sucesso
NOT_DELIVERED	O ativo não foi recebido

Tipo ProductDeliveryInstruction
Estrutura de instruções de entrega do produto fornecendo que fornece códigos de erro e informações de status. As instruções podem aparecer na resposta de nível superior (resumindo todos os problemas relacionados à entrega) ou nos objetos ProductDelivery (específicos para entregas de ativos individuais).

Nome do campo	Tipo	É obrigatório	Descrição
TitlePart	ProductTitlePartDescriptor	Não	Descrição da parte do título
TitlePartStatus	String	Não	Status de entrega da parte do título
ErrorCode	String	Não	Código de erro
Regiões	String[]	Não	Lista de regiões ou territórios

Valores comuns de TitlePartStatus
O campo TitlePartStatus indica o status de entrega de um ativo nas mensagens de instrução.

Valor	Descrição
NOT_DELIVERED	O ativo não foi entregue
SUCCESSFULLY_DELIVERED	O ativo foi entregue com sucesso

Observação: Os esquemas acima representam a estrutura atual da resposta da API e podem ser aprimorados em versões futuras.

Resposta de exemplo

Os exemplos a seguir demonstram respostas típicas da API para diferentes cenários. Use-os para entender a estrutura de resposta e como interpretar as informações de status.

Exemplo 1: Todos os ativos entregues com sucesso

Este exemplo demonstra uma resposta típica da API para um título de filme em que todos os ativos necessários foram entregues com sucesso. A resposta mostra o status Pronto, sem necessidade de ação.

Exemplo 2: Ativos necessários ausentes

Este exemplo demonstra uma resposta da API quando os ativos necessários estão ausentes, mostrando como a API indica o status ACTION_NEEDED e fornece informações sobre o erro.

Caso de uso: você enviou metadados para um episódio de TV, mas ainda não entregou os arquivos de vídeo. A API mostra quais formatos de vídeo estão ausentes e bloqueia a publicação.

Principais diferenças em relação ao Exemplo 1:

OverallProgressCode é “Problema” em vez de “Pronto”
ProgressDetail mostra a contagem de ActionNeeded de 2
As entradas TitlePartStatus com ActionType “ACTION_NEEDED” têm LastDelivery nulo
A matriz de instruções no nível superior mostra o status NOT_DELIVERED
Alguns ativos entregues têm avisos de validação em suas instruções

Perguntas frequentes

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

A matriz de instruções fornece códigos de erro detalhados e informações de status:

Instruções de alto nível - Resumo de todos os problemas de entrega em todos os ativos
Instruções de entrega do produto - Avisos ou erros específicos para entregas de ativos individuais
Código de erro - identifica o problema específico (por exemplo, avisos de validação, dependências ausentes)
TitlePartStatus - Mostra se o ativo foi entregue (SUCCESSFULLY_DELIVERED, NOT_DELIVERED)