Game.setLeaderboardScore

함수형 API submitGameCenterLeaderBoardScore로도 같은 기능을 쓸 수 있어요.

기능 설명

게임 앱에서 사용자의 게임 점수를 토스게임센터 리더보드에 제출해요. score는 실수 형태의 숫자를 문자열로 전달해야 해요. 예를 들어 "123.45" 또는 "9999"예요.

토스앱 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);
  }
});