ユーザー情報へのアクセスと、ユーザーとのやり取りに使用します。
追加のメソッドは
IPlayerServiceを参照してください。
Steamworks Web APIの使用に関する詳細は、
Web API 概要を参照してください。
CheckAppOwnership
GET https://partner.steam-api.com/ISteamUser/CheckAppOwnership/v2/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
| steamid | uint64 | ✔ | ユーザーのSteamID |
| appid | uint32 | ✔ | 所有権を確認するAppID |
指定のユーザーがアプリを所有しているかどうかを確認します。
JSON応答には次のフィールドが含まれます：
| 名前 | 型 | 説明 |
|---|
| ownsapp | bool | ユーザーがアプリの実際の所有者であるかどうかを示します |
| permanent | bool | ユーザーが永久的にアプリを所有しているかどうか。ファミリーシェアリング、無料ウィークエンド、PCカフェ経由での所有はtrueではありません。 |
| timestamp | string | アプリが取得された時間 |
| ownersteamid | uint64 | ユーザーがファミリーシェアリング経由でこのアプリにアクセスしている場合、真の所有者を示します。 それ以外の場合は渡されたSteamIDと同じ。 |
| sitelicense | bool | ユーザーがPCカフェプログラム経由でこのアプリにアクセスしているかどうかを示します。 |
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴:
- バージョン 2 では、応答に sitelicense 要素を追加
注: この呼び出しは、このメソッドを使用する指定のApp IDを所有するパブリッシャーのAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
GetAppPriceInfo
GET https://partner.steam-api.com/ISteamUser/GetAppPriceInfo/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
| steamid | uint64 | ✔ | ユーザーのSteamID |
| appids | string | ✔ | コンマで区切られたappIDのリスト (最大: 100) |
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
応答の例：{
"price_info": {
"220": {
"packageid": 36,
"currency": "USD",
"initial_price": 999,
"final_price": 999,
"discount_percent": 0
}
}
}
GetDeletedSteamIDs
GET https://partner.steam-api.com/ISteamUser/GetDeletedSteamIDs/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キーです。 |
| rowversion | uint64 | ✔ | 削除されたアカウントのページングに使用する符号なし64ビット値。 このAPIの初めての呼び出しでは０を渡し、その後、追加リクエストごとに前回の呼び出しから返された値を渡します。 この値は将来の呼び出しのため、あなたのサーバーで保管される必要があります。 |
削除の前にゲームを所有していた「削除されたアカウント」のリストの取得にGetDeletedSteamIDsを使用できます。 このAPIは、GDPRおよびその他の個人情報関連の目的で、ユーザー関連データを削除できるようにするために作成されました。
提供されたSteamworksパブリッシャーキーは、認証と、チェックするAppIDのリストの作成の両方に使用されます。
GetFriendList
GET https://partner.steam-api.com/ISteamUser/GetFriendList/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIユーザー認証キー。 |
| steamid | uint64 | ✔ | ユーザーのSteamID |
| relationship | string | | 関係性のタイプ（例：フレンド） |
GetPlayerBans
GET https://partner.steam-api.com/ISteamUser/GetPlayerBans/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIユーザー認証キー。 |
| steamids | string | ✔ | コンマで区切られたSteamIDのリスト |
GetPlayerSummaries
GET https://partner.steam-api.com/ISteamUser/GetPlayerSummaries/v2/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIユーザー認証キーです。 |
| steamids | string | ✔ | コンマで区切られたSteamIDのリスト（最大: 100) |
注: この呼び出しは、Webサイトでユーザーに関する情報を表示する必要がある場合にのみ使用してください。 ゲームクライアントがこの情報を必要とする場合は、代わりにクライアントAPIを使用してください。
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴：
呼び出しからの応答は次のようになります：
"response":{
"players":[
{
"steamid":"77561198355051011",
"communityvisibilitystate":1,
"profilestate":1,
"personaname":"Mister Manager",
"lastlogoff":1556305001,
"profileurl":"https://steamcommunity.com/profiles/77561198355051011/",
"avatar":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/32/32f70a383a437d03af91d2f01a0776adf75201b5.jpg",
"avatarmedium":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/32/32f70a383a437d03af91d2f01a0776adf75201b5_medium.jpg",
"avatarfull":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/32/32f70a383a437d03af91d2f01a0776adf75201b5_full.jpg",
},
{
"steamid":"77561197978236369",
"communityvisibilitystate":3,
"profilestate":1,
"personaname":"Olive The Dog",
"lastlogoff":1556239336,
"profileurl":"https://steamcommunity.com/id/olive_the_dog/",
"avatar":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/41/555d2fbb879593c0565ce0489428a09c019feffa.jpg",
"avatarmedium":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/41/555d2fbb879593c0565ce0489428a09c019feffa_medium.jpg",
"avatarfull":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/41/555d2fbb879593c0565ce0489428a09c019feffa_full.jpg",
}
]
}
GetPublisherAppOwnership
GET https://partner.steam-api.com/ISteamUser/GetPublisherAppOwnership/v3/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
| steamid | uint64 | ✔ | ユーザーのSteamID |
このメソッドには、現在公式にはサポートされていない古いバージョンが存在します。 今後も引き続き使用可能ですが、最新バージョンの使用を強く推奨します。
変更履歴：
- バージョン 3 - 応答にsitelicense要素を追加
呼び出しからの応答は次のようになります：
"appownership":{
"apps":[
{
"appid":60,
"ownsapp":true,
"permanent":true,
"timestamp":"2005-04-03T17:50:29Z",
"ownersteamid":"76561197978236369",
"sitelicense":"false"
},
{
"appid":220,
"ownsapp":false,
"permanent":false,
"timestamp":"NIL",
"ownersteamid":"0",
"sitelicense":"true"
}
]
}
JSON応答には次のフィールドが含まれます：
| 名前 | 型 | 説明 |
|---|
| appid | uint32 | WebAPIキーと関連するAppID |
| ownsapp | bool | ユーザーが現在アプリを所有しているかどうか。購入、CDキーの登録、ファミリーシェアリング、無料ウィークエンド、PCカフェプログラム経由の所有はtrueです。 |
| permanent | bool | ユーザーが永久的にアプリを所有しているかどうか。ファミリーシェアリング、無料ウィークエンド、PCカフェ経由での所有はtrueではありません。 |
| timestamp | string | ユーザーがappIDを最初に取得したときのGMT時間 |
| ownersteamid | uint64 | ユーザーがファミリーシェアリング経由でこのアプリにアクセスしている場合、真の所有者を示します。 それ以外の場合は渡されたSteamIDと同じ。 |
| sitelicense | bool | ユーザーがPCカフェプログラム経由でこのアプリにアクセスしているかどうかを示します。 |
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
GetPublisherAppOwnershipChanges
GET https://partner.steam-api.com/ISteamUser/GetPublisherAppOwnershipChanges/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
| packagerowversion | string | ✔ | パッケージの変更を読み取るための符号なし64ビット行バージョン。 読み取られたデータの行バージョンは、将来の呼び出しでの使用のために返されます。 |
| cdkeyrowversion | string | ✔ | CDキーの変更を読み取るための符号なし64ビット行バージョン。 読み取られたデータの行バージョンは、将来の呼び出しでの使用のために返されます。 |
このメソッドを使用して、特定のパッケージまたはキーの行バージョン番号から、開始後所有権変更があったSteamIDを判別できます。 返されたSteamIDのリストから、
GetPublisherAppOwnershipを呼び出すと、渡されたキーと関連するグループ内のアプリケーションについて、関連する所有データが返されます。 パートナーは、Steamにおける製品所有についてより深く理解するために、リンクされたSteamアカウントと組み合わせてこのデータを追跡したい場合があります。
その場合、始めに
GetPublisherAppOwnershipChangesを、
packagerowversion と
cdkeyrowversionの値を０（ゼロ）で渡して呼び出します。 呼び出しからの応答は次のようになります：
"ownershipchanges": {
"steamids": [
{
"steamid": "76561198114498811"
},
{
"steamid": "76561198114498812"
},
...
],
"packagerowversion": "12448390228",
"cdkeyrowversion": "49857241147",
"moredata": true
}
JSON応答には次のフィールドが含まれます：
| 名前 | 型 | 説明 |
|---|
| steamids/steamid | string | 行バージョンを提供してからアカウントに変更があったSteamIDのリスト。 呼び出し毎に最大10,000個のSteamIDを返します。 |
| packagerowversion | string | 返された最後のSteamIDがマッチする行バージョンのパッケージ。 将来のGetPublisherAppOwnershipChanges呼び出しのために保管します。 |
| cdkeyrowversion | string | 返された最後のSteamIDがマッチする行バージョンのCDキー。 将来のGetPublisherAppOwnershipChanges呼び出しのために保管します。 |
| moredata | bool | より多くの新しいデータが利用可能かどうかを示す。 |
この初回呼び出しの応答後：
- 各SteamIDにおけるAppID毎の実際の所有権の確認にGetPublisherAppOwnershipを呼び出します。 必要に応じてそのデータを保存または使用します。
- 全てのSteamID が処理されたら、moredataの値を確認します。 値がtrueの場合、GetPublisherAppOwnershipChangesを新たに呼び出して、前回のGetPublisherAppOwnershipChangesへの呼び出しが返した値をpackagerowversionとcdkeyrowversionに渡します。
- moredataがfalseと返すようになるまで、ステップ１と２を繰り返します。
- （例えば24時間後など）今後のGetPublisherAppOwnershipChanges呼び出しで 0 (ゼロ)から再度開始しないために、packagerowversion とcdkeyrowversion の最終的な値を保存します。
注： この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください！
GetUserGroupList
GET https://partner.steam-api.com/ISteamUser/GetUserGroupList/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web API パブリッシャー認証キー |
| steamid | uint64 | ✔ | ユーザーのSteamID |
ResolveVanityURL
GET https://partner.steam-api.com/ISteamUser/ResolveVanityURL/v1/
| 名前 | 型 | 必須 | 説明 |
|---|
| key | string | ✔ | Steamworks Web APIユーザー認証キー |
| vanityurl | string | ✔ | SteamID取得のためのバニティURL |
| url_type | int32 | | バニティURLのタイプ 1（デフォルト）：個人プロフィール、2：グループ、3：公式ゲームグループ |
