Scores: listWindow

Lista as pontuações em um placar ao redor (e incluindo) a pontuação de um jogador. Faça o teste agora.

Solicitação

Solicitação HTTP

GET https://www.googleapis.com/games/v1/leaderboards/leaderboardId/window/collection

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
collection string O conjunto de pontuações que você está solicitando.

Os valores aceitáveis são:
  • "FRIENDS": lista apenas as pontuações dos amigos.
  • "PUBLIC": lista todas as pontuações no placar público.
  • "SOCIAL": (obsoleto) Pontuações sociais do Google+ legadas. Use a coleção FriendsS.
leaderboardId string É o ID do placar.
Parâmetros de consulta obrigatórios
timeSpan string O período para as pontuações e classificações solicitadas.

Os valores aceitáveis são:
  • "ALL_TIME": liste as melhores pontuações de todos os tempos.
  • "DAILY": exibe as pontuações mais altas do dia atual.
  • "WEEKLY": liste as pontuações mais altas da semana atual.
Parâmetros de consulta opcionais
language string O idioma preferencial a ser usado para strings retornadas por esse método.
maxResults integer O número máximo de pontuações de placar a serem retornadas na resposta. Para qualquer resposta, o número real de pontuações de placar retornadas pode ser menor que o maxResults especificado. Os valores aceitos são de 1 a 30, inclusive.
pageToken string O token retornado pela solicitação anterior.
resultsAbove integer O número preferencial de pontuações a serem retornadas acima da pontuação do jogador. Mais pontuações poderão ser retornadas se o jogador estiver na parte inferior do quadro de liderança; menos pontuações poderão ser retornadas se o jogador estiver na parte superior. Precisa ser menor ou igual a maxResults.
returnTopIfAbsent boolean Verdadeiro se as pontuações superiores forem retornadas quando o jogador não estiver no placar. O padrão é "true".

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/games

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação com este método.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "games#leaderboardScores",
  "nextPageToken": string,
  "prevPageToken": string,
  "numScores": long,
  "playerScore": {
    "kind": "games#leaderboardEntry",
    "player": players Resource,
    "scoreRank": long,
    "formattedScoreRank": string,
    "scoreValue": long,
    "formattedScore": string,
    "timeSpan": string,
    "writeTimestampMillis": long,
    "scoreTag": string
  },
  "items": [
    {
      "kind": "games#leaderboardEntry",
      "player": players Resource,
      "scoreRank": long,
      "formattedScoreRank": string,
      "scoreValue": long,
      "formattedScore": string,
      "timeSpan": string,
      "writeTimestampMillis": long,
      "scoreTag": string
    }
  ]
}
Nome da propriedade Valor Descrição Observações
kind string Identifica exclusivamente o tipo do recurso. O valor é sempre a string fixa games#leaderboardScores.
nextPageToken string O token de paginação para a próxima página de resultados.
prevPageToken string O token de paginação para a página de resultados anterior.
numScores long É o número total de pontuações no placar.
playerScore nested object Pontuação do jogador solicitante no placar. A pontuação do jogador pode aparecer aqui e na lista de pontuações acima. Se você estiver vendo um placar público e o jogador não compartilhar as informações do jogo publicamente, os valores scoreRank e formattedScoreRank não estarão presentes.
playerScore.kind string Identifica exclusivamente o tipo do recurso. O valor é sempre a string fixa games#leaderboardEntry.
playerScore.player nested object O jogador que detém essa pontuação.
playerScore.scoreRank long A classificação desta pontuação do placar.
playerScore.formattedScoreRank string A string localizada para a classificação desta pontuação do placar.
playerScore.scoreValue long Valor numérico dessa pontuação.
playerScore.formattedScore string A string localizada para o valor numérico desta pontuação.
playerScore.timeSpan string É o período dessa maior pontuação.
Os valores possíveis são:
  • "ALL_TIME": a pontuação é a maior de todos os tempos.
  • "WEEKLY": é a maior pontuação semanal.
  • "DAILY": é a maior pontuação diária.


Os valores aceitáveis são os seguintes:
  • "ALL_TIME"
  • "DAILY"
  • "WEEKLY"
playerScore.writeTimestampMillis long É o carimbo de data/hora em que essa pontuação foi registrada, em milissegundos desde o período em UTC.
playerScore.scoreTag string Informações adicionais sobre a pontuação. Os valores não podem conter mais de 64 caracteres seguros de URI, conforme definido na seção 2.3 da RFC 3986.
items[] list As pontuações no placar.
items[].kind string Identifica exclusivamente o tipo do recurso. O valor é sempre a string fixa games#leaderboardEntry.
items[].player nested object O jogador que detém essa pontuação.
items[].scoreRank long A classificação desta pontuação do placar.
items[].formattedScoreRank string A string localizada para a classificação desta pontuação do placar.
items[].scoreValue long Valor numérico dessa pontuação.
items[].formattedScore string A string localizada para o valor numérico desta pontuação.
items[].timeSpan string É o período dessa maior pontuação.
Os valores possíveis são:
  • "ALL_TIME": a pontuação é a maior de todos os tempos.
  • "WEEKLY": é a maior pontuação semanal.
  • "DAILY": é a maior pontuação diária.


Os valores aceitáveis são os seguintes:
  • "ALL_TIME"
  • "DAILY"
  • "WEEKLY"
items[].writeTimestampMillis long É o carimbo de data/hora em que essa pontuação foi registrada, em milissegundos desde o período em UTC.
items[].scoreTag string Informações adicionais sobre a pontuação. Os valores não podem conter mais de 64 caracteres seguros de URI, conforme definido na seção 2.3 da RFC 3986.

Confira!

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.