L’API Prime Video Avils 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é utilizzare l’API Informazioni sulla disponibilità?
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 nelle finestre di disponibilità, permettendo al team di concentrarsi su attività strategiche
- Maggiore efficienza: aggiorna finestre di disponibilità specifiche senza inviare nuovamente interi set di dati, risparmiando tempo e riducendo l’elaborazione ridondante.
- Feedback diretto: convalida i dati in tempo reale e ricevi messaggi di errore immediati senza accedere a Slate per le correzioni manuali.
- Interoperabilità: basato su un’interfaccia REST indipendente dal linguaggio, dal sistema e dalla piattaforma, accessibile da qualsiasi sistema dotato di una connessione Internet.
Operazioni ed endpoint delle API
Tutti gli endpoint sono indipendenti dalla lingua e accessibili tramite HTTP 1.1 da qualsiasi sistema dotato di connessione Internet. Gli endpoint Avils non seguono un protocollo specifico e possono essere chiamati in qualsiasi ordine in base alle esigenze del flusso di lavoro.
Informazioni sui modelli Extract
Un modello di estrazione definisce come strutturare e inviare i dati sulla disponibilità a Prime Video. Immagina che sia come scegliere tra inviarci le informazioni complete del tuo catalogo o inviare solo le modifiche specifiche che devi apportare.
Operazione 1 - Creazione/aggiornamento delle informazioni sulla disponibilità
- Cosa fa: aggiunge nuove finestre di disponibilità o aggiorna quelle esistenti per i tuoi titoli.
- Perché ne hai bisogno: in questo modo comunichi a Prime Video quando e dove i tuoi contenuti devono essere disponibili per i clienti. Che tu stia lanciando nuovi contenuti o estendendo una licenza esistente, questa operazione garantisce che i dati sulla disponibilità siano aggiornati.
Operazione 2 - Recupera informazioni sulla disponibilità
- Cosa fa: recupera le informazioni sulla disponibilità attuale dai sistemi Prime Video.
- Perché ne hai bisogno: verifica i dati di disponibilità che Prime Video ha in archivio, risolvi eventuali discrepanze o recupera i dati per scopi di reportistica e riconciliazione.
Operazione 3 - Convalida delle 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: individua gli errori di formattazione, i campi obbligatori mancanti o le violazioni delle regole aziendali prima che influiscano sulla disponibilità dei contenuti. Ciò consente di risparmiare tempo eliminando la necessità di inviare, attendere l’elaborazione, correggere gli errori e inviare nuovamente.
Operazione 4 - Eliminare Informazioni sulla disponibilità
- Cosa fa: rimuove le finestre di disponibilità dai sistemi Prime Video.
- Perché ne hai bisogno: gestisci scenari isolati 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 una tantum. La scadenza mantiene 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 (riutilizzabili) o permanenti, consentendo al sistema di gestire automaticamente le risposte senza intervento manuale.
Codice HTTP |
Description |
Riprovabile |
200 |
La chiamata API ha avuto successo. I chiamanti devono controllare l’oggetto di risposta per ulteriori dettagli. |
N/A |
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 ripetibili (500, 503), implementate la logica di ripetizione con ritardi appropriati tra i tentativi. Gli errori non riprovabili (400, 401, 404) indicano problemi relativi alla 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 Informazioni sulla disponibilità. Tutti gli schemi di payload sono conformi allo standard MDDF API v2.6. Sebbene sia possibile includere qualsiasi attributo dell’API MDDF v2.6 nel payload, Prime Video elabora solo gli attributi supportati, mentre gli attributi non supportati verranno ignorati.
Nota: per un riferimento completo degli attributi supportati che corrispondono alla nostra specifica EMA avils, consulta la colonna EMA avails nella tabella Core Data Types riportata di seguito. Per informazioni su come vengono gestiti e utilizzati gli avail su Prime Video, consulta la pagina dei diritti sui contenuti.
Conversione di MDDF XML in JSON L’API MDDF
Avils definisce lo schema in formato XML, ma supporta payload sia in XML che in JSON. Le API Prime Video Avils utilizzano payload con codifica JSON.Il processo di conversione da MDDF XML a JSON è descritto di seguito: I namespace sono omessi
<alice>bob</alice>
becomes
{ "alice": "bob" }
Gli elementi annidati diventano proprietà annidate
<alice><bob>charlie</bob><david>edgar</david></alice>
becomes
{ "alice": { "bob": "charlie", "david": "edgar" } }
Più elementi con lo stesso nome diventano elementi dell’array
<alice><bob>charlie</bob><bob>david</bob></alice>
becomes
{ "alice": { "bob": [ "charlie", "david" ] } }
Gli attributi entrano nelle proprietà e sono preceduti da un carattere di sottolineatura
<alice charlie="david">bob</alice>
becomes
{ "alice": { "_charlie": "david", "value": "bob" } }
Tipi di dati dello schema comuni Lo schema
dell’API Informazioni sulla disponibilità supporta i seguenti tipi di dati:
| Type |
Description |
| booleano |
Tipo booleano. Valori consentiti: true, false |
| Numero intero |
Intero con segno a 32 bit. |
| LongInteger |
Intero firmato a 64 bit. |
| Decimale |
Numero in virgola mobile. |
| Stringa |
Una serie 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. |
| Array |
Raccolta di articoli di tipo ASME. Designato da []. |
Nota: il numero massimo di articoli consentito nelle richieste batch è limitato a 100.
Schemi di richiesta e risposta
Questa sezione definisce le strutture dati per tutte le operazioni dell’API Informazioni sulla disponibilità. Questi schemi specificano il formato esatto delle richieste che invii a Prime Video e delle risposte che ricevi. La comprensione di queste strutture è essenziale per una corretta integrazione delle API.
Schema 1 - Creazione/aggiornamento delle informazioni sulla disponibilità
Questi schemi definiscono la struttura per la creazione o l’aggiornamento delle finestre di disponibilità nel sistema Prime Video. Utilizzali 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 |
Type |
È obbligatorio |
Description |
avvalersi |
Avvalersi |
Sì |
Dati di 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 di successo per confermare che l’operazione è stata completata e verifica gli errori se l’invio non è riuscito.Attributo |
Type |
È obbligatorio |
Description |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
No |
Elenco degli errori in caso di guasto |
Tipo putAvailsBatchApiRequest Utilizza 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 negli aggiornamenti in blocco.
Attributo |
Type |
È obbligatorio |
Description |
Richiedi articoli |
putAvailsBatchAPIRequestItem [] |
Sì |
Elenco delle richieste individuali |
Tipo putAvailsBatchApiResponse La risposta batch restituisce risultati individuali per ogni articolo della richiesta batch. Ogni elemento di risposta corrisponde a un elemento di richiesta tramite RequestItemID.
Attributo |
Type |
È obbligatorio |
Description |
Elementi di risposta |
putAvailsBatchApi ResponseItem [] |
Sì |
Elenco degli elementi di risposta |
Tipo PutAvailsBatchApiRequestItem 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 |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch. Si tratta di una stringa univoca che utilizzerai per identificare ogni articolo del batch e che verrà collegata alla nostra risposta al batch. |
percorso |
Stringa |
Sì |
Percorso di una risorsa per questo elemento della richiesta. |
corpo |
putAvailsBatchApiRequestItemBody |
Sì |
Dati sulla disponibilità |
Tipo putAvailsBatchApiRequestItemBody Il corpo di ogni elemento della richiesta batch contiene i dati sulla disponibilità effettiva che stai inviando.
Attributo |
Type |
È obbligatorio |
Description |
avvalersi |
Avvalersi |
Sì |
Dati sulla disponibilità |
Tipo PutAvailsBatchApiResponseItem Ogni elemento di risposta nel batch indica l’esito positivo o negativo della richiesta corrispondente. Utilizza RequestItemID per abbinare le risposte alle tue richieste originali.
Attributo |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
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 Prime Video. Usali per interrogare le informazioni sui diritti attuali per i tuoi contenuti.
GetAvailSAPIResponse
type La risposta contiene i dati di disponibilità completi per il contenuto richiesto, inclusi tutti i termini di licenza e i diritti territoriali.
Attributo |
Type |
È obbligatorio |
Description |
avvalersi |
Avvalersi |
Sì |
Dati sulla disponibilità |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
No |
Elenco degli errori in caso di guasto |
GetAvailsBatchApiRequest
Recupera più finestre di disponibilità in una singola chiamata API. Ciò è efficiente quando è necessario verificare i diritti per più titoli o transazioni.
Attributo |
Type |
È obbligatorio |
Description |
Richiedi articoli |
getAvailsBatchAPIRequestItem [] |
Sì |
Elenco delle richieste individuali |
GetAvailsBatchApiResponse
Restituisce i dati di disponibilità per ogni articolo richiesto. Ogni risposta corrisponde a una richiesta tramite RequestItemID.
Attributo |
Type |
È obbligatorio |
Description |
Elementi di risposta |
getAvailsBatchApi ResponseItem [] |
Sì |
Elenco degli elementi di risposta |
GetAvailsBatchApiRequestItem
Ogni elemento della richiesta get specifica il percorso della risorsa che si desidera recuperare.
Attributo |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch |
percorso |
Stringa |
Sì |
Percorso di una risorsa per questo elemento della richiesta. |
getAvailsBatchApiResponseItem
Ogni elemento di risposta contiene i dati sulla disponibilità se il recupero ha avuto esito positivo o i dettagli dell’errore in caso di esito negativo.
Attributo |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
No |
Elenco degli errori in caso di guasto |
avvalersi |
Avvalersi |
No |
Oggetto disponibile |
Schema 3 - Convalida delle Informazioni sulla disponibilità
Questi schemi ti consentono di testare i dati sulla disponibilità prima di inviarli al sistema Prime Video. La convalida rileva tempestivamente gli errori senza creare o modificare finestre di disponibilità effettive.
ValidateAvailSAPIRequest
type La risposta di convalida indica se i dati superano tutte le regole di convalida. Controlla eventuali errori prima di inviare la richiesta di creazione o aggiornamento effettiva.
Attributo |
Type |
È obbligatorio |
Description |
avvalersi |
Avvalersi |
Sì |
Dati sulla disponibilità |
ValidateAvailSAPIResponse
type La risposta di convalida indica se i dati superano tutte le regole di convalida. Controlla eventuali errori prima di inviare la richiesta di creazione o aggiornamento effettiva.
Attributo |
Type |
È obbligatorio |
Description |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
No |
Elenco degli errori in caso di guasto |
ValidateAvailsBatchAPIRequest
type Convalida più finestre di disponibilità in una singola chiamata. Ciò è particolarmente utile quando si preparano invii in batch di grandi dimensioni.
Attributo |
Type |
È obbligatorio |
Description |
Richiedi articoli |
ValidateAvailsBatchAPIRequestItem [] |
Sì |
Elenco delle richieste individuali |
ValidateAvailsBatchApiResponse
type Restituisce i risultati di convalida per ogni articolo del batch. Ogni risposta corrisponde a un elemento della richiesta tramite RequestItemID.
Attributo |
Type |
È obbligatorio |
Description |
Elementi di risposta |
Validate AvailsBatchApi ResponseItem [] |
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 |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch |
percorso |
Stringa |
Sì |
Percorso di una risorsa per la richiesta: |
corpo |
convalida il corpo dell’oggetto della richiesta AvailsBatchApiRequestItem |
Sì |
Corpo della richiesta |
ValidateAvailsBatchApiRequestItemBody type
Contiene i dati della finestra di disponibilità da convalidare.
Attributo |
Type |
È obbligatorio |
Description |
avvalersi |
Avvalersi |
Sì |
Dati sulla disponibilità |
ValidateAvailsBatchApiResponseItem
type Ogni elemento di risposta di convalida mostra se i dati corrispondenti hanno superato i controlli di convalida.
Attributo |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
No |
Elenco degli errori in caso di guasto |
Schema 4 - Eliminare Informazioni sulla disponibilità
Questi schemi definiscono come rimuovere le finestre di disponibilità dal sistema 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 mantengono i dati storici e l’audit trail, il che è utile per la creazione di report e la riconciliazione.
DeleteAvailSAPIResponse
type Conferma se l’operazione di eliminazione è stata completata correttamente. Controlla il campo di successo ed esamina eventuali errori.
Attributo |
Type |
È obbligatorio |
Description |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
No |
Elenco degli errori in caso di guasto |
DeleteAvailsBatchApiRequest
type Elimina più finestre di disponibilità in una singola chiamata API. Ciò è utile per le eliminazioni in blocco o la scadenza dei diritti.
Attributo |
Type |
È obbligatorio |
Description |
Richiedi articoli |
DeleteAvailsBatchAPIRequestItem [] |
Sì |
Elenco delle richieste individuali |
DeleteAvailsBatchApiResponse
type Restituisce i risultati dell’eliminazione per ogni articolo nella richiesta batch.
Attributo |
Type |
È obbligatorio |
Description |
Elementi di risposta |
DeleteAvailsBatchApi ResponseItem [] |
Sì |
Elenco degli elementi di risposta. |
DeleteAvailsBatchApiRequestItem
type Ogni elemento della richiesta di eliminazione specifica il percorso della risorsa da rimuovere.
Attributo |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch |
percorso |
Stringa |
Sì |
Percorso di una risorsa per questo elemento della richiesta. |
DeleteAvailsBatchApiResponseItem
type Ogni elemento di risposta conferma se l’eliminazione è riuscita per la richiesta corrispondente.
Attributo |
Type |
È obbligatorio |
Description |
ID dell’articolo della richiesta |
Stringa |
Sì |
Identificatore univoco dell’articolo nella richiesta del batch |
successo |
booleano |
Sì |
Stato dell’operazione |
errori |
Errore [] |
No |
Elenco degli errori in caso di guasto |
Tipi di dati principali
Questi tipi di dati fondamentali vengono utilizzati in tutti gli schemi API. La comprensione di queste strutture è essenziale per lavorare con qualsiasi operazione. Per ulteriori informazioni, consulta la pagina sui diritti sui contenuti.
Tipo di errore Struttura di errore
Standard restituita quando le operazioni falliscono. Il codice identifica il tipo di errore, mentre il messaggio fornisce dettagli leggibili dall’uomo.
Attributo |
Type |
È obbligatorio |
Description |
codice |
Stringa |
Sì |
Una stringa che descrive il tipo di errore. |
messaggio |
Stringa |
Sì |
Descrizione dell’errore leggibile dall’uomo |
Tipo di utilizzo
La struttura dati principale 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 |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
ALID |
Stringa |
Sì |
Speciifica l’identificatore del titolo. Deve corrispondere all’ALID specificato nel contributo dei metadati. |
ALID |
Disposizione |
Disposizione disponibile |
Sì |
Specifica la granularità del modello di estrazione. |
N/A |
Licenziante |
Editore |
Sì |
Specifica le informazioni sull’entità che concede la licenza a Prime Video. |
N/A |
Risorsa |
Risorsa disponibile [] |
Sì |
Informazioni sull’asset. Nell’elenco deve essere specificata una sola risorsa. |
N/A |
Transazione |
AvailTrans [] |
Sì |
Informazioni sulla transazione. |
N/A |
Diritto condiviso |
availSharedEntitlement [] |
No |
Informazioni sui diritti ad altri servizi. |
N/A |
AvailDisposition type
Definisce se si tratta di un’operazione Full Extract o Full Delete e se si tratta di creare/aggiornare o eliminare dati.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
Tipo di entryType |
Enumera |
Sì |
Valori consentiti: fullExtract, fullDelete |
Disposizione |
Tipo di editore
Identifica l’organizzazione come licenziante dei contenuti. Questo valore viene fornito da Prime Video durante l’onboarding.
Attributo |
Type |
Richiesto |
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 avere lo stesso valore usato nei file EMA. |
DisplayName |
Il tipo AvailAsset descrive la risorsa di contenuto oggetto della licenza. La struttura varia in base al WorkType (Movie, Episode, Season, ecc.).
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
_ContentID |
Stringa |
Sì |
Specifica l’ID del contenuto per questa risorsa. In genere è uguale all’ALID. |
ContentID |
WorkType |
Enumera |
Sì |
Valori consentiti: Film, Corto, Episodio, Stagione, Supplementare |
WorkType |
Metadata |
Metadati AvailUnit |
Condizionale |
Descrive i metadati per Movie o Short. Obbligatorio quando WorkType è Movie o Short. |
N/A |
Metadati degli episodi |
Disponi i metadati degli episodi |
Condizionale |
Descrive i metadati per Episode. Obbligatorio quando WorkType è Episode. |
N/A |
Metadati sulla stagione |
Metadati AvailSeasonSeason |
Condizionale |
Descrive i metadati per la Stagione. Obbligatorio quando WorkType è impostato su Season. |
N/A |
Il
tipo AvailSharedEntitlement specifica i diritti per altri ecosistemi digitali come DMA (Digital Movie Alliance).
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
_ecosistema |
Enum |
Sì |
Valori consentiti: DMA |
N/A |
ID dell’ecosistema |
Stringa |
Sì |
Identificatore del titolo specifico dell’ecosistema |
ID_DMA_ |
AvailUnitMetadata type
Metadata per contenuti autonomi come film o cortometraggi.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
TitleInternalAlias |
Stringa [] |
Sì |
Nome del titolo. Nell’elenco deve essere specificato un solo nome di titolo. |
TitleInternalAlias |
AvailEpisodeMetadata
type Metadata Metadata specifici degli episodi TV, inclusi il numero degli episodi e le informazioni sulla stagione/serie principale.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
TitleInternalAlias |
Stringa [] |
Sì |
Nome del titolo per l’episodio. Nell’elenco deve essere specificato un solo titolo. |
EpisodeTitleInternalAlias |
Numero dell’episodio |
Informazioni sulla sequenza dei contenuti |
Sì |
Numero di questo episodio entro la stagione. |
EpisodeNumber |
Metadati relativi alla stagione |
Metadati AvailSeasonSeason |
Condizionale |
Descrive i metadati per la Stagione. Obbligatorio quando WorkType è Episode o Season. |
N/A |
Metadati della serie |
Metadati della serie Avail |
Condizionale |
Descrive i metadati per la Serie. Obbligatorio quando WorkType è Episode o Season. |
N/A |
Metadata del tipo
AvailSeasonMetadata per le stagioni TV, inclusi il numero della stagione e il conteggio degli episodi.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
SeasonContentID |
Stringa |
Sì |
ALID per la stagione. |
SeasonContentID |
SeasonTitleInternalAlias |
Stringa [] |
No |
Nome del titolo per la Stagione. Nell’elenco deve essere specificato un solo nome del titolo. |
SeasonTitleInternalAlias |
SeasonNumber |
Informazioni sulla sequenza dei contenuti |
Sì |
Number per questa stagione all’interno della serie. |
SeasonNumber |
Numero di episodi |
Numero intero |
Sì |
Numero di episodi in questa stagione. |
EpisodeCount |
Metadati della serie |
Metadati della serie Avail |
Condizionale |
Descrive i metadati per la Serie. Obbligatorio quando WorkType è impostato su Season. |
N/A |
AvailSeriesMetadata type Metadata per le serie TV, che fornisce le informazioni di primo livello sulle serie.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
SeriesContentID |
Stringa |
Sì |
ALID per serie. |
SeriesContentID |
Alias interno del titolo della serie |
Stringa [] |
No |
Nome del titolo per la Serie. Nell’elenco deve essere specificato un solo nome di titolo. |
Alias interno del titolo della serie |
Numero di stagioni |
Numero intero |
No |
Numero di stagioni di questa serie. |
SeasonCount |
Il tipo AvailTrans
definisce una transazione di licenza specifica, inclusi territorio, date, tipo di licenza e condizioni commerciali. Qui è dove si specificano i diritti effettivi concessi.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
_TransactionID |
Stringa |
No |
Identificatore univoco per la finestra di disponibilità. Facoltativo quando si utilizza FullExtract. |
AvailID |
Licensetype |
Enumera |
Sì |
Valori consentiti: SVOD, VOD, EST, POEST, VOD |
LicenseType |
Territorio |
Regione [] |
Sì |
Territorio in cui è consentita la distribuzione. Deve essere fornito un solo articolo territoriale. Tutti i movimenti all’interno di un singolo oggetto Avail devono avere lo stesso territorio. |
Territorio |
Start |
Data/ora |
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. |
Start |
End |
Data/ora |
No |
Data e ora di fine della distribuzione in formato ISO. Se non fornita, 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. |
End |
Asset Language |
AssetLanguage [] |
No |
Lingua per la risorsa espressa come codice di lingua ISO con tipo di risorsa. Tipi di risorse consentiti: subtitle, audio, subdub, sub, dub, ov, mta, any |
AssetLanguage |
AllowedLanguage |
AssetLanguage [] |
No |
Codice in linguaggio ISO con tipo di risorsa. Tipi di risorse consentiti: sottotitoli, audio, sub, dub, subdub, qualsiasi |
Lingue consentite |
Holdback Language |
AssetLanguage [] |
No |
Codice in linguaggio ISO con tipo di risorsa. Tipi di risorse consentiti: sottotitoli, audio, sub, dub, subdub, qualsiasi |
HoldbackLanguage |
Descrizione dei diritti di licenza |
Stringa |
No |
Utilizzato per specificare la priorità di pubblicazione. |
LicenseRightsDescription |
FormatProfile |
AvailFormatProfile |
Sì |
Qualità del video utilizzato. Valori consentiti: SD, HD, UHD |
FormatProfile |
ID del contratto |
Stringa |
No |
Speciifica le informazioni contrattuali. Valori consentiti: |
ContractID |
Termini |
Termini disponibili [] |
Sì |
Specifica l’elenco dei termini commerciali per la finestra di disponibilità. |
OtherTerms |
OtherInstructions |
Stringa |
No |
Istruzioni di elaborazione aggiuntive per la finestra di disponibilità. |
OtherInstructions |
Region type
Indica un territorio geografico utilizzando i codici country ISO.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
country |
corda |
Sì |
Codice country ISO 3166-1 a 2 lettere |
N/A |
AssetLanguage
type Definisce la disponibilità del linguaggio per le risorse audio e sottotitoli.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
valore |
Stringa |
Sì |
Language per l’asset espresso come codice di linguaggio RFC 5646 con tipo di asset. |
N/A |
_risorsa |
Stringa |
No |
Sono consentiti set di valori diversi, a seconda dell’attributo language del tipo AvailTrans. |
N/A |
AvailFormatProfile
type Specifica il livello di qualità video per la disponibilità.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
valore |
Enum |
Sì |
Qualità del video utilizzato. Valori consentiti: SD, HD, UHD |
N/A |
AvailTerms type Struttura
flessibile per specificare i termini commerciali. Ogni termine ha un nome e un valore del tipo appropriato (Money, Text, Event, Boolean, Duration o Number).
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
_nomeTermine |
Stringa |
Sì |
Identifica il termine. Il valore non fa distinzione tra maiuscole e minuscole. Per un elenco dei valori consentiti, vedi sotto. |
N/A |
Soldi |
Soldi |
No |
Per ulteriori dettagli, vedere di seguito. |
N/A |
Testo |
Stringa |
No |
Per ulteriori dettagli, vedere di seguito. |
N/A |
Evento |
Data/ora |
No |
Per ulteriori dettagli, vedere di seguito. |
N/A |
booleano |
Booleano |
No |
Per ulteriori dettagli, vedere di seguito. |
N/A |
Durata |
Stringa |
No |
Per ulteriori dettagli, vedere di seguito. |
N/A |
Number |
Numero intero |
No |
Per ulteriori dettagli, vedere di seguito. |
N/A |
Tipo di moneta
Rappresenta i valori monetari con specificazione della valuta.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
valore |
Decimale |
No |
Valore monetario, richiesto per alcuni tipi di prezzo |
N/A |
_valuta |
Stringa |
Sì |
Codice valuta ISO |
N/A |
Tipo di durata
Rappresenta una durata temporale utilizzando il formato di durata ISO 8601. I valori devono essere specificati in ore intere.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
valore |
Stringa |
sì |
Durata ISO 8601 in ore intere. Formato: PT {N} H dove {N} è un numero intero di ore. Ad esempio, PT48H per 48 ore o PT720H per 30 giorni. |
N/A |
Tipo ContentSequenceInfo
specifica i numeri di sequenza per episodi e stagioni.
Attributo |
Type |
Richiesto |
Note |
Mappatura dei file EMA |
Number |
Numero intero |
Sì |
Numero di sequenza del contenuto, ad esempio il numero dell’episodio o il numero della stagione |
N/A |
Termini Avail supportati (NOTA: scorri verso destra per visualizzare la mappatura EMA completa)
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 |
Richiesto |
Note |
Mappatura dei file EMA |
Identità del canale |
Testo |
Sì |
Identifier per un canale o un abbonamento. |
GroupIdentity |
Livello |
Testo |
Condizionale |
Livello di prezzo. Obbligatorio se il tipo di licenza è POEST. |
PriceType |
SRP |
Soldi |
Condizionale |
Prezzo al dettaglio consigliato. Obbligatorio se il tipo di licenza è POEST. |
SRP |
WSP |
Soldi |
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 |
Annunciate la data |
Evento |
No |
Data in cui il rivenditore è autorizzato ad annunciare la data di inizio della disponibilità del titolo all’interno del 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 validità. 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 |
Tempo a disposizione dell’utente per completare la visualizzazione una volta iniziata, 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 dell’orologio. |
Scarica |
Esclusivo |
Booleano |
No |
Le risorse sono esclusive nell’ambito della transazione. |
Esclusivo |
ExclusiveAttributes |
Testo |
No |
Specifica il tipo di esclusività. Considerato solo quando Exclusive è vero. Se Exclusive è vero, verrà utilizzato un valore predefinito se non viene fornito. |
ExclusiveAttributes |
BrandingRights |
Booleano |
No |
Indica l’intenzione del partner di mostrare il marchio. |
BrandingRights |
Attributi BrandingRights |
Testo |
No |
Speciifica il testo del marchio. Considerato solo quando BrandingRights è vero. Se BrandingRights è true, verrà utilizzato un valore predefinito se non viene fornito. |
Attributi BrandingRights |
Consenti annunci |
Booleano |
No |
Determina se gli annunci sono consentiti o vietati. Questo termine può apparire solo una volta. |
Non disponibile in EMA |
Posizionamento degli annunci consentito |
Testo |
Condizionale |
Specifica la posizione nel rullino in cui è possibile inserire gli annunci. I valori consentiti sono: PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks. |
Non disponibile in EMA |
Posizionamento di annunci vietato |
Testo |
Condizionale |
Specificate la posizione nel rullino in cui non è possibile inserire gli annunci. I valori consentiti sono: PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks. |
Non disponibile in EMA |
Consegna e utilizzo di CuePoint |
Testo |
No |
Speciifica gli obblighi di consegna e utilizzo del cuepoint. Valori consentiti: PartnerWillDeliverand PrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated. |
Non disponibile in EMA |
Vendita su base cieca |
Testo |
No |
Valori consentiti: GuaranteedImpressions, noGuaranteedImpressions |
Non disponibile in EMA |
sponsorizzazioni |
Testo |
No |
Valori consentiti: Consentito, Proibito, consentito con restrizioni. |
Non disponibile in EMA |
Restrizioni alle sponsorizzazioni |
Testo |
Condizionale |
Testo in formato libero |
Non disponibile in EMA |
| Linee guida Talent e Amazon Ads (** non dovrebbero avere interruzioni di riga) |
Testo |
No |
Valori consentiti: noRestrictions, consultationRequired |
Non disponibile in EMA |
Restrizioni relative ai talenti |
Testo |
Condizionale |
Testo in formato libero |
Non disponibile in EMA |
Limite di caricamento dell’annuncio |
Testo |
No |
Numero di minuti pubblicitari all’ora. Value deve essere un numero intero valido. |
Non disponibile in EMA |
AdKey |
Testo |
No |
Testo in formato libero Identificatore |
Non disponibile in EMA |
CompleteYourBundle (** non dovrebbe avere interruzioni di riga) |
Number |
No |
Lo sconto percentuale viene 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 uno sconto del 20% sulla Stagione 2. |
Non disponibile in EMA |
ExcludedFromBundleDiscount (** non dovrebbe avere interruzioni di riga) |
booleano |
No |
Se impostato su true, esclude questa finestra di disponibilità dall’idoneità allo sconto del pacchetto. Utilizzalo durante i periodi di prezzo premium (ad esempio, nuove uscite) o per i titoli che dovrebbero mantenere il prezzo pieno. Se assente o falso, il titolo è idoneo a sconti in bundle. |
Non disponibile in EMA |
Enumerazione BusinessLine L’enumerazione BusinessLine specifica
il modello di business di Prime Video in base al quale i contenuti vengono concessi in licenza e distribuiti. Ciò determina il modo in cui i clienti accedono ai contenuti e il modo in cui vengono generate le entrate.
Value |
Description |
TVOD |
TVOD significa acquisto o noleggio. Tipi di licenza correlati: EST, VOD, POEST |
ABBONAMENTO PRIME_ |
Abbonamento Amazon Prime o Amazon Kids+. Tipi di licenza correlati: SVOD |
CANALI |
Abbonamento a canali di terze parti. Tipi di licenza correlati: SVOD |
VOD |
Contenuti gratuiti. Tipi di licenza correlati: FVOD |
Nota: il valore BusinessLine determina quale modello di business si applica alla disponibilità dei contenuti. Quando invii avails, 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 rappresentante Prime Video.
Informazioni sulla disponibilità del payload di esempio
Gli esempi seguenti mostrano come strutturare le chiamate API per scenari di integrazione comuni. Consulta Payload Examples per coppie complete di richiesta/risposta con JSON formattato correttamente che puoi utilizzare come modelli per la tua integrazione.