A API Asset Status permite que você verifique quais entregas são necessárias para publicar seu livro e o status atual de cada entrega (por exemplo, sucesso, falha, falta) e, se não, por quê. Centralize seus dados de entrega de ativos em seus próprios sistemas em vez de verificar manualmente o Slate, oferecendo visibilidade em tempo real de todas as suas entregas e tipos de ativos. Você pode usar a API Asset Status para visualizar qualquer um dos dados atualmente disponíveis na guia Assets no Slate.
Por que usar a API Asset Status?
- Operações centralizadas — Extraia dados de entrega de ativos diretamente para seus próprios sistemas junto com seus outros canais de distribuição, sem a necessidade de 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 a publicação de seus títulos, reduzindo o tempo de resolução
- Gerenciamento proativo de ativos — monitore todo o seu catálogo programaticamente em todos os territórios e tipos de ativos, permitindo que você escale 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
Formato de solicitação
A API Asset Status usa uma simples recuperação por meio da estrutura de solicitação GET, na qual todos os parâmetros da consulta são passados pelo URL. Nenhum corpo de solicitação é necessário. Isso facilita a integração em seus sistemas e o teste usando clientes HTTP padrão ou ferramentas de linha de comando. Basta criar o URL com seu identificador de título e filtros opcionais e enviar uma solicitação GET para recuperar o status atual das entregas de seus ativos.
https://partnerapi.primevideo.com/v1/assets/{licensor}/status/{ALID}?marketplace={marketplace}
Essa tabela define os parâmetros que você pode usar para consultar informações sobre o status do ativo.
Parâmetro |
Type |
É obrigatório |
Description |
licenciante |
Cadeia |
sim |
O identificador da sua organização fornecido pelo Prime Video durante a integração |
ALID |
Cadeia |
sim |
Identificador do título (ALID ou SKU) correspondente à sua contribuição |
mercado |
Cadeia |
Não |
O Amazon Marketplace para o qual o livro foi enviado. O padrão é GLOBAL e não precisa ser fornecido. Se você estiver procurando por um título em seu catálogo do Classic Marketplace, indique qual deles como parâmetro. Valores permitidos: GLOBAL, EUA, DE, JP, GB |
Exemplos de solicitações
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123?marketplace=global
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123
Observação: quanto mais específicos forem seus parâmetros de solicitação, mais direcionada será sua resposta. Se você omitir o parâmetro opcional de mercado, a API retornará as informações de status de todos os escopos aplicáveis associados a esse ALID.
Esquema de resposta
O esquema de resposta define a estrutura dos dados retornados pela API Asset Status. A compreensão desses 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 sobre o status do ativo para o livro solicitado. Cada resposta inclui dados de status filtrados pelos parâmetros da sua solicitação, permitindo que você entenda o estado da entrega em diferentes tipos e requisitos de ativos.
Nome do campo |
Type |
É obrigatório |
Description |
Fonte |
Plataforma de entrega |
sim |
Plataforma de entrega de origem. Observe que isso sempre deve ser o Prime Video. |
Destino |
Editora de entrega |
sim |
O alias de parceiro do título que recebe os ativos. |
Escopo |
Escopo de entrega |
sim |
Informações sobre o escopo de entrega |
IDs de plataforma |
Identificadores de plataforma |
sim |
Identificadores de plataforma |
Código de progresso geral |
Código de progresso |
sim |
Código de progresso geral: Pronto, em questão, em andamento, ausente |
Detalhe do progresso |
Item de detalhe do progresso [] |
sim |
Lista de detalhes do progresso |
Status da peça do título |
Título do produto Status da peça [] |
sim |
Informações sobre o status da peça de título |
Instruções |
Instrução de entrega do produto [] |
Não |
Instruções de entrega |
DeliveryPlatform Type
Fonte informações sobre a plataforma de entrega.
Nome do campo |
Type |
É obrigatório |
Description |
Plataforma |
Cadeia |
sim |
Plataforma de entrega de origem. Observe que isso sempre deve ser o Prime Video. |
DeliveryPublisher Type
Informações do editor de destino. Isso identifica sua organização como destinatária do conteúdo.
Nome do campo |
Type |
É obrigatório |
Description |
Editora |
Cadeia |
sim |
O alias de parceiro do título que recebe os ativos. |
DeliveryScope Type
Informações do escopo de entrega que definem o contexto da consulta de status do ativo.
Nome do campo |
Type |
É obrigatório |
Description |
ALID |
Cadeia |
sim |
Identificador lógico do ativo ou SKU |
Marketplace |
Cadeia |
sim |
O Amazon Marketplace para o qual o livro foi enviado. O padrão é GLOBAL e não precisa ser fornecido. |
Region |
Cadeia |
Não |
Região ou território |
FormatProfile |
Cadeia |
Não |
Qualidade do vídeo disponível. Valores permitidos: SD, HD, UHD, MAX |
LicenseType |
Cadeia |
Não |
Valores permitidos: SVOD, FVOD, EST, POST, VOD |
ID do benefício |
Cadeia |
Não |
Identificador de um canal ou assinatura (obrigatório para ofertas de SVOD) |
Tipo de identificadores de plataforma
Estrutura de identificadores de plataforma contendo identificadores de título.
Nome do campo |
Type |
Obrigatório |
Description |
GTI |
Cadeia |
sim |
Identificador de título global |
IDs do editor |
Identificador do editor [] |
sim |
Identificadores do editor |
PublisherIdentifier Type
A lista de IDs fornecidas pelo parceiro.
Nome do campo |
Type |
Obrigatório |
Description |
ALID |
Cadeia |
sim |
Identificador de título |
Marketplace |
Cadeia |
sim |
O Amazon Marketplace para o qual o livro foi enviado. O padrão é GLOBAL e não precisa ser fornecido. |
ProgressCode Type
Valores de enumeração do código de progresso que indicam o status geral da entrega do ativo.
Value |
Description |
Pronto |
Os ativos foram ingeridos |
Problema |
Há um problema com a entrega ou processamento de ativos |
Em processo |
Os ativos estão sendo entregues e processados |
Desaparecido |
Um ativo específico ainda não foi entregue |
ProgressDetailItem Type
Estrutura do item de detalhe do progresso que fornece estatísticas resumidas.
Nome do campo |
Type |
Obrigatório |
Description |
Progresso |
Código de progresso |
sim |
Código de progresso |
Total |
Longo |
sim |
Contagem total de ativos |
Ação necessária |
Longo |
sim |
Número de ativos da contagem total que exigem ação |
ProductTitlePartStatus Type
A estrutura de dados principal 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 |
Type |
É obrigatório |
Description |
Tipo primário |
Cadeia |
sim |
O tipo primário do ativo |
Tipo secundário |
Cadeia |
sim |
Tipo secundário - Por exemplo, se o tipo primário for IMAGE, o subtipo poderá ser 2x3 ou Poster. |
FormatProfile |
Cadeia |
Não |
Formato, perfil ou qualidade |
Localidade |
Cadeia |
Não |
Localidade - ex en-US ou es-419 |
Contextos de oferta |
Escopo de entrega [] |
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 |
Peças de título condicionais |
Parte do título condicional do produto [] |
Não |
Partes condicionais do título |
Tipo de regra |
Cadeia |
sim |
Tipo de regra: obrigatório, recomendado, condicional |
Tipo de ação |
Cadeia |
sim |
Tipo de ação |
Fontes de regras |
Cadeia de caracteres [] |
sim |
Fontes de regras |
Última entrega |
Entrega do produto |
Não |
Informações da última entrega |
Entrega prévia bem-sucedida |
Entrega do produto |
Não |
Informações anteriores de entrega bem-sucedida |
Data da primeira entrega |
Cadeia |
Não |
Data da primeira entrega |
Progresso |
Código de progresso |
sim |
Código de progresso: Pronto, emitido, em andamento, ausente |
Data esperada |
Cadeia |
Não |
Data de entrega prevista |
Data de início mais antiga |
Cadeia |
Não |
Data de início mais antiga |
Valores comuns de PrimaryType
O campo PrimaryType identifica a categoria do ativo que está sendo entregue.
Value |
Description |
METADADOS |
Metadados do título (descrições, elenco, equipe, etc.) |
VÍDEO |
Arquivos de mezanino de vídeo |
IMAGEM |
Obra de arte (arte de caixa, arte de capa, imagens de heróis, pôsteres) |
ÁUDIO |
Faixas de áudio |
TEXTO_CRONOMETRADO |
Legendas e legendas |
Valores comuns do ActionType
O campo ActionType indica se você precisa agir em uma entrega específica de ativos.
Value |
Description |
AÇÃO_NECESSÁRIA |
O recurso está ausente ou tem erros que precisam ser resolvidos para que o livro seja publicado |
AÇÃO_RECOMENDADA |
O ativo não é obrigatório, mas recomendado para uma melhor experiência do cliente |
NENHUMA AÇÃO É NECESSÁRIA |
O ativo foi entregue com sucesso, nenhuma ação é necessária |
Valores comuns do tipo de regra
O campo RuleType define se um ativo é obrigatório ou opcional para a publicação de seu livro.
Value |
Description |
obrigatório |
Deve ser entregue para que o livro seja publicado |
recomendado |
Não é obrigatório, mas melhora a experiência do cliente |
condicional |
Exigido somente se determinadas condições forem atendidas |
ProductConditionalTitlePart Type
Estrutura de peça de título condicional que define requisitos condicionais para entrega de ativos.
Nome do campo |
Type |
É obrigatório |
Description |
Tipo de regra |
Cadeia |
sim |
Tipo de regra |
Regiões |
Cadeia de caracteres [] |
sim |
Lista de regiões ou territórios |
Peças do título |
Descritor da peça do título do produto [] |
sim |
Partes do título |
Valores do tipo de regra
O campo RuleType define a relação lógica entre as partes condicionais do título.
Value |
Description |
ANINHADO |
Todos os trechos do título na estrutura devem ser satisfeitos (e a lógica) |
SOLTEIRO |
Qualquer uma das partes do título satisfaz o requisito (ou lógica) |
ProductTitlePartDescriptor Type
Título Estrutura do descritor da peça que define um requisito específico da peça do título.
Nome do campo |
Type |
É obrigatório |
Description |
Tipo primário |
Cadeia |
sim |
O tipo primário do ativo |
Tipo secundário |
Cadeia |
sim |
Tipo secundário - Por exemplo, se o tipo primário for IMAGE, o subtipo poderá ser 2x3 ou Poster. |
FormatProfile |
Cadeia |
Não |
Formato, perfil ou qualidade |
Localidade |
Cadeia |
Não |
Localidade - ex en-US ou es-419 |
Tipo de entrega
Do produto Informações de entrega do produto que fornecem informações detalhadas sobre a entrega de um ativo. Esse campo será nulo se o ativo ainda não tiver sido entregue.
Nome do campo |
Type |
É obrigatório |
Description |
Status |
Cadeia |
Não |
Status da entrega - NOT_DELIVERED ou SUCCESSFULLY_DELIVERED |
Nome do arquivo |
Cadeia |
Não |
Nome do arquivo |
Hash |
Cadeia |
Não |
Hash ou soma de verificação do arquivo |
Data de entrega |
Cadeia |
Não |
Data de entrega no formato ISO 8601 |
Localidade |
Cadeia |
Não |
Localidade |
ServiceProvider |
Cadeia |
Não |
Provedor de serviços ou conta de entrega |
Tipo de apresentação |
Cadeia |
Não |
Presentation type |
Tipo de faixa dinâmica |
Cadeia |
Não |
Tipo de faixa dinâmica |
Instruções |
Instrução de entrega do produto [] |
Não |
Instruções ou erros de entrega |
Valores de status comuns
O campo Status indica se a entrega de um ativo foi recebida e processada com sucesso.
Value |
Description |
_ENTREGUE COM SUCESSO |
O ativo foi entregue e processado com sucesso |
NÃO ENTREGUE |
O ativo não foi recebido |
ProductDeliveryInstruction Type
Estrutura de instrução de entrega do produto 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 de entrega) ou nos objetos ProductDelivery (específicos para entregas de ativos individuais).
Nome do campo |
Type |
É obrigatório |
Description |
Parte do título |
Descritor da peça do título do produto |
Não |
Descritor da peça do título |
Status da peça do título |
Cadeia |
Não |
Status de entrega da peça de título |
Código de erro |
Cadeia |
Não |
Código de erro |
Regiões |
Cadeia de caracteres [] |
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.
Value |
Description |
NÃO ENTREGUE |
O ativo não foi entregue |
_ENTREGUE COM SUCESSO |
O ativo foi entregue com sucesso |
Observação: os esquemas acima representam a estrutura atual de resposta da API e podem ser aprimorados em versões futuras.
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 de erro.
{
"Destination": {
"Publisher": "1cendgametestpartner1"
},
"Instructions": [
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "HD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": {
"FormatProfile": null,
"Locale": "ja",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
"TitlePartStatus": "SUCCESSFULLY_DELIVERED"
}
],
"OverallProgressCode": "Issue",
"ProgressDetail": [
{
"ActionNeeded": 0,
"Progress": "Ready",
"Total": 8
},
{
"ActionNeeded": 2,
"Progress": "Missing",
"Total": 2
}
],
"Scope": {
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": null,
"FormatProfile": null,
"LicenseType": null,
"Marketplace": "GLOBAL",
"Region": null
},
"TitlePartStatus": [
{
"ActionType": "ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE", "PR", "AU", "JP", "GB", "US", "CA"],
"RuleType": "NESTED",
"TitleParts": [
{
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
}
]
}
],
"EarliestStartDate": "Thu Jan 09 15:00:00 UTC 2025",
"FormatProfile": "SD",
"LastDelivery": null,
"Locale": null,
"OfferContexts": [
{
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": "Prime",
"FormatProfile": "SD",
"LicenseType": "SVOD",
"Marketplace": "GLOBAL",
"Region": "US"
}
],
"PrimaryType": "VIDEO",
"PriorSuccessfulDelivery": null,
"Progress": "Missing",
"RuleSources": ["PUBLISHING_SPEC"],
"RuleType": "REQUIRED",
"SecondaryType": "MEZZ"
},
{
"ActionType": "NO_ACTION_NEEDED",
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "ja-jp",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "ja",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
},
{
"ActionType": "NO_ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE"],
"RuleType": "SINGLE",
"TitleParts": [
{
"FormatProfile": null,
"Locale": "de",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
{
"FormatProfile": null,
"Locale": "en",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
}
]
}
],
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "de-de",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "de",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
}
]
}
