Skip to main content

​
GET (/media//fields)

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

​
Remarques

Par défaut, les API Entertainment Discovery Services (EDS) renvoient 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 davantage 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. À la place, les noms peuvent être transmis à cette API, qui génère une valeur beaucoup plus courte pouvant être transmise aux autres API. Pour toute API qui accepte ce paramètre, la valeur fournie doit être le sur-ensemble 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ît 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 contiennent 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 vous souhaitez utiliser un cache, il est recommandé que sa durée ne dépasse pas la session de l’utilisateur. En plus des noms de champs réels, cette API accepte « all » comme valeur valide. Cela génère une valeur qui contient tous les champs 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 également envoyer desired={list of fields separated by a '.'} à toute API qui accepte le jeton fields. Vous ne pouvez pas transmettre desired et fields simultanément.

​
Paramètres d’URI

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

| Paramètre| Type| Description| | --- | --- | --- | --- | --- | --- | | desired| string| Requis. Liste, séparée par des ’.’, des champs à renvoyer 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 non spécifié ici ne sera renvoyé. |

​
Voir aussi

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