Skip to main content

​
GET (/media//fields)

Obtient le jeton des champs. Le domaine de ces URI est eds.xboxlive.com.

​
Remarques

Par défaut, les API d’Entertainment Discovery Services (EDS) renvoient un ensemble minimal très restreint de champs pour chaque élément :
  • Type d’élément multimédia
  • Groupe multimédia
  • Id
  • Nom
Pour obtenir plus d’informations, les API acceptent un paramètre fields qui spécifie les données supplémentaires à renvoyer. Comme il existe de nombreux champs possibles, spécifier leur nom complet dans chaque appel d’API alourdirait considérablement 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 pour lesquels des données existent (par exemple, si « AvatarBodyType » est inclus dans l’appel à GET (/media/{marketplaceId}/fields), seuls les AvatarItems contiendront ce champ). Les valeurs renvoyé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 une 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 champs réels, cette API accepte « all » comme valeur valide. Cela génère une valeur qui contient chaque champ qu’il est possible de spécifier. L’utilisation de la valeur « all » est recommandée uniquement à des fins de développement, de débogage et de test. Vous pouvez aussi envoyer desired={list of fields separated by a '.'} à toute API qui accepte le jeton fields. Vous ne pouvez pas transmettre desired et fields en même temps.

​
Paramètres d’URI

​
Paramètres de chaîne de requête

| Paramètre| Type| Description| | --- | --- | --- | --- | --- | --- | | desired| chaîne| Obligatoire. Liste de champs séparés par « . » qui doivent être renvoyés en plus de l’ensemble minimal. Il n’est pas garanti que tous les champs spécifiés soient renvoyés pour chaque objet (les données peuvent simplement ne pas exister pour certains éléments), mais aucun champ hors de l’ensemble minimal qui n’est pas spécifié ici ne sera renvoyé. |

​
Voir aussi

Parent
/media//fields
Informations supplémentaires
En-têtes communs d’EDS Paramètres d’EDS Affineurs de requête d’EDS URI de Marketplace Référence supplémentaire
Last modified on October 6, 2026