Die Prime Video Avails-API ist Teil der Content-API-Suite und ermöglicht es dir, die Verfügbarkeit deiner Titel auf Prime Video durch direkte Integration mit deinen Content-Rights-Management-Systemen zu verwalten. Übermittle oder aktualisiere Verfügbarkeitsfenster und rufe sie ab oder lösche sie mit größerer Genauigkeit und Kontrolle als bei herkömmlichen Datei-Uploads.
Warum solltest du die Avails-API verwenden?
Die API optimiert deinen Content-Management-Workflow und gibt dir mehr Kontrolle über deinen Prime-Video-Katalog:
- Automatisiertes Management – Vermeide manuelle Uploads und reduziere Fehler, indem du die Übermittlung und Aktualisierung des Verfügbarkeitsfensters automatisierst, sodass sich dein Team auf strategische Aufgaben konzentrieren kann
- Höhere Effizienz – Aktualisiere bestimmte Verfügbarkeitsfenster, ohne ganze Datensätze erneut einreichen zu müssen. Das spart Zeit und reduziert redundante Verarbeitungsvorgänge.
- Direktes Feedback – Validiere deine Daten in Echtzeit und erhalte sofortige Fehlermeldungen, ohne dich für manuelle Korrekturen bei Slate anmelden zu müssen.
- Interoperabilität – Basiert auf einer REST-Schnittstelle, die sprach-, system- und plattformunabhängig ist und von jedem System mit Internetverbindung aus zugänglich ist.
API-Betrieb und -Endpunkte
Alle Endpunkte sind sprachunabhängig und über HTTP 1.1 von jedem System mit Internetverbindung aus zugänglich. Die Avails-Endpunkte folgen keinem bestimmten Protokoll und können je nach deinen Workflow-Anforderungen in beliebiger Reihenfolge aufgerufen werden.
Über Extract Models
Ein Extract Model definiert, wie du Verfügbarkeitsdaten strukturierst und an Prime Video sendest. Stelle dir vor, du hast die Wahl, uns deine vollständigen Kataloginformationen zu senden oder nur die spezifischen Änderungen zu senden, die du vornehmen musst.
Vorgang 1 – Avails erstellen/aktualisieren
- Was es macht: Fügt neue Verfügbarkeitsfenster hinzu oder aktualisiert bestehende für deine Titel.
- Warum du es brauchst: So teilst du Prime Video mit, wann und wo deine Inhalte für die Kundschaft verfügbar sein sollen. Ganz gleich, ob du neue Inhalte veröffentlichst oder eine bestehende Lizenz verlängerst, dieser Vorgang stellt sicher, dass deine Verfügbarkeitsdaten aktuell sind.
Vorgang 3 – Avails validieren
- Was es macht: Überprüft deine Verfügbarkeitsdaten auf Fehler, bevor du sie an die Live-Systeme von Prime Video sendest.
- Warum du es brauchst: Ermittle Formatierungsfehler, fehlende Pflichtfelder oder Verstöße gegen Geschäftsregeln, bevor sich diese auf die Verfügbarkeit deiner Inhalte auswirken. Dies spart Zeit, da du nicht mehr abschicken, auf die Verarbeitung warten, dann Fehler beheben und erneut einreichen musst.
Vorgang 4 – Avails löschen
- Was es macht: Entfernt Verfügbarkeitsfenster aus den Systemen von Prime Video.
- Warum du es brauchst: Bearbeite einmalige Szenarien, in denen die Verfügbarkeit vollständig entfernt werden muss und nicht abgelaufen ist.
- Wichtig: Wir empfehlen dringend, Inhalte ablaufen zu lassen, indem du das Enddatum anpasst, anstatt sie zu löschen, außer in einmaligen Anwendungsfällen. Beim Ablaufen werden deine historischen Daten und deine Audit-Spur gespeichert.
HTTP-Antwortcodes
Alle Avails-Endpunkte geben Standard-HTTP-Codes zurück, die dir mitteilen, ob deine API-Anfrage erfolgreich war oder fehlgeschlagen ist und ob Fehler temporär (wiederholbar) oder dauerhaft sind, sodass dein System Antworten ohne manuelles Eingreifen automatisch verarbeiten kann.
HTTP-Kode |
Beschreibung |
Wiederholbar |
200 |
Der API-Aufruf war erfolgreich. Anrufer sollten das Antwortobjekt auf weitere Details überprüfen. |
N/V |
400 |
Schlechte Anfrage einschließlich Validierungsfehlern. |
Nein |
401 |
Nicht autorisiert. |
Nein |
404 |
Nicht gefunden. |
Nein |
500 |
Interner Fehler. |
Ja |
503 |
Abhängigkeitsfehler. |
Ja |
Hinweis: Implementiere bei wiederholbaren Fehlern (500, 503) eine Wiederholungslogik mit angemessenen Verzögerungen zwischen den Versuchen. Fehler, die nicht wiederholbar sind (400, 401, 404), weisen auf Probleme mit deiner Anfrage hin, die vor dem erneuten Absenden korrigiert werden müssen.
API-Schemas
Die in dieser Dokumentation beschriebenen Schemas sollen Entwickelnden bei der Integration in die Avails-API helfen. Alle Payload-Schemas entsprechen dem MDDF-API-v2.6-Standard. Du kannst zwar alle MDDF-API-v2.6-Attribute in deine Payload aufnehmen, Prime Video verarbeitet jedoch nur unterstützte Attribute – nicht unterstützte Attribute werden ignoriert.
Hinweis: Eine vollständige Referenz der unterstützten Attribute, die unserer EMA-Avails-Spezifikation entsprechen, findest du in der Spalte EMA-Avails in der Tabelle mit den wichtigsten Datentypen unten. Informationen darüber, wie Avails in Prime Video verwaltet und verwendet werden, findest du auf der Seite mit Inhaltsrechten.
MDDF XML in JSON konvertieren
Die MDDF-Avails-API definiert ihr Schema im XML-Format, unterstützt aber Payloads sowohl in XML als auch in JSON. Die APIs von Prime Video Avails verwenden JSON-kodierte Nutzlasten. Das Verfahren zur Konvertierung von MDDF XML in JSON wird im Folgenden beschrieben:
Namespaces werden weggelassen
<alice>bob</alice>
becomes
{ "alice": "bob" }
Verschachtelte Elemente werden zu verschachtelten Eigenschaften
<alice><bob>charlie</bob><david>edgar</david></alice>
becomes
{ "alice": { "bob": "charlie", "david": "edgar" } }
Mehrere Elemente mit demselben Namen werden zu Array-Elementen
<alice><bob>charlie</bob><bob>david</bob></alice>
becomes
{ "alice": { "bob": [ "charlie", "david" ] } }
Attribute stehen in Eigenschaften und werden mit einem Unterstrich vorangestellt
<alice charlie="david">bob</alice>
becomes
{ "alice": { "_charlie": "david", "value": "bob" } }
Allgemeine Schemadatentypen
Das Avails-API-Schema unterstützt die folgenden Datentypen:
| Typ |
Beschreibung |
| Boolesch |
Boolescher Typ. Zulässige Werte: true, false |
| Ganzzahl |
32-Bit-Ganzzahl mit Vorzeichen. |
| Lange Ganzzahl |
64-Bit-Ganzzahl mit Vorzeichen. |
| Dezimalwert |
Fließkommazahl. |
| Zeichenfolge |
Eine Reihe von Zeichen. |
| Zeitstempel |
ISO-Zeitstempel. |
| Aufzählung |
Eine Aufzählungszeichenfolge mit einer vordefinierten Menge zulässiger Werte. |
| Struktur |
Die Struktur dient als Aggregator für andere Attribute. |
| Reihe |
Sammlung von Artikeln des ASME-Typs. Festgelegt von []. |
Hinweis: Die maximale Anzahl von Elementen, die in Batch-Anfragen zulässig sind, ist auf 100 begrenzt.
Anfrage- und Antwortschemas
In diesem Abschnitt werden die Datenstrukturen für alle Avails-API-Operationen definiert. Diese Schemas spezifizieren das genaue Format für Anfragen, die du an Prime Video sendest, und für Antworten, die du zurückerhältst. Das Verständnis dieser Strukturen ist für eine erfolgreiche API-Integration unerlässlich.
Schema 1 – Avails erstellen/aktualisieren
Diese Schemas definieren die Struktur für die Erstellung oder Aktualisierung von Verfügbarkeitsfenstern im Prime-Video-System. Verwende diese, wenn du neue Inhaltsrechte einreichen oder bestehende ändern musst.
PutAvailsAPIRequest-Typ
Dies ist das primäre Anfrageobjekt für das Senden eines einzelnen Verfügbarkeitsfensters.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
avail |
Avail |
Ja |
Verfügbarkeitsdaten – Dies ist das oberste Level-Attribut jeder Put- oder Validate-Anfrage |
PutAvailsAPIResponse-Typ
Die Antwort, die du nach dem Absenden eines Verfügbarkeitsfensters erhältst. Überprüfe das Erfolgsfeld, um zu bestätigen, dass der Vorgang abgeschlossen wurde, und überprüfe die Fehler, falls die Übermittlung fehlgeschlagen ist.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
PutAvailsBatchAPIRequest-Typ
Verwende dieses Schema, wenn du mehrere Verfügbarkeitsfenster in einem einzigen API-Aufruf einreichen musst. Batch-Vorgänge verbessern die Effizienz bei der Verwaltung großer Kataloge oder bei Massenaktualisierungen.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItems |
PutAvailsBatchAPIRequestItem[] |
Ja |
Liste der einzelnen Anfragen |
PutAvailsBatchAPIResponse-Typ
Die Batch-Antwort gibt individuelle Ergebnisse für jeden Artikel in deiner Batch-Anfrage zurück. Jedes Antwortelement entspricht einem Anforderungselement über die requestItemId.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
responseItems |
PutAvailsBatchAPIResponseItem[] |
Ja |
Liste der Antwortelemente |
putAvailsBatchAPIRequestItem-Typ
Jedes Element in einer Batch-Anfrage benötigt eine eindeutige Kennung und einen eindeutigen Pfad, die den Vorgangstyp (vollständiger Extrakt) und die Zielressource angeben.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage. Dies ist eine eindeutige Zeichenfolge, mit der du jeden Artikel in der Charge identifizierst und die mit der Batch-Antwort von uns verknüpft wird. |
Pfad |
Zeichenfolge |
Ja |
Pfad zu einer Ressource für dieses Anforderungselement. |
Hauptteil |
PutAvailsBatchAPIRequestItemBody |
Ja |
Daten zur Verfügbarkeit |
putAvailsBatchAPIRequestItemBody-Typ
Der Hauptteil jedes Batch-Anforderungselements enthält die tatsächlichen Verfügbarkeitsdaten, die du einreichst.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
avail |
Avail |
Ja |
Daten zur Verfügbarkeit |
putAvailsBatchAPIResponseItem-Typ
Jedes Antwortelement im Batch gibt an, ob die entsprechende Anfrage erfolgreich war oder nicht. Verwende die requestItemId, um Antworten deiner ursprünglichen Anfragen zuzuordnen.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
Schema 2 – Avails abrufen
Diese Schemas definieren, wie bestehende Verfügbarkeitsfenster aus dem Prime-Video-System abgerufen werden. Verwende diese, um aktuelle Rechteinformationen für deine Inhalte abzufragen.
GetAvailsAPIResponse-Typ
Die Antwort enthält die vollständigen Verfügbarkeitsdaten für den angeforderten Inhalt, einschließlich aller Lizenzbedingungen und territorialen Rechte.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
avail |
Avail |
Ja |
Daten zur Verfügbarkeit |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
GetAvailsBatchAPIRequest
Rufe mehrere Verfügbarkeitsfenster in einem einzigen API-Aufruf ab. Dies ist effizient, wenn du die Rechte für mehrere Titel oder Transaktionen überprüfen musst.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItems |
GetAvailsBatchAPIRequestItem[] |
Ja |
Liste der einzelnen Anfragen |
GetAvailsBatchAPIResponse
Gibt die Verfügbarkeitsdaten für jeden angeforderten Artikel zurück. Jede Antwort entspricht einer Anfrage über die requestItemId.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
responseItems |
GetAvailsBatchAPIResponseItem[] |
Ja |
Liste der Antwortelemente |
GetAvailsBatchAPIRequestItem
Jedes Abrufanforderungselement gibt den Pfad zu der Ressource an, die du abrufen möchtest.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage |
Pfad |
Zeichenfolge |
Ja |
Pfad zu einer Ressource für dieses Anforderungselement. |
GetAvailsBatchAPIResponseItem
Jedes Antwortelement enthält die Verfügbarkeitsdaten, wenn der Abruf erfolgreich war, oder Fehlerdetails, falls er fehlgeschlagen ist.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
avail |
Avail |
Nein |
Avail verfügbar |
Schema 3 – Avails validieren
Mit diesen Schemas kannst du deine Verfügbarkeitsdaten testen, bevor du sie an das Prime-Video-System sendest. Bei der Validierung werden Fehler frühzeitig erkannt, ohne dass tatsächliche Verfügbarkeitsfenster erstellt oder geändert werden müssen.
ValidateAvailsAPIRequest-Typ
Die Validierungsantwort gibt an, ob deine Daten alle Validierungsregeln bestehen. Überprüfe alle Fehler, bevor du die eigentliche Erstellungs- oder Aktualisierungsanforderung absendest.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
avail |
Avail |
Ja |
Daten zur Verfügbarkeit |
ValidateAvailsAPIResponse-Typ
Die Validierungsantwort gibt an, ob deine Daten alle Validierungsregeln bestehen. Überprüfe alle Fehler, bevor du die eigentliche Erstellungs- oder Aktualisierungsanforderung absendest.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
ValidateAvailsBatchAPIRequest-Typ
Validiere mehrere Verfügbarkeitsfenster in einem einzigen Aufruf. Dies ist besonders nützlich, wenn du große Batch-Einreichungen vorbereitest.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItems |
ValidateAvailsBatchAPIRequestItem[] |
Ja |
Liste der einzelnen Anfragen |
ValidateAvailsBatchAPIResponse-Typ
Gibt Validierungsergebnisse für jeden Artikel in deinem Batch zurück. Jede Antwort entspricht einem Anforderungselement über die requestItemID.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
responseItems |
ValidateAvailsBatchAPIResponseItem[] |
Ja |
Liste der Antwortelemente |
ValidateAvailsBatchAPIRequestItem type
Jedes Validierungsanforderungselement enthält den Ressourcenpfad, an den /validate angehängt ist, um ihn von tatsächlichen Erstellungs- oder Aktualisierungsvorgängen zu unterscheiden.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage |
Pfad |
Zeichenfolge |
Ja |
Pfad zu einer Ressource für die Anfrage: |
Hauptteil |
ValidateAvailsBatchAPIRequestItemBody |
Ja |
Hauptteil anfordern |
ValidateAvailsBatchAPIRequestItemBody-Typ
Enthält die zu validierenden Daten des Verfügbarkeitsfensters.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
avail |
Avail |
Ja |
Daten zur Verfügbarkeit |
ValidateAvailsBatchAPIResponseItem-Typ
Jedes Validierungsantwortelement zeigt an, ob die entsprechenden Daten die Validierungsprüfungen bestanden haben.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
Schema 4 – Avails löschen
Diese Schemas definieren, wie Verfügbarkeitsfenster aus dem Prime-Video-System entfernt werden.
Wichtig: Wir empfehlen dringend, Inhalte ablaufen zu lassen, indem du das Enddatum anpasst, anstatt sie zu löschen, außer in bestimmten Anwendungsfällen wie der Erfüllung von Compliance-Anforderungen. Bei ablaufenden Inhalten bleiben deine historischen Daten und dein Audit-Trail erhalten, was für die Berichterstattung und den Abgleich von Nutzen ist.
DeleteAvailsAPIResponse-Typ
Bestätigt, ob der Löschvorgang erfolgreich abgeschlossen wurde. Überprüfe das Erfolgsfeld und überprüfe alle Fehler.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
DeleteAvailsBatchAPIRequest-Typ
Lösche mehrere Verfügbarkeitsfenster in einem einzigen API-Aufruf. Dies ist nützlich bei Massen-Takedowns oder beim Ablauf von Rechten.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItems |
DeleteAvailsBatchAPIRequestItem[] |
Ja |
Liste der einzelnen Anfragen |
DeleteAvailsBatchAPIResponse-Typ
Gibt Löschergebnisse für jedes Element in deiner Batch-Anfrage zurück.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
responseItems |
DeleteAvailsBatchAPIResponseItem[] |
Ja |
Liste der Antwortelemente. |
DeleteAvailsBatchAPIRequestItem-Typ
Jedes Löschanforderungselement gibt den Pfad zu der Ressource an, die entfernt werden soll.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage |
Pfad |
Zeichenfolge |
Ja |
Pfad zu einer Ressource für dieses Anforderungselement. |
DeleteAvailsBatchAPIResponseItem-Typ
Jedes Antwortelement bestätigt, ob das Löschen für die entsprechende Anfrage erfolgreich war.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
requestItemId |
Zeichenfolge |
Ja |
Eindeutige Kennung des Artikels in der Batch-Anfrage |
Erfolgreich |
Boolesch |
Ja |
Status des Vorgangs |
Fehler |
Fehler[] |
Nein |
Liste der Fehler im Fehlerfall |
Kerndatentypen
Diese grundlegenden Datentypen werden in allen API-Schemas verwendet. Das Verständnis dieser Strukturen ist für die Arbeit mit jeder verfügbaren Operation unerlässlich. Weitere Informationen findest du auf der Seite Inhaltsrechte.
Fehlertyp
Die Standardfehlerstruktur wird zurückgegeben, wenn Vorgänge fehlschlagen. Der Code identifiziert den Fehlertyp, während die Nachricht für Menschen lesbare Details enthält.
Attribut |
Typ |
Ist verpflichtend |
Beschreibung |
Code |
Zeichenfolge |
Ja |
Eine Zeichenfolge, die den Fehlertyp beschreibt. |
Nachricht |
Zeichenfolge |
Ja |
Für Menschen lesbare Beschreibung des Fehlers |
Avail-Typ
Die Kerndatenstruktur, die ein vollständiges Verfügbarkeitsfenster darstellt. Dies beinhaltet alle Informationen zu Inhaltsrechten, Lizenzbedingungen, Gebieten und Geschäftsbedingungen.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
ALID |
Zeichenfolge |
Ja |
Gibt die Titelkennung an. Muss mit der im Metadatenbeitrag angegebenen ALID übereinstimmen. |
ALID |
Disposition |
AvailDisposition |
Ja |
Legt die Granularität des Extract Models fest. |
N/V |
Lizenzgeber |
Herausgeber |
Ja |
Gibt Informationen zur Entität an, die Prime Video eine Lizenz gewährt. |
N/V |
Asset |
AvailAsset[] |
Ja |
Informationen zum Asset. In der Liste sollte nur ein einziges Asset angegeben werden. |
N/V |
Transaktion |
AvailTrans[] |
Ja |
Informationen zur Transaktion. |
N/V |
SharedEntitlement |
AvailSharedEntitlement[] |
Nein |
Informationen zu Ansprüchen auf andere Dienstleistungen. |
N/V |
AvailDisposition-Typ
Definiert, ob es sich um einen Full-Extract- oder einen Full-Delete-Vorgang handelt und ob Daten erstellt/aktualisiert oder gelöscht werden.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
EntryType |
Aufzählung |
Ja |
Zulässige Werte: FullExtract, FullDelete |
Disposition |
Herausgebertyp
Identifiziert deine Organisation als Inhaltslizenzgeber. Dieser Wert wird von Prime Video beim Onboarding bereitgestellt.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
DisplayName |
Zeichenfolge |
Ja |
Gibt den Namen des Prime-Video-Partners an. Dieser Wert wird Partnern von Prime Video zur Verfügung gestellt. Muss derselbe Wert sein, der in EMA-Dateien verwendet wird. |
DisplayName |
AvailAsset-Typ
Beschreibt das Inhalts-Asset, das lizenziert wird. Die Struktur variiert je nach Arbeitstyp (Film, Folge, Staffel usw.).
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
_contentID |
Zeichenfolge |
Ja |
Gibt die Inhalts-ID für dieses Asset an. In der Regel dasselbe wie ALID. |
ContentID |
WorkType |
Aufzählung |
Ja |
Zulässige Werte: Film, Short, Folge, Staffel, Ergänzung |
WorkType |
Metadaten |
AvailUnitMetadata |
Abhängig |
Beschreibt Metadaten für Film oder Short. Erforderlich, wenn WorkType auf Movie oder Short gesetzt ist. |
N/V |
EpisodeMetadata |
AvailEpisodeMetadata |
Abhängig |
Beschreibt Metadaten für die Folge. Erforderlich, wenn WorkType auf Folge gesetzt ist. |
N/V |
SeasonMetadata |
AvailSeasonMetadata |
Abhängig |
Beschreibt Metadaten für die Staffel. Erforderlich, wenn WorkType auf Staffel gesetzt ist. |
N/V |
AvailSharedTitlement-Typ
Spezifiziert Rechte für andere digitale Ökosysteme wie DMA (Digital Movie Alliance).
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
_ecosystem |
Aufzählung |
Ja |
Zulässige Werte: DMA |
N/V |
EcosystemID |
Zeichenfolge |
Ja |
Ökosystemspezifische Titelkennung |
DMA_ID |
AvailUnitMetadaten-Typ
Metadaten für eigenständige Inhalte wie Filme oder Shorts.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
TitleInternalAlias |
String[] |
Ja |
Titelname. In der Liste sollte nur ein einziger Titelname angegeben werden. |
TitleInternalAlias |
AvailEpisodeMetadaten-Typ
Spezifische Metadaten für TV-Folgen, einschließlich Folgennummer und Informationen zur übergeordneten Staffel/Serie.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
TitleInternalAlias |
String[] |
Ja |
Titelname für Folge. In der Liste sollte nur ein einziger Titelname angegeben werden. |
EpisodeTitleInternalAlias |
EpisodeNumber |
ContentSequenceInfo |
Ja |
Nummer dieser Folge innerhalb der Staffel. |
EpisodeNumber |
SeasonMetadata |
AvailSeasonMetadata |
Abhängig |
Beschreibt Metadaten für die Staffel. Erforderlich, wenn WorkType auf Folge oder Staffel gesetzt ist. |
N/V |
SeriesMetadata |
AvailSeriesMetadata |
Abhängig |
Beschreibt Metadaten für die Serie. Erforderlich, wenn WorkType auf Folge oder Staffel gesetzt ist. |
N/V |
AvailSeasonMetadaten-Typ
Metadaten für Fernsehstaffeln, einschließlich Staffelnummer und Anzahl der Folgen.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
SeasonContentID |
Zeichenfolge |
Ja |
ALID für Staffel. |
SeasonContentID |
SeasonTitleInternalAlias |
String[] |
Nein |
Titelname für die Staffel. In der Liste sollte nur ein einziger Titelname angegeben werden. |
SeasonTitleInternalAlias |
SeasonNumber |
ContentSequenceInfo |
Ja |
Nummer für diese Staffel innerhalb der Serie. |
SeasonNumber |
NumberOfEpisodes |
Ganzzahl |
Ja |
Anzahl der Folgen in dieser Staffel. |
EpisodeCount |
SeriesMetadata |
AvailSeriesMetadata |
Abhängig |
Beschreibt Metadaten für die Serie. Erforderlich, wenn WorkType auf Staffel gesetzt ist. |
N/V |
AvailSeriesMetadaten-Typ
Metadaten für Fernsehserien, die die Serieninformationen auf oberster Ebene bereitstellen.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
SeriesContentID |
Zeichenfolge |
Ja |
ALID für Serien. |
SeriesContentID |
SeriesTitleInternalAlias |
String[] |
Nein |
Titelname für die Serie. In der Liste sollte nur ein einziger Titelname angegeben werden. |
SeriesTitleInternalAlias |
NumberOfSeasons |
Ganzzahl |
Nein |
Anzahl der Staffeln in dieser Serie. |
SeasonCount |
AvailTrans-Typ
Definiert eine bestimmte Lizenztransaktion, einschließlich Gebiet, Daten, Lizenztyp und Geschäftsbedingungen. Hier gibst du an, welche Rechte tatsächlich gewährt werden.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
_TransactionID |
Zeichenfolge |
Nein |
Eindeutige Kennung für das Verfügbarkeitsfenster. Optional bei Verwendung von FullExtract. |
AvailID |
LicenseType |
Aufzählung |
Ja |
Zulässige Werte: SVOD, FVOD, EST, POEST, VOD |
LicenseType |
Gebiet |
Region[] |
Ja |
Gebiet, in dem die Verbreitung erlaubt ist. Es darf nur ein einziges Gebietselement bereitgestellt werden. Alle Transaktionen innerhalb eines einzelnen Avail-Objekts müssen dasselbe Gebiet haben. |
Gebiet |
Start |
DateTime |
Ja |
Startdatum und Uhrzeit für die Verbreitung im ISO-Format. HINWEIS: Wenn keine Zeitzone angegeben ist, verwenden wir die östlichste Zeitzone in der Region. Du kannst jedoch eine beliebige Zeitzone angeben, wenn du eine bestimmte Veröffentlichungszeit wünscht. |
Start |
Ende |
DateTime |
Nein |
Enddatum und Uhrzeit für die Verbreitung im ISO-Format. Wenn nicht angegeben, hat die Verbreitung eine unbegrenzte Dauer. HINWEIS: Wenn keine Zeitzone angegeben ist, verwenden wir die östlichste Zeitzone in der Region. Du kannst jedoch eine beliebige Zeitzone angeben, wenn du eine bestimmte Takedown-Zeit wünscht. |
Ende |
AssetLanguage |
AssetLanguage[] |
Nein |
Sprache für das Asset, ausgedrückt als ISO-Sprachcode mit Asset-Typ. Zulässige Asset-Typen: Untertitel, Audio, Subdub, Sub, Dub, OV, MTA, beliebig |
AssetLanguage |
AllowedLanguage |
AssetLanguage[] |
Nein |
ISO-Sprachcode mit Asset-Typ. Zulässige Asset-Typen: Untertitel, Audio, Sub, Dub, Subdub, beliebig |
AllowedLanguages |
HoldbackLanguage |
AssetLanguage[] |
Nein |
ISO-Sprachcode mit Asset-Typ. Zulässige Asset-Typen: Untertitel, Audio, Sub, Dub, Subdub, beliebig |
HoldbackLanguage |
LicenseRightsDescription |
Zeichenfolge |
Nein |
Wird verwendet, um die Veröffentlichungspriorität anzugeben. |
LicenseRightsDescription |
FormatProfile |
AvailFormatProfile |
Ja |
Qualität des verfügbaren Videos. Zulässige Werte: SD, HD, UHD |
FormatProfile |
ContractID |
Zeichenfolge |
Nein |
Gibt Vertragsinformationen an. Zulässige Werte: |
ContractID |
Bedingungen |
AvailTerms[] |
Ja |
Gibt eine Liste der Geschäftsbedingungen für das Verfügbarkeitsfenster an. |
OtherTerms |
OtherInstructions |
Zeichenfolge |
Nein |
Zusätzliche Verarbeitungsanweisungen für das Verfügbarkeitsfenster. |
OtherInstructions |
Art der Region
Gibt ein geografisches Gebiet mithilfe von ISO-Ländercodes an.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
country |
Zeichenfolge |
Ja |
2-Buchstaben-Ländercode nach ISO 3166-1 |
N/V |
AssetLanguage-Typ
Definiert die Sprachverfügbarkeit für Audio- und Untertitel-Assets.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
value |
Zeichenfolge |
Ja |
Sprache für das Asset, ausgedrückt als RFC-5646-Sprachcode mit Asset-Typ. |
N/V |
_asset |
Zeichenfolge |
Nein |
Je nach Sprachattribut vom Typ AvailTrans sind unterschiedliche Werte zulässig. |
N/V |
AvailFormatProfile-Typ
Gibt die Videoqualitätsstufe für die Verfügbarkeit an.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
value |
Aufzählung |
Ja |
Qualität des verfügbaren Videos. Zulässige Werte: SD, HD, UHD |
N/V |
AvailTerms-Typ
Flexible Struktur zur Spezifizierung von Geschäftsbegriffen. Jeder Begriff hat einen Namen und einen Wert des entsprechenden Typs (Geld, Text, Event, Boolesch, Dauer oder Zahl).
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
_termName |
Zeichenfolge |
Ja |
Identifiziert den Begriff. Der Wert unterscheidet nicht zwischen Groß- und Kleinschreibung. Eine Liste der zulässigen Werte findest du unten. |
N/V |
Geld |
Geld |
Nein |
Weitere Einzelheiten findest du unten. |
N/V |
Text |
Zeichenfolge |
Nein |
Weitere Einzelheiten findest du unten. |
N/V |
Ereignis |
DateTime |
Nein |
Weitere Einzelheiten findest du unten. |
N/V |
Boolesch |
Boolesch |
Nein |
Weitere Einzelheiten findest du unten. |
N/V |
Dauer |
Zeichenfolge |
Nein |
Weitere Einzelheiten findest du unten. |
N/V |
Zahl |
Ganzzahl |
Nein |
Weitere Einzelheiten findest du unten. |
N/V |
Art des Geldes
Stellt monetäre Werte mit Währungsspezifikation dar.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
value |
Dezimalwert |
Nein |
Geldwert, für einige Preisarten erforderlich |
N/V |
_currency |
Zeichenfolge |
Ja |
ISO-Währungscode |
N/V |
ContentSequenceInfo-Typ
Gibt Sequenznummern für Folgen und Staffeln an.
Attribut |
Typ |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
Zahl |
Ganzzahl |
Ja |
Sequenznummer des Inhalts, z. B. Folgennummer oder Staffelnummer |
N/V |
Unterstützte Avail-Bedingungen
In der folgenden Tabelle sind alle unterstützten Geschäftsbedingungen aufgeführt, die in das AvailTerms-Array aufgenommen werden können. Jeder Begriff regelt bestimmte Aspekte der Lizenzierung, der Preisgestaltung, der Werbung und des Kundenerlebnisses.
Name des Begriffs |
Attribut |
Erforderlich |
Hinweise |
EMA-Dateizuordnung |
ChannelIdentity |
Text |
Ja |
Kennung für einen Kanal oder ein Abonnement. |
GroupIdentity |
Stufe |
Text |
Abhängig |
Preisstufe. Erforderlich, wenn der Lizenztyp POEST ist. |
PriceType |
SRP |
Geld |
Abhängig |
Vorgeschlagener Verkaufspreis. Erforderlich, wenn der Lizenztyp POEST ist. |
SRP |
WSP |
Geld |
Abhängig |
Einkauspreis. Erforderlich, wenn der Lizenztyp POEST ist. |
PriceValue |
Kategorie |
Text |
Abhängig |
Preiskategorie. Erforderlich, wenn der Lizenztyp POEST ist. |
PriceValue |
AnnounceDate |
Ereignis |
Nein |
Datum, an dem der Einzelhändler das Startdatum der Verfügbarkeit des Titels im verfügbaren Gebiet bekannt geben darf. |
AnnounceDate |
SuppressionLiftDate |
Ereignis |
Abhängig |
Erster Tag, an dem ein Titel öffentlich bekannt gegeben werden kann, wenn er zu einem bestimmten zukünftigen Zeitpunkt verfügbar ist, sofern er verfügbar ist. Erforderlich, wenn der Lizenztyp POEST ist. |
SuppressionLiftDate |
RentalDuration |
Dauer |
Abhängig |
Ausleihdauer in Stunden. Erforderlich, wenn der Lizenztyp SVOD ist. |
RentalDuration |
WatchDuration |
Dauer |
Abhängig |
Gibt an, wie lange die nutzende Person nach dem Start der Anzeige Zeit hat, in Stunden. Erforderlich, wenn der Lizenztyp SVOD ist. |
WatchDuration |
Download |
Text |
Nein |
Die Lizenz beinhaltet die Erlaubnis zum Herunterladen. Gültige Werte sind Ja und Nein. Wenn der Lizenztyp SVOD ist, müssen sowohl die Leihdauer als auch die Wiedergabedauer angegeben werden. |
Download |
Exklusiv |
Boolesch |
Nein |
Assets sind im Rahmen der Transaktion exklusiv. |
Exklusiv |
ExclusiveAttributes |
Text |
Nein |
Gibt die Art der Exklusivität an. Wird nur berücksichtigt, wenn der Wert für Exclusive wahr ist. Ein Standardwert wird verwendet, falls er nicht angegeben wird, wenn Exclusive wahr ist. |
ExclusiveAttributes |
BrandingRights |
Boolesch |
Nein |
Zeigt die Absicht des Partners an, ein Branding anzuzeigen. |
BrandingRights |
Attribute für Markenrechte |
Text |
Nein |
Gibt den Branding-Text an. Wird nur berücksichtigt, wenn BrandingRights wahr ist. Ein Standardwert wird verwendet, wenn er nicht angegeben wird, wenn BrandingRights wahr ist. |
Attribute für Markenrechte |
allowAds |
Boolesch |
Nein |
Legt fest, ob Werbung erlaubt oder verboten ist. Dieser Begriff kann nur einmal vorkommen. |
In EMA nicht verfügbar |
allowedAdPlacement |
Text |
Abhängig |
Gibt die Position in der Rolle an, an der Werbung eingefügt werden kann. Zulässige Werte sind: PreRoll, MidRoll, Postroll, Overlays, PauseAds, Squeezebacks. |
In EMA nicht verfügbar |
prohibitedAdPlacement |
Text |
Abhängig |
Gibt die Position in der Rolle an, an der keine Werbung eingefügt werden kann. Zulässige Werte sind: PreRoll, MidRoll, Postroll, Overlays, PauseAds, Squeezebacks. |
In EMA nicht verfügbar |
cuepointDeliveryAndUsage |
Text |
Nein |
Spezifiziert die Liefer- und Nutzungsverpflichtungen von Cuepoint. Zulässige Werte: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated. |
In EMA nicht verfügbar |
blindBasisSelling |
Text |
Nein |
Zulässige Werte: GuaranteedImpressions, NoGuaranteedImpressions |
In EMA nicht verfügbar |
sponsorships |
Text |
Nein |
Zulässige Werte: Permitted, Prohibited, PermittedWithRestrictions. |
In EMA nicht verfügbar |
sponsorshipsRestrictions |
Text |
Abhängig |
Freiformtext |
In EMA nicht verfügbar |
talentAndAmazonAdGuidelines |
Text |
Nein |
Zulässige Werte: NoRestrictions, ConsultationRequired |
In EMA nicht verfügbar |
talentRestrictions |
Text |
Abhängig |
Freiformtext |
In EMA nicht verfügbar |
adLoadLimit |
Text |
Nein |
Anzahl der Werbeminuten pro Stunde. Der Wert muss eine gültige Ganzzahl sein. |
In EMA nicht verfügbar |
adKey |
Text |
Nein |
Freiformtext |
In EMA nicht verfügbar |
CompleteYourBundleDiscountPercentage |
Zahl |
Nein |
Der prozentuale Rabatt wird gewährt, wenn Kunden ein Paket abschließen, indem sie Titel kaufen, die sie noch nicht besitzen. Ein Rabatt von 20 % bedeutet beispielsweise, dass Kunden, die Staffel 1 eines Pakets mit 2 Staffeln besitzen, 20 % Rabatt auf Staffel 2 erhalten. |
In EMA nicht verfügbar |
ExcludedFromBundleDiscount |
Boolesch |
Nein |
Wenn dieser Wert auf Wahr gesetzt ist, wird dieses Verfügbarkeitsfenster von der Ermäßigung auf Pakete ausgeschlossen. Verwende diese Option während Premium-Preiszeiträumen (z. B. bei Neuerscheinungen) oder für Titel, für die der volle Preis beibehalten werden soll. Wenn der Titel fehlt oder falsch ist, hat er Anspruch auf Paketrabatte. |
In EMA nicht verfügbar |
BusinessLine-Aufzählung
Die BusinessLine-Aufzählung spezifiziert das Prime-Video-Geschäftsmodell, nach dem Inhalte lizenziert und vertrieben werden. Dies bestimmt, wie Kunden auf die Inhalte zugreifen und wie Einnahmen generiert werden.
Wert |
Beschreibung |
TVOD |
TVOD bedeutet Kauf oder Ausleihen. Verwandte Lizenztypen: EST, VOD, POEST |
PRIME_SUBSCRIPTION |
Amazon-Prime- oder Amazon-Kids+-Abonnement. Verwandte Lizenztypen: SVOD |
CHANNELS |
Kanalabonnement eines Drittanbieters. Verwandte Lizenztypen: SVOD |
FVOD |
Kostenlose Inhalte. Verwandte Lizenztypen: FVOD |
Hinweis: Der BusinessLine-Wert bestimmt, welches Geschäftsmodell für die Verfügbarkeit deiner Inhalte gilt. Stelle bei der Einreichung von Unterlagen sicher, dass die BusinessLine deiner vertraglichen Vereinbarung mit Prime Video entspricht. Wenn du Fragen dazu hast, welche BusinessLine-Werte für deine Partnerschaft verfügbar sind, wende dich an deine Prime-Video-Ansprechperson.
Beispielnutzlast-Avails
Die folgenden Beispiele zeigen, wie du deine API-Aufrufe für gängige Integrationsszenarien strukturierst. Unter Beispielnutzlast findest du vollständige Anforderungs-/Antwortpaare mit korrekt formatiertem JSON, die du als Vorlagen für deine Integration verwenden kannst.