ISteamLeaderboardsインターフェイス (Steamworks ドキュメント)

Steamworks ドキュメンテーション

ISteamLeaderboardsインターフェイス

Steamランキングへのアクセスに使用されます。

SteamworksのWeb APIの使用に関する詳細は、Web API 概要を参照してください。

DeleteLeaderboard

POST https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/

名前	型	必須	説明
key	string	✔	Steamworks Web APIパブリッシャー認証キー
appid	uint32	✔	ゲームのAppID
name	string	✔	削除するランキングの名前

注：この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。このようなAPIは必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!

POST https://partner.steam-api.com/ISteamLeaderboards/FindOrCreateLeaderboard/v2/

名前	型	必須	説明
key	string	✔	Steamworks Web APIパブリッシャー認証キー
appid	uint32	✔	ゲームのAppID
name	string	✔	作成するランキングの名前
sortmethod	string		このランキングに使用する並べ替え方法（デフォルトは昇順）
displaytype	string		このランキングの表示方法（デフォルトは数値）
createifnotfound	bool		これがtrueで、ランキングが存在しない場合は作成されます。デフォルトはtrueです。
onlytrustedwrites	bool		これがtrueの場合、ランキングスコアはクライアントによって設定できなくなり、SetLeaderboardScore WebAPI経由でパブリッシャーによってのみに設定可能になります。デフォルトは falseです。
onlyfriendsreads	bool		これがtrueの場合、ランキングスコアはクライアントによってフレンド用にのみ読み込まれます。スコアはパブリッシャーによって常に読み込まれます。デフォルトはfalseです。

このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴：

注意： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。このようなAPIは必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！

GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardEntries/v1/

名前	型	必須	説明
key	string	✔	Steamworks Web APIパブリッシャー認証キー
appid	uint32	✔	ゲームのAppID
rangestart	int32	✔	範囲開始または0
rangeend	int32	✔	範囲終了または最大ランキングエントリー
steamid	uint64		フレンドとユーザーリクエスト周辺で使用されるSteamID
leaderboardid	int32	✔	表示するランキングのID
datarequest	uint32	✔	リクエストの種類：RequestGlobal、RequestAroundUser、RequestFriends

GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardsForGame/v2/

名前	型	必須	説明
key	string	✔	Steamworks Web APIパブリッシャー認証キー
appid	uint32	✔	ゲームのAppID

POST https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/

名前	型	必須	説明
key	string	✔	Steamworks Web APIパブリッシャー認証キー
appid	uint32	✔	ゲームのAppID
leaderboardid	uint32	✔	対象ランキングの数値ID。 GetLeaderboardsForGameから取得可能

POST https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/v1/

名前	型	必須	説明
key	string	✔	Steamworks Web APIパブリッシャー認証キー
appid	uint32	✔	ゲームのAppID
leaderboardid	uint32	✔	対象ランキングの数値ID。 GetLeaderboardsForGameから取得可能
steamid	uint64	✔	スコアを設定するsteamID
score	int32	✔	このユーザー用に設定するスコア
scoremethod	string	✔	使用するアップデート方法 "KeepBest" または "ForceUpdate"
details	rawbinary		ゲーム特定のスコア獲得方法の詳細。最大256バイト。