GET (/scids//leaderboards/?include=valuemetadata)
Obtiene una tabla de clasificación global predefinida junto con los metadatos asociados a los valores de la tabla de clasificación. El dominio de estos URI esleaderboards.xboxlive.com.
- Comentarios
- Parámetros de URI
- Parámetros de cadena de consulta
- Autorización
- Efecto de la configuración de privacidad en el recurso
- Encabezados de solicitud obligatorios
- Encabezados de solicitud opcionales
- Códigos de estado HTTP
- Encabezados de respuesta
- Cuerpo de la respuesta
Comentarios
El parámetro de consulta ?include=valuemetadata permite que la respuesta incluya los metadatos asociados a los valores de la tabla de clasificación. Los metadatos de valor contienen datos especificados por el cliente asociados al valor, como el modelo y el color de un coche usado para lograr el mejor tiempo en un circuito de carreras. Los metadatos de valor se definen en la estadística de usuario en la que se basa la tabla de clasificación, no en la propia tabla de clasificación. Las API de tablas de clasificación son todas de solo lectura y, por lo tanto, solo admiten el verbo GET. Reflejan “páginas” clasificadas y ordenadas de estadísticas de jugador indexadas que se derivan de las estadísticas de usuario individuales que se escribieron a través del sistema de datos de jugador. Los índices completos de una tabla de clasificación pueden ser bastante grandes y los autores de llamadas nunca pedirán verlos en su totalidad; por lo tanto, este URI admite varios argumentos de cadena de consulta que permiten al autor de la llamada especificar qué tipo de vista quiere ver de esa tabla de clasificación. Las operaciones GET no modifican ningún recurso, por lo que producirán los mismos resultados si se ejecutan una o varias veces.Parámetros de URI
Parámetros de cadena de consulta
| Parámetro| Tipo| Descripción| | --- | --- | --- | --- | --- | --- | | include=valuemetadata| string| Indica que la respuesta incluye los metadatos de valor asociados a los valores de la tabla de clasificación.| | maxItems| Entero de 32 bits sin signo| Número máximo de registros de la tabla de clasificación que se devuelven en una página de resultados. Si no se especifica, se devolverá un número predeterminado (10). El valor máximo de maxItems aún no está definido, pero queremos evitar conjuntos de datos grandes, por lo que este valor probablemente debería apuntar al conjunto más grande que una interfaz de usuario pueda controlar por llamada.| | skipToRank| Entero de 32 bits sin signo| Devuelve una página de resultados que comienza en la posición especificada de la tabla de clasificación. El resto de los resultados estará ordenado por posición. Esta cadena de consulta puede devolver un token de continuación que se puede pasar en una consulta posterior para obtener “la página siguiente” de resultados.| | skipToUser| string| Devuelve una página de resultados de la tabla de clasificación en torno al xuid del jugador especificado, independientemente de la posición o puntuación de ese usuario. La página se ordenará por posición de percentil con el usuario especificado en la última posición de la página para las vistas predefinidas, o en el medio para las vistas de tabla de clasificación de estadísticas. No se proporciona continuationToken para este tipo de consulta.| | continuationToken| string| Si una llamada anterior devolvió un continuationToken, el autor de la llamada puede devolver ese token “tal cual” en una cadena de consulta para obtener la página siguiente de resultados.|Autorización
Hay lógica de autorización implementada para escenarios de aislamiento de contenido y control de acceso.- Tanto las tablas de clasificación como las estadísticas de usuario se pueden leer desde clientes de cualquier plataforma, siempre que el autor de la llamada envíe un token XSTS válido con la solicitud. Obviamente, las escrituras están limitadas a los clientes compatibles con el sistema de datos de jugador.
- Los desarrolladores de títulos pueden marcar las estadísticas como abiertas o restringidas con Partner Center. Las tablas de clasificación son estadísticas abiertas. Las estadísticas abiertas son accesibles desde Smartglass, así como desde aplicaciones de iOS, Android, Windows, Windows Phone y web, siempre que el usuario esté autorizado en el sandbox. La autorización del usuario en un sandbox se administra mediante Partner Center.