L’API Asset Status vous permet de vérifier quelles livraisons sont nécessaires pour publier votre titre et le statut actuel de chaque livraison (succès, échec, absence, etc.) et si ce n’est pas le cas, pourquoi. Centralisez les données de livraison de vos éléments dans vos propres systèmes au lieu de vérifier manuellement Slate, ce qui vous donne une visibilité en temps réel sur toutes vos livraisons et types d’éléments. Vous pouvez utiliser l’API Asset Status pour consulter toutes les données actuellement disponibles dans l’onglet Éléments de Slate.
Pourquoi utiliser l’API Asset Status ?
- Opérations centralisées : importez les données de livraison des éléments directement dans vos propres systèmes, ainsi que dans vos autres canaux de distribution, sans avoir à vous connecter à Slate pour chaque vérification de statut
- Résolution plus rapide des problèmes : détectez immédiatement les problèmes de livraison et comprenez ce qui empêche la mise en ligne de vos titres, réduisant ainsi le délai de résolution
- Gestion proactive des éléments : surveillez l’intégralité de votre catalogue par programmation sur tous les territoires et types d’éléments, vous permettant de faire évoluer vos opérations au fur et à mesure de la croissance de votre activité
- Vérification de la livraison en temps réel : soyez instantanément au courant de la livraison de vos éléments ou de la présence d’erreurs nécessitant une action
Format de requête
L’API Asset Status utilise une simple structure de récupération via requête GET où tous les paramètres de requête sont transmis via l’URL. Aucun corps de requête n’est requis. Cela facilite l’intégration dans vos systèmes ainsi que les tests à l’aide de clients HTTP ou d’outils de ligne de commande standards. Créez simplement l’URL avec votre identifiant de titre et les filtres optionnels, puis envoyez une requête GET pour récupérer le statut actuel de vos livraisons d’éléments.
https://partnerapi.primevideo.com/v1/assets/{licensor}/status/{ALID}?marketplace={marketplace}
Ce tableau définit les paramètres que vous pouvez utiliser pour demander des informations sur le statut de vos éléments.
Paramètre |
Type |
Est obligatoire |
Description |
licensor |
Chaîne de caractères |
Oui |
L’identifiant de votre organisation fourni par Prime Video lors de l’intégration |
ALID |
Chaîne de caractères |
Oui |
Identifiant du titre (ALID ou SKU) correspondant à votre contribution |
marketplace |
Chaîne de caractères |
Non |
La région du site Amazon sur lequel le titre a été soumis. La valeur par défaut est GLOBAL et il n’est pas obligatoire de la fournir. Si vous recherchez un titre dans votre catalogue Classic Marketplace, veuillez indiquer lequel en tant que paramètre. Valeurs autorisées : GLOBAL, US, DE, JP, GB |
Exemples de requêtes
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123?marketplace=global
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123
Remarque : Plus les paramètres de votre requête sont spécifiques, plus votre réponse sera ciblée. Si vous omettez le paramètre optionnel « région du site », l’API renverra les informations de statut pour tous les périmètres applicables associés à cet ALID.
Schéma de réponse
Le schéma de réponse définit la structure des données renvoyées par l’API Asset Status. La compréhension de ces types de données vous aidera à analyser la réponse et à intégrer efficacement les informations de statut dans vos systèmes.
ProductStatus
La réponse de premier niveau contenant des informations sur le statut des éléments pour le titre demandé. Chaque réponse inclut des données de statut filtrées en fonction des paramètres de votre requête, ce qui vous permet de comprendre le statut de la livraison pour différents types d’éléments et d’exigences.
Nom du champ |
Type |
Est obligatoire |
Description |
Source |
DeliveryPlatform |
Oui |
Plateforme de diffusion source. Notez qu’il doit toujours s’agir de Prime Video. |
Destination |
DeliveryPublisher |
Oui |
L’alias du partenaire pour le titre recevant les éléments. |
Scope |
DeliveryScope |
Oui |
Informations sur l’étendue de la livraison |
PlatformIDs |
PlatformIdentifiers |
Oui |
Identifiants de plateforme |
OverallProgressCode |
ProgressCode |
Oui |
Code de progression global : Ready, Issue, In-Process, Missing |
ProgressDetail |
ProgressDetailItem[] |
Oui |
Liste des détails de la progression |
TitlePartStatus |
ProductTitlePartStatus[] |
Oui |
Informations sur le statut de la partie du titre |
Instructions |
ProductDeliveryInstruction[] |
Non |
Instructions de livraison |
Types pour DeliveryPlatform
Informations sur la plateforme de diffusion source.
Nom du champ |
Type |
Est obligatoire |
Description |
Platform |
Chaîne de caractères |
Oui |
Plateforme de diffusion source. Notez qu’il doit toujours s’agir de Prime Video. |
Types pour DeliveryPublisher
Informations sur l’éditeur de destination. Cela permet d’identifier votre organisation en tant que destinataire du contenu.
Nom du champ |
Type |
Est obligatoire |
Description |
Publisher |
Chaîne de caractères |
Oui |
L’alias du partenaire pour le titre recevant les éléments. |
Types pour DeliveryScope
Informations sur l’étendue de la livraison définissant le contexte de la requête sur le statut des éléments.
Nom du champ |
Type |
Est obligatoire |
Description |
ALID |
Chaîne de caractères |
Oui |
Identifiant logique de l’élément ou SKU |
Marketplace |
Chaîne de caractères |
Oui |
La région du site Amazon sur lequel le titre a été soumis. La valeur par défaut est GLOBAL et il n’est pas obligatoire de la fournir. |
Region |
Chaîne de caractères |
Non |
Région ou territoire |
FormatProfile |
Chaîne de caractères |
Non |
Qualité de la vidéo disponible. Valeurs autorisées : SD, HD, UHD, MAX |
LicenseType |
Chaîne de caractères |
Non |
Valeurs autorisées : SVOD, FVOD, EST, POEST, VOD |
BenefitID |
Chaîne de caractères |
Non |
Identifiant d’une chaîne ou d’un abonnement (obligatoire pour les offres SVOD) |
Types pour PlatformIdentifiers
Structure des identifiants de plateforme contenant des identifiants de titre.
Nom du champ |
Type |
Obligatoire |
Description |
GTI |
Chaîne de caractères |
Oui |
Identifiant de titre global (GTI) |
PublisherIDs |
PublisherIdentifier[] |
Oui |
Identifiants d’éditeur |
Types pour PublisherIdentifier
La liste des identifiants fournis par les partenaires.
Nom du champ |
Type |
Obligatoire |
Description |
ALID |
Chaîne de caractères |
Oui |
Identifiant du titre |
Marketplace |
Chaîne de caractères |
Oui |
La région du site Amazon sur lequel le titre a été soumis. La valeur par défaut est GLOBAL et il n’est pas obligatoire de la fournir. |
Types pour ProgressCode
Valeurs d’énumération des codes de progression indiquant le statut général de la livraison des éléments.
Valeur |
Description |
Ready |
Des éléments ont été ingérés |
Issue |
Il y a un problème avec la livraison ou le traitement des éléments |
In-Process |
Les éléments sont livrés et traités |
Missing |
Un élément spécifique n’a pas encore été livré |
Types pour ProgressDetailItem
Structure de l’objet de détails de progression fournissant des statistiques récapitulatives.
Nom du champ |
Type |
Obligatoire |
Description |
Progress |
ProgressCode |
Oui |
Code de progression |
Total |
Long |
Oui |
Nombre total d’éléments |
ActionNeeded |
Long |
Oui |
Nombre d’éléments sur le total nécessitant une action |
Types pour ProductTitlePartStatus
Structure de données de base représentant le statut d’une seule livraison d’élements requise. Cela inclut le statut de livraison, les exigences d’action et les données détaillées au niveau des transactions.
Nom du champ |
Type |
Est obligatoire |
Description |
PrimaryType |
Chaîne de caractères |
Oui |
Le type principal de l’élément |
SecondaryType |
Chaîne de caractères |
Oui |
Type secondaire : par exemple, si le type principal était IMAGE, le sous-type peut être 2:3 ou Affiche |
FormatProfile |
Chaîne de caractères |
Non |
Profil de format ou qualité |
Locale |
Chaîne de caractères |
Non |
Code de langue - par ex. en-US ou es-419 |
OfferContexts |
DeliveryScope[] |
Oui |
Chaque OfferContext représente une configuration d’offre spécifique (région, type de licence, profil de format, etc.) qui utilise l’élément |
ConditionalTitleParts |
ProductConditionalTitlePart[] |
Non |
Parties de titre conditionnelles |
RuleType |
Chaîne de caractères |
Oui |
Type de règle : required, recommended, conditional |
ActionType |
Chaîne de caractères |
Oui |
Type d’action |
RuleSources |
Chaîne de caractères[] |
Oui |
Sources des règles |
LastDelivery |
ProductDelivery |
Non |
Informations sur la dernière livraison |
PriorSuccessfulDelivery |
ProductDelivery |
Non |
Informations sur la livraison réussie préalable |
FirstDeliveryDate |
Chaîne de caractères |
Non |
Date de première livraison |
Progress |
ProgressCode |
Oui |
Code de progression : Ready, Issue, In-Process, Missing |
ExpectedDate |
Chaîne de caractères |
Non |
Date de livraison prévue |
EarliestStartDate |
Chaîne de caractères |
Non |
Date de début la plus proche |
Valeurs courantes pour PrimaryType
Le champ PrimaryType identifie la catégorie d’éléments en cours de livraison.
Valeur |
Description |
METADATA |
Métadonnées du titre (descriptions, distribution, équipe, etc.) |
VIDEO |
Fichiers vidéo Mezzanine. |
IMAGE |
Illustrations (illustration de boîtier, couverture, images représentant le héros, affiches) |
AUDIO |
Pistes audio |
TIMED_TEXT |
Sous-titres |
Valeurs courantes pour ActionType
Le champ ActionType indique si vous devez effectuer des actions concernant la livraison d’un élément spécifique.
Valeur |
Description |
ACTION_NEEDED |
L’élément est manquant ou comporte des erreurs qui doivent être résolues afin de publier le titre |
ACTION_RECOMMENDED |
L’élément n’est pas obligatoire mais recommandé pour une meilleure expérience client |
NO_ACTION_NEEDED |
L’élément a bien été livré, aucune action n’est requise |
Valeurs courantes pour RuleType
Le champ RuleType définit si un élément est obligatoire ou facultatif pour la publication de votre titre.
Valeur |
Description |
required |
Doit être livré pour que le titre soit publié |
recommended |
Non obligatoire mais améliore l’expérience client |
conditional |
Obligatoire uniquement si certaines conditions sont remplies |
Types pour ProductConditionalTitlePart
Structure pour partie conditionnelle du titre définissant les exigences conditionnelles pour la livraison d’éléments.
Nom du champ |
Type |
Est obligatoire |
Description |
RuleType |
Chaîne de caractères |
Oui |
Type de règle |
Regions |
Chaîne de caractères[] |
Oui |
Liste des régions ou territoires |
TitleParts |
ProductTitlePartDescriptor[] |
Oui |
Parties du titre |
Valeurs pour RuleType
Le champ RuleType définit la relation logique entre les parties conditionnelles du titre.
Valeur |
Description |
NESTED |
Toutes les parties du titre dans la structure doivent être satisfaites (logique AND) |
SINGLE |
N’importe laquelle des parties du titre répond à l’exigence (logique OR) |
Types pour ProductTitlePartDescriptor
Structure de descripteur de partie de titre définissant une exigence spécifique de partie de titre.
Nom du champ |
Type |
Est obligatoire |
Description |
PrimaryType |
Chaîne de caractères |
Oui |
Le type principal de l’élément |
SecondaryType |
Chaîne de caractères |
Oui |
Type secondaire : par exemple, si le type principal était IMAGE, le sous-type peut être 2:3 ou Affiche |
FormatProfile |
Chaîne de caractères |
Non |
Profil de format ou qualité |
Locale |
Chaîne de caractères |
Non |
Code de langue - par ex. en-US ou es-419 |
Types pour ProductDelivery
Informations sur la livraison du produit fournissant des informations détaillées sur la livraison d’un élément. Ce champ sera nul si l’élément n’a pas encore été livré.
Nom du champ |
Type |
Est obligatoire |
Description |
Status |
Chaîne de caractères |
Non |
Statut de la livraison : NOT_DELIVERED ou SUCCESSFULLY_DELIVERED |
FileName |
Chaîne de caractères |
Non |
Nom du fichier |
Hash |
Chaîne de caractères |
Non |
Hachage ou somme de contrôle de fichier |
DeliveredDate |
Chaîne de caractères |
Non |
Date de livraison au format ISO 8601 |
Locale |
Chaîne de caractères |
Non |
Locale |
ServiceProvider |
Chaîne de caractères |
Non |
Fournisseur de services ou compte de livraison |
PresentationType |
Chaîne de caractères |
Non |
Type de présentation |
DynamicRangeType |
Chaîne de caractères |
Non |
Type de plage dynamique |
Instructions |
ProductDeliveryInstruction[] |
Non |
Instructions de livraison ou erreurs |
Valeurs courantes pour Status
Le champ Status indique si la livraison d’un élément a été correctement reçue et traitée.
Valeur |
Description |
SUCCESSFULLY_DELIVERED |
L’élément a été correctement livré et traité |
NOT_DELIVERED |
L’élément n’a pas été reçu |
Types pour ProductDeliveryInstruction
Structure d’instructions de livraison du produit fournissant des codes d’erreur et des informations sur le statut. Les instructions peuvent apparaître dans la réponse de niveau supérieur (résumant tous les problèmes de livraison) ou dans les objets ProductDelivery (spécifiques aux livraisons d’éléments individuels).
Nom du champ |
Type |
Est obligatoire |
Description |
TitlePart |
ProductTitlePartDescriptor |
Non |
Descripteur de la partie du titre |
TitlePartStatus |
Chaîne de caractères |
Non |
Statut de livraison de la partie du titre |
ErrorCode |
Chaîne de caractères |
Non |
Code d’erreur |
Regions |
Chaîne de caractères[] |
Non |
Liste des régions ou territoires |
Valeurs courantes pour TitlePartStatus
Le champ TitlePartStatus indique le statut de livraison d’un élément dans les messages d’instructions.
Valeur |
Description |
NOT_DELIVERED |
L’élément n’a pas été livré |
SUCCESSFULLY_DELIVERED |
L’élément a été correctement livré |
Remarque : Les schémas ci-dessus représentent la structure de réponse actuelle de l’API et pourront être améliorés dans les prochaines versions.