Video Central

L’API Prime Video Avails fa parte della suite Content API e ti consente di gestire la disponibilità dei tuoi titoli su Prime Video attraverso l’integrazione diretta con i tuoi sistemi di gestione dei diritti sui contenuti. Invia, aggiorna, recupera o elimina le finestre di disponibilità con maggiore precisione e controllo rispetto ai caricamenti di file tradizionali.

Perché usare l’API Avails?

L’API semplifica il flusso di lavoro di gestione dei contenuti e ti offre un maggiore controllo sul tuo catalogo Prime Video:

Gestione automatizzata: elimina i caricamenti manuali e riduci gli errori automatizzando gli invii e gli aggiornamenti delle finestre di disponibilità, permettendo al team di concentrarsi sulle attività strategiche
Maggiore efficienza: aggiorna le finestre di disponibilità specifiche senza inviare nuovamente interi set di dati, risparmiando tempo e riducendo l’elaborazione ridondante.
Feedback diretto: convalida i tuoi dati in tempo reale e ricevi messaggi di errore immediati senza accedere a Slate per le correzioni manuali.
Interoperabilità: basata su un’interfaccia REST indipendente dal linguaggio, dal sistema e dalla piattaforma, accessibile da qualsiasi sistema con una connessione Internet.

Operazioni API ed Endpoint

Tutti gli Endpoint sono indipendenti dalla lingua e accessibili tramite HTTP 1.1 da qualsiasi sistema con una connessione Internet. Gli Endpoint Avails non seguono un protocollo specifico e possono essere richiamati in qualsiasi ordine in base alle esigenze del flusso di lavoro.

Informazioni su Extract Models
Un modello di estrazione definisce come strutturare e inviare i dati sulla disponibilità a Prime Video. Consideralo come scegliere tra inviarci le informazioni complete del tuo catalogo o inviare solo le modifiche specifiche che devi apportare.

Modello Full Extract Invia tutte le finestre di disponibilità per un ambito specifico (Titolo + Territorio + Linea di business) in un’unica richiesta. Questo è il modello predefinito per tutti i partner.

Quando utilizzarlo: distribuzione di nuovi contenuti, aggiornamenti completi o quando si desidera garantire che tutti i dati sulla disponibilità di un titolo siano sincronizzati.

Come funziona: invii informazioni complete sulla disponibilità e Prime Video sostituisce tutti i dati esistenti per quell’ambito con i tuoi dati inviati.

Operazione 1: Creazione/aggiornamento di Avails

Cosa fa: Aggiunge nuove finestre di disponibilità o aggiorna quelle esistenti per i tuoi titoli.
Perché ne hai bisogno: In questo modo puoi dire a Prime Video quando e dove i tuoi contenuti devono essere disponibili per i clienti. Sia che stiate lanciando nuovi contenuti o estendendo una licenza esistente, questa operazione garantisce che i dati sulla disponibilità siano aggiornati.

Operazione 2: Recupera Avails

Cosa fa: Recupera le informazioni attuali sulla disponibilità dai sistemi di Prime Video.
Perché ne hai bisogno: Verifica i dati sulla disponibilità presenti in Prime Video, risolvi le discrepanze o estrai i dati per scopi di reporting e riconciliazione.

Operazione 3: Convalida Informazioni sulla disponibilità

Cosa fa: Verifica la presenza di errori nei dati di disponibilità prima di inviarli ai sistemi live di Prime Video.
Perché ne hai bisogno: Rileva errori di formattazione, campi obbligatori mancanti o violazioni delle regole aziendali prima che influiscano sulla disponibilità dei contenuti. Ciò consente di risparmiare tempo eliminando la necessità di inviare, attendere l’elaborazione, quindi correggere gli errori e inviare nuovamente.

Operazione 4: Elimina Informazioni sulla disponibilità

Cosa fa: Rimuove le finestre di disponibilità dai sistemi di Prime Video.
Perché ne hai bisogno: Gestisci scenari una tantum in cui la disponibilità deve essere completamente rimossa anziché scaduta.
Importante: Consigliamo vivamente di far scadere i contenuti modificando la data di fine anziché eliminarli, ad eccezione di casi d’uso occasionali. La scadenza conserva i dati storici e l’audit trail.

Codici di risposta HTTP

Tutti gli Endpoint Avails restituiscono codici HTTP standard che indicano se la richiesta API è riuscita o meno e se gli errori sono temporanei (rieseguibili) o permanenti, consentendo al sistema di gestire automaticamente le risposte senza intervento manuale.

Codice HTTP	Descrizione	Riutilizzabile
200	La chiamata API è andata a buon fine. I chiamanti devono controllare l’oggetto della risposta per ulteriori dettagli.	Non disponibile
400	Richiesta errata, inclusi errori di convalida.	No
401	Non autorizzato.	No
404	Non trovato	No
500	Errore interno.	Sì
503	Errore di dipendenza.	Sì

Nota: Per gli errori rieseguibili (500, 503), implementa la logica dei tentativi con ritardi appropriati tra i tentativi. Gli errori non ripetibili (400, 401, 404) indicano problemi con la richiesta che richiedono una correzione prima di inviarla nuovamente.

Schemi API

Gli schemi descritti in questa documentazione sono progettati per aiutare gli sviluppatori a integrarsi con l’API Avails. Tutti gli schemi di payload sono conformi allo standard MDDF API v2.6. Sebbene tu possa includere qualsiasi attributo dell’API MDDF v2.6 nel tuo payload, Prime Video elabora solo gli attributi supportati: gli attributi non supportati verranno ignorati.

Nota: Per un riferimento completo degli attributi supportati che corrispondono alla nostra specifica EMA Avails, consulta la colonna EMA Avails nella tabella dei tipi di dati principali di seguito. Per informazioni su come vengono gestiti e utilizzate le Informazioni sulla disponibilità in Prime Video, consulta la pagina Content Rights.

Conversione da MDDF XML a JSON

L’API Avails MDDF definisce il suo schema in formato XML, ma supporta payload sia in XML che in JSON. Le API Prime Video Avails utilizzano payload con codifica JSON. Il processo per convertire MDDF XML in JSON è descritto di seguito:

I Namespace sono omessi

Gli elementi annidati diventano proprietà annidate

Più elementi con lo stesso nome diventano elementi di matrice

Gli attributi vanno nelle proprietà e sono preceduti da un trattino basso

Tipi di dati dello schema comuni

Lo schema API Avails supporta i seguenti tipi di dati:

Tipo

Descrizione

Booleano

Tipo booleano. Valori consentiti: true, false

Intero

Numero intero con segno a 32 bit.

Numero intero lungo

Numero intero con segno a 64 bit.

Decimale

Numero a virgola mobile.

Stringa

Una array di caratteri.

Timestamp

Timestamp ISO.

Enum

Una stringa enumerata con un set predefinito di valori consentiti.

Struttura

La struttura funge da aggregatore per altri attributi.

Matrice

Raccolta di articoli di tipo ASME. Designated by [].

Nota: Il numero massimo di elementi consentito nelle richieste batch è limitato a 100.

Schemi di richiesta e risposta

Questa sezione definisce le strutture di dati per tutte le operazioni dell’API Avails. Questi schemi specificano il formato esatto delle richieste inviate a Prime Video e delle risposte che riceverai in ritorno. La comprensione di queste strutture è essenziale per una corretta integrazione delle API.

Schema 1: Creazione/aggiornamento di Informazioni sulla disponibilità

Questi schemi definiscono la struttura per la creazione o l’aggiornamento delle finestre di disponibilità nel sistema Prime Video. Usali quando devi inviare nuovi diritti sui contenuti o modificare quelli esistenti.

PutAvailsAPIRequest type
Questo è l’oggetto di richiesta principale per l’invio di una singola finestra di disponibilità.

Attributo	Tipo	È obbligatorio	Descrizione
informazioni sulla disponibilità	Informazioni sulla disponibilità	Sì	Dati sulla disponibilità: questo è l’attributo di primo livello di qualsiasi richiesta put o validate

PutAvailsAPIResponse type

La risposta che riceverai dopo aver inviato una finestra di disponibilità. Controlla il campo success per confermare il completamento dell’operazione e controlla gli errori se l’invio non è riuscito.

Attributo	Tipo	È obbligatorio	Descrizione
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto

PutAvailsBatchAPIRequest type
Usa questo schema quando devi inviare più finestre di disponibilità in una singola chiamata API. Le operazioni in batch migliorano l’efficienza nella gestione di cataloghi di grandi dimensioni o nella realizzazione di aggiornamenti in blocco.

Attributo	Tipo	È obbligatorio	Descrizione
requestItems	PutAvailsBatchAPIRequestItem[]	Sì	Elenco delle richieste individuali

PutAvailsBatchAPIResponse type
La risposta batch restituisce risultati individuali per ogni elemento della richiesta batch. Ogni elemento di risposta corrisponde a un elemento di richiesta tramite requestItemId.

Attributo	Tipo	È obbligatorio	Descrizione
responseItems	PutAvailsBatchAPIResponseItem[]	Sì	Elenco degli elementi di risposta

PutAvailsBatchAPIRequestItem type
Ogni elemento di una richiesta batch richiede un identificatore e un percorso univoci che specificano il tipo di operazione (Full Extract) e la risorsa di destinazione.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch. Si tratta di una stringa univoca che verrà utilizzata per identificare ogni elemento del batch e che verrà collegata alla nostra risposta al batch.
path	Stringa	Sì	Percorso di una risorsa per questo elemento della richiesta. Per il modello Full Extract il formato è: /avails/{licensor}/full-extract/{ALID}
body	PutAvailsBatchAPIRequestItemBody	Sì	Dati sulla disponibilità

PutAvailsBatchAPIRequestItemBody type
Il corpo di ogni elemento della richiesta batch contiene i dati sulla disponibilità effettiva che stai inviando.

Attributo	Tipo	È obbligatorio	Descrizione
informazioni sulla disponibilità	Informazioni sulla disponibilità	Sì	Dati sulla disponibilità

PutAvailsBatchAPIResponseItem type
Ogni elemento di risposta nel batch indica l’esito positivo o negativo della richiesta corrispondente. Usa requestItemId per abbinare le risposte alle tue richieste originali.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto

Schema 2: Recupera Informazioni sulla disponibilità

Questi schemi definiscono come recuperare le finestre di disponibilità esistenti dal sistema di Prime Video. Usali per richiedere informazioni sui diritti correnti per i tuoi contenuti.

GetAvailsAPIResponse type
La risposta contiene i dati completi sulla disponibilità del contenuto richiesto, inclusi tutti i termini di licenza e i diritti territoriali.

Attributo	Tipo	È obbligatorio	Descrizione
informazioni sulla disponibilità	Informazioni sulla disponibilità	Sì	Dati sulla disponibilità
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto

GetAvailsBatchAPIRequest
Recupera più finestre di disponibilità in una singola chiamata API. Ciò è efficace quando è necessario verificare i diritti per più titoli o transazioni.

Attributo	Tipo	È obbligatorio	Descrizione
requestItems	GetAvailsBatchAPIRequestItem[]	Sì	Elenco delle richieste individuali

GetAvailsBatchAPIResponse
Restituisce i dati di disponibilità per ogni elemento richiesto. Ogni risposta corrisponde a una richiesta tramite requestItemId.

Attributo	Tipo	È obbligatorio	Descrizione
responseItems	GetAvailsBatchAPIResponseItem[]	Sì	Elenco degli elementi di risposta

GetAvailsBatchAPIRequestItem
Ogni elemento della richiesta get specifica il percorso della risorsa che si desidera recuperare.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch
path	Stringa	Sì	Percorso di una risorsa per questo elemento della richiesta. Per il modello Full Extract il formato è: /avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

GetAvailsBatchAPIResponseItem
Ogni elemento della risposta contiene i dati sulla disponibilità se il recupero è andato a buon fine o i dettagli dell’errore in caso di esito negativo.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto
informazioni sulla disponibilità	Informazioni sulla disponibilità	No	Avail object

Schema 3: Convalida di Informazioni sulla disponibilità

Questi schemi consentono di testare i dati sulla disponibilità prima di inviarli al sistema di Prime Video. La convalida rileva gli errori in anticipo senza creare o modificare le finestre di disponibilità effettive.

ValidateAvailsAPIRequest type
La risposta di convalida indica se i tuoi dati superano tutte le regole di convalida. Verifica eventuali errori prima di inviare l’effettiva richiesta di creazione o aggiornamento.

Attributo	Tipo	È obbligatorio	Descrizione
informazioni sulla disponibilità	Informazioni sulla disponibilità	Sì	Dati sulla disponibilità

ValidateAvailsAPIResponse type
La risposta di convalida indica se i tuoi dati superano tutte le regole di convalida. Verifica eventuali errori prima di inviare l’effettiva richiesta di creazione o aggiornamento.

Attributo	Tipo	È obbligatorio	Descrizione
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto

ValidateAvailsBatchAPIRequest type
Convalida più finestre di disponibilità in un’unica chiamata. Ciò è particolarmente utile quando si preparano invii di batch di grandi dimensioni.

Attributo	Tipo	È obbligatorio	Descrizione
requestItems	ValidateAvailsBatchAPIRequestItem[]	Sì	Elenco delle richieste individuali

ValidateAvailsBatchAPIResponse type
Restituisce i risultati della convalida per ogni elemento del batch. Ogni risposta corrisponde a un elemento della richiesta tramite requestItemId.

Attributo	Tipo	È obbligatorio	Descrizione
responseItems	ValidateAvailsBatchAPIResponseItem[]	Sì	Elenco degli elementi di risposta

ValidateAvailsBatchAPIRequestItem type
Ogni elemento della richiesta di convalida include il percorso della risorsa con /validate aggiunto per distinguerlo dalle effettive operazioni di creazione o aggiornamento.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch
path	Stringa	Sì	Percorso verso una risorsa per la richiesta: Full Extract model: /avails/{licensor}/full-extract/{ALID}/validate
body	ValidateAvailsBatchAPIRequestItemBody	Sì	Request body

ValidateAvailsBatchAPIRequestItemBody type
Contiene i dati della finestra di disponibilità da convalidare.

Attributo	Tipo	È obbligatorio	Descrizione
informazioni sulla disponibilità	Informazioni sulla disponibilità	Sì	Dati sulla disponibilità

ValidateAvailsBatchAPIResponseItem type
Ogni elemento della risposta di convalida mostra se i dati corrispondenti hanno superato i controlli di convalida.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto

Schema 4: Elimina Informazioni sulla disponibilità

Questi schemi definiscono come rimuovere le finestre di disponibilità dal sistema di Prime Video.

Importante: Consigliamo vivamente di far scadere i contenuti modificando la data di fine anziché eliminarli, ad eccezione di casi d’uso specifici, ad esempio per soddisfare i requisiti di conformità. I contenuti in scadenza conservano i dati storici e l’audit trail, utili per la creazione di report e riconciliazione.

DeleteAvailsAPIResponse type
Conferma se l’operazione di eliminazione è stata completata correttamente. Controlla il campo success ed esamina eventuali errori.

Attributo	Tipo	È obbligatorio	Descrizione
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto

DeleteAvailsBatchAPIRequest type
Elimina più finestre di disponibilità con una singola chiamata API. Ciò è utile per le rimozioni in blocco o le scadenze dei diritti.

Attributo	Tipo	È obbligatorio	Descrizione
requestItems	DeleteAvailsBatchAPIRequestItem[]	Sì	Elenco delle richieste individuali

DeleteAvailsBatchAPIResponse type
Restituisce i risultati dell’eliminazione per ogni elemento della richiesta batch.

Attributo	Tipo	È obbligatorio	Descrizione
responseItems	DeleteAvailsBatchAPIResponseItem[]	Sì	Elenco degli elementi di risposta.

DeleteAvailsBatchAPIRequestItem type
Ogni elemento della richiesta di eliminazione specifica il percorso della risorsa da rimuovere.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch
path	Stringa	Sì	Percorso di una risorsa per questo elemento della richiesta. Per il modello Full Extract il formato è: /avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH\|FIXED_FEE}&channelIdentity={Channel}

DeleteAvailsBatchAPIResponseItem type
Ogni elemento di risposta conferma se l’eliminazione è riuscita per la richiesta corrispondente.

Attributo	Tipo	È obbligatorio	Descrizione
requestItemId	Stringa	Sì	Identificatore univoco dell’elemento nella richiesta in batch
Operazione riuscita	Booleano	Sì	Stato dell’operazione
errori	Error[]	No	Elenco degli errori in caso di guasto

Tipi di dati principali

Questi tipi di dati fondamentali vengono utilizzati in tutti gli schemi API. Comprendere queste strutture è essenziale per lavorare con qualsiasi operazione avails. Per ulteriori informazioni, consulta la pagina Content Rights.

Error type
Struttura di errore standard restituita quando le operazioni falliscono. Il code identifica il tipo di errore, mentre il message fornisce dettagli leggibili dall’uomo.

Attributo	Tipo	È obbligatorio	Descrizione
code	Stringa	Sì	Una stringa che descrive il tipo di errore. Codici di errore di convalida: APIV{number}, CRMSV{number} Codici di errore del servizio: APIE{number}, CRMSE{number} Esempi: APIV400, CRMSE500
message	Stringa	Sì	Descrizione dell’errore leggibile dall’uomo

Avail type
La struttura dei dati di base che rappresenta una finestra di disponibilità completa. Ciò include tutte le informazioni sui diritti sui contenuti, i termini di licenza, i territori e le condizioni commerciali.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
ALID	Stringa	Sì	Specifica l’identificatore del titolo. Deve corrispondere all’ALID specificato nel contributo dei metadati.	ALID
Disposizione	AvailDisposition	Sì	Specifica la granularità del modello di estrazione.	Non disponibile
Licensor	Editore	Sì	Specifica le informazioni sull’entità che concede la licenza a Prime Video.	Non disponibile
Risorsa	AvailAsset[]	Sì	Informazioni sulla risorsa. Nell’elenco deve essere specificata una sola risorsa.	Non disponibile
Transazione	AvailTrans []	Sì	Informazioni sulla transazione.	Non disponibile
SharedEntitlement	AvailSharedEntitlement []	No	Informazioni sui diritti per altri servizi.	Non disponibile

AvailDisposition type
Definisce se si tratta di un’operazione Full Extract o Full Delete e se si tratta di creazione/aggiornamento o eliminazione di dati.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
EntryType	Enum	Sì	Valori consentiti: FullExtract, FullDelete	Disposizione

Tipo di Publisher
Identifica la tua organizzazione come licenziante dei contenuti. Questo valore viene fornito da Prime Video durante l’onboarding.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
DisplayName	Stringa	Sì	Specifica il nome del partner Prime Video. Questo valore verrà fornito ai partner da Prime Video. Deve essere lo stesso valore utilizzato nei file EMA.	DisplayName

AvailAsset type
Descrive la risorsa di contenuto a cui è stata concessa la licenza. La struttura varia in base al tipo di lavoro (film, episodio, stagione, ecc.).

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
_contentID	Stringa	Sì	Specifica l’ID del contenuto per questa risorsa. In genere è uguale a ALID.	ContentID
WorkType	Enum	Sì	Valori consentiti: Film, cortometraggio, episodio, stagione, contenuto supplementare	WorkType
Metadati	AvailUnitMetadata	Condizionale	Descrive i metadati per film o cortometraggio. Obbligatorio quando WorkType è Movie o Short.	Non disponibile
EpisodeMetadata	AvailEpisodeMetadata	Condizionale	Descrive i metadati per Episodio. Obbligatorio quando WorkType è Episode.	Non disponibile
SeasonMetadata	AvailSeasonMetadata	Condizionale	Descrive i metadati per le stagioni. Obbligatorio quando WorkType è Season.	Non disponibile

AvailSharedEntitlement type
Specifica i diritti per altri ecosistemi digitali come DMA (Digital Movie Alliance).

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
_ecosystem	Enum	Sì	Valori consentiti: DMA Nota: UVVU: Ultravioletto non supportato.	Non disponibile
EcosystemID	Stringa	Sì	Identificatore del titolo specifico dell’ecosistema	DMA_ID

AvailUnitMetadata type
Metadati per contenuti autonomi come film o cortometraggi.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
TitleInternalAlias	String[]	Sì	Nome titolo. Nell’elenco deve essere specificato un solo nome di titolo.	TitleInternalAlias

AvailEpisodeMetadata type
Metadati specifici per gli episodi TV, tra cui il numero dell’episodio e le informazioni sulla stagione/serie principale.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
TitleInternalAlias	String[]	Sì	Nome del titolo per l’episodio. Nell’elenco deve essere specificato un solo nome di titolo.	EpisodeTitleInternalAlias
EpisodeNumber	ContentSequenceInfo	Sì	Numero di questo episodio nell’arco della stagione.	EpisodeNumber
SeasonMetadata	AvailSeasonMetadata	Condizionale	Descrive i metadati per le stagioni. Obbligatorio quando WorkType è Episodio o Stagione.	Non disponibile
SeriesMetadata	AvailSeriesMetadata	Condizionale	Descrive i metadati per le serie. Obbligatorio quando WorkType è Episodio o Stagione.	Non disponibile

AvailSeasonMetadata type
Metadati per le stagioni TV, incluso il numero della stagione e il conteggio degli episodi.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
SeasonContentID	Stringa	Sì	ALID per la stagione.	SeasonContentID
SeasonTitleInternalAlias	String[]	No	Nome del titolo per la stagione.. Nell’elenco deve essere specificato un solo nome di titolo.	SeasonTitleInternalAlias
SeasonNumber	ContentSequenceInfo	Sì	Numero di questa stagione all’interno della serie.	SeasonNumber
NumberOfEpisodes	Intero	Sì	Numero di episodi in questa stagione.	EpisodeCount
SeriesMetadata	AvailSeriesMetadata	Condizionale	Descrive i metadati per le serie. Obbligatorio quando WorkType è Season.	Non disponibile

AvailSeriesMetadata type
Metadati per le serie TV, che forniscono le informazioni sulle serie di primo livello.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
SeriesContentID	Stringa	Sì	ALID per le serie.	SeriesContentID
SeriesTitleInternalAlias	String[]	No	Nome del titolo per le serie. Nell’elenco deve essere specificato un solo nome di titolo.	SeriesTitleInternalAlias
NumberOfSeasons	Intero	No	Numero di stagioni di questa serie.	SeasonCount

AvailTrans type
Definisce una transazione di licenza specifica, inclusi territorio, date, tipo di licenza e condizioni commerciali. Qui si specificano i diritti effettivi concessi.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
_TransactionID	Stringa	No	Identificatore univoco della finestra di disponibilità. Facoltativo quando si utilizza FullExtract.	AvailID
LicenseType	Enum	Sì	Valori consentiti: SVOD, FVOD, EST, POEST, VOD	LicenseType
Territorio	Region[]	Sì	Territorio in cui è consentita la distribuzione. È necessario fornire un solo elemento territorio. Tutte le transazioni all’interno di un singolo oggetto Avail devono avere lo stesso territorio.	Territorio
Inizio	DateTime	Sì	Data e ora di inizio della distribuzione in formato ISO. NOTA: Se non è incluso alcun fuso orario, utilizzeremo il fuso orario più orientale della regione. Tuttavia, puoi includere qualsiasi fuso orario se desideri un orario di rilascio specifico.	Inizio
Fine	DateTime	No	Data e ora di fine della distribuzione in formato ISO. Se non prevista, la distribuzione ha una durata illimitata. NOTA: Se non è incluso alcun fuso orario, utilizzeremo il fuso orario più orientale della regione. Tuttavia, puoi includere qualsiasi fuso orario se desideri un orario di rimozione specifico.	Fine
AssetLanguage	AssetLanguage[]	No	Lingua per la risorsa espressa come codice di lingua ISO con tipo di risorsa. Tipi di asset consentiti: sottotitoli, audio, subdub, sub, dub, ov, mta, qualsiasi	AssetLanguage
AllowedLanguage	AssetLanguage[]	No	Codice della lingua ISO con tipo di risorsa. Tipi di asset consentiti: sottotitoli, audio, sub, dub, subdub, qualsiasi	AllowedLanguages
HoldbackLanguage	AssetLanguage[]	No	Codice della lingua ISO con tipo di risorsa. Tipi di asset consentiti: sottotitoli, audio, sub, dub, subdub, qualsiasi	HoldbackLanguage
LicenseRightsDescription	Stringa	No	Utilizzato per specificare la priorità di pubblicazione.	LicenseRightsDescription
FormatProfile	AvailFormatProfile	Sì	Qualità del video reso disponibile. Valori consentiti: SD, HD, UHD	FormatProfile
ContractID	Stringa	No	Specifica le informazioni contrattuali. Valori consentiti: - CPH - FIXED_FEE - FIXED_FEE:{Deal ID} Quando si inviano le informazioni sulla disponibilità, le opzioni FIXED_FEE sono limitate dal licenziante.	ContractID
Terms	AvailTerms[]	Sì	Specifica l’elenco dei termini aziendali per la finestra di disponibilità.	OtherTerms
OtherInstructions	Stringa	No	Istruzioni di elaborazione aggiuntive per la finestra di disponibilità.	OtherInstructions

Region type
Specifica un territorio geografico utilizzando i codici ISO dei paesi.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
country	Stringa	Sì	Codice paese ISO 3166-1 a 2 lettere	Non disponibile

AssetLanguage type
Definisce la disponibilità della lingua per le risorse audio e sottotitoli.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
value	Stringa	Sì	Lingua per la risorsa espressa come codice di lingua RFC 5646 con tipo di risorsa.	Non disponibile
_asset	Stringa	No	Sono consentiti diversi set di valori, a seconda dell’attributo della lingua del tipo AvailTrans. Valori consentiti per AvailTrans.AssetLanguage: sottotitoli, audio, subdub, sub, dub, ov, mta, qualsiasi. Questo attributo richiede la stessa risorsa inviata per tutte le lingue. Valori consentiti per AvailTrans.AllowedLanguage and AvailTrans. HoldbackLanguage: sottotitoli, audio, sub, dub, subdub, qualsiasi. Quando il valore dell’asset è «subdub», «any» o il valore è assente, passerà a due risorse: «subtitle» e «audio». Le risorse «sub» e «dub» vengono convertite nei loro equivalenti «sottotitoli» e «audio» in MDDF.	Non disponibile

AvailFormatProfile type
Specifica il livello di qualità video per la disponibilità.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
value	Enum	Sì	Qualità del video reso disponibile. Valori consentiti: SD, HD, UHD	Non disponibile

AvailTerms type
Struttura flessibile per specificare le condizioni commerciali. Ogni termine ha un nome e un valore del tipo appropriato (Money, Text, Event, Boolean, Duration o Number).

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
_termName	Stringa	Sì	Identifica il termine. Il valore non fa distinzione tra maiuscole e minuscole. Per un elenco dei valori consentiti, vedi sotto.	Non disponibile
Denaro	Denaro	No	Per maggiori dettagli, vedi sotto.	Non disponibile
Testo	Stringa	No	Per maggiori dettagli, vedi sotto.	Non disponibile
Evento	DateTime	No	Per maggiori dettagli, vedi sotto.	Non disponibile
Booleano	Booleano	No	Per maggiori dettagli, vedi sotto.	Non disponibile
Durata	Stringa	No	Per maggiori dettagli, vedi sotto.	Non disponibile
Numero	Intero	No	Per maggiori dettagli, vedi sotto.	Non disponibile

Tipo di denaro
Rappresenta valori monetari con specifiche di valuta.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
value	Decimale	No	Valore monetario, richiesto per alcuni tipi di prezzo	Non disponibile
_currency	Stringa	Sì	Codice valuta ISO	Non disponibile

ContentSequenceInfo type
Specifica i numeri di sequenza per episodi e stagioni.

Attributo	Tipo	Obbligatorio	Note	Mappatura dei file EMA
Numero	Intero	Sì	Numero di sequenza dei contenuti, ad esempio il numero dell’episodio o il numero della stagione	Non disponibile

Supported Avail terms
La tabella seguente elenca tutti i termini aziendali supportati che possono essere inclusi nell’array AvailTerms. Ogni termine controlla aspetti specifici delle licenze, dei prezzi, della pubblicità e dell’esperienza del cliente.

Nome del termine	Attributo	Obbligatorio	Note	Mappatura dei file EMA
ChannelIdentity	Testo	Sì	Identificatore per un canale o un abbonamento.	GroupIdentity
Livello	Testo	Condizionale	Livello di prezzo. Obbligatorio se il tipo di licenza è POEST.	PriceType
SRP	Denaro	Condizionale	Prezzo al dettaglio suggerito. Obbligatorio se il tipo di licenza è POEST.	SRP
WSP	Denaro	Condizionale	Prezzo all’ingrosso Obbligatorio se il tipo di licenza è POEST.	PriceValue
Categoria	Testo	Condizionale	Categoria di prezzo Obbligatorio se il tipo di licenza è POEST.	PriceValue
AnnounceDate	Evento	No	Data in cui il rivenditore è autorizzato ad annunciare la data di inizio della disponibilità del titolo nel territorio disponibile.	AnnounceDate
SuppressionLiftDate	Evento	Condizionale	Prima data in cui un titolo potrebbe essere annunciato pubblicamente come disponibile in una data futura specifica nel territorio di disponibilità. Obbligatorio se il tipo di licenza è POEST.	SuppressionLiftDate
RentalDuration	Durata	Condizionale	Durata del periodo di noleggio in ore. Obbligatorio se il tipo di licenza è SVOD.	RentalDuration
WatchDuration	Durata	Condizionale	Quanto tempo ha a disposizione l’utente per completare la visualizzazione una volta avviata, in ore. Obbligatorio se il tipo di licenza è SVOD.	WatchDuration
Scarica	Testo	No	La licenza include l’autorizzazione al download. I valori validi sono Sì e No. Quando il tipo di licenza è SVOD, è necessario specificare sia la durata del noleggio che la durata della visione.	Scarica
Esclusivo	Booleano	No	Le attività sono esclusive nell’ambito della Transazione.	Esclusivo
ExclusiveAttributes	Testo	No	Specifica il tipo di esclusività. Considerato solo quando Exclusive è true. Verrà utilizzato un valore predefinito se non viene fornito quando Exclusive è true.	ExclusiveAttributes
BrandingRights	Booleano	No	Indica l’intenzione del partner di mostrare il marchio.	BrandingRights
BrandingRightsAttributes	Testo	No	Specifica il testo del marchio. Considerato solo quando BrandingRights è true. Verrà utilizzato un valore predefinito se non viene fornito quando BrandingRights è true	BrandingRightsAttributes
allowAds	Booleano	No	Determina se gli annunci sono consentiti o vietati. Questo termine può apparire una sola volta.	Non disponibile in EMA
allowedAdPlacement	Testo	Condizionale	Specifica la posizione nel rullo in cui è possibile inserire gli annunci. I valori consentiti sono: PreRoll, MidRoll, PostRoll, Overlay, PauseAds, Squeezebacks. Consentito solo quando allowAds è true. Questo termine può apparire più di una volta. È possibile specificare allowedAdPlacement o prohibitedAdPlacement, ma non entrambi.	Non disponibile in EMA
prohibitedAdPlacement	Testo	Condizionale	Specifica la posizione nel rullo in cui non è possibile inserire annunci. I valori consentiti sono: PreRoll, MidRoll, PostRoll,Overlays, PauseAds, Squeezebacks. Questo termine può apparire più di una volta. Consentito solo quando allowAds è true. È possibile specificare allowedAdPlacement o prohibitedAdPlacement, ma non entrambi.	Non disponibile in EMA
cuepointDeliveryAndUsage	Testo	No	Specifica l’erogazione e gli obblighi d’uso dei cuepoint. Valori consentiti: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated. Consentito solo quando allowAds è true.	Non disponibile in EMA
blindBasisSelling	Testo	No	Valori consentiti: GuaranteedImpressions, NoGuaranteedImpressions Questo attributo deve essere presente solo se allowAds è impostato su true.	Non disponibile in EMA
sponsorizzazioni	Testo	No	Valori consentiti: Consentito, vietato, consentito con restrizioni. Questo attributo deve essere presente solo se allowAds è impostato su true.	Non disponibile in EMA
sponsorshipsRestrictions	Testo	Condizionale	Testo in formato libero Questo attributo deve essere presente solo se le sponsorizzazioni sono impostate su AllowedWithRestrictions.	Non disponibile in EMA
talentAndAmazonAdGuidelines	Testo	No	Valori consentiti: Nessuna restrizione, è richiesta la consultazione Questo attributo deve essere presente solo se allowAds è impostato su true.	Non disponibile in EMA
talentRestrictions	Testo	Condizionale	Testo in formato libero Questo attributo deve essere presente solo se talentAndAmazonAdGuidelines è impostato su ConsultationRequired.	Non disponibile in EMA
adLoadLimit	Testo	No	Numero di minuti pubblicitari all’ora. Il valore deve essere un numero intero valido. Questo attributo deve essere presente solo se allowAds è impostato su true.	Non disponibile in EMA
adKey	Testo	No	Testo in formato libero Identificatore univoco per la mappatura dei contenuti sui server di gestione degli annunci.	Non disponibile in EMA
CompleteYourBundleDiscountPercentage	Numero	No	Sconto percentuale applicato quando i clienti completano un pacchetto acquistando titoli rimanenti che non possiedono già. Ad esempio, uno sconto del 20% significa che i clienti che possiedono la Stagione 1 di un pacchetto di 2 stagioni ricevono il 20% di sconto sulla Stagione 2.	Non disponibile in EMA
ExcludedFromBundleDiscount	Booleano	No	Se impostato su true, esclude questa finestra di disponibilità dall’idoneità allo sconto del pacchetto. Utilizzalo durante i periodi con prezzi premium (ad esempio, nuove uscite) o per i titoli che dovrebbero mantenere il prezzo pieno. Se assente o falso, il titolo è idoneo per gli sconti sui pacchetti.	Non disponibile in EMA

BusinessLine Enumeration
L’enumerazione BusinessLine specifica il modello di business di Prime Video in base al quale i contenuti vengono concessi in licenza e distribuiti. Questo determina in che modo i clienti accedono ai contenuti e come vengono generate le entrate.

Value	Descrizione
TVOD	TVOD significa acquisto o noleggio. Tipi di licenza correlati: EST, VOD, POEST
PRIME_SUBSCRIPTION	Abbonamento Amazon Prime o Amazon Kids+. Tipi di licenza correlati: SVOD
CANALI	Abbonamento a canali di terze parti. Tipi di licenza correlati: SVOD
FVOD	Contenuti gratuiti. Tipi di licenza correlati: FVOD

Nota: Il valore BusinessLine determina quale modello di business si applica alla disponibilità dei contenuti. Quando invii Informazioni sulla disponibilità, assicurati che BusinessLine sia in linea con il tuo accordo contrattuale con Prime Video. Se hai domande sui valori BusinessLine disponibili per la tua partnership, contatta il tuo referente Prime Video.

Payload di esempio Informazioni sulla disponibilità

Gli esempi seguenti dimostrano come strutturare le chiamate API per scenari di integrazione comuni. Vedi Payload Examples per coppie complete di richiesta/risposta con JSON correttamente formattato che puoi utilizzare come modelli per la tua integrazione.

Domande frequenti

Le sezioni seguenti forniscono risposte alle domande più comuni sull’utilizzo dell’API Avails.

Uso generale dell’API

Un payload è costituito dai dati che invii o ricevi dall’API: è il contenuto effettivo della tua richiesta o risposta. Consideralo come il pacchetto di informazioni che stai scambiando con i sistemi Prime Video. Ogni esempio dimostra la struttura JSON corretta e i campi obbligatori per gli scenari più comuni, aiutandoti a formattare le tue richieste API e interpretare le risposte di Prime Video.

La Content API Suite ti consente di automatizzare i flussi di lavoro di gestione dei contenuti e ricevere visibilità in tempo reale sullo stato dei tuoi contenuti su Prime Video. Questa suite include:

API Avils: invia, aggiorna, recupera ed elimina i diritti sui contenuti (avails) in modo programmatico in tutte le linee di business e i territori
API sullo stato dell’offerta: controlla se i tuoi titoli sono disponibili sulla vetrina Prime Video e scopri cosa impedisce la pubblicazione dei titoli
API Asset Status: monitora lo stato di consegna degli asset e ricevi un feedback immediato sulla disponibilità dei contenuti

Quando effettui l’accesso alla Content API Suite, riceverai l’accesso alle API richieste durante il processo di onboarding. Tutti gli API di questa suite utilizzano l’autenticazione basata su certificati MTLS (Mutual Transport Layer Security) con chiavi API.

Rimozione di contenuti e modifiche alla data

Invia Avails