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 d’Entertainment Discovery Services (EDS), mais chacun est accepté par plus d’une 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 retournée (la taille de la page étant déterminée par le paramètre maxItems), accompagnée d’un jeton de continuation qui peut être utilisé pour obtenir la deuxième page de résultats. La deuxième page contiendrait le jeton de continuation de la troisième page de résultats, et ainsi de suite. |
| Desired | chaîne | Facultatif. Consultez l’API Combined Field Name. |
| desiredMediaItemTypes | tableau de chaînes | Facultatif. Ce paramètre détermine les types d’éléments à retourner dans la réponse. |
| Domain | chaîne | Facultatif. Le paramètre Domain détermine le contexte du marketplace 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 peut uniquement demander du contenu XBOX One (ou ultérieur). Si le client veut changer de domaine pour afficher du contenu XBOX 360, il doit spécifier « Xbox360 » pour Domain. Actuellement, les résultats interdomaines 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 seul le contenu interne est retourné ou si le contenu interne et le contenu tiers sont tous deux retournés par la requête. |
| freeOnly | Valeur booléenne | Paramètre de filtre facultatif. Limite les résultats au contenu gratuit seulement. |
| GroupBy | TK | Le paramètre groupBy sert à 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 retourner plusieurs listes d’éléments, le nombre d’éléments de 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 retourné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 des bandes-annonces. |
| 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 | Requis. Tous les ID (jusqu’à 10) pour lesquels les détails seront retourné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. Le type des ID transmis au paramètre ids. Les valeurs valides comprennent :
|
| latestOnly | Valeur booléenne | Paramètre de filtre facultatif. Limite les résultats à ceux ayant la date de sortie la plus récente. |
| maxItems | entier signé 32 bits | Facultatif. Détermine le nombre maximal d’éléments qui doivent être retournés par un appel. Les valeurs valides sont les nombres de 1 à 25 inclusivement. La valeur par défaut du paramètre est 25 s’il est omis. |
| mediaGroup | chaîne | Facultatif. Le groupe de médias des ID. Tous les ID fournis doivent partager le même groupe de médias. |
| MediaItemType | chaîne | Facultatif. Le 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 | Requis. Le paramètre orderBy détermine la façon dont les éléments retournés doivent être triés. Les valeurs courantes de ce champ sont énumérées ici, mais certaines API peuvent prendre en charge des valeurs supplémentaires.
|
| preferredProvider | chaîne | Facultatif. Si l’utilisateur a un fournisseur de contenu préféré, comme 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é seront affichées en haut de la liste des fournisseurs (si l’élément est offert par le fournisseur de contenu préféré). |
| q | chaîne | Requis. 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 sans groupes croisés, le paramètre skipItems sert à 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; ainsi, skipItems=0 (ou simplement l’omission de skipItems) commence la récupération au début de la liste. skipItems=3 ignorerait les trois premiers éléments de la liste et commencerait 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, si l’utilisateur a un abonnement payant ou gratuit). Les valeurs possibles sont les suivantes.
|
| TargetDevices | chaîne | EDS offre la possibilité de filtrer les offres selon les appareils cibles. Les offres (ProviderContent ou Availability) retourné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 évalué seulement. |