Skip to main content

​
API EDS auxiliaires

Plusieurs API d’Entertainment Discovery Services (EDS) ne fournissent pas directement d’informations sur le contenu, mais donnent des informations générales sur la façon d’utiliser le service ou aident à piloter des modèles d’interface utilisateur courants.

​
API auxiliaires

​
Valeurs des paramètres d’API

Cette API décrit les paramètres qui peuvent être utilisés avec le service. Les informations retournées sont utilisables par l’interface utilisateur du client, car un texte localisé accompagne chaque paramètre. Aucune des API ci-dessous n’accepte de paramètres de requête. | API| URI| Description| | --- | --- | --- | --- | --- | --- | | Types| //metadata/mediaGroups| La liste complète des groupes de médias| | Types d’éléments multimédias par groupe de médias| //metadata/mediaGroups//mediaItemTypes| La liste des types d’éléments multimédias contenus dans le groupe de médias donné.| | Tous les types d’éléments multimédias| //metadata/mediaItemTypes| La liste complète des types d’éléments multimédias| | Champs par type d’élément multimédia| //metadata/mediaItemTypes//fields| La liste des champs d’un seul type d’élément multimédia| | Affineurs de requête| //metadata/mediaItemTypes//queryRefiners| La liste des affineurs de requête pris en charge pour le type d’élément multimédia donné| | Toutes les valeurs d’affineur de requête| //metadata/mediaItemTypes//queryRefiners/| Les valeurs de l’affineur de requête spécifié pour le type d’élément multimédia donné| | Toutes les sous-valeurs d’affineur de requête| //metadata/mediaItemTypes//queryRefiners//subQueryRefinerValues| La liste des sous-valeurs pour une valeur d’affineur de requête donnée (p. ex. « sous-genres d’un genre donné »). La valeur de l’affineur de requête est transmise sous forme de paramètre de chaîne de requête nommé « queryRefinerValue », ce qui permet de transmettre des valeurs d’affineur de requête contenant des caractères interdits dans les radicaux d’URI.| | Tris| //metadata/mediaItemTypes//sortOrders| La liste des ordres de tri pour le type d’élément multimédia donné|

​
Générateur de classification de contenu combinée

L’application du contrôle parental sur le contenu que les enfants sont autorisés à voir est une tâche complexe. Non seulement chaque type d’élément multimédia possède son propre système de classification, mais ces systèmes de classification peuvent varier d’un pays ou d’une région à l’autre. Cela signifie que plusieurs éléments de données différents doivent être spécifiés pour filtrer correctement tous les éléments. Au lieu de spécifier tous les paramètres dans tous les appels d’API, cette API génère une valeur à transmettre aux paramètres combinedContentRating des autres API tout en communiquant les mêmes informations. Cela vise à rendre les API plus faciles à utiliser et à maintenir, puisque les différents paramètres transmis à cette API sont regroupés en une seule valeur réutilisable pour les autres API. Bien que les valeurs exactes retournées par cette API puissent éventuellement changer, elles devraient changer très rarement (par exemple, entre les versions d’EDS) et pourraient donc être mises en cache pendant de longues périodes. Toute API acceptant un paramètre combinedContentRating renverra un message d’erreur explicite si la valeur transmise n’est pas valide, ce qui indique que l’appelant doit simplement appeler de nouveau cette API pour obtenir une valeur à jour. Si une API accepte un paramètre combinedContentRating, mais qu’aucun n’est fourni, aucun filtrage du contenu basé sur le contrôle parental n’aura lieu
Remarque :
Cela ne signifie pas que seul le contenu « sécuritaire » est retourné; cela signifie que tout le contenu est retourné, y compris le contenu potentiellement explicite).

​
Nom de champ combiné

Par défaut, les API EDS retournent un ensemble minimal très restreint de champs pour chaque élément :
  • Type d’élément multimédia
  • Groupe de médias
  • Id
  • Nom
Pour obtenir plus d’informations, les API acceptent un paramètre « fields » qui spécifie quelles données supplémentaires doivent être retournées. Comme il existe de nombreux champs possibles, spécifier leur nom complet pour chaque appel d’API alourdirait grandement la requête. Les noms peuvent plutôt être transmis à cette API, qui générera une valeur beaucoup plus petite pouvant être transmise aux autres API. Pour toute API qui accepte ce paramètre, la valeur fournie doit être le surensemble de tous les champs de tous les types d’éléments multimédias spécifiés. Il n’est pas possible de spécifier des ensembles de champs différents pour différents types d’éléments multimédias. Toutefois, si un champ s’applique à un type d’élément multimédia, mais pas à un autre, il n’apparaîtra que dans les types d’éléments multimédias où des données existent (p. ex. si « AvatarBodyType » est inclus dans l’appel à l’API Combined Field Name, seuls les AvatarItems contiendront le champ). Les valeurs retournées par cette API se prêtent très bien à la mise en cache; en fait, elles ne devraient changer qu’entre les déploiements d’EDS. Si la mise en cache est souhaitée, il est recommandé que le cache ne dure pas plus longtemps que la session de l’utilisateur.  En plus d’accepter les noms de champ réels, cette API accepte « all » comme valeur valide. Cela générera une valeur contenant chacun des champs qu’il est possible de spécifier. La valeur « all » ne devrait être utilisée qu’à des fins de développement, de débogage et de test.

​
Voir aussi

Parent
Référence supplémentaire
Informations supplémentaires
URI de Marketplace
Last modified on October 6, 2026