Avails-API-Payload-Schemata

Typ

Beschreibung

Boolean

Boolescher Typ. Zulässige Werte: true, false

Integer

32-Bit-Ganzzahl mit Vorzeichen.

LongInteger

64-Bit-Ganzzahl mit Vorzeichen.

Decimal

Fließkommazahl.

String

Eine Zeichenfolge

Timestamp

ISO-Zeitstempel.

Enum

Eine Aufzählungszeichenfolge mit einem vordefinierten Satz zulässiger Werte.

Struct

Struktur dient als Aggregator für andere Attribute.

Array

Sammlung von Elementen des ASME-Typs. Festgelegt von [].

Attribut

Typ

Ist obligatorisch

Beschreibung

avail

Avail

Ja

Verfügbarkeitsdaten

Attribut

Typ

Ist obligatorisch

Beschreibung

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall

Attribut

Typ

Ist obligatorisch

Beschreibung

avail

Avail

Ja

Verfügbarkeitsdaten

Attribut

Typ

Ist obligatorisch

Beschreibung

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall

Attribut

Typ

Ist obligatorisch

Beschreibung

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall

Attribut

Typ

Ist obligatorisch

Beschreibung

avail

Avail

Ja

Verfügbarkeitsdaten

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItems

PutAvailsBatchAPIRequestItem[]

Ja

Liste der einzelnen Anfragen

Attribut

Typ

Ist obligatorisch

Beschreibung

responseItems

PutAvailsBatchAPIResponseItem[]

Ja

Liste der Antwortelemente

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

path

String

Ja

Pfad zu einer Ressource für dieses Anfrageelement.

Das Format für Full Extract-Modell ist:
/avails/{licensor}/full-extract/{ALID}

Das Format für Partial Extract-Modell ist:
/avails/{licensor}/partial-extract/transactions/{transactionID}

body

PutAvailsBatchAPIRequestItemBody

Ja

Verfügbarkeitsdaten

Attribut

Typ

Ist obligatorisch

Beschreibung

avail

Avail

Ja

Verfügbarkeitsdaten

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItems

ValidateAvailsBatchAPIRequestItem[]

Ja

Liste der einzelnen Anfragen

Attribut

Typ

Ist obligatorisch

Beschreibung

responseItems

ValidateAvailsBatchAPIResponseItem[]

Ja

Liste der Antwortelemente

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

path

String

Ja

Pfad zu einer Ressource für dieses Anfrageelement.

Das Format für Full Extract-Modell ist: /avails/{licensor}/full-extract/{ALID}/validate

Das Format für Partial Extract-Modell ist: /avails/{licensor}/partial-extract/transactions/{transactionID}/validate

body

ValidateAvailsBatchAPIRequestItemBody

Ja

Anfragetextkörper

Attribut

Typ

Ist obligatorisch

Beschreibung

avail

Avail

Ja

Verfügbarkeitsdaten

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall:

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItems

DeleteAvailsBatchAPIRequestItem[]

Ja

Liste der einzelnen Anfragen

Attribut

Typ

Ist obligatorisch

Beschreibung

responseItems

DeleteAvailsBatchAPIResponseItem[]

Ja

Liste der Antwortelemente.

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

path

String

Ja

Pfad zu einer Ressource für dieses Anfrageelement.

Das Format für Full Extract-Modell ist:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH|FIXED_FEE}&channelIdentity={Channel}

Das Format für Partial Extract-Modell ist:
/avails/{licensor}/partial-extract/transactions/{transactionID}

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItems

GetAvailsBatchAPIRequestItem[]

Ja

Liste der einzelnen Anfragen

Attribut

Typ

Ist obligatorisch

Beschreibung

responseItems

GetAvailsBatchAPIResponseItem[]

Ja

Liste der Antwortelemente

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

path

String

Ja

Pfad zu einer Ressource für dieses Anfrageelement.

Das Format für Full Extract-Modell ist:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

Das Format für Partial Extract-Modell ist:
/avails/{licensor}/partial-extract/transactions/{transactionID}

Attribut

Typ

Ist obligatorisch

Beschreibung

requestItemId

String

Ja

Eindeutige Kennung des Elements in Batch-Anfrage

success

Boolean

Ja

Status der Operation

errors

Error[]

Nein

Liste der Fehler im Fehlerfall

avail

Avail

Nein

Avail-Objekt

Attribut

Typ

Ist obligatorisch

Beschreibung

code

String

Ja

Eine Zeichenfolge, die den Fehlertyp beschreibt.

Validierungsfehlercodes: APIV{Zahl}, CRMSV{Zahl}
Service-Fehlercodes: APIE{Zahl}, CRMSE{Zahl}

Beispiele: APIV400, CRMSE500

message

String

Ja

Von Menschen lesbare Beschreibung des Fehlers

Attribut

Typ

Erforderlich

Hinweise

ALID

String

Ja

Gibt die Titelkennung an. Muss mit der im Metadatenbeitrag angegebenen ALID übereinstimmen.

Disposition

AvailDisposition

Ja

Gibt die Granularität des Extraktmodells an.

Licensor

Publisher

Ja

Gibt Informationen zu der Entität an, die Prime Video die Lizenz erteilt.

Asset

AvailAsset[]

Ja

Information zum Asset. In der Liste sollte nur ein einziges Asset angegeben werden.

Transaction

AvailTrans[]

Ja

Informationen zur Transaktion.

SharedEntitlement

AvailSharedEntitlement[]

Nein

Informationen über Ansprüche für andere Dienste.

Attribut

Typ

Erforderlich

Hinweise

EntryType

Enum

Ja

Zulässige Werte: FullExtract, FullDelete, PartialExtract, PartialDelete

Attribut

Typ

Erforderlich

Hinweise

DisplayName

String

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.

Attribut

Typ

Erforderlich

Hinweise

_contentID

String

Ja

Gibt die Inhalts-ID für dieses Asset an. Dieser Wert wird Partnern von Prime Video zur Verfügung gestellt. Muss derselbe Wert sein, der in EMA-Dateien verwendet wird. Muss derselbe ALID-Wert sein, der im Avail angegeben wird.

WorkType

Enum

Ja

Zulässige Werte: Movie, Short, Episode, Season, Supplemental

Metadaten

AvailUnitMetadata

Nein

Beschreibt Metadaten für „Movie“ oder „Short“. Erforderlich, wenn WorkType „Movie“ oder „Short“ ist.

EpisodeMetadata

AvailEpisodeMetadata

Nein

Beschreibt Metadaten für eine Folge. Erforderlich, wenn WorkType „Episode“ ist.

SeasonMetadata

AvailSeasonMetadata

Nein

Beschreibt Metadaten für die Staffel. Erforderlich, wenn WorkType „Season“ ist.

Attribut

Typ

Erforderlich

Hinweise

_ecosystem

Enum

Ja

Zulässige Werte: DMA

EcosystemID

String

Ja

Ökosystemspezifische Titelkennung

Attribut

Typ

Erforderlich

Hinweise

TitleInternalAlias

String[]

Ja

Name des Titels. In der Liste sollte nur ein einziger Titelname angegeben werden.

Attribut

Typ

Erforderlich

Hinweise

TitleInternalAlias

String[]

Ja

Titelname für Folge. In der Liste sollte nur ein einziger Titelname angegeben werden.

EpisodeNumber

ContentSequenceInfo

Ja

Nummer dieser Folge innerhalb der Staffel.

SeasonMetadata

AvailSeasonMetadata

Ja

Beschreibt Metadaten für die Staffel. Erforderlich, wenn WorkType „Episode“ oder „Season“ ist.

SeriesMetadata

AvailSeriesMetadata

Ja

Beschreibt Metadaten für die Serie. Erforderlich, wenn WorkType „Episode“ oder „Season“ ist.

Attribut

Typ

Erforderlich

Hinweise

SeasonContentID

String

Ja

ALID für die Staffel.

SeasonTitleInternalAlias

String[]

Nein

Titelname für die Staffel. In der Liste sollte nur ein einziger Titelname angegeben werden.

SeasonNumber

ContentSequenceInfo

Ja

Nummer dieser Staffel innerhalb der Serie.

NumberOfEpisodes

Integer

Ja

Anzahl der Folgen innerhalb dieser Staffel.

SeriesMetadata

AvailSeriesMetadata

Nein

Beschreibt Metadaten für die Serie. Erforderlich, wenn WorkType „Season“ ist.

Attribut

Typ

Erforderlich

Hinweise

SeriesContentID

String

Ja

ALID für die Serie.

SeriesTitleInternalAlias

String[]

Nein

Titelname für die Serie. In der Liste sollte nur ein einziger Titelname angegeben werden.

NumberOfSeasons

Integer

Nein

Anzahl der Staffeln in dieser Serie.

Attribut

Typ

Erforderlich

Hinweise

_TransactionID

String

Nein

Eindeutige Kennung für das Verfügbarkeitsfenster. Erforderlich, wenn PartialExtract verwendet wird. Optional, wenn FullExtract verwendet wird.

LicenseType

Enum

Ja

Zulässige Werte: SVOD, FVOD, EST, POEST, VOD

Territory

Region[]

Yes

Gebiet, in dem der Vertrieb zulässig ist. Es darf nur ein einziges Gebietselement bereitgestellt werden. Alle Transaktionen innerhalb eines einzigen Avail-Objekts müssen dasselbe Gebiet haben.

Start

DateTime

Ja

Startdatum und -uhrzeit für die Bereitstellung im ISO-Format.

End

DateTime

Nein

Enddatum und -uhrzeit für die Bereitstellung im ISO-Format. Falls nicht angegeben, hat die Bereitstellung eine unbegrenzte Dauer.

AssetLanguage

AssetLanguage[]

Nein

Sprache für Asset, angegeben als ISO-Sprachcode mit Asset-Typ. Zulässige Asset-Typen: subtitle, audio, subdub, sub, dub, ov, mta, any

AllowedLanguage

AssetLanguage[]

Nein

ISO-Sprachcode mit Asset-Typ Zulässige Asset-Typen: subtitle, audio, sub, dub, subdub, any

HoldbackLanguage

AssetLanguage[]

Nein

ISO-Sprachcode mit Asset-Typ Zulässige Asset-Typen: subtitle, audio, sub, dub, subdub, any

LicenseRightsBeschreibung

String

Nein

Wird verwendet, um die Veröffentlichungspriorität anzugeben.

FormatProfile

AvailFormatProfile

Ja

Qualität des verfügbaren Videos. Zulässige Werte: SD, HD, UHD

ContractID

String

Nein

Gibt Vertragsinformationen an. Zulässige Werte:
- CPH
- FIXED_FEE
- FIXED_FEE:{Deal ID}
Bei der Einreichung von Avails sind die FIXED_FEE-Optionen vom Lizenzgeber eingeschränkt

Terms

AvailTerms[]

Ja

Gibt eine Liste der Geschäftsbedingungen für das Verfügbarkeitsfenster an.

OtherInstructions

String

Nein

Zusätzliche Verarbeitungsanweisungen für das Verfügbarkeitsfenster.

Attribut

Typ

Erforderlich

Hinweise

country

String

Ja

ISO-3166-1-Ländercode, bestehend aus 2 Buchstaben

Attribut

Typ

Erforderlich

Hinweise

value

String

Ja

Sprache für Asset, angegeben als RFC 5646-Sprachcode mit Asset-Typ.

_asset

String

Nein

Je nach Sprachattribut vom AvailTrans-Typ sind unterschiedliche Werte zulässig.

Zulässige Werte für AvailTrans.AssetLanguage:
subtitle, audio, subdub, sub, dub, ov, mta, any.
Für dieses Attribut muss dasselbe Asset für alle Sprachen eingereicht werden.

Zulässige Werte für AvailTrans.AllowedLanguage und AvailTrans. HoldbackLanguage:
subtitle, audio, sub, dub, subdub, any.
Wenn der Asset-Wert “subdub” oder “any” ist oder der Wert fehlt, wird er auf zwei Assets verzweigt: “subtitle” und “audio”.

Assets “sub” und “dub” werden in ihre MDDF-Äquivalente “subtitle” and “audio” konvertiert.

Attribut

Typ

Erforderlich

Hinweise

value

Enum

Ja

Qualität des verfügbaren Videos. Zulässige Werte: SD, HD, UHD

Attribut

Typ

Erforderlich

Hinweise

_termName

String

Ja

Gibt den Term an. Der Wert unterscheidet nicht zwischen Groß- und Kleinschreibung. Eine Liste der zulässigen Werte siehe unten.

Money

Money

Nein

Weitere Details siehe unten.

Text

String

Nein

Weitere Details siehe unten.

Event

DateTime

Nein

Weitere Details siehe unten.

Boolean

Boolean

Nein

Weitere Details siehe unten.

Duration

String

Nein

Weitere Details siehe unten.

Number

Integer

Nein

Weitere Details siehe unten.

Term-Name

Attribut

Erforderlich

Hinweise

ChannelIdentity

Text

Ja

Kennung für einen Channel oder ein Abonnement.

Tier

Text

Bedingt

Preisstufe. Erforderlich, wenn der Lizenztyp POEST ist.

SRP

Money

Bedingt

Empfohlener Verkaufspreis. Erforderlich, wenn der Lizenztyp POEST ist.

WSP

Money

Bedngt

Großhandelspreis. Erforderlich, wenn der Lizenztyp POEST ist.

Category

Text

Bedingt

Preiskategorie. Erforderlich, wenn der Lizenztyp POEST ist.

AnnounceDate

Event

Nein

Datum, an dem der Händler das Startdatum der Verfügbarkeit des Titels innerhalb des verfügbaren Gebiets bekannt geben darf.

SuppressionLiftDate

Event

Bedingt

Erstes Datum, an dem öffentlich bekannt gegeben werden darf, dass ein Titel an einem bestimmten zukünftigen Datum im Avail-Gebiet verfügbar ist. Erforderlich, wenn der Lizenztyp POEST ist.

RentalDuration

Duration

Bedingt

Dauer der Leihfrist in Stunden. Erforderlich, wenn der Lizenztyp SVOD ist.

WatchDuration

Duration

Bedingt

Wie lange der Benutzer nach dem Start des Titels Zeit ( in Stunden) hat, um ihn anzusehen. Erforderlich, wenn der Lizenztyp SVOD ist.

Download

Text

Nein

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.

Exclusive

Boolean

Nein

Assets sind im Rahmen der Transaktion exklusiv.

ExclusiveAttributes

Text

Nein

Gibt die Art der Exklusivität an. Wird nur berücksichtigt, wenn der Wert für „Exclusive“ true ist. Ein Standardwert wird verwendet, falls keiner angegeben wird, wenn „Exclusive“ true ist.

BrandingRights

Boolean

Nein

Zeigt die Absicht des Partners an, ein Branding anzuzeigen.

BrandingRightsAttributs

Text

Nein

Gibt den Branding-Text an. Wird nur berücksichtigt, wenn „BrandingRights“ true ist. Ein Standardwert wird verwendet, falls keiner angegeben wird, wenn „BrandingRights“ true ist.

allowAds

Boolean

Nein

Legt fest, ob Werbung erlaubt oder verboten ist. Dieser Term darf nur einmal vorkommen.

allowedAdPlacement

Text

Bedingt

Gibt die Position in der Rolle an, an der Werbung eingefügt werden kann. Zulässige Werte sind: PreRoll, MidRoll, Postroll, Overlays, PauseAds, Squeezebacks.
Nur zulässig, wenn „allowAds“ true ist.

Dieser Term kann mehrmals vorkommen. Es kann entweder „allowedAdPlacement“ oder „prohibitedAdPlacement“ angegeben werden, aber nicht beide.

prohibitedAdPlacement

Text

Bedingt

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.
Dieser Term kann mehrmals vorkommen.

Nur zulässig, wenn „allowAds“ true ist.

Es kann entweder „allowedAdPlacement“ oder „prohibitedAdPlacement“ angegeben werden, aber nicht beide.

cuepointDeliveryAndUsage

Text

Nein

Gibt Cuepoint-Bereitstellungs- und Nutzungsverpflichtungen. Zulässige Werte: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated.

Nur zulässig, wenn „allowAds“ true ist.

blindBasisSelling

Text

Nein

Zulässige Werte: GuaranteedImpressions, NoGuaranteedImpressions

Dieses Attribut sollte nur vorhanden sein, wenn „allowAds“ auf true gesetzt ist.

sponsorships

Text

Nein

Zulässige Werte: Permitted, Prohibited, PermittedWithRestrictions.

Dieses Attribut sollte nur vorhanden sein, wenn „allowAds“ auf true gesetzt ist.

sponsorshipsRestrictions

Text

Bedingt

Freiformtext

Dieses Attribut sollte nur vorhanden sein, wenn „sponsorships“ auf „AllowedWithRestrictions“ gesetzt ist.

talentAndAmazonAdGuidelines

Text

Nein

Zulässige Werte: NoRestrictions, ConsultationRequired

Dieses Attribut sollte nur vorhanden sein, wenn „allowAds“ auf true gesetzt ist.

talentRestrictions

Text

Bedingt

Freiformtext

Dieses Attribut sollte nur vorhanden sein, wenn „talentAndAmazonAdGuidelines“ auf „ConsultationRequired“ gesetzt ist.

adLoadLimit

Text

Nein

Anzahl der Werbeminuten pro Stunde. Der Wert muss eine gültige Ganzzahl sein.

Dieses Attribut sollte nur vorhanden sein, wenn „allowAds“ auf true gesetzt ist.

Attribut

Typ

Erforderlich

Hinweise

value

Decimal

Nein

Geldwert, für einige Preistypen erforderlich

_currency

String

Ja

ISO-Währungscode

Attribut

Typ

Erforderlich

Hinweise

Number

Integer

Ja

Sequenznummer des Inhalts, wie Folgen- oder Staffelnummer

Aufzählungswert

Beschreibung

TVOD

TVOD bedeutet Kauf- oder Leihtitel. Verwandte Lizenztypen: EST, VOD, POEST

PRIME_SUBSCRIPTION

Amazon Prime- oder Amazon Kids+-Abonnement. Verwandte Lizenztypen: SVOD

CHANNELS

Channel-Abonnement von Drittanbietern. Verwandte Lizenztypen: SVOD

FVOD

Kostenloser Inhalt. Verwandte Lizenztypen: FVOD