L’API Prime Video Avails fait partie de la suite d’API de contenu 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 de contenu. Soumettre, mettre à jour, récupérer ou supprimer des fenêtres de disponibilité avec une précision et un contrôle supérieurs à ceux des téléchargements de fichiers traditionnels.
Pourquoi utiliser l’API Avains ?
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 télé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 les tâches stratégiques
- Efficacité accrue : mettez à jour des fenêtres de disponibilité spécifiques sans soumettre à nouveau des ensembles de données complets, ce qui permet de gagner du temps et de réduire les traitements redondants.
- Feedback direct : 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é : repose sur une interface REST indépendante du langage, du système et de la plate-forme, accessible depuis n’importe quel système disposant d’une connexion Internet.
Opérations d’API et points de terminaison
Tous/Toutes les terminaisons sont indépendantes de la langue et accessibles via HTTP 1.1 depuis n’importe quel système disposant d’une connexion Internet. Les points de terminaison Avavis 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’extrait Un modèle d’extrait définit la manière dont vous structurez et soumettez les données de disponibilité à Prime Video. Cela revient à choisir entre nous envoyer les informations complètes de votre catalogue ou envoyer uniquement les modifications spécifiques que vous devez apporter.
Opération 1 - Créer/mettre à jour les Renseignements utiles
- Ce qu’il fait : ajoute de nouvelles fenêtres de disponibilité ou met à jour les fenêtres existantes pour vos titres.
- Pourquoi vous en avez besoin : c’est ainsi que vous indiquez à Prime Video quand et où votre contenu doit être mis à la disposition des clients. Que vous lanciez un nouveau contenu ou que vous prolongiez une licence existante, cette opération garantit que vos données de disponibilité sont à jour.
Opération 2 - Récupérer les renseignements utiles
- Ce qu’il fait : récupère les informations de disponibilité actuelles des systèmes Prime Video.
- Pourquoi en avez-vous besoin : vérifiez les données de disponibilité enregistrées par Prime Video, corrigez les incohérences ou extrayez les données à des fins de reporting et de rapprochement.
Opération 3 - Valider les renseignements utiles
- Ce qu’il fait : vérifie que vos données de disponibilité ne contiennent pas d’erreurs avant de les envoyer aux systèmes en direct de Prime Video.
- Pourquoi vous en avez besoin : Détectez les erreurs de mise en forme, les champs obligatoires manquants ou les violations des règles commerciales avant qu’ils n’affectent la disponibilité de votre contenu. Cela permet de gagner du temps en éliminant le besoin de soumettre, d’attendre le traitement, puis de corriger les erreurs et de soumettre à nouveau.
Opération 4 - Supprimer les renseignements utiles
- Ce qu’il fait : Supprime les fenêtres de disponibilité des systèmes Prime Video.
- Pourquoi vous en avez besoin : Gérez des scénarios ponctuels dans lesquels la disponibilité doit être complètement supprimée plutôt que 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 dans les cas d’utilisation ponctuels. Expiring conserve vos données historiques et votre piste d’audit.
Codes de réponse HTTP
Tous/Toutes les bornes Avails renvoient des codes HTTP standard qui vous indiquent si votre demande d’API a abouti ou non 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 d’API a réussi. Les appelants doivent vérifier l’objet de réponse pour plus de détails. |
N/A |
400 |
Mauvaise demande, y compris les échecs de validation. |
Non |
401 |
Non autorisé. |
Non |
404 |
Non trouvé |
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 doivent être corrigés avant de la soumettre à nouveau.
Schémas d’API
Les schémas décrits dans cette documentation sont conçus pour aider les développeurs à intégrer l’API Avails. Tous/Toutes les structures de charge utile sont conformes à la norme MDDF API v2.6. Bien que vous puissiez inclure n’importe quel attribut de l’API MDDF 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 une référence complète des attributs pris en charge correspondant à notre spécification EMA avails, consultez la colonne EMA avails dans le tableau des types de données de base ci-dessous. Pour en savoir plus sur la façon dont les ressources sont gérées et utilisées sur Prime Video, consultez la page des droits relatifs au contenu.
Conversion du XML MDDF en JSON
L’API MDDF Avails définit son schéma au format XML, mais prend en charge les charges utiles en XML et en JSON. Les API Prime Video Avails utilisent des charges utiles codées en JSON. Le processus de conversion du XML MDDF en JSON est décrit ci-dessous : Les espaces de
noms sont omis
<alice>bob</alice>
becomes
{ "alice": "bob" }
Les éléments imbriqués deviennent des propriétés imbriquées
<alice><bob>charlie</bob><david>edgar</david></alice>
becomes
{ "alice": { "bob": "charlie", "david": "edgar" } }
Plusieurs éléments portant le même nom deviennent des éléments de tableau
<alice><bob>charlie</bob><bob>david</bob></alice>
becomes
{ "alice": { "bob": [ "charlie", "david" ] } }
Les attributs apparaissent dans les propriétés et sont précédés d’un trait de soulignement
<alice charlie="david">bob</alice>
becomes
{ "alice": { "_charlie": "david", "value": "bob" } }
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. |
| Décimal |
Nombre à virgule flottante. |
| Corde |
Un ensemble de personnages. |
| Horodatage |
Horodatage ISO. |
| Enum |
Chaîne énumérée avec un ensemble prédéfini de valeurs autorisées. |
| Structure |
La structure sert d’agrégateur pour les autres attributs. |
| Array |
Collection d’articles de type ASME. Désigné par []. |
Remarque : Le nombre maximum d’articles autorisés dans les demandes par lots 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 Renseignements utiles. Ces schémas indiquent le format exact des demandes que vous envoyez à Prime Video et des réponses que vous recevez en retour. La compréhension de ces structures est essentielle pour une intégration réussie des API.
Schéma 1 - Création/mise à jour des renseignements utiles
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 |
profiter |
Profitez |
Oui |
Données de disponibilité : il s’agit de l’attribut de premier niveau de toute demande de vente ou de validation |
Type de réponse 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 |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
Type PutAvailsBatchApiRequest Utilisez ce schéma lorsque vous devez soumettre plusieurs fenêtres de disponibilité en un seul appel d’API. Les opérations par lots améliorent l’efficacité lors de la gestion de catalogues volumineux ou lors de mises à jour groupées.
Attribut |
Type |
Est obligatoire |
Description |
Demander des articles |
Mettre un article de demande par lots disponible [] |
Oui |
Liste des demandes individuelles |
Type PutAvailsBatchApiResponse La réponse par lots renvoie des résultats individuels pour chaque article de votre demande de lot. Chaque élément de réponse correspond à un élément de demande via le RequestItemID.
Attribut |
Type |
Est obligatoire |
Description |
Éléments de réponse |
Mettre un élément de réponse par lot disponible [] |
Oui |
Liste des éléments de réponse |
Type PutAvailsBatchApiRequestItem Chaque élément d’une demande par lots nécessite un identifiant et un chemin uniques qui spécifient le type d’opération (Full Extract) et la ressource cible.
Attribut |
Type |
Est obligatoire |
Description |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots. Il s’agit d’une chaîne unique que vous utiliserez pour identifier chaque article du lot et qui sera liée à la réponse du lot de notre part. |
chemin |
Corde |
Oui |
Chemin d’accès à une ressource pour cet élément de demande. |
corps |
Mettre AvailsBatchApiRequestItemBody |
Oui |
Données de disponibilité |
Type PutAvailsBatchApiRequestItemBody Le corps de chaque élément de demande par lots contient les données de disponibilité réelles que vous soumettez.
Attribut |
Type |
Est obligatoire |
Description |
profiter |
Profitez |
Oui |
Données de disponibilité |
Type PutAvailsBatchApiResponseItem Chaque élément de réponse du lot indique le succès ou l’échec de la demande correspondante. Utilisez le RequestItemID pour faire correspondre les réponses à vos demandes d’origine.
Attribut |
Type |
Est obligatoire |
Description |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots |
succès |
Booléen |
Oui |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
Schéma 2 - Récupérer les renseignements utiles
Ces schémas définissent comment récupérer les fenêtres de disponibilité existantes depuis le système Prime Video. Utilisez-les pour consulter les informations actuelles sur les droits relatifs à votre contenu.
Type GetAvailsApiResponse La réponse contient les données de disponibilité complètes pour le contenu demandé, y compris toutes les conditions de licence et les droits territoriaux.
Attribut |
Type |
Est obligatoire |
Description |
profiter |
Profitez |
Oui |
Données de disponibilité |
succès |
Booléen |
Oui |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
GetAvailsBatchApiRequest
Récupérez plusieurs fenêtres de disponibilité en un seul appel d’API. Cela est efficace lorsque vous devez vérifier les droits de plusieurs titres ou transactions.
Attribut |
Type |
Est obligatoire |
Description |
Demander des articles |
Obtenir un article de demande par lots [] |
Oui |
Liste des demandes individuelles |
GetAvailsBatchApiResponse
Renvoie les données de disponibilité pour chaque article demandé. Chaque réponse correspond à une demande via le RequestItemID.
Attribut |
Type |
Est obligatoire |
Description |
Éléments de réponse |
GetAvailsBatchApiResponseItem [] |
Oui |
Liste des éléments de réponse |
GetAvailsBatchApiRequestItem
Chaque élément de requête get indique le chemin d’accès à la ressource que vous souhaitez récupérer.
Attribut |
Type |
Est obligatoire |
Description |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots |
chemin |
Corde |
Oui |
Chemin d’accès à une ressource pour cet élément de demande. |
GetAvailsBatchApiResponseItem
Chaque élément de réponse contient les données de disponibilité en cas de réussite de la récupération ou le détail de l’erreur en cas d’échec.
Attribut |
Type |
Est obligatoire |
Description |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots |
succès |
Booléen |
Oui |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
profiter |
Profitez |
Non |
Objet Avail |
Schéma 3 - Valider les renseignements utiles
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 les 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 toutes les erreurs avant de soumettre la demande de création ou de mise à jour.
Attribut |
Type |
Est obligatoire |
Description |
profiter |
Profitez |
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 toutes les erreurs avant de soumettre la demande de création ou de mise à jour.
Attribut |
Type |
Est obligatoire |
Description |
succès |
Booléen |
Oui |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
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 de grande taille.
Attribut |
Type |
Est obligatoire |
Description |
Demander des articles |
ValidateAvailsBatchApiRequestItem [] |
Oui |
Liste des demandes individuelles |
Le
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 |
Éléments de réponse |
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 |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots |
chemin |
Corde |
Oui |
Chemin d’accès à une ressource pour la demande : modèle |
corps |
Valider AvailsBatchApiRequestItemBody |
Oui |
Corps de la demande |
Le type
ValidateAvailsBatchApiRequestItemBody contient les données de la fenêtre de disponibilité à valider.
Attribut |
Type |
Est obligatoire |
Description |
profiter |
Profitez |
Oui |
Données de disponibilité |
ValidateAvailsBatchApiResponseItem
type Chaque élément de réponse de validation indique si les données correspondantes ont passé les contrôles de validation.
Attribut |
Type |
Est obligatoire |
Description |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots |
succès |
Booléen |
Oui |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
Schéma 4 - Supprimer les renseignements utiles
Ces schémas définissent comment supprimer les 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 dans des cas d’utilisation spécifiques tels que le respect des exigences de conformité. Le contenu expirant conserve vos données historiques et votre piste d’audit, ce qui est précieux pour les rapports et les rapprochements.
Le
type DeleteAvailsApiResponse confirme si l’opération de suppression s’est terminée avec succès. Vérifiez le champ de réussite et examinez les éventuelles erreurs.
Attribut |
Type |
Est obligatoire |
Description |
succès |
Booléen |
Oui |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
Type DeleteAvailsBatchApiRequest Supprime plusieurs fenêtres de disponibilité en un seul appel d’API. Cela est utile pour les retraits groupés ou les expirations de droits.
Attribut |
Type |
Est obligatoire |
Description |
Demander des articles |
Supprimer un article de demande d’API Availsbatch [] |
Oui |
Liste des demandes individuelles |
Le
type DeleteAvailsBatchApiResponse renvoie les résultats de suppression pour chaque élément de votre demande de lot.
Attribut |
Type |
Est obligatoire |
Description |
Éléments de réponse |
Supprimer l’élément AvailsBatchApiResponseItem [] |
Oui |
Liste des éléments de réponse. |
Type DeleteAvailsBatchApiRequestItem Chaque élément de demande de suppression indique le chemin d’accès à la ressource à supprimer.
Attribut |
Type |
Est obligatoire |
Description |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots |
chemin |
Corde |
Oui |
Chemin d’accès à une ressource pour cet élément de demande. |
DeleteAvailsBatchApiResponseItem
type Chaque élément de réponse confirme si la suppression a réussi pour la demande correspondante.
Attribut |
Type |
Est obligatoire |
Description |
ID de l’article de demande |
Corde |
Oui |
Identifiant unique de l’article dans la demande par lots |
succès |
Booléen |
Oui |
Statut de l’opération |
erreurs |
Erreur [] |
Non |
Liste des erreurs en cas de panne |
Types de données de base
Ces types de données fondamentaux sont utilisés dans tous les schémas d’API. La compréhension de ces structures est essentielle pour travailler avec n’importe quelle opération Avails. Pour de plus amples informations, 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 détails lisibles par l’homme.
Attribut |
Type |
Est obligatoire |
Description |
code |
Corde |
Oui |
Chaîne décrivant le type d’erreur. |
message |
Corde |
Oui |
Description de l’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 relatives aux droits relatifs au contenu, aux conditions de licence, aux territoires et aux conditions commerciales.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
ALID |
Corde |
Oui |
Spécifie l’identifiant du titre. Doit correspondre à l’ALID spécifié dans la contribution aux métadonnées. |
ALID |
Disposition |
Disponibilité et disposition |
Oui |
Spécifie la granularité du modèle d’extrait. |
S.O. |
Concédant |
Editeur |
Oui |
Spécifie les informations relatives à l’entité qui octroie une licence à Prime Video. |
S.O. |
Actif |
Actif disponible [] |
Oui |
Informations sur l’actif. Un seul actif doit être spécifié dans la liste. |
S.O. |
Transaction |
AvailTrans [1] |
Oui |
Informations sur la transaction. |
S.O. |
Titre partagé |
Bénéficier d’un droit partagé [] |
Non |
Informations sur les droits à d’autres services. |
S.O. |
Le type AvailDisposition définit s’il s’agit d’une opération Full Extract ou Full Delete, et s’il s’agit de créer/mettre à jour ou de supprimer des données.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
Type d’entrée |
Enum |
Oui |
Valeurs autorisées : FullExtract, FullDelete |
Disposition |
Type d’éditeur
Identifie votre organisation en tant que concédant le contenu. Cette valeur est fournie par Prime Video lors de l’intégration.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
DisplayName |
Corde |
Oui |
Spécifie le nom du partenaire Prime Video. Cette valeur sera fournie aux partenaires par Prime Video. Doit être la même valeur que celle utilisée dans les fichiers EMA. |
DisplayName |
Le type AvailAsset
décrit l’actif de contenu sous licence. La structure varie en fonction du WorkType (film, épisode, saison, etc.).
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
_ID du contenu |
Corde |
Oui |
Spécifie l’ID de contenu pour cette ressource. Généralement identique à ALID. |
ContentID |
WorkType |
Enum |
Oui |
Valeurs autorisées : Film, Court métrage, Épisode, Saison, Supplémentaire |
WorkType |
Metadonnées |
Métadonnées AvailUnit |
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. |
S.O. |
Métadonnées des épisodes |
Utiliser les métadonnées des épisodes |
Conditionnel |
Décrit les métadonnées de l’épisode. Obligatoire lorsque WorkType est défini sur Episode. |
S.O. |
Métadonnées saisonnières |
Afficher les métadonnées de la saison |
Conditionnel |
Décrit les métadonnées de la Saison. Obligatoire lorsque WorkType est défini sur Saison. |
S.O. |
Le
type AvailSharedTitle spécifie les droits pour d’autres écosystèmes numériques tels que DMA (Digital Movie Alliance).
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
_écosystème |
Enum |
Oui |
Valeurs autorisées : DMA |
S.O. |
ID de l’écosystème |
Corde |
Oui |
Identifiant de titre spécifique à l’écosystème |
DMA_ID |
AvailUnitMetadata de type
Metadata pour du contenu autonome tel que des films ou des courts métrages.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
TitleInternalAlias |
Chaîne [] |
Oui |
Nom du titre. Un seul nom de titre doit être indiqué dans la liste. |
TitleInternalAlias |
AvailePisodeMetadata
type Métadonnées spécifiques aux épisodes télévisés, y compris le numéro de l’épisode et les informations sur les saisons/séries parentes.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
TitleInternalAlias |
Chaîne [] |
Oui |
Nom du titre de l’épisode. Un seul nom de titre doit être indiqué dans la liste. |
EpisodeTitleInternalAlias |
EpisodEnumber |
Informations sur la séquence de contenu |
Oui |
Number de cet épisode au cours de la saison. |
EpisodeNumber |
Métadonnées saisonnières |
Afficher les métadonnées de la saison |
Conditionnel |
Décrit les métadonnées de la Saison. Obligatoire lorsque WorkType est un épisode ou une saison. |
S.O. |
Métadonnées de la série |
Métadonnées de la série AVAIL |
Conditionnel |
Décrit les métadonnées pour les séries. Obligatoire lorsque WorkType est un épisode ou une saison. |
S.O. |
AvailSeasonMetadata type
Métadonnées pour les saisons télévisées, y compris le numéro de saison et le nombre d’épisodes.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
SeasonContentId |
Corde |
Oui |
ALID pour la saison. |
SeasonContentID |
SeasonTitleInternalAlias |
Chaîne [] |
Non |
Nom du titre de la Saison. Un seul nom de titre doit être indiqué dans la liste. |
SeasonTitleInternalAlias |
SeasonNumber |
Informations sur la séquence de contenu |
Oui |
Number pour cette saison au sein de la série. |
SeasonNumber |
Nombre d’épisodes |
Nombre entier |
Oui |
Number d’épisodes de cette saison. |
EpisodeCount |
Métadonnées de la série |
Métadonnées de la série AVAIL |
Conditionnel |
Décrit les métadonnées pour les séries. Obligatoire lorsque WorkType est défini sur Saison. |
S.O. |
AvailSeriesMetadata type
Metadata pour les séries TV, fournissant des informations de haut niveau sur les séries.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
SeriesContentId |
Corde |
Oui |
ALID pour les séries. |
SeriesContentId |
Titre de la série InternalAlias |
Chaîne [] |
Non |
Nom du titre de la Série. Un seul nom de titre doit être indiqué dans la liste. |
Titre de la série InternalAlias |
Nombre de saisons |
Nombre entier |
Non |
Number de saisons dans cette série. |
SeasonCount |
Type AvailTrans
Définit une transaction de licence spécifique, y compris 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 |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
_ID de transaction |
Corde |
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 |
Région [] |
Oui |
Territoire où la distribution est autorisée. Un seul élément de territoire doit être fourni. Tous/Toutes les transactions au sein d’un même objet Avail doivent avoir le même territoire. |
Territoire |
Start |
Date/Heure |
Oui |
Date et heure de début de 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. |
Start |
End |
Date/Heure |
Non |
Date et heure de fin de distribution au format ISO. Si elle n’est pas fournie, la distribution a une durée 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 décollage précise. |
End |
AssetLanguage |
AssetLanguage [] |
Non |
Language de la ressource exprimé sous forme de code de langue ISO avec le type de ressource. Types de ressources autorisés : sous-titre, audio, subdub, sub, dub, ov, mta, tous |
AssetLanguage |
AllowedLanguage |
AssetLanguage [] |
Non |
Code de language ISO avec type de ressource. Types de ressources autorisés : sous-titre, audio, sub, dub, subdub, n’importe quel |
Langues autorisées |
HoldbackLanguage |
AssetLanguage [] |
Non |
Code de language ISO avec type de ressource. Types de ressources autorisés : sous-titre, audio, sub, dub, subdub, n’importe quel |
HoldbackLanguage |
LicenseRightsDescription |
Corde |
Non |
Utilisé pour spécifier la priorité de publication. |
LicenseRightsDescription |
FormatProfile |
Profil AvailFormat |
Oui |
Qualité de la vidéo disponible. Valeurs autorisées : SD, HD, UHD |
FormatProfile |
ContractiD |
Corde |
Non |
Spécifie les informations contractuelles. Valeurs autorisées : |
ContractID |
Termes |
Conditions d’utilisation [] |
Oui |
Spécifie la liste des conditions commerciales pour la fenêtre de disponibilité. |
OtherTerms |
OtherInstructions |
Corde |
Non |
Instructions de traitement supplémentaires pour la fenêtre de disponibilité. |
OtherInstructions |
Region type
Spécifie un territoire géographique à l’aide des codes de pays ISO.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
country |
Corde |
Oui |
Code de pays ISO 3166-1 à 2 lettres |
S.O. |
Le
type AssetLanguage définit la disponibilité de la langue pour les ressources audio et les sous-titres.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
valeur |
Corde |
Oui |
Language de la ressource exprimé sous la forme du code de langage RFC 5646 avec le type de ressource. |
S.O. |
_actif |
Corde |
Non |
Différents ensembles de valeurs sont autorisés, en fonction de l’attribut de language du type AvailTrans. |
S.O. |
Type AvailFormatProfile
Spécifie le niveau de qualité vidéo pour la disponibilité.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
valeur |
Enum |
Oui |
Qualité de la vidéo disponible. Valeurs autorisées : SD, HD, UHD |
S.O. |
Type AvailTerms Structure
flexible pour spécifier les conditions commerciales. Chaque terme possède un nom et une valeur du type approprié (Money, Text, Event, Boolean, Duration ou Number).
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
_Nom du terme |
Corde |
Oui |
Identifie le terme. La valeur ne fait pas la distinction majuscules/majuscules. Pour une liste des valeurs autorisées, voir ci-dessous. |
S.O. |
Argent |
Argent |
Non |
Pour plus de détails, voir ci-dessous. |
S.O. |
Texte |
Corde |
Non |
Pour plus de détails, voir ci-dessous. |
S.O. |
Événement |
Date/Heure |
Non |
Pour plus de détails, voir ci-dessous. |
S.O. |
Booléen |
Booléen |
Non |
Pour plus de détails, voir ci-dessous. |
S.O. |
Durée |
Corde |
Non |
Pour plus de détails, voir ci-dessous. |
S.O. |
Number |
Nombre entier |
Non |
Pour plus de détails, voir ci-dessous. |
S.O. |
Le type de monnaie représente les valeurs monétaires avec la spécification de la devise.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
valeur |
Décimal |
Non |
Valeur monétaire, requise pour certains types de prix |
S.O. |
_devise |
Corde |
Oui |
Code de devise ISO |
S.O. |
Type de durée
Représente une durée selon le format de durée ISO 8601. Les valeurs doivent être spécifiées en heures entières.
Attribut |
Type |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
valeur |
Corde |
Oui |
Durée ISO 8601 en heures entières. Format : PT {N} H où {N} est un nombre entier d’heures. Par exemple, PT48H pendant 48 heures ou PT720H pendant 30 jours. |
S.O. |
Type ContentSequenceInfo
Spécifie les numéros de séquence pour les épisodes et les saisons.
Attribut |
Type |
Nécessaire |
Remarques |
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 |
S.O. |
Termes Avail pris en charge (REMARQUE : faites défiler l’écran vers la droite pour un mappage EMA complet)
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 |
Nécessaire |
Remarques |
Mappage de fichiers EMA |
Identité de la chaîne |
Texte |
Oui |
Identifier une chaîne ou un abonnement. |
GroupIdentity |
Niveau |
Texte |
Conditionnel |
Niveau de tarification. Obligatoire si le type de licence est POEST. |
PriceType |
SRP |
Argent |
Conditionnel |
Prix de détail suggéré. Obligatoire si le type de licence est POEST. |
SRP |
WSP |
Argent |
Conditionnel |
Prix de gros. Obligatoire si le type de licence est POEST. |
PriceValue |
Catégorie |
Texte |
Conditionnel |
Catégorie de prix. Obligatoire si le type de licence est POEST. |
PriceValue |
AnnounceDate |
Événement |
Non |
Date à laquelle le revendeur est autorisé à annoncer la date de début de disponibilité du titre sur le territoire disponible. |
AnnounceDate |
Date de levée de suppressionLiftDate |
Événement |
Conditionnel |
Première date à laquelle un titre peut être annoncé publiquement comme étant disponible à une date ultérieure précise dans le territoire disponible. Obligatoire si le type de licence est POEST. |
Date de levée de suppressionLiftDate |
Durée de la location |
Durée |
Conditionnel |
Durée de la période de location en heures. Obligatoire si le type de licence est SVOD. |
Durée de la location |
WatchDuration |
Durée |
Conditionnel |
Combien de temps l’utilisateur dispose pour terminer le visionnage une fois qu’il a commencé, en heures. Obligatoire si le type de licence est SVOD. |
WatchDuration |
Download |
Texte |
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. |
Download |
Exclusif |
Booléen |
Non |
Les actifs sont exclusifs dans le cadre de la transaction. |
Exclusif |
ExclusiveAttributs |
Texte |
Non |
Spécifie le type d’exclusivité. Considéré uniquement lorsque Exclusive est vrai. Une valeur par défaut sera utilisée si elle n’est pas fournie lorsque Exclusive est vrai. |
ExclusiveAttributs |
BrandingRights |
Booléen |
Non |
Indique l’intention du partenaire d’afficher son image de marque. |
BrandingRights |
BrandingRightsAttributes |
Texte |
Non |
Spécifie le texte de marque. Considéré uniquement lorsque BrandingRights est vrai. Une valeur par défaut sera utilisée si elle n’est pas fournie lorsque BrandingRights est vrai. |
BrandingRightsAttributes |
Autoriser les publicités |
Booléen |
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 l’EMA |
Placement d’annonce autorisé |
Texte |
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. |
Non disponible dans l’EMA |
Placement d’annonce interdit |
Texte |
Conditionnel |
Spécifie l’emplacement dans le rouleau où les annonces ne peuvent pas être insérées. Les valeurs autorisées sont les suivantes : PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks. |
Non disponible dans l’EMA |
Livraison et utilisation de Cuepoint |
Texte |
Non |
Spécifie les obligations de livraison et d’utilisation des points de cueillette. Valeurs autorisées : le partenaire livrera et Prime Video doit utiliser, Prime Video utilisera s’il est livré, aucune obligation de livraison ou d’utilisation, talent obligé. |
Non disponible dans l’EMA |
Blind Base Selling |
Texte |
Non |
Valeurs autorisées : GuaranteedImpressions, NoGuaranteedImpressions |
Non disponible dans l’EMA |
parrainages |
Texte |
Non |
Valeurs autorisées : Autorisé, Interdit, PermittedWithRestrictions. |
Non disponible dans l’EMA |
Restrictions relatives aux commandites |
Texte |
Conditionnel |
Texte de forme libre |
Non disponible dans l’EMA |
| Directives relatives aux publicités TalentandAmazon (** ne doit pas comporter de saut de ligne) |
Texte |
Non |
Valeurs autorisées : NoRestrictions, ConsultationRequired |
Non disponible dans l’EMA |
Restrictions relatives aux talents |
Texte |
Conditionnel |
Texte de forme libre |
Non disponible dans l’EMA |
Limite de chargement des annonces |
Texte |
Non |
Number de minutes publicitaires par heure. La valeur doit être un entier valide. |
Non disponible dans l’EMA |
Clé publicitaire |
Texte |
Non |
Texte de forme libre Identifiant |
Non disponible dans l’EMA |
CompleteYourBundle (** ne devrait pas avoir de saut de ligne) |
Number |
Non |
Pourcentage de réduction appliqué lorsque les clients complètent une offre groupée en achetant des titres qu’ils ne possèdent pas encore. Par exemple, une réduction de 20 % signifie que les clients qui possèdent la saison 1 d’un pack de 2 saisons bénéficient d’une réduction de 20 % sur la saison 2. |
Non disponible dans l’EMA |
ExcludedFrom (** ne doit pas avoir de saut de ligne) |
Booléen |
Non |
Lorsque ce paramètre est défini sur true, cette fenêtre de disponibilité est exclue de l’éligibilité aux remises groupées. À utiliser pendant les périodes de tarification premium (par exemple, les nouvelles versions) ou pour les titres dont le prix doit être maintenu à un prix complet. En cas d’absence ou de faux, le titre est éligible à des remises groupées. |
Non disponible dans l’EMA |
Énumération BusinessLine
L’énumération BusinessLine indique le modèle commercial de Prime Video selon lequel le contenu est concédé sous licence et distribué. Cela détermine comment les clients accèdent au contenu et comment les revenus sont générés.
Value |
Description |
TVOD |
TVOD signifie achat ou location. Types de licences associés : EST, VOD, POEST |
ABONNEMENT PRIME |
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 |
VOD |
Du 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 offres, assurez-vous que BusinessLine est conforme à votre accord contractuel avec Prime Video. Si vous avez des questions concernant les valeurs BusinessLine applicables à votre partenariat, contactez votre représentant Prime Video.
Renseignements utiles concernant les exemples de charge utile
Les exemples suivants montrent comment structurer vos appels d’API pour des scénarios d’intégration courants. Consultez les exemples de charge utile pour des paires requête/réponse complètes avec du JSON correctement formaté que vous pouvez utiliser comme modèles pour votre intégration.