GET (/scids//leaderboards/)
Obtém um placar de líderes global predefinido. O domínio desses URIs éleaderboards.xboxlive.com.
- Comentários
- Parâmetros de URI
- Parâmetros da cadeia de caracteres de consulta
- Autorização
- Efeito das configurações de privacidade no recurso
- Cabeçalhos de solicitação obrigatórios
- Cabeçalhos de solicitação opcionais
- Códigos de status HTTP
- Cabeçalhos de resposta
- Corpo da resposta
Comentários
As APIs de placar de líderes são todas somente leitura e, portanto, só oferecem suporte ao verbo GET. Elas refletem “páginas” classificadas e ordenadas de estatísticas de jogadores indexadas, derivadas de estatísticas individuais de usuários que foram gravadas por meio do sistema Player Data. Índices completos de placares de líderes podem ser bem grandes, e os chamadores nunca pedirão para ver um em sua totalidade; portanto, este URI oferece suporte a vários argumentos de cadeia de caracteres de consulta que permitem que um chamador especifique que tipo de exibição deseja ver desse placar de líderes. As operações GET não modificam nenhum recurso; portanto, isso produzirá os mesmos resultados se executado uma vez ou várias vezes.Parâmetros de URI
Parâmetros da cadeia de caracteres de consulta
| Parâmetro| Tipo| Descrição| | --- | --- | --- | --- | --- | --- | | maxItems| inteiro sem sinal de 32 bits| Número máximo de registros do placar de líderes a serem retornados em uma página de resultados. Se não for especificado, um número padrão será retornado (10). O valor máximo de maxItems ainda não está definido, mas queremos evitar grandes conjuntos de dados; portanto, esse valor provavelmente deve visar o maior conjunto que uma interface do usuário de ajuste possa manipular por chamada.| | skipToRank| inteiro sem sinal de 32 bits| Retorna uma página de resultados começando pela classificação especificada no placar de líderes. O restante dos resultados estará ordenado por classificação. Essa cadeia de caracteres de consulta pode retornar um token de continuação que pode ser realimentado em uma consulta subsequente para obter “a próxima página” de resultados.| | skipToUser| string| Retorna uma página de resultados do placar de líderes em torno do xuid de jogador especificado, independentemente da classificação ou da pontuação desse usuário. A página será ordenada por classificação de percentil, com o usuário especificado na última posição da página para exibições predefinidas ou no meio para exibições de placar de líderes de estatísticas. Nenhum continuationToken é fornecido para esse tipo de consulta.| | continuationToken| string| Se uma chamada anterior retornou um continuationToken, o chamador poderá passar esse token “no estado em que se encontra” em uma cadeia de caracteres de consulta para obter a próxima página de resultados.|Autorização
Há uma lógica de autorização implementada para cenários de isolamento de conteúdo e controle de acesso.- Tanto os placares de líderes quanto as estatísticas de usuário podem ser lidos de clientes em qualquer plataforma, desde que o chamador envie um token XSTS válido com a solicitação. As gravações, obviamente, são limitadas aos clientes compatíveis com o sistema Player Data.
- Os desenvolvedores de títulos podem marcar estatísticas como abertas ou restritas com o Partner Center. Os placares de líderes são estatísticas abertas. As estatísticas abertas podem ser acessadas pelo Smartglass, bem como por aplicativos iOS, Android, Windows, Windows Phone e Web, desde que o usuário esteja autorizado na área restrita. A autorização do usuário em uma área restrita é gerenciada por meio do Partner Center.