Steamワークショップアイテムとのやり取りに使用する追加メソッドを提供します。
プライマリインターフェイスについては
ISteamRemoteStorage、
ICloudServiceと併せて参照してください。
注: これはサービスインターフェイスです。このインターフェイスのメソッドは
input_json
パラメーターで呼び出す必要があります。
Steamworks Web APIの使用に関する詳細は、
Web API 概要を参照してください。
Delete
GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIユーザー認証キー |
publishedfileid | uint64 | ✔ | 削除するアイテム |
appid | uint32 | ✔ | アイテムが属するアプリ |
アイテムを削除します。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
QueryFiles
GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIユーザー認証キー。 |
query_type | uint32 | ✔ | IPublishedFileService#EPublishedFileQueryType |
page | uint32 | ✔ | 現在のページ。 現在の上限は1000です。 |
cursor | string | ✔ | 結果をページ分割するカーソル(最初のリクエスト用には '*' に設定)。 改ページ位置をより調整可能にするため、ページパラメーターの使用よりもこちらを優先します。 使用時、ページパラメーターは無視されます。 応答で返された "next_cursor" の値を使用して、次の結果セットを取得するための次のクエリを設定します。 |
numperpage | uint32 | | (オプション)結果数。ページごとに返されます。 |
creator_appid | uint32 | ✔ | ファイルを作成したアプリ。 |
appid | uint32 | ✔ | ファイルを使用するアプリ。 |
requiredtags | string | ✔ | 一致するタグ。 以下のmatch_all_tagsパラメーターをご覧ください。 |
excludedtags | string | ✔ | (オプション)クエリを満たすために、公開されたファイルに存在してはならないタグ。 |
match_all_tags | bool | | trueの場合、アイテムにはすべてのタグが指定されている必要があります。そうでない場合、少なくともタグの1つが必要です。 |
required_flags | string | ✔ | 返されたアイテムに設定する必要がある必須フラグ |
omitted_flags | string | ✔ | 返されるアイテムに設定してはならないフラグ |
search_text | string | ✔ | アイテムのタイトルまたは説明に一致するテキスト |
filetype | uint32 | ✔ | IPublishedFileService#EPublishedFileInfoMatchingFileType |
child_publishedfileid | uint64 | ✔ | 指定のアイテムを参照するすべてのアイテムを検索します。 |
days | uint32 | ✔ | query_typeがk_PublishedFileQueryType_RankedByTrendの場合、これは[1,7]の投票を取得する日数です。 |
include_recent_votes_only | bool | ✔ | query_typeがk_PublishedFileQueryType_RankedByTrendの場合、指定された日の範囲内に投票があるアイテムのみに結果セットを制限します |
cache_max_age_seconds | uint32 | | 指定された秒数の間、古いデータが返されることを許可します。 |
language | int32 | | 検索する言語と返される言語。 デフォルトは英語。 |
required_kv_tags | {message} | ✔ | 一致するために必要なキーと値のタグ。 |
totalonly | bool | ✔ | (オプション)trueの場合、クエリを満たすファイルの総数のみを返します。 |
ids_only | bool | ✔ | (オプション)trueの場合、このクエリを満たすファイルの公開済みファイルIDのみを返します。 |
return_vote_data | bool | ✔ | 投票データを返します。 |
return_tags | bool | ✔ | ファイル詳細のタグを返します。 |
return_kv_tags | bool | ✔ | ファイル詳細のキー/値タグを返します。 |
return_previews | bool | ✔ | ファイル詳細のプレビュー画像と動画詳細を返します。 |
return_children | bool | ✔ | ファイル詳細の子アイテムIDを返します。 |
return_short_description | bool | ✔ | file_descriptionの代わりにshort_descriptionフィールドに入力します。 |
return_for_sale_data | bool | ✔ | 価格情報を返します(ある場合)。 |
return_metadata | bool | | メタデータを入力します。 |
return_playtime_stats | uint32 | ✔ | 今日より前の指定された日数のプレイ時間データを返します。 |
公開済みファイルの検索クエリを実行します。
SetDeveloperMetadata
POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キーです。 |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
metadata | string | ✔ | |
公開済みファイルの開発者のメタデータを設定します。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
UpdateAppUGCBan
POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キーです。 |
steamid | uint64 | ✔ | ユーザーのSteam ID |
appid | uint32 | ✔ | |
expiration_time | uint32 | ✔ | 禁止の期限が切れた時のUnixタイムスタンプ。0で削除。 |
reason | string | | ユーザーが禁止された理由。 ユーザーに表示されます。 |
アプリ内でユーザーのUGC禁止の追加/更新/削除。expiration_timeを設定。禁止の削除には0。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
UpdateBanStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キーです。 |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
banned | bool | ✔ | |
reason | string | ✔ | アイテムが禁止された理由。 管理者のみに表示。 |
公開済のファイル上での禁止のステータスを更新します。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
UpdateIncompatibleStatus
POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キーです。 |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
incompatible | bool | ✔ | |
公開済のファイル上の互換性ステータスを更新します。 "Incompatible"のアイテムはコミュニティハブとユーザープロフィールに表示されなくなりますが、直接リンクからのアクセスは引き続き可能です。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPI キーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
UpdateTags
POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
名前 | 型 | 必須 | 説明 |
key | string | ✔ | Steamworks Web APIパブリッシャー認証キー。 |
publishedfileid | uint64 | ✔ | |
appid | uint32 | ✔ | |
add_tags | string | | 追加するタグ。 |
remove_tags | string | | 削除するタグ。 |
公開済ファイル上のタグを更新します。 既存のタグは
remove_tags
パラメーター内で指定されない限り、削除されません。
注: この呼び出しでは、このメソッドの使用にパブリッシャーAPIキーを必要とします。 このようなAPIは
必ずセキュリティ保護されたサーバー上から呼び出し、決して直接クライアントから使用しないでください!
列挙型
これらはISteamRemoteStorageで使用するために定義された列挙型です。
EPublishedFileQueryType
UGCアイテムを照会するための方法。
名前 | 値 |
k_PublishedFileQueryType_RankedByVote | 0 |
k_PublishedFileQueryType_RankedByPublicationDate | 1 |
k_PublishedFileQueryType_AcceptedForGameRankedByAcceptanceDate | 2 |
k_PublishedFileQueryType_RankedByTrend | 3 |
k_PublishedFileQueryType_FavoritedByFriendsRankedByPublicationDate | 4 |
k_PublishedFileQueryType_CreatedByFriendsRankedByPublicationDate | 5 |
k_PublishedFileQueryType_RankedByNumTimesReported | 6 |
k_PublishedFileQueryType_CreatedByFollowedUsersRankedByPublicationDate | 7 |
k_PublishedFileQueryType_NotYetRated | 8 |
k_PublishedFileQueryType_RankedByTotalUniqueSubscriptions | 9 |
k_PublishedFileQueryType_RankedByTotalVotesAsc | 10 |
k_PublishedFileQueryType_RankedByVotesUp | 11 |
k_PublishedFileQueryType_RankedByTextSearch | 12 |
k_PublishedFileQueryType_RankedByPlaytimeTrend | 13 |
k_PublishedFileQueryType_RankedByTotalPlaytime | 14 |
k_PublishedFileQueryType_RankedByAveragePlaytimeTrend | 15 |
k_PublishedFileQueryType_RankedByLifetimeAveragePlaytime | 16 |
k_PublishedFileQueryType_RankedByPlaytimeSessionsTrend | 17 |
k_PublishedFileQueryType_RankedByLifetimePlaytimeSessions | 18 |
k_PublishedFileQueryType_RankedByInappropriateContentRating | 19 |
k_PublishedFileQueryType_RankedByBanContentCheck | 20 |
k_PublishedFileQueryType_RankedByLastUpdatedDate | 21 |
EPublishedFileInfoMatchingFileType
共有ファイルをQueryFileによって照会するための方法。
名前 | 値 | 説明 |
k_PFI_MatchingFileType_Items | 0 | アイテム |
k_PFI_MatchingFileType_Collections | 1 | ワークショップアイテムのコレクション |
k_PFI_MatchingFileType_Art | 2 | アートワーク |
k_PFI_MatchingFileType_Videos | 3 | 動画 |
k_PFI_MatchingFileType_Screenshots | 4 | スクリーンショット |
k_PFI_MatchingFileType_CollectionEligible | 5 | コレクション内に含むことが可能なアイテム |
k_PFI_MatchingFileType_Games | 6 | 未使用 |
k_PFI_MatchingFileType_Software | 7 | 未使用 |
k_PFI_MatchingFileType_Concepts | 8 | 未使用 |
k_PFI_MatchingFileType_GreenlightItems | 9 | 未使用 |
k_PFI_MatchingFileType_AllGuides | 10 | ガイド |
k_PFI_MatchingFileType_WebGuides | 11 | Steam Webガイド |
k_PFI_MatchingFileType_IntegratedGuides | 12 | アプリケーション統合ガイド |
k_PFI_MatchingFileType_UsableInGame | 13 | |
k_PFI_MatchingFileType_Merch | 14 | 販売を目的とした投票があるワークショップ商品 |
k_PFI_MatchingFileType_ControllerBindings | 15 | Steamコントローラバインド |
k_PFI_MatchingFileType_SteamworksAccessInvites | 16 | 内部使用 |
k_PFI_MatchingFileType_Items_Mtx | 17 | ゲーム内で購入可能なワークショップアイテム |
k_PFI_MatchingFileType_Items_ReadyToUse | 18 | ユーザーが即時使用可能なワークショップアイテム |
k_PFI_MatchingFileType_WorkshopShowcase | 19 | |
k_PFI_MatchingFileType_GameManagedItems | 20 | ユーザーではなく、ゲームによって完全に管理され、Webには表示されません。 |