Paramètres EDS
Paramètres de chaîne de requête
Ces paramètres de requête ne sont pas nécessairement acceptés par toutes les API Entertainment Discovery Services (EDS), mais chacun est accepté par plusieurs API.| Paramètre | Type | Description |
|---|---|---|
| combinedContentRating | chaîne | Facultatif. Consultez GET (/media//contentRating). |
| continuationToken | chaîne | Facultatif. Le jeton de continuation est un blob opaque qui contient les informations dont le service a besoin pour la pagination dans certains scénarios. Si la valeur est omise, la première page de résultats est renvoyée (la taille de page étant déterminée par le paramètre maxItems), accompagnée d’un jeton de continuation permettant d’obtenir la deuxième page de résultats. La deuxième page contient le jeton de continuation de la troisième page de résultats, et ainsi de suite. |
| Desired | chaîne | Facultatif. Consultez l’API Nom de champ combiné. |
| desiredMediaItemTypes | tableau de chaînes | Facultatif. Ce paramètre détermine les types d’éléments à renvoyer dans la réponse. |
| Domain | chaîne | Facultatif. Le paramètre Domain détermine le contexte de la place de marché de jeux et d’applications pour lequel le client effectue l’appel. Par défaut, le domaine est « Modern », ce qui indique que le client ne peut demander que du contenu XBOX One (ou ultérieur). Si le client souhaite changer de domaine pour afficher du contenu XBOX 360, il doit spécifier Domain sur « Xbox360 ». Actuellement, les résultats inter-domaines ne sont pas pris en charge. Les valeurs possibles sont :
|
| fields | chaîne | Facultatif. Consultez GET (/media//fields). |
| firstPartyOnly | valeur booléenne | Paramètre de filtre facultatif. Détermine si la requête renvoie uniquement du contenu interne (first-party) ou à la fois du contenu interne et tiers. |
| freeOnly | valeur booléenne | Paramètre de filtre facultatif. Limite les résultats au seul contenu gratuit. |
| GroupBy | TK | Le paramètre groupBy permet de classer le jeu de résultats en groupes, plutôt qu’en un seul jeu de résultats. La spécification de ce paramètre modifie le jeu de résultats pour renvoyer plusieurs listes d’éléments, le nombre d’éléments dans chaque compartiment étant déterminé par le paramètre maxItems.
|
| hasTrailer | valeur booléenne | Paramètre de filtre facultatif. Détermine si les éléments renvoyés doivent contenir une bande-annonce ou si la présence d’une bande-annonce est facultative. Si la valeur est true, tous les éléments doivent avoir une bande-annonce. |
| id | chaîne | Facultatif. S’il est fourni, limite les résultats aux seuls enfants de l’élément ayant l’ID donné. Si ce paramètre est fourni, MediaItemType doit également être spécifié. |
| ids | tableau de chaînes | Obligatoire. Tous les ID (jusqu’à 10) pour lesquels les détails seront renvoyés. Notez que tout ID contenant des caractères interdits dans une URL (les ID de type ProviderContentId sont normalement eux-mêmes des URL complètes et contiennent donc des caractères interdits) doit être encodé en URL pour être correctement envoyé à EDS. |
| idType | chaîne | Facultatif. Type des ID transmis au paramètre ids. Les valeurs valides sont notamment :
|
| latestOnly | valeur booléenne | Paramètre de filtre facultatif. Limite les résultats à ceux dont la date de sortie est la plus récente. |
| maxItems | entier signé 32 bits | Facultatif. Détermine le nombre maximal d’éléments à renvoyer par un appel. Les valeurs valides sont les nombres compris entre 1 et 25 inclus. La valeur par défaut est 25 si le paramètre est omis. |
| mediaGroup | chaîne | Facultatif. Groupe de médias des ID. Tous les ID fournis doivent partager le même groupe de médias. |
| MediaItemType | chaîne | Facultatif. Type de l’élément dont l’ID a été spécifié dans le paramètre id. Si le paramètre id est fourni, ce paramètre doit également être spécifié. |
| orderBy | chaîne | Obligatoire. Le paramètre orderBy détermine la façon dont les éléments renvoyés doivent être triés. Les valeurs courantes de ce champ sont répertoriées ici, mais certaines API peuvent prendre en charge des valeurs supplémentaires.
|
| preferredProvider | chaîne | Facultatif. Si l’utilisateur dispose d’un fournisseur de contenu préféré, tel que Comcast Xfinity ou Verizon FIOS, l’ID de ce fournisseur peut être transmis. Bien que l’ordre réel des éléments ne change pas, pour chaque élément, les informations du fournisseur spécifié s’affichent en haut de la liste des fournisseurs (si le fournisseur de contenu préféré propose l’élément). |
| q | chaîne | Obligatoire. Terme de requête utilisé dans la recherche. |
| queryRefiners | tableau de chaînes | Facultatif. Consultez la liste des affineurs de requête EDS. |
| relationship | chaîne | Facultatif. Filtre qui utilise le paramètre ID comme base pour rechercher d’autres produits correspondant au type de relation spécifié :
|
| ScopeId | chaîne | Ce paramètre est utilisé dans les scénarios de recherche inversée pour les médias vidéo. |
| ScopeIdType | chaîne | Ce paramètre est utilisé dans les scénarios de recherche inversée pour les médias vidéo. Valeurs possibles : Title. |
| skipItems | entier signé 32 bits | Facultatif. Pour la pagination dans les scénarios non inter-groupes, le paramètre skipItems permet de déterminer combien d’éléments ont déjà été vus (et donc quel élément doit être affiché en premier dans le jeu de résultats). La valeur commence à 0 : skipItems=0 (ou l’absence de skipItems) commence la récupération au début de la liste. skipItems=3 ignore les trois premiers éléments de la liste et commence la récupération au quatrième élément. |
| subscriptionLevel | tableau de chaînes | Paramètre de filtre facultatif. Le paramètre subscriptionLevel détermine le type d’abonnement de l’utilisateur (par exemple, s’il dispose d’un abonnement payant ou gratuit). Les valeurs possibles sont les suivantes.
|
| TargetDevices | chaîne | EDS offre la possibilité de filtrer les offres pour les appareils cibles. Les offres (ProviderContent ou Availability) renvoyées pour l’élément peuvent être limitées à un appareil cible. |
| topRatedOnly | valeur booléenne | Paramètre de filtre facultatif. Limite les résultats au contenu le mieux noté. |