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 (par exemple, réussite, échec, manquante) et, dans le cas contraire, pourquoi. Centralisez les données de livraison de vos actifs 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 tous les types d’actifs. Vous pouvez utiliser l’API Statut des actifs pour consulter toutes les données actuellement disponibles dans l’onglet Ressources de Slate.
Pourquoi utiliser l’API Asset Status ?
- Opérations centralisées : intégrez les données de livraison des actifs 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 déterminez ce qui empêche la mise en ligne de vos titres, réduisant ainsi le temps de résolution
- Gestion proactive des actifs : surveillez l’intégralité de votre catalogue de manière programmatique sur tous les territoires et types d’actifs, ce qui vous permet d’adapter les opérations à la croissance de votre entreprise
- Vérification de la livraison en temps réel — Sachez instantanément quand vos actifs ont été livrés avec succès ou s’il existe des erreurs nécessitant une action
Format de demande
L’API Asset Status utilise une structure de requête simple de récupération via GET dans laquelle 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 et les tests à l’aide de clients HTTP standard ou d’outils de ligne de commande. Créez simplement l’URL avec votre identifiant de titre et des filtres facultatifs, puis envoyez une requête GET pour récupérer le statut actuel de vos livraisons d’actifs.
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 l’état des actifs.
Paramètre |
Type |
Est obligatoire |
Description |
donneur de licence |
Corde |
Oui |
L’identifiant de votre organisation fourni par Prime Video lors de l’intégration |
ALID |
Corde |
Oui |
Identifiant du titre (ALID ou SKU) correspondant à votre contribution |
marché |
Corde |
Non |
L’Amazon Marketplace auquel le titre a été soumis. La valeur par défaut est GLOBAL et il n’est pas nécessaire de le fournir. Si vous recherchez un titre dans votre catalogue Classic Marketplace, veuillez indiquer lequel comme paramètre. Valeurs autorisées : GLOBAL, US, DE, JP, GB |
Exemples de demandes
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 demande sont précis, plus votre réponse sera ciblée. Si vous omettez le paramètre optionnel Marketplace, l’API renvoie des informations d’état pour toutes les étendues applicables associées à 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 d’état dans vos systèmes.
ProductStatus
La réponse de haut niveau contenant les informations sur l’état de l’actif pour le titre demandé. Chaque réponse inclut des données d’état filtrées en fonction des paramètres de votre demande, ce qui vous permet de comprendre l’état de livraison selon les différents types d’actifs et exigences.
Nom du champ |
Type |
Est obligatoire |
Description |
La source |
Plateforme de livraison |
Oui |
Plateforme de diffusion des sources. Notez qu’il doit toujours s’agir de Prime Video. |
Destination |
Editeur de livraison |
Oui |
Alias du partenaire pour le titre recevant les actifs. |
Champ |
Étendue de la livraison |
Oui |
Informations sur le périmètre de livraison |
ID de plate-forme |
Identifiants de plateforme |
Oui |
Identifiants de plateforme |
Code de progression global |
Code de progression |
Oui |
Code de progression global : Prêt, Problème, En cours, Manquant |
Détail de la progression |
ProgressDetailItem [] |
Oui |
Liste des détails de progression |
État de la pièce de titre |
Titre du produit, état de la pièce [] |
Oui |
Informations sur le statut de la pièce de titre |
Instructions |
Instructions de livraison du produit [] |
Non |
Instructions de livraison |
Type de plateforme de livraison
Informations sur la plateforme de livraison source.
Nom du champ |
Type |
Est obligatoire |
Description |
Plateforme |
Corde |
Oui |
Plateforme de diffusion des sources. Notez qu’il doit toujours s’agir de Prime Video. |
DeliveryPublisher Type
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 |
Editeur |
Corde |
Oui |
Alias du partenaire pour le titre recevant les actifs. |
Type DeliveryScope
Informations sur l’étendue de livraison définissant le contexte de la requête sur l’état de l’actif.
Nom du champ |
Type |
Est obligatoire |
Description |
ALID |
Corde |
Oui |
Identifier logique ou SKU de l’actif |
Marketplace |
Corde |
Oui |
L’Amazon Marketplace auquel le titre a été soumis. La valeur par défaut est GLOBAL et il n’est pas nécessaire de le fournir. |
Region |
Corde |
Non |
Region ou territoire |
FormatProfile |
Corde |
Non |
Qualité des vidéos disponibles. Valeurs autorisées : SD, HD, UHD, MAX |
LicenseType |
Corde |
Non |
Valeurs autorisées : SVOD, FVOD, EST, POEST, VOD |
ID de prestation |
Corde |
Non |
Identifier une chaîne ou un abonnement (obligatoire pour les offres SVOD) |
Type PlatformIdentifiers
Structure des identifiants de plateforme contenant les identifiants de titre.
Nom du champ |
Type |
Nécessaire |
Description |
GTI |
Corde |
Oui |
Identifier le titre global |
Identifiants de l’éditeur |
Identifiant de l’éditeur [] |
Oui |
Identifiants de l’éditeur |
Type d’identifiant de publication
La liste des identifiants fournis par le partenaire.
Nom du champ |
Type |
Nécessaire |
Description |
ALID |
Corde |
Oui |
Identifier le titre |
Marketplace |
Corde |
Oui |
L’Amazon Marketplace auquel le titre a été soumis. La valeur par défaut est GLOBAL et il n’est pas nécessaire de le fournir. |
Type ProgressCode
Valeurs d’énumération du code de progression indiquant l’état général de la livraison des actifs.
Value |
Description |
Prêt |
Les actifs ont été ingérés |
Problème |
Un problème est survenu lors de la livraison ou du traitement des actifs |
En cours |
Les actifs sont livrés et traités |
Manquant |
Un actif spécifique n’a pas encore été livré |
Type ProgressDetailItem
Structure détaillée des éléments de progression fournissant des statistiques récapitulatives.
Nom du champ |
Type |
Nécessaire |
Description |
Progrès |
Code de progression |
Oui |
Code de progression |
Total |
Longue |
Oui |
Nombre total d’actifs |
Action nécessaire |
Longue |
Oui |
Nombre d’actifs nécessitant une action par rapport au nombre total |
Type ProductTitlePartStatus
Structure de données de base représentant l’état d’une livraison d’actifs unique requise. Cela inclut le statut de livraison, les mesures à prendre et les données détaillées au niveau des transactions.
Nom du champ |
Type |
Est obligatoire |
Description |
Type principal |
Corde |
Oui |
Type principal de l’actif |
Type secondaire |
Corde |
Oui |
Type secondaire : par exemple, si le type principal était IMAGE, le sous-type peut être 2x3 ou Poster. |
FormatProfile |
Corde |
Non |
Format, profil ou qualité |
Local |
Corde |
Non |
Locale - ex en-US ou es-419 |
Contextes d’offre |
Périmètre de livraison [] |
Oui |
Chaque OfferContext représente une configuration d’offre spécifique (région, type de licence, profil de format, etc.) qui utilise l’actif |
Pièces de titre conditionnelles |
Titre conditionnel du produit, partie [] |
Non |
Parties du titre conditionnelles |
Type de règle |
Corde |
Oui |
Type de règle : obligatoire, recommandé, conditionnel |
Type d’action |
Corde |
Oui |
type d’action |
Sources de règles |
Chaîne [] |
Oui |
Sources de règles |
Dernière livraison |
Livraison du produit |
Non |
Dernières informations de livraison |
Livraison réussie antérieure |
Livraison du produit |
Non |
Informations de livraison antérieures réussies |
Date de première livraison |
Corde |
Non |
Date de première livraison |
Progrès |
Code de progression |
Oui |
Code de progression : Prêt, Problème, En cours, Manquant |
Date prévue |
Corde |
Non |
Date de livraison prévue |
Date de début la plus proche |
Corde |
Non |
Date de début la plus proche |
Valeurs PrimaryType communes
Le champ PrimaryType identifie la catégorie d’actif livré.
Value |
Description |
MÉTADONNÉES |
Métadonnées du titre (descriptions, acteurs, équipe, etc.) |
VIDÉO |
Fichiers Video Mezzanine |
IMAGE |
Œuvres d’art (coffret, couverture, images de héros, affiches) |
AUDIO |
Pistes audio |
TEXTE_CHRONOMÉTRÉ |
Sous-titres et légendes |
Valeurs ActionType communes
Le champ ActionType indique si vous devez prendre des mesures concernant une livraison d’actifs spécifique.
Value |
Description |
ACTION NÉCESSAIRE |
La ressource est manquante ou contient des erreurs qui doivent être corrigées pour que le titre soit publié |
ACTION RECOMMANDÉE |
L’actif n’est pas obligatoire mais recommandé pour une meilleure expérience client |
AUCUNE ACTION NÉCESSAIRE |
L’actif est livré avec succès, aucune action n’est requise |
Valeurs de type de règle communes
Le champ RuleType définit si une ressource est obligatoire ou facultative pour la publication de votre titre.
Value |
Description |
requis |
Doit être livré pour que le titre soit publié |
recommandé |
Non obligatoire mais améliore l’expérience client |
conditionnel |
Obligatoire uniquement si certaines conditions sont remplies |
ProductConditionalTitlePart Type
De titre conditionnel Structure d’article définissant les exigences conditionnelles pour la livraison des actifs.
Nom du champ |
Type |
Est obligatoire |
Description |
Type de règle |
Corde |
Oui |
type de règle |
Régions |
Chaîne [] |
Oui |
Liste des régions ou territoires |
Pièces du titre |
Description de la pièce du titre du produit [] |
Oui |
Parties du titre |
Valeurs RuleType
Le champ RuleType définit la relation logique entre les parties conditionnelles du titre.
Value |
Description |
IMBRIQUÉ |
Tous/Toutes les parties du titre de la structure doivent être satisfaites (ET logique) |
UNIQUE |
N’importe laquelle des parties du titre répond à l’exigence (logique OR) |
ProductTitlePartDescriptor Type
Structure du descripteur de pièce de titre définissant une exigence spécifique d’article de titre.
Nom du champ |
Type |
Est obligatoire |
Description |
Type principal |
Corde |
Oui |
Type principal de l’actif |
Type secondaire |
Corde |
Oui |
Type secondaire : par exemple, si le type principal était IMAGE, le sous-type peut être 2x3 ou Poster. |
FormatProfile |
Corde |
Non |
Format, profil ou qualité |
Local |
Corde |
Non |
Locale - ex en-US ou es-419 |
Type de livraison
Du produit Informations de livraison du produit fournissant des informations détaillées sur la livraison d’un actif. Ce champ sera nul si l’actif n’a pas encore été livré.
Nom du champ |
Type |
Est obligatoire |
Description |
Statut |
Corde |
Non |
État de livraison : NOT_DELIVERED ou SUCCESSFULLY_DELIVERED |
Nom du fichier |
Corde |
Non |
Nom du fichier |
Hash |
Corde |
Non |
Hachage ou somme de contrôle du fichier |
Date de livraison |
Corde |
Non |
Date de livraison au format ISO 8601 |
Local |
Corde |
Non |
Local |
ServiceProvider |
Corde |
Non |
Prestataire de services ou compte de livraison |
Type de présentation |
Corde |
Non |
Type de présentation |
Type de plage dynamique |
Corde |
Non |
type de plage dynamique |
Instructions |
Instructions de livraison du produit [] |
Non |
Instructions de livraison ou erreurs |
Valeurs de statut communes
Le champ Statut indique si la livraison d’un actif a été reçue et traitée avec succès.
Value |
Description |
LIVRÉ AVEC SUCCÈS |
L’actif a été livré et traité avec succès |
NON LIVRÉ |
L’actif n’a pas été reçu |
Type d’instruction de livraison du produit
Structure des instructions de livraison du produit fournissant des codes d’erreur et des informations d’état. Les instructions peuvent apparaître dans la réponse de haut niveau (résumant tous les problèmes de livraison) ou dans les objets ProductDelivery (spécifiques aux livraisons d’actifs individuelles).
Nom du champ |
Type |
Est obligatoire |
Description |
Titre (partie 1) |
Titre du produit, description de la pièce |
Non |
Titre, descripteur de pièce |
État de la pièce de titre |
Corde |
Non |
État de livraison de la pièce de titre |
Code d’erreur |
Corde |
Non |
Code d’erreur |
Régions |
Chaîne [] |
Non |
Liste des régions ou territoires |
Valeurs communes de TitlePartStatus
Le champ TitlePartStatus indique l’état de livraison d’un actif dans les messages d’instructions.
Value |
Description |
NON LIVRÉ |
L’actif n’a pas été livré |
LIVRÉ AVEC SUCCÈS |
L’actif a été livré avec succès |
Remarque : Les schémas ci-dessus représentent la structure de réponse actuelle de l’API et peuvent être améliorés dans les versions futures.
Exemple 2 : Ressources requises manquantes
Cet exemple illustre une réponse de l’API lorsque les ressources requises sont manquantes, en montrant comment l’API indique le statut ACTION_NEEDED et fournit des informations d’erreur.
{
"Destination": {
"Publisher": "1cendgametestpartner1"
},
"Instructions": [
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "HD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": {
"FormatProfile": null,
"Locale": "ja",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
"TitlePartStatus": "SUCCESSFULLY_DELIVERED"
}
],
"OverallProgressCode": "Issue",
"ProgressDetail": [
{
"ActionNeeded": 0,
"Progress": "Ready",
"Total": 8
},
{
"ActionNeeded": 2,
"Progress": "Missing",
"Total": 2
}
],
"Scope": {
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": null,
"FormatProfile": null,
"LicenseType": null,
"Marketplace": "GLOBAL",
"Region": null
},
"TitlePartStatus": [
{
"ActionType": "ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE", "PR", "AU", "JP", "GB", "US", "CA"],
"RuleType": "NESTED",
"TitleParts": [
{
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
}
]
}
],
"EarliestStartDate": "Thu Jan 09 15:00:00 UTC 2025",
"FormatProfile": "SD",
"LastDelivery": null,
"Locale": null,
"OfferContexts": [
{
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": "Prime",
"FormatProfile": "SD",
"LicenseType": "SVOD",
"Marketplace": "GLOBAL",
"Region": "US"
}
],
"PrimaryType": "VIDEO",
"PriorSuccessfulDelivery": null,
"Progress": "Missing",
"RuleSources": ["PUBLISHING_SPEC"],
"RuleType": "REQUIRED",
"SecondaryType": "MEZZ"
},
{
"ActionType": "NO_ACTION_NEEDED",
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "ja-jp",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "ja",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
},
{
"ActionType": "NO_ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE"],
"RuleType": "SINGLE",
"TitleParts": [
{
"FormatProfile": null,
"Locale": "de",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
{
"FormatProfile": null,
"Locale": "en",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
}
]
}
],
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "de-de",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "de",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
}
]
}
