GET (/scids//leaderboards/?include=valuemetadata)
Obtient un classement global prédéfini ainsi que toutes les métadonnées associées aux valeurs du classement. Le domaine de ces URI estleaderboards.xboxlive.com.
- Remarques
- Paramètres d’URI
- Paramètres de chaîne de requête
- Autorisation
- Effet des paramètres de confidentialité sur la ressource
- En-têtes de requête obligatoires
- En-têtes de requête facultatifs
- Codes d’état HTTP
- En-têtes de réponse
- Corps de la réponse
Remarques
Le paramètre de requête ?include=valuemetadata permet à la réponse d’inclure toutes les métadonnées associées aux valeurs du classement. Les métadonnées de valeur contiennent des données spécifiées par le client associées à la valeur, comme le modèle et la couleur d’une voiture utilisée pour obtenir le meilleur temps sur une piste de course. Les métadonnées de valeur sont définies sur la statistique utilisateur sur laquelle repose le classement, et non sur le classement lui-même. Les API de classement sont toutes en lecture seule et ne prennent donc en charge que le verbe GET. Elles reflètent des « pages » classées et triées de statistiques de joueurs indexées, dérivées des statistiques individuelles des utilisateurs écrites au moyen du système Player Data. Les index de classement complets peuvent être assez volumineux, et les appelants ne demanderont jamais à en voir un dans son intégralité; cet URI prend donc en charge plusieurs arguments de chaîne de requête qui permettent à l’appelant de préciser le type de vue qu’il souhaite obtenir de ce classement. Les opérations GET ne modifient aucune ressource; elles produisent donc les mêmes résultats, qu’elles soient exécutées une ou plusieurs fois.Paramètres d’URI
Paramètres de chaîne de requête
| Paramètre| Type| Description| | --- | --- | --- | --- | --- | --- | | include=valuemetadata| chaîne| Indique que la réponse inclut toutes les métadonnées de valeur associées aux valeurs du classement.| | maxItems| entier non signé de 32 bits| Nombre maximal d’enregistrements de classement à retourner dans une page de résultats. S’il n’est pas spécifié, un nombre par défaut sera retourné (10). La valeur maximale de maxItems n’est pas encore définie, mais nous voulons éviter les grands ensembles de données; cette valeur devrait donc viser le plus grand ensemble qu’une interface utilisateur de syntonisation pourrait gérer par appel.| | skipToRank| entier non signé de 32 bits| Retourne une page de résultats commençant au rang de classement spécifié. Le reste des résultats sera trié par rang. Cette chaîne de requête peut retourner un jeton de continuation qui peut être réinjecté dans une requête subséquente pour obtenir « la page suivante » de résultats.| | skipToUser| chaîne| Retourne une page de résultats de classement autour du xuid du joueur spécifié, quel que soit le rang ou le score de cet utilisateur. La page sera triée par rang centile, l’utilisateur spécifié occupant la dernière position de la page pour les vues prédéfinies, ou le milieu pour les vues de classement de statistiques. Aucun continuationToken n’est fourni pour ce type de requête.| | continuationToken| chaîne| Si un appel précédent a retourné un continuationToken, l’appelant peut renvoyer ce jeton « tel quel » dans une chaîne de requête pour obtenir la page de résultats suivante.|Autorisation
Une logique d’autorisation est mise en œuvre pour les scénarios d’isolement du contenu et de contrôle d’accès.- Les classements et les statistiques utilisateur peuvent être lus à partir de clients sur n’importe quelle plateforme, à condition que l’appelant soumette un jeton XSTS valide avec la requête. Les écritures sont évidemment limitées aux clients pris en charge par le système Player Data.
- Les développeurs de titres peuvent marquer les statistiques comme ouvertes ou restreintes avec Partner Center. Les classements sont des statistiques ouvertes. Les statistiques ouvertes sont accessibles par Smartglass, ainsi que par les applications iOS, Android, Windows, Windows Phone et Web, tant que l’utilisateur est autorisé dans le sandbox. L’autorisation des utilisateurs dans un sandbox est gérée au moyen de Partner Center.