Video Central

L’API Prime Video Avails fait partie de la suite Content API et vous permet de gérer la disponibilité de vos titres sur Prime Video grâce à une intégration directe à vos systèmes de gestion des droits relatifs au contenu. Soumettez, mettez à jour, récupérez ou supprimez des fenêtres de disponibilité avec une précision et un contrôle accrus par rapport aux téléchargements de fichiers traditionnels.

Pourquoi utiliser l’API Avails ?

L’API rationalise votre flux de gestion de contenu et vous permet de mieux contrôler votre catalogue Prime Video :

Gestion automatisée : éliminez les chargements manuels et réduisez les erreurs en automatisant les soumissions et les mises à jour des fenêtres de disponibilité, ce qui permet à votre équipe de se concentrer sur des tâches stratégiques
Efficacité accrue : mettez à jour des fenêtres de disponibilité spécifiques sans soumettre à nouveau des ensembles de données entiers, ce qui permet de gagner du temps et de réduire les traitements redondants.
Retours directs : validez vos données en temps réel et recevez des messages d’erreur immédiats sans avoir à vous connecter à Slate pour effectuer des corrections manuelles.
Interopérabilité : construit sur une interface REST indépendante de la langue, du système et de la plate-forme, accessible depuis n’importe quel système doté d’une connexion Internet.

Opérations API et points de terminaison

Tous les terminaux sont indépendants de la langue et accessibles via HTTP 1.1 depuis n’importe quel système disposant d’une connexion Internet. Les points de terminaison Avails ne suivent aucun protocole spécifique et peuvent être appelés dans n’importe quel ordre en fonction des besoins de votre flux de travail.

À propos des modèles d’extraction
Un modèle d’extraction définit la manière dont vous structurez et soumettez les données de disponibilité à Prime Video. C’est comme si vous deviez choisir entre nous envoyer les informations complètes de votre catalogue ou nous envoyer uniquement les modifications spécifiques que vous devez apporter.

Full Extract Model Soumettre toutes les fenêtres de disponibilité pour un périmètre spécifique (Titre + Territoire + Secteur d’activité) en une seule demande. Il s’agit du modèle par défaut pour tous les partenaires.

Quand utiliser : diffuser du nouveau contenu, effectuer des mises à jour complètes ou lorsque vous souhaitez vous assurer que toutes les données de disponibilité d’un titre sont synchronisées.

Fonctionnement : vous envoyez des informations de disponibilité complètes, et Prime Video remplace toutes les données existantes correspondant à cette étendue par votre envoi.

Opération 1 - Créer/mettre à jour des disponibilités

Ce que fait l’opération : Ajoute de nouvelles fenêtres de disponibilité ou met à jour celles qui existent déjà pour vos titres.
Pourquoi vous en avez besoin : Il vous permet d’indiquer à Prime Video quand et où votre contenu doit être mis à la disposition des clients. Que vous lanciez de nouveaux contenus ou que vous prolongiez une licence existante, cette opération garantit la mise à jour de vos données de disponibilité.

Opération 2 - Récupérer des disponibilités

Ce que fait l’opération : Récupère les informations de disponibilité actuelles des systèmes Prime Video.
Pourquoi vous en avez besoin : Vérifier les données de disponibilité enregistrées par Prime Video, corriger les écarts ou extraire les données à des fins de création de rapports et de rapprochement.

Opération 3 - Valider des disponibilités

Ce que fait l’opération : Vérifie la présence d’erreurs dans vos données de disponibilité avant de les envoyer aux systèmes live de Prime Video.
Pourquoi vous en avez besoin : Détecter les erreurs de mise en forme, les champs obligatoires manquants ou les violations des règles de gestion avant que cela n’ait un impact sur la disponibilité de votre contenu. Cela permet de gagner du temps en évitant d’avoir à soumettre les informations, à attendre le traitement, puis à corriger les erreurs et à les soumettre à nouveau.

Opération 4 - Supprimer des disponibilités

Ce que fait l’opération : Supprime des fenêtres de disponibilité des systèmes Prime Video.
Pourquoi vous en avez besoin : Gérer les cas exceptionnels où la disponibilité doit être complètement supprimée plutôt que simplement expirée.
Important : Nous vous recommandons vivement de faire expirer le contenu en ajustant la date de fin plutôt que de le supprimer, sauf pour des cas d’utilisation ponctuels. L’expiration permet de conserver vos données historiques et votre piste d’audit.

Codes de réponse HTTP

Tous les points de terminaison Avails renvoient des codes HTTP standard qui vous indiquent si votre demande API a réussi ou échoué et si les erreurs sont temporaires (réessayables) ou permanentes, ce qui permet à votre système de gérer automatiquement les réponses sans intervention manuelle.

Code HTTP	Description	Réessayable
200	L’appel API a réussi. Les appelants doivent vérifier l’objet de la réponse pour plus de détails.	N/A
400	Demande incorrecte comportant des erreurs de validation.	Non
401	Non autorisé.	Non
404	Introuvable.	Non
500	Erreur interne.	Oui
503	Erreur de dépendance.	Oui

Remarque : Pour les erreurs réessayables (500, 503), implémentez une logique de nouvelle tentative avec des délais appropriés entre les tentatives. Les erreurs non réessayables (400, 401, 404) indiquent des problèmes liés à votre demande qui nécessitent une correction avant de la soumettre à nouveau.

Schémas API

Les schémas décrits dans cette documentation sont conçus pour aider les développeurs à intégrer l’API Avails. Tous les schémas de charge utile sont conformes à la norme MDDF API v2.6. Bien que vous puissiez inclure n’importe quel attribut MDDF API v2.6 dans votre charge utile, Prime Video ne traite que les attributs pris en charge. Les attributs non pris en charge seront ignorés.

Remarque : Pour obtenir une liste complète des attributs pris en charge correspondant à notre spécification EMA Avails, consultez la colonne EMA Avails dans le tableau « Types de données de base » ci-dessous. Pour plus d’informations sur la manière dont les ressources sont gérées et utilisées dans Prime Video, consultez la page Droits relatifs au contenu.

Conversion de MDDF XML en JSON

L’API MDDF Avails définit son schéma au format XML, mais prend en charge les charges utiles au format XML et JSON. Les API Prime Video Avails utilisent des charges utiles codées au format JSON. Le processus de conversion de MDDF XML en JSON est décrit ci-dessous :

Des espaces de noms ont été omis

Les éléments imbriqués deviennent des propriétés imbriquées

Plusieurs éléments portant le même nom deviennent des éléments de tableau

Les attributs entrent dans les propriétés et sont précédés d’un trait de soulignement

Types de données de schéma courants

Le schéma de l’API Avails prend en charge les types de données suivants :

Type

Description

Booléen

Type booléen. Valeurs autorisées : vrai, faux

Nombre entier

Entier signé de 32 bits.

Entier long

Entier signé de 64 bits.

Valeur décimale

Nombre à virgule flottante.

Chaîne de caractères

Un ensemble de caractères.

Horodatage

Horodatage ISO.

Enum

Chaîne énumérée avec un ensemble prédéfini de valeurs autorisées.

Struct

La structure sert d’agrégateur pour les autres attributs.

Array

Collection d’éléments de type ASME. Désigné par [].

Remarque : Le nombre maximum d’éléments autorisés dans les demandes par lot est limité à 100.

Schémas de demande et de réponse

Cette section définit les structures de données pour toutes les opérations de l’API Avails. Ces schémas indiquent le format exact des demandes que vous envoyez à Prime Video et des réponses que vous recevez en retour. Il est essentiel de comprendre ces structures pour réussir l’intégration API.

Schéma 1 - Créer/mettre à jour des disponibilités

Ces schémas définissent la structure de création ou de mise à jour des fenêtres de disponibilité dans le système Prime Video. Utilisez-les lorsque vous devez soumettre de nouveaux droits de contenu ou modifier des droits existants.

Type PutAvailsAPIRequest
Il s’agit de l’objet de demande principal pour soumettre une fenêtre de disponibilité unique.

Attribut	Type	Est obligatoire	Description
disponibilité	Disponibilité	Oui	Données de disponibilité : il s’agit de l’attribut de niveau supérieur de toute demande de saisie ou de validation

Type PutAvailsAPIResponse

La réponse que vous recevrez après avoir soumis une fenêtre de disponibilité. Vérifiez le champ de réussite pour confirmer que l’opération est terminée et vérifiez les erreurs en cas d’échec de la soumission.

Attribut	Type	Est obligatoire	Description
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec

Type PutAvailsBatchAPIRequest
Utilisez ce schéma lorsque vous devez soumettre plusieurs fenêtres de disponibilité en un seul appel API. Les opérations par lot améliorent l’efficacité lors de la gestion de catalogues volumineux ou lors de mises à jour en masse.

Attribut	Type	Est obligatoire	Description
requestItems	PutAvailsBatchAPIRequestItem[]	Oui	Liste des demandes individuelles

Type PutAvailsBatchAPIResponse
La réponse au lot renvoie des résultats individuels pour chaque élément de votre demande par lot. Chaque élément de réponse correspond à un élément de demande via le requestItemId.

Attribut	Type	Est obligatoire	Description
responseItems	PutAvailsBatchAPIResponseItem[]	Oui	Liste des éléments de réponse

Type PutAvailsBatchAPIRequestItem
Chaque élément d’une demande par lot nécessite un identifiant et un chemin uniques qui spécifient le type d’opération (extrait complet) et la ressource cible.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot. Il s’agit d’une chaîne unique que vous utiliserez pour identifier chaque élément du lot et qui sera liée à la réponse au lot que nous avons envoyée.
chemin	Chaîne de caractères	Oui	Chemin d’accès à une ressource pour cet élément de demande. Pour le modèle Full Extract, le format est le suivant : /avails/{licensor}/full-extract/{ALID}
corps	PutAvailsBatchAPIRequestItemBody	Oui	Données de disponibilité

Type PutAvailsBatchAPIRequestItemBody
Le corps de chaque élément de demande par lot contient les données de disponibilité réelles que vous soumettez.

Attribut	Type	Est obligatoire	Description
disponibilité	Disponibilité	Oui	Données de disponibilité

Type PutAvailsBatchAPIResponseItem
Chaque élément de la réponse au lot indique le succès ou l’échec de la demande correspondante. Utilisez le requestItemId pour faire correspondre les réponses à vos demandes initiales.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec

Schéma 2 - Récupérer les disponibilités

Ces schémas définissent comment récupérer les fenêtres de disponibilité existantes à partir du système Prime Video. Utilisez-les pour obtenir des informations sur les droits actuels pour votre contenu.

Type GetAvailsAPIResponse
La réponse contient les données de disponibilité complètes du contenu demandé, y compris toutes les conditions de licence et les droits territoriaux.

Attribut	Type	Est obligatoire	Description
disponibilité	Disponibilité	Oui	Données de disponibilité
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec

GetAvailsBatchAPIRequest
Récupérez plusieurs fenêtres de disponibilité en un seul appel API. Cela est efficace lorsque vous devez vérifier les droits de plusieurs titres ou transactions.

Attribut	Type	Est obligatoire	Description
requestItems	GetAvailsBatchAPIRequestItem[]	Oui	Liste des demandes individuelles

GetAvailsBatchAPIResponse
Renvoie les données de disponibilité pour chaque élément demandé. Chaque réponse correspond à une demande via le requestItemId.

Attribut	Type	Est obligatoire	Description
responseItems	GetAvailsBatchAPIResponseItem[]	Oui	Liste des éléments de réponse

GetAvailsBatchAPIRequestItem
Chaque élément de requête get spécifie le chemin d’accès à la ressource que vous souhaitez récupérer.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot
chemin	Chaîne de caractères	Oui	Chemin d’accès à une ressource pour cet élément de demande. Pour le modèle Full Extract, le format est le suivant : /avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

GetAvailsBatchAPIResponseItem
Chaque élément de réponse contient les données de disponibilité si la récupération a réussi, ou les détails de l’erreur en cas d’échec.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec
disponibilité	Disponibilité	Non	Objet de disponibilité

Schéma 3 - Valider des disponibilités

Ces schémas vous permettent de tester vos données de disponibilité avant de les soumettre au système Prime Video. La validation détecte les erreurs à un stade précoce sans créer ni modifier de fenêtres de disponibilité réelles.

Type ValidateAvailsAPIRequest
La réponse de validation indique si vos données respectent toutes les règles de validation. Vérifiez les éventuelles erreurs avant de soumettre la demande de création ou de mise à jour.

Attribut	Type	Est obligatoire	Description
disponibilité	Disponibilité	Oui	Données de disponibilité

Type ValidateAvailsAPIResponse
La réponse de validation indique si vos données respectent toutes les règles de validation. Vérifiez les éventuelles erreurs avant de soumettre la demande de création ou de mise à jour.

Attribut	Type	Est obligatoire	Description
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec

Type ValidateAvailsBatchAPIRequest
Validez plusieurs fenêtres de disponibilité en un seul appel. Cela est particulièrement utile lors de la préparation de soumissions par lots importants.

Attribut	Type	Est obligatoire	Description
requestItems	ValidateAvailsBatchAPIRequestItem[]	Oui	Liste des demandes individuelles

Type ValidateAvailsBatchAPIResponse
Renvoie les résultats de validation pour chaque article de votre lot. Chaque réponse correspond à un élément de demande via le requestItemId.

Attribut	Type	Est obligatoire	Description
responseItems	ValidateAvailsBatchAPIResponseItem[]	Oui	Liste des éléments de réponse

Type ValidateAvailsBatchAPIRequestItem
Chaque élément de demande de validation inclut le chemin de la ressource auquel /validate est ajouté pour le distinguer des opérations de création ou de mise à jour réelles.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot
chemin	Chaîne de caractères	Oui	Chemin d’accès à une ressource pour la demande : Modèle d’extraction complet : /avails/{licensor}/full-extract/{ALID}/validate
corps	ValidateAvailsBatchAPIRequestItemBody	Oui	Corps de la demande

Type ValidateAvailsBatchAPIRequestItemBody
Contient les données de la fenêtre de disponibilité à valider.

Attribut	Type	Est obligatoire	Description
disponibilité	Disponibilité	Oui	Données de disponibilité

Type ValidateAvailsBatchAPIResponseItem
Chaque élément de réponse de validation indique si les données correspondantes ont réussi les contrôles de validation.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec

Schéma 4 - Supprimer des disponibilités

Ces schémas définissent comment supprimer des fenêtres de disponibilité du système Prime Video.

Important : Nous vous recommandons vivement de faire expirer le contenu en ajustant la date de fin plutôt que de le supprimer, sauf pour des cas d’utilisation spécifiques tels que ceux liés à des exigences de conformité. Les contenus expirés conservent vos données historiques et votre piste d’audit, ce qui est précieux pour la création de rapports et le rapprochement.

Type DeleteAvailsAPIResponse
Confirme si l’opération de suppression s’est terminée correctement. Vérifiez le champ de réussite et les éventuelles erreurs.

Attribut	Type	Est obligatoire	Description
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec

Type DeleteAvailsBatchAPIRequest
Supprimez plusieurs fenêtres de disponibilité en un seul appel API. Ceci est utile pour les retraits groupés ou les expirations de droits.

Attribut	Type	Est obligatoire	Description
requestItems	DeleteAvailsBatchAPIRequestItem[]	Oui	Liste des demandes individuelles

Type DeleteAvailsBatchAPIResponse
Renvoie les résultats de suppression pour chaque élément de votre demande par lot.

Attribut	Type	Est obligatoire	Description
responseItems	DeleteAvailsBatchAPIResponseItem[]	Oui	Liste des éléments de réponse.

Type DeleteAvailsBatchAPIRequestItem
Chaque élément de la demande de suppression indique le chemin d’accès à la ressource à supprimer.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot
chemin	Chaîne de caractères	Oui	Chemin d’accès à une ressource pour cet élément de demande. Pour le modèle Full Extract, le format est le suivant : /avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH\|FIXED_FEE}&channelIdentity={Channel}

Type DeleteAvailsBatchAPIResponseItem
Chaque élément de réponse confirme si la suppression a réussi pour la demande correspondante.

Attribut	Type	Est obligatoire	Description
requestItemId	Chaîne de caractères	Oui	Identifiant unique de l’élément dans la demande par lot
succès	Booléen	Oui	État de l’opération
erreurs	Erreur []	Non	Liste des erreurs en cas d’échec

Types de données de base

Ces types de données fondamentaux sont utilisés dans tous les schémas API. La compréhension de ces structures est essentielle pour travailler avec n’importe quelle opération de disponibilité. Pour plus de détails, veuillez consulter la page Droits relatifs au contenu.

Type d’erreur
Structure d’erreur standard renvoyée en cas d’échec des opérations. Le code identifie le type d’erreur, tandis que le message fournit des informations lisibles par l’homme.

Attribut	Type	Est obligatoire	Description
code	Chaîne de caractères	Oui	Chaîne décrivant le type d’erreur. Codes d’erreur de validation : APIV{number}, CRMSV{number} Codes d’erreur de service : APIE{number}, CRMSE{number} Exemples : APIV400, CRMSE500
message	Chaîne de caractères	Oui	Description d’erreur lisible par l’homme

Type de disponibilité
Structure de données de base représentant une fenêtre de disponibilité complète. Cela inclut toutes les informations concernant les droits relatifs au contenu, les conditions de licence, les territoires et les conditions commerciales.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
ALID	Chaîne de caractères	Oui	Spécifie l’identifiant du titre. Doit correspondre à l’ALID spécifié dans la contribution aux métadonnées.	ALID
Disposition	AvailDisposition	Oui	Spécifie la granularité du modèle d’extrait.	N/A
Concédant	Éditeur	Oui	Spécifie les informations relatives à l’entité qui accorde une licence à Prime Video.	N/A
Actif	AvailAsset[]	Oui	Informations sur l’actif. Une seule ressource doit être spécifiée dans la liste.	N/A
Transaction	AvailTrans[]	Oui	Informations sur la transaction.	N/A
SharedEntitlement	AvailSharedEntitlement[]	Non	Informations sur les droits à d’autres services.	N/A

Type AvailDisposition
Définit s’il s’agit d’une opération d’extraction complète ou de suppression complète, et s’il s’agit de créer/mettre à jour ou de supprimer des données.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
EntryType	Enum	Oui	Valeurs autorisées : FullExtract, FullDelete	Disposition

Type d’éditeur
Identifie votre organisation en tant que concédant de licence de contenu. Cette valeur est fournie par Prime Video lors de l’intégration.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
DisplayName	Chaîne de caractères	Oui	Spécifie le nom du partenaire Prime Video. Cette valeur sera fournie aux partenaires par Prime Video. La valeur doit être la même que celle utilisée dans les fichiers EMA.	DisplayName

Type AvailAsset
Décrit le contenu faisant l’objet d’une licence. La structure varie en fonction du WorkType (film, épisode, saison, etc.).

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
_contentID	Chaîne de caractères	Oui	Spécifie l’ID de contenu pour cet actif. Généralement identique à ALID.	ContentID
WorkType	Enum	Oui	Valeurs autorisées : Film, court-métrage, épisode, saison, supplément	WorkType
Métadonnées	AvailUnitMetadata	Conditionnel	Décrit les métadonnées d’un film ou d’un court métrage. Obligatoire lorsque WorkType est un film ou un court métrage.	N/A
EpisodeMetadata	AvailEpisodeMetadata	Conditionnel	Décrit les métadonnées de l’épisode. Obligatoire lorsque WorkType est défini sur Épisode.	N/A
SeasonMetadata	AvailSeasonMetadata	Conditionnel	Décrit les métadonnées de la saison. Obligatoire lorsque WorkType est défini sur Saison.	N/A

Type AvailSharedEntitlement
Spécifie les droits pour d’autres écosystèmes numériques tels que la DMA (Digital Movie Alliance).

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
_ecosystem	Enum	Oui	Valeurs autorisées : DMA Remarque : UVVU - Les ultraviolets ne sont pas pris en charge.	N/A
EcosystemID	Chaîne de caractères	Oui	Identifiant de titre spécifique à l’écosystème	DMA_ID

Type AvailUnitMetadata
Des métadonnées pour des contenus autonomes tels que des films ou des courts métrages.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
TitleInternalAlias	String[]	Oui	Nom du titre. Un seul nom de titre doit être spécifié dans la liste.	TitleInternalAlias

Type AvailEpisodeMetadata
Métadonnées spécifiques aux épisodes de séries, y compris le numéro de l’épisode et les informations relatives à la saison/à la série mère.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
TitleInternalAlias	String[]	Oui	Nom du titre de l’épisode Un seul nom de titre doit être spécifié dans la liste.	EpisodeTitleInternalAlias
EpisodeNumber	ContentSequenceInfo	Oui	Numéro de cet épisode dans la saison.	EpisodeNumber
SeasonMetadata	AvailSeasonMetadata	Conditionnel	Décrit les métadonnées de la saison. Obligatoire lorsque WorkType est un épisode ou une saison.	N/A
SeriesMetadata	AvailSeriesMetadata	Conditionnel	Décrit les métadonnées de la série. Obligatoire lorsque WorkType est un épisode ou une saison.	N/A

Type AvailSeasonMetadata
Métadonnées pour les saisons de séries, y compris le numéro de saison et le nombre d’épisodes.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
SeasonContentID	Chaîne de caractères	Oui	ALID de la saison.	SeasonContentID
SeasonTitleInternalAlias	String[]	Non	Nom du titre de la saison. Un seul nom de titre doit être spécifié dans la liste.	SeasonTitleInternalAlias
SeasonNumber	ContentSequenceInfo	Oui	Numéro de cette saison au sein de la série.	SeasonNumber
NumberOfEpisodes	Nombre entier	Oui	Nombre d’épisodes dans cette saison.	EpisodeCount
SeriesMetadata	AvailSeriesMetadata	Conditionnel	Décrit les métadonnées de la série. Obligatoire lorsque WorkType est défini sur Saison.	N/A

Type AvailSeriesMetadata
Métadonnées pour les séries, fournissant des informations de premier niveau sur les séries.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
SeriesContentID	Chaîne de caractères	Oui	ALID pour les séries.	SeriesContentID
SeriesTitleInternalAlias	String[]	Non	Nom du titre de la série Un seul nom de titre doit être spécifié dans la liste.	SeriesTitleInternalAlias
NumberOfSeasons	Nombre entier	Non	Nombre de saisons de cette série.	SeasonCount

Type AvailTrans
Définit une transaction de licence spécifique, notamment le territoire, les dates, le type de licence et les conditions commerciales. C’est ici que vous spécifiez les droits réellement accordés.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
_TransactionID	Chaîne de caractères	Non	Identifiant unique pour la fenêtre de disponibilité. Facultatif lors de l’utilisation de FullExtract.	AvailID
LicenseType	Enum	Oui	Valeurs autorisées : SVOD, FVOD, EST, POEST, VOD	LicenseType
Territoire	Region[]	Oui	Territoire où la distribution est autorisée. Un seul élément de territoire doit être fourni. Toutes les transactions au sein d’un même objet Avail doivent avoir le même territoire.	Territoire
Début	DateTime	Oui	Date et heure de début de la distribution au format ISO. REMARQUE : Si aucun fuseau horaire n’est inclus, nous utiliserons le fuseau horaire le plus à l’est de la région. Cependant, vous pouvez inclure n’importe quel fuseau horaire si vous souhaitez une heure de sortie spécifique.	Début
Fin	DateTime	Non	Date et heure de fin de distribution au format ISO. Si elle n’est pas fournie, la durée de distribution est illimitée. REMARQUE : Si aucun fuseau horaire n’est inclus, nous utiliserons le fuseau horaire le plus à l’est de la région. Cependant, vous pouvez inclure n’importe quel fuseau horaire si vous souhaitez une heure de retrait spécifique.	Fin
AssetLanguage	AssetLanguage[]	Non	Langue de l’actif exprimée sous forme de code de langue ISO avec le type de ressource. Types d’actifs autorisés : sous-titre, audio, subdub, sub, dub, ov, mta, any	AssetLanguage
AllowedLanguage	AssetLanguage[]	Non	Code de langue ISO avec type de ressource. Types d’actifs autorisés : sous-titre, audio, sub, dub, subdub, subdub, any	AllowedLanguages
HoldbackLanguage	AssetLanguage[]	Non	Code de langue ISO avec type de ressource. Types d’actifs autorisés : sous-titre, audio, sub, dub, subdub, subdub, any	HoldbackLanguage
LicenseRightsDescription	Chaîne de caractères	Non	Utilisé pour spécifier la priorité de publication.	LicenseRightsDescription
FormatProfile	AvailFormatProfile	Oui	Qualité de la vidéo disponible. Valeurs autorisées : SD, HD, UHD	FormatProfile
ContractID	Chaîne de caractères	Non	Spécifie les informations contractuelles. Valeurs autorisées : - CPH - FIXED_FEE - FIXED_FEE:{Deal ID} Lors de la soumission des disponibilités, les options FIXED_FEE sont limitées par le concédant.	ContractID
Termes	AvailTerms[]	Oui	Spécifie la liste des termes commerciaux pour la fenêtre de disponibilité.	OtherTerms
OtherInstructions	Chaîne de caractères	Non	Instructions de traitement supplémentaires pour la fenêtre de disponibilité.	OtherInstructions

Type Region
Spécifie un territoire géographique à l’aide des codes de pays ISO.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
pays	Chaîne de caractères	Oui	Code de pays ISO 3166-1 à 2 lettres	N/A

Type AssetLanguage
Définit la disponibilité des langues pour les ressources audio et les sous-titres.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
valeur	Chaîne de caractères	Oui	Langue de l’actif exprimée sous forme de code de langue RFC 5646 avec type d’actif.	N/A
_asset	Chaîne de caractères	Non	Différents ensembles de valeurs sont autorisés, en fonction de l’attribut de langue du type AvailTrans. Valeurs autorisées pour AvailTrans.AssetLanguage : sous-titre, audio, subdub, sub, dub, ov, mta, any. Cet attribut nécessite la même ressource soumise pour toutes les langues. Valeurs autorisées pour AvailTrans.AllowedLanguage et AvailTrans. HoldbackLanguage: sous-titre, audio, sub, dub, subdub, subdub, any. Lorsque la valeur de l’actif est « subdub », « any » ou que la valeur est absente, elle sera réduite à deux actifs : « sous-titre » et « audio ». Les actifs « sub » et « dub » sont convertis en « sous-titres » et « audio » équivalents au format MDDF.	N/A

Type AvailFormatProfile
Spécifie le niveau de qualité vidéo pour la disponibilité.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
valeur	Enum	Oui	Qualité de la vidéo disponible. Valeurs autorisées : SD, HD, UHD	N/A

Type AvailTerms
Structure flexible pour spécifier les termes commerciaux. Chaque terme possède un nom et une valeur du type approprié (Money, Text, Event, Boolean, Duration ou Number).

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
_termName	Chaîne de caractères	Oui	Identifie le terme. La valeur ne fait pas la distinction entre majuscules et minuscules. Pour une liste des valeurs autorisées, voir ci-dessous.	N/A
Money	Money	Non	Pour plus de détails, voir ci-dessous.	N/A
Text	Chaîne de caractères	Non	Pour plus de détails, voir ci-dessous.	N/A
Event	DateTime	Non	Pour plus de détails, voir ci-dessous.	N/A
Boolean	Boolean	Non	Pour plus de détails, voir ci-dessous.	N/A
Duration	Chaîne de caractères	Non	Pour plus de détails, voir ci-dessous.	N/A
Number	Nombre entier	Non	Pour plus de détails, voir ci-dessous.	N/A

Type Money
Représente les valeurs monétaires avec spécification de devise.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
valeur	Valeur décimale	Non	Valeur monétaire, requise pour certains types de prix	N/A
_currency	Chaîne de caractères	Oui	Code de devise ISO	N/A

Type ContentSequenceInfo
Spécifie les numéros de séquence des épisodes et des saisons.

Attribut	Type	Obligatoire	Commentaires	Mappage de fichiers EMA
Number	Nombre entier	Oui	Numéro de séquence du contenu, tel que le numéro d’épisode ou le numéro de saison	N/A

Conditions d’utilisation prises en charge
Le tableau suivant répertorie tous les termes commerciaux pris en charge qui peuvent être inclus dans le tableau AvailTerms. Chaque terme contrôle des aspects spécifiques des licences, de la tarification, de la publicité et de l’expérience client.

Nom du terme	Attribut	Obligatoire	Commentaires	Mappage de fichiers EMA
ChannelIdentity	Text	Oui	Identifiant d’une chaîne ou d’un abonnement.	GroupIdentity
Niveau	Text	Conditionnel	Niveau de tarification. Obligatoire si le type de licence est POEST.	PriceType
SRP	Money	Conditionnel	Prix de détail suggéré. Obligatoire si le type de licence est POEST.	SRP
WSP	Money	Conditionnel	Prix de gros Obligatoire si le type de licence est POEST.	PriceValue
Catégorie	Text	Conditionnel	Catégorie de prix. Obligatoire si le type de licence est POEST.	PriceValue
AnnounceDate	Event	Non	Date à laquelle le revendeur est autorisé à annoncer la date de début de disponibilité du titre sur le territoire disponible.	AnnounceDate
SuppressionLiftDate	Event	Conditionnel	Première date à laquelle un titre pourrait être annoncé publiquement comme étant disponible à une date ultérieure précise dans la zone de disponibilité. Obligatoire si le type de licence est POEST.	SuppressionLiftDate
RentalDuration	Duration	Conditionnel	Durée de la période de location en heures. Obligatoire si le type de licence est SVOD.	RentalDuration
WatchDuration	Duration	Conditionnel	Le temps dont dispose l’utilisateur pour terminer le visionnage une fois celui-ci commencé, en heures. Obligatoire si le type de licence est SVOD.	WatchDuration
Télécharger	Text	Non	La licence inclut l’autorisation de téléchargement. Les valeurs valides sont Oui et Non. Lorsque le type de licence est SVOD, la durée de location et la durée de visionnage doivent être spécifiées.	Télécharger
Exclusive	Boolean	Non	Les actifs sont exclusifs dans le cadre de la transaction.	Exclusive
ExclusiveAttributes	Text	Non	Spécifie le type d’exclusivité. Uniquement pris en compte lorsque Exclusive est vrai. Une valeur par défaut sera utilisée si elle n’est pas fournie lorsque Exclusive est vrai.	ExclusiveAttributes
BrandingRights	Boolean	Non	Indique l’intention du partenaire d’afficher sa marque.	BrandingRights
BrandingRightsAttributes	Text	Non	Spécifie le texte de la marque. Uniquement pris en compte lorsque BrandingRights est vrai. Une valeur par défaut sera utilisée si elle n’est pas fournie lorsque BrandingRights est défini sur vrai.	BrandingRightsAttributes
allowAds	Boolean	Non	Détermine si les publicités sont autorisées ou interdites. Ce terme ne peut apparaître qu’une seule fois.	Non disponible dans EMA
allowedAdPlacement	Text	Conditionnel	Spécifie l’emplacement dans le rouleau où les annonces peuvent être insérées. Les valeurs autorisées sont les suivantes : PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks. Autorisé uniquement lorsque allowAds est défini sur vrai. Ce terme peut apparaître plusieurs fois. Vous pouvez spécifier allowedAdPlacement ou prohibitedAdPlacement, mais pas les deux.	Non disponible dans EMA
prohibitedAdPlacement	Text	Conditionnel	Spécifie l’emplacement dans le rouleau où les publicités ne peuvent pas être insérées. Les valeurs autorisées sont les suivantes : PreRoll, MidRoll, PostRoll,Overlays, PauseAds, Squeezebacks. Ce terme peut apparaître plusieurs fois. Autorisé uniquement lorsque allowAds est défini sur vrai. Vous pouvez spécifier allowedAdPlacement ou prohibitedAdPlacement, mais pas les deux.	Non disponible dans EMA
cuepointDeliveryAndUsage	Text	Non	Spécifie les obligations de livraison et d’utilisation des points de repère. Valeurs autorisées : PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated. Autorisé uniquement lorsque allowAds est défini sur vrai.	Non disponible dans EMA
blindBasisSelling	Text	Non	Valeurs autorisées : GuaranteedImpressions, NoGuaranteedImpressions Cet attribut ne doit être présent que si allowAds est défini sur true.	Non disponible dans EMA
parrainages	Text	Non	Valeurs autorisées : Permitted, Prohibited, PermittedWithRestrictions. Cet attribut ne doit être présent que si allowAds est défini sur true.	Non disponible dans EMA
sponsorshipsRestrictions	Text	Conditionnel	Texte en format libre Cet attribut ne doit être présent que si les parrainages sont définis sur allowedWithRestrictions.	Non disponible dans EMA
talentAndAmazonAdGuidelines	Text	Non	Valeurs autorisées : NoRestrictions, ConsultationRequired Cet attribut ne doit être présent que si allowAds est défini sur true.	Non disponible dans EMA
talentRestrictions	Text	Conditionnel	Texte en format libre Cet attribut ne doit être présent que si talentAndAmazonAdGuidelines est défini sur ConsultationRequired.	Non disponible dans EMA
adLoadLimit	Text	Non	Nombre de minutes de publicité par heure. La valeur doit être un entier valide. Cet attribut ne doit être présent que si allowAds est défini sur true.	Non disponible dans EMA
adKey	Text	Non	Texte en format libre Identifiant unique permettant de mapper le contenu aux serveurs de gestion des publicités.	Non disponible dans EMA
CompleteYourBundleDiscountPercentage	Number	Non	Pourcentage de réduction appliqué lorsque les clients complètent une offre groupée en achetant les titres qu’ils ne possèdent pas encore. Par exemple, une remise de 20 % signifie que les clients qui possèdent la saison 1 d’un forfait de 2 saisons bénéficient d’une réduction de 20 % sur la saison 2.	Non disponible dans EMA
ExcludedFromBundleDiscount	Boolean	Non	Lorsque ce paramètre est défini sur vrai, cette fenêtre de disponibilité est exclue de l’éligibilité à l’offre groupée. À utiliser pendant les périodes de tarification premium (par exemple, les nouvelles sorties) ou pour les titres qui doivent conserver leur prix plein. En cas d’absence ou de faux, le titre peut bénéficier d’offres groupées.	Non disponible dans EMA

Énumération BusinessLine
L’énumération BusinessLine spécifie le modèle commercial de Prime Video selon lequel le contenu est concédé sous licence et distribué. Cela détermine la manière dont les clients accèdent au contenu et la manière dont les revenus sont générés.

Value	Description
TVOD	TVOD signifie achat ou location. Types de licences associés : EST, VOD, POEST
PRIME_SUBSCRIPTION	Abonnement Amazon Prime ou Amazon Kids+. Types de licences associés : SVOD
CHAÎNES	Abonnement à une chaîne tierce. Types de licences associés : SVOD
FVOD	Contenu gratuit. Types de licences associés : FVOD

Remarque : La valeur BusinessLine détermine le modèle commercial qui s’applique à la disponibilité de votre contenu. Lorsque vous soumettez des disponibilités, assurez-vous que BusinessLine est conforme à votre accord contractuel avec Prime Video. Si vous avez des questions concernant les valeurs BusinessLine disponibles pour votre partenariat, contactez votre représentant Prime Video.

Exemple de charge utile Avails

Les exemples suivants montrent comment structurer vos appels API pour des scénarios d’intégration courants. Consultez la section Exemples de charge utile pour des paires requête/réponse complètes avec un format JSON correctement formaté que vous pouvez utiliser comme modèles pour votre intégration.

FAQ

Les sections suivantes fournissent des réponses aux questions courantes concernant l’utilisation de l’API Avails.

Utilisation générale de l’API

Une charge utile correspond aux données que vous envoyez à l’API ou que vous recevez depuis celle-ci. Il s’agit du contenu réel de votre demande ou de votre réponse. Considérez-le comme l’ensemble d’informations que vous échangez avec les systèmes Prime Video. Chaque exemple montre la structure JSON correcte et les champs obligatoires pour les scénarios courants, ce qui vous aide à formater vos demandes d’API et à interpréter les réponses de Prime Video.

La suite Content API vous permet d’automatiser les flux de travail de gestion de contenu et de bénéficier d’une visibilité en temps réel sur le statut de votre contenu sur Prime Video. Cette suite comprend :

Renseignements utiles — Soumettre, mettre à jour, récupérer et supprimer les droits de contenu (avails) de manière programmatique dans tous les secteurs d’activité et territoires
API de statut de l’offre : vérifiez si vos titres sont en ligne sur la boutique Prime Video et comprenez ce qui empêche la mise en ligne des titres
API d’état des actifs : surveillez l’état de livraison des actifs et recevez des informations instantanées sur l’état de préparation du contenu

Lorsque vous intégrez la Content API Suite, vous aurez accès aux API que vous demandez au cours du processus d’intégration. Tous/Toutes les API de cette suite utilisent l’authentification basée sur des certificats MTLS (Mutual Transport Layer Security) avec des clés d’API.

Suppression de contenu et modifications de date

Soumettre des disponibilités

Avails API