Game.setLeaderboardScore

函数式 API submitGameCenterLeaderBoardScore也可以通过它使用相同的功能。

功能说明

在游戏应用中，将用户的游戏分数提交到 Toss 游戏中心排行榜。 分数应以字符串形式传递浮点数。例如 "123.45" 或 "9999"。

Toss App Android/iOS 5.221.0 可在上述环境中使用。在未能接收到桥接响应的环境中， undefined可能会返回。

类型

Game.setLeaderboardScore(params: { score: string }): Promise<SubmitGameCenterLeaderBoardScoreResponse | undefined>;

Params

{
  score: string;
}

Response

type SubmitGameCenterLeaderBoardScoreResponse = {
  statusCode:
    | "SUCCESS"
    | "LEADERBOARD_NOT_FOUND"
    | "PROFILE_NOT_FOUND"
    | "UNPARSABLE_SCORE";
};

响应 statusCode 值：

statusCode	说明
SUCCESS	分数提交成功了
LEADERBOARD_NOT_FOUND	找不到排行榜
PROFILE_NOT_FOUND	用户没有资料
UNPARSABLE_SCORE	无法解析分数。应以浮点数（float）形式的字符串传递

错误

如果在非游戏应用的迷你应用中调用，Promise 会被 reject。此时 error.message是 “排行榜 API 只能在游戏应用中使用。”。

示例代码

import { Game } from "@apps-in-toss/web-framework";

const button = document.querySelector("#submit-score");

button.addEventListener("click", async () => {
  try {
    const result = await Game.setLeaderboardScore({ score: "123.45" });

    if (result?.statusCode === "SUCCESS") {
      console.log("分数提交成功！");
    } else {
      console.error("分数提交失败：", result?.statusCode);
    }
  } catch (error) {
    console.error(error);
  }
});