L’API Asset Status ti consente di verificare quali consegne sono necessarie per pubblicare il tuo titolo e lo stato attuale di ciascuna consegna (ad esempio riuscita, fallita, mancante) e, in caso negativo, il perché. Centralizza i dati di consegna delle risorse nei tuoi sistemi invece di controllare manualmente Slate, offrendoti visibilità in tempo reale su tutte le consegne e i tipi di risorsa. Puoi utilizzare l’API Asset Status per visualizzare tutti i dati attualmente disponibili nella scheda Assets di Slate.
Perché utilizzare l’API Asset Status?
- Operazioni centralizzate: inserisci i dati di consegna delle risorse direttamente nei tuoi sistemi insieme agli altri canali di distribuzione, senza bisogno di accedere a Slate per ogni controllo dello stato
- Risoluzione più rapida dei problemi: rileva immediatamente i problemi di consegna e scopri cosa impedisce la pubblicazione dei tuoi titoli, riducendo i tempi di risoluzione
- Gestione proattiva delle risorse: monitora l’intero catalogo in modo programmatico su tutti i territori e i tipi di asset, consentendoti di scalare le operazioni man mano che la tua azienda cresce
- Verifica della consegna in tempo reale: scopri immediatamente quando le tue risorse sono state consegnate con successo o se ci sono errori che richiedono un’azione
Formato di richiesta
L’API Asset Status utilizza una semplice struttura di recupero tramite GET in cui tutti i parametri della query vengono passati attraverso l’URL: non è richiesto il corpo della richiesta. Ciò semplifica l’integrazione nei sistemi e il test utilizzando client HTTP standard o strumenti da riga di comando. È sufficiente creare l’URL con l’identificatore del titolo e i filtri opzionali, quindi inviare una richiesta GET per recuperare lo stato corrente delle consegne delle risorse.
https://partnerapi.primevideo.com/v1/assets/{licensor}/status/{ALID}?marketplace={marketplace}
Questa tabella definisce i parametri che è possibile utilizzare per interrogare le informazioni sullo stato delle risorse.
Parametro |
Tipo |
È obbligatorio |
Descrizione |
licensor |
Stringa |
Sì |
L’identificativo della tua organizzazione fornito da Prime Video durante l’onboarding |
ALID |
Stringa |
Sì |
Identificatore del titolo (ALID o SKU) corrispondente al tuo contributo |
marketplace |
Stringa |
No |
L’Amazon Marketplace a cui è stato inviato il titolo. Il valore predefinito è GLOBAL e non deve essere fornito. Se stai cercando un titolo nel tuo catalogo Classic Marketplace, indica quale titolo come parametro. Valori consentiti: GLOBAL, US, DE, JP, GB |
Richieste di esempio
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123?marketplace=global
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123
Nota: Più specifici sono i parametri della tua richiesta, più mirata sarà la tua risposta. Se ometti il parametro opzionale marketplace, l’API restituirà le informazioni sullo stato per tutti gli ambiti applicabili associati a quell’ALID.
Schema di risposta
Lo schema di risposta definisce la struttura dei dati restituiti dall’API Asset Status. La comprensione di questi tipi di dati ti aiuterà ad analizzare la risposta e a integrare efficacemente le informazioni sullo stato nei tuoi sistemi.
ProductStatus
La risposta di primo livello contenente le informazioni sullo stato delle risorse per il titolo richiesto. Ogni risposta include dati sullo stato filtrati in base ai parametri della richiesta, che consentono di comprendere lo stato di consegna tra diversi tipi di asset e requisiti.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
Source |
DeliveryPlatform |
Sì |
Piattaforma di consegna alla fonte. Nota che dovrebbe essere sempre Prime Video. |
Destinazione |
DeliveryPublisher |
Sì |
L’alias del partner per il titolo che riceve le risorse. |
Ambito |
DeliveryScope |
Sì |
Informazioni sull’ambito di consegna |
PlatformIDs |
PlatformIdentifiers |
Sì |
Identificatori della piattaforma |
OverallProgressCode |
ProgressCode |
Sì |
Codice di avanzamento generale: Pronto, emesso, in corso, mancante |
ProgressDetail |
ProgressDetailItem[] |
Sì |
Elenco dei dettagli sullo stato di avanzamento |
TitlePartStatus |
ProductTitlePartStatus[] |
Sì |
Informazioni sullo stato della parte del titolo |
Istruzioni |
ProductDeliveryInstruction[] |
No |
Istruzioni di consegna |
DeliveryPlatform Type
Informazioni sulla piattaforma di consegna della fonte.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
Piattaforma |
Stringa |
Sì |
Piattaforma di consegna alla fonte. Nota che dovrebbe essere sempre Prime Video. |
DeliveryPublisher Type
Informazioni sul Publisher di destinazione. Questo identifica la tua organizzazione come destinataria dei contenuti.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
Publisher |
Stringa |
Sì |
L’alias del partner per il titolo che riceve le risorse. |
DeliveryScope Type
Informazioni sull’ambito di consegna che definiscono il contesto della richiesta sullo stato della risorsa.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
ALID |
Stringa |
Sì |
SKU o identificatore logico della risorsa |
Marketplace |
Stringa |
Sì |
L’Amazon Marketplace a cui è stato inviato il titolo. Il valore predefinito è GLOBAL e non deve essere fornito. |
Regione |
Stringa |
No |
Regione o territorio |
FormatProfile |
Stringa |
No |
Qualità del video disponibile. Valori consentiti: SD, HD, UHD, MAX |
LicenseType |
Stringa |
No |
Valori consentiti: SVOD, FVOD, EST, POEST, VOD |
BenefitID |
Stringa |
No |
Identificatore per un canale o un abbonamento (richiesto per le offerte SVOD) |
PlatformIdentifiers Type
Struttura degli identificatori della piattaforma contenente gli identificatori del titolo.
Nome campo |
Tipo |
Obbligatorio |
Descrizione |
GTI |
Stringa |
Sì |
Identificatore globale del titolo |
PublisherIDs |
PublisherIdentifier[] |
Sì |
Identificativi del Publisher |
PublisherIdentifier Type
L’elenco degli ID forniti dal partner.
Nome campo |
Tipo |
Obbligatorio |
Descrizione |
ALID |
Stringa |
Sì |
Identificatore del titolo |
Marketplace |
Stringa |
Sì |
L’Amazon Marketplace a cui è stato inviato il titolo. Il valore predefinito è GLOBAL e non deve essere fornito. |
Tipo ProgressCode
Valori di enumerazione del codice di avanzamento che indicano lo stato generale della consegna delle risorse.
Value |
Descrizione |
Pronto |
Le risorse sono state acquisite |
Problema |
C’è un problema con la consegna o l’elaborazione delle risorse |
In corso |
Le risorse vengono consegnate ed elaborate |
Mancante |
Una risorsa specifica non è stata ancora consegnata |
ProgressDetailItem Type
Struttura degli elementi di dettaglio dei progressi che fornisce statistiche riassuntive.
Nome campo |
Tipo |
Obbligatorio |
Descrizione |
Progresso |
ProgressCode |
Sì |
Codice di avanzamento |
Totale |
Long |
Sì |
Conteggio totale delle risorse |
ActionNeeded |
Long |
Sì |
Numero di risorse del conteggio totale che richiedono un’azione |
ProductTitlePartStatus Type
La struttura dei dati di base che rappresenta lo stato di una singola fornitura di risorse richiesta. Ciò include lo stato della consegna, i requisiti di azione e i dati dettagliati a livello di transazione.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
PrimaryType |
Stringa |
Sì |
Il tipo principale di risorsa |
SecondaryType |
Stringa |
Sì |
Tipo secondario: ad esempio, se il tipo principale era IMAGE, il sottotipo potrebbe essere 2x3 o Poster |
FormatProfile |
Stringa |
No |
Profilo o qualità del formato |
Locale |
Stringa |
No |
Locale - ex en-US o es-419 |
OfferContexts |
DeliveryScope[] |
Sì |
Ogni OfferContext rappresenta una configurazione di offerta specifica (regione, tipo di licenza, profilo di formato, ecc.) che utilizza la risorsa |
ConditionalTitleParts |
ProductConditionalTitlePart[] |
No |
Parti del titolo condizionali |
RuleType |
Stringa |
Sì |
Tipo di regola: obbligatorio, consigliato, condizionale |
ActionType |
Stringa |
Sì |
Tipo di azione |
RuleSources |
String[] |
Sì |
Fonti delle regole |
LastDelivery |
ProductDelivery |
No |
Informazioni sull’ultima consegna |
PriorSuccessfulDelivery |
ProductDelivery |
No |
Informazioni precedenti sulla consegna avvenuta con successo |
FirstDeliveryDate |
Stringa |
No |
Prima data di consegna |
Progresso |
ProgressCode |
Sì |
Codice di avanzamento: Pronto, emesso, in corso, mancante |
ExpectedDate |
Stringa |
No |
Data di invio prevista |
EarliestStartDate |
Stringa |
No |
Prima data di inizio |
Valori PrimaryType comuni
Il campo PrimaryType identifica la categoria di risorse che vengono consegnate.
Value |
Descrizione |
METADATI |
Metadati del titolo (descrizioni, cast, troupe, ecc.) |
VIDEO |
File master compressi |
IMAGE |
Grafica (cofanetto, copertina, immagini principali, poster) |
AUDIO |
Tracce audio |
TIMED_TEXT |
Sottotitoli e didascalie |
Common ActionType Values
Il campo ActionType indica se è necessario intervenire sulla consegna di una risorsa specifica.
Value |
Descrizione |
ACTION_NEEDED |
La risorsa è mancante o presenta errori che devono essere risolti per la pubblicazione del titolo |
ACTION_RECOMMENDED |
La risorsa non è obbligatoria ma consigliata per una migliore esperienza del cliente |
NO_ACTION_NEEDED |
La risorsa è stata consegnata con successo, non è richiesta alcuna azione |
Valori RuleType comuni
Il campo RuleType definisce se una risorsa è obbligatoria o facoltativa per la pubblicazione del titolo.
Value |
Descrizione |
required |
Deve essere consegnato perché il titolo venga pubblicato |
recommended |
Non richiesto ma migliora l’esperienza del cliente |
conditional |
Richiesto solo se sono soddisfatte determinate condizioni |
ProductConditionalTitlePart Type
Struttura condizionale della parte del titolo che definisce i requisiti condizionali per la consegna delle risorse.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
RuleType |
Stringa |
Sì |
Tipo di regola |
Regioni |
String[] |
Sì |
Elenco di regioni o territori |
TitleParts |
ProductTitlePartDescriptor[] |
Sì |
Parti del titolo |
Valori RuleType
Il campo RuleType definisce la relazione logica tra le parti condizionali del titolo.
Value |
Descrizione |
NESTED |
Tutte le parti del titolo nella struttura devono essere soddisfatte (logica AND) |
SINGLE |
Una qualsiasi delle parti del titolo soddisfa il requisito (logica OR) |
ProductTitlePartDescriptor Type
Struttura del descrittore della parte del titolo che definisce un requisito specifico per la parte del titolo.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
PrimaryType |
Stringa |
Sì |
Il tipo principale di risorsa |
SecondaryType |
Stringa |
Sì |
Tipo secondario: ad esempio, se il tipo principale era IMAGE, il sottotipo potrebbe essere 2x3 o Poster |
FormatProfile |
Stringa |
No |
Profilo o qualità del formato |
Locale |
Stringa |
No |
Locale - ex en-US o es-419 |
ProductDelivery Type
Informazioni sulla consegna del prodotto che forniscono informazioni dettagliate sulla consegna di un asset. Questo campo sarà nullo se l’asset non è stato ancora consegnato.
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
Stato |
Stringa |
No |
Stato della spedizione: NOT_DELIVERED o SUCCESSFULLY_DELIVERED |
FileName |
Stringa |
No |
Nome file |
Hash |
Stringa |
No |
Hash o checksum del file |
DeliveredDate |
Stringa |
No |
Data di consegna in formato ISO 8601 |
Locale |
Stringa |
No |
Locale |
ServiceProvider |
Stringa |
No |
Fornitore di servizi o account di consegna |
PresentationType |
Stringa |
No |
Tipo di presentazione |
DynamicRangeType |
Stringa |
No |
Tipo di gamma dinamica |
Istruzioni |
ProductDeliveryInstruction[] |
No |
Istruzioni di consegna o errori |
Valori di stato comuni
Il campo Stato indica se la consegna di un asset è stata ricevuta ed elaborata correttamente.
Value |
Descrizione |
SUCCESSFULLY_DELIVERED |
La risorsa è stata consegnata ed elaborata con successo |
NOT_DELIVERED |
La risorsa non è stata ricevuta |
ProductDeliveryInstruction Type
Struttura delle istruzioni di consegna del prodotto che fornisce codici di errore e informazioni sullo stato. Le istruzioni possono essere visualizzate nella risposta di primo livello (riepilogando tutti i problemi di consegna) o all’interno degli oggetti ProductDelivery (specifici per le consegne di singoli asset).
Nome campo |
Tipo |
È obbligatorio |
Descrizione |
TitlePart |
ProductTitlePartDescriptor |
No |
Descrittore parte del titolo |
TitlePartStatus |
Stringa |
No |
Stato di consegna della parte del titolo |
ErrorCode |
Stringa |
No |
Codice di errore |
Regioni |
String[] |
No |
Elenco di regioni o territori |
Valori TitlePartStatus comuni
Il campo TitlePartStatus indica lo stato di consegna di una risorsa all’interno dei messaggi di istruzioni.
Value |
Descrizione |
NOT_DELIVERED |
La risorsa non è stata consegnata |
SUCCESSFULLY_DELIVERED |
La risorsa è stata consegnata con successo |
Nota: Gli schemi sopra riportati rappresentano l’attuale struttura di risposta dell’API e potrebbero essere migliorati nelle versioni future.
Esempio 1: Tutte le risorse sono state consegnate con successo
Questo esempio dimostra una tipica risposta API per il titolo di un film in cui tutte le risorse richieste sono state consegnate con successo. La risposta mostra lo stato Pronto senza che sia necessaria alcuna azione.
{
"Destination": {
"Publisher": "TheDogChannel"
},
"Instructions": [],
"OverallProgressCode": "Ready",
"PlatformIDs": {
"GTI": "amzn1.dv.gti.e627fc28-5fde-435f-bc4e-44a9bad712df",
"PublisherIDs": [
{
"ALID": "FunWithTennisBalls",
"Marketplace": "GLOBAL"
}
]
},
"ProgressDetail": [
{
"ActionNeeded": 0,
"Progress": "Ready",
"Total": 11
}
],
"Scope": {
"ALID": "FunWithTennisBalls",
"BenefitID": "dogchannel",
"FormatProfile": null,
"LicenseType": null,
"Marketplace": "GLOBAL",
"Region": null
},
"Source": {
"Platform": "Prime Video"
},
"TitlePartStatus": [
{
"ActionType": "NO_ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["US"],
"RuleType": "NESTED",
"TitleParts": [
{
"FormatProfile": null,
"Locale": null,
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
}
]
}
],
"EarliestStartDate": "Wed Jun 01 04:00:00 UTC 2022",
"ExpectedDate": null,
"FirstDeliveryDate": null,
"FormatProfile": null,
"LastDelivery": {
"DeliveredDate": "Mon Feb 26 22:56:53 UTC 2024",
"DynamicRangeType": null,
"FileName": "passionflix_82_this-side-of-heaven_v5_MEC.xml",
"Hash": "3f73286984d4c71fd7a341c9b16be3ff",
"Instructions": null,
"Locale": "en-us",
"PresentationType": null,
"ServiceProvider": "stockholmstream",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": null,
"OfferContexts": [
{
"ALID": "FunWithTennisBalls",
"BenefitID": "dogchannel",
"FormatProfile": "HD",
"LicenseType": "SVOD",
"Marketplace": "GLOBAL",
"Region": "US"
}
],
"PrimaryType": "METADATA",
"PriorSuccessfulDelivery": {
"DeliveredDate": "Wed May 31 04:32:00 UTC 2023",
"DynamicRangeType": null,
"FileName": "fun_with_v4_MEC.xml",
"Hash": null,
"Instructions": null,
"Locale": "en-us",
"PresentationType": null,
"ServiceProvider": "thepound",
"Status": null
},
"Progress": "Ready",
"RuleSources": ["PUBLISHING_SPEC"],
"RuleType": "REQUIRED",
"SecondaryType": "NONE"
},
{
"ActionType": "NO_ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["US"],
"RuleType": "NESTED",
"TitleParts": [
{
"FormatProfile": "HD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
}
]
}
],
"EarliestStartDate": "Wed Jun 01 04:00:00 UTC 2022",
"FormatProfile": "HD",
"LastDelivery": {
"DeliveredDate": "Mon Feb 27 14:59:03 UTC 2023",
"DynamicRangeType": "SDR",
"FileName": "fun_with_tennis_mwf5.mp4",
"Hash": "88cbed6edabce11b9b503130081e7bd8",
"Instructions": null,
"Locale": "en-us",
"PresentationType": "MAIN",
"ServiceProvider": "thepound",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": null,
"OfferContexts": [
{
"ALID": "FunWithTennisBalls",
"BenefitID": "dogchannel",
"FormatProfile": "HD",
"LicenseType": "SVOD",
"Marketplace": "GLOBAL",
"Region": "US"
}
],
"PrimaryType": "VIDEO",
"Progress": "Ready",
"RuleType": "REQUIRED",
"SecondaryType": "MEZZ"
}
]
}
Esempio 2: Risorse obbligatorie mancanti
Questo esempio dimostra una risposta dell’API quando mancano le risorse richieste, mostrando come l’API indica lo stato ACTION_NEEDED e fornisce informazioni sugli errori.
{
"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"
}
]
}
