Steamworks ドキュメンテーション
IPublishedFileServiceインターフェイス
Steamワークショップアイテムとのやり取りに使用する追加メソッドを提供します。

プライマリインターフェイスについてはISteamRemoteStorageICloudServiceと併せて参照してください。

注: これはサービスインターフェイスです。このインターフェイスのメソッドはinput_jsonパラメーターで呼び出す必要があります。

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

Delete

GET https://api.steampowered.com/IPublishedFileService/Delete/v1/
名前必須説明
keystringSteamworks Web APIユーザー認証キー
publishedfileiduint64削除するアイテム
appiduint32アイテムが属するアプリ

アイテムを削除します。

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

QueryFiles

GET https://api.steampowered.com/IPublishedFileService/QueryFiles/v1/
名前必須説明
keystringSteamworks Web APIユーザー認証キー。
query_typeuint32IPublishedFileService#EPublishedFileQueryType
pageuint32現在のページ。 現在の上限は1000です。
cursorstring結果をページ分割するカーソル(最初のリクエスト用には '*' に設定)。 改ページ位置をより調整可能にするため、ページパラメーターの使用よりもこちらを優先します。 使用時、ページパラメーターは無視されます。 応答で返された "next_cursor" の値を使用して、次の結果セットを取得するための次のクエリを設定します。
numperpageuint32(オプション)結果数。ページごとに返されます。
creator_appiduint32ファイルを作成したアプリ。
appiduint32ファイルを使用するアプリ。
requiredtagsstring一致するタグ。 以下のmatch_all_tagsパラメーターをご覧ください。
excludedtagsstring(オプション)クエリを満たすために、公開されたファイルに存在してはならないタグ。
match_all_tagsbooltrueの場合、アイテムにはすべてのタグが指定されている必要があります。そうでない場合、少なくともタグの1つが必要です。
required_flagsstring返されたアイテムに設定する必要がある必須フラグ
omitted_flagsstring返されるアイテムに設定してはならないフラグ
search_textstringアイテムのタイトルまたは説明に一致するテキスト
filetypeuint32IPublishedFileService#EPublishedFileInfoMatchingFileType
child_publishedfileiduint64指定のアイテムを参照するすべてのアイテムを検索します。
daysuint32query_typeがk_PublishedFileQueryType_RankedByTrendの場合、これは[1,7]の投票を取得する日数です。
include_recent_votes_onlyboolquery_typeがk_PublishedFileQueryType_RankedByTrendの場合、指定された日の範囲内に投票があるアイテムのみに結果セットを制限します
cache_max_age_secondsuint32指定された秒数の間、古いデータが返されることを許可します。
languageint32検索する言語と返される言語。 デフォルトは英語。
required_kv_tags{message}一致するために必要なキーと値のタグ。
totalonlybool(オプション)trueの場合、クエリを満たすファイルの総数のみを返します。
ids_onlybool(オプション)trueの場合、このクエリを満たすファイルの公開済みファイルIDのみを返します。
return_vote_databool投票データを返します。
return_tagsboolファイル詳細のタグを返します。
return_kv_tagsboolファイル詳細のキー/値タグを返します。
return_previewsboolファイル詳細のプレビュー画像と動画詳細を返します。
return_childrenboolファイル詳細の子アイテムIDを返します。
return_short_descriptionboolfile_descriptionの代わりにshort_descriptionフィールドに入力します。
return_for_sale_databool価格情報を返します(ある場合)。
return_metadataboolメタデータを入力します。
return_playtime_statsuint32今日より前の指定された日数のプレイ時間データを返します。

公開済みファイルの検索クエリを実行します。
: "filetype" パラメーター(IPublishedFileService#EPublishedFileInfoMatchingFileType)で照会できますが、結果には"file_type"値が含まれます。 その値はISteamRemoteStorage#EWorkshopFileTypeに相当します。

SetDeveloperMetadata

POST https://partner.steam-api.com/IPublishedFileService/SetDeveloperMetadata/v1/
名前必須説明
keystringSteamworks Web APIパブリッシャー認証キーです。
publishedfileiduint64
appiduint32
metadatastring

公開済みファイルの開発者のメタデータを設定します。

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

UpdateAppUGCBan

POST https://partner.steam-api.com/IPublishedFileService/UpdateAppUGCBan/v1/
名前必須説明
keystringSteamworks Web APIパブリッシャー認証キーです。
steamiduint64ユーザーのSteam ID
appiduint32
expiration_timeuint32禁止の期限が切れた時のUnixタイムスタンプ。0で削除。
reasonstringユーザーが禁止された理由。 ユーザーに表示されます。

アプリ内でユーザーのUGC禁止の追加/更新/削除。expiration_timeを設定。禁止の削除には0。

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

UpdateBanStatus

POST https://partner.steam-api.com/IPublishedFileService/UpdateBanStatus/v1/
名前必須説明
keystringSteamworks Web APIパブリッシャー認証キーです。
publishedfileiduint64
appiduint32
bannedbool
reasonstringアイテムが禁止された理由。 管理者のみに表示。

公開済のファイル上での禁止のステータスを更新します。

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

UpdateIncompatibleStatus

POST https://partner.steam-api.com/IPublishedFileService/UpdateIncompatibleStatus/v1/
名前必須説明
keystringSteamworks Web APIパブリッシャー認証キーです。
publishedfileiduint64
appiduint32
incompatiblebool

公開済のファイル上の互換性ステータスを更新します。 "Incompatible"のアイテムはコミュニティハブとユーザープロフィールに表示されなくなりますが、直接リンクからのアクセスは引き続き可能です。

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

UpdateTags

POST https://partner.steam-api.com/IPublishedFileService/UpdateTags/v1/
名前必須説明
keystringSteamworks Web APIパブリッシャー認証キー。
publishedfileiduint64
appiduint32
add_tagsstring追加するタグ。
remove_tagsstring削除するタグ。

公開済ファイル上のタグを更新します。 既存のタグはremove_tagsパラメーター内で指定されない限り、削除されません。

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

列挙型

これらはISteamRemoteStorageで使用するために定義された列挙型です。

EPublishedFileQueryType

UGCアイテムを照会するための方法。

名前
k_PublishedFileQueryType_RankedByVote0
k_PublishedFileQueryType_RankedByPublicationDate1
k_PublishedFileQueryType_AcceptedForGameRankedByAcceptanceDate2
k_PublishedFileQueryType_RankedByTrend3
k_PublishedFileQueryType_FavoritedByFriendsRankedByPublicationDate4
k_PublishedFileQueryType_CreatedByFriendsRankedByPublicationDate5
k_PublishedFileQueryType_RankedByNumTimesReported6
k_PublishedFileQueryType_CreatedByFollowedUsersRankedByPublicationDate7
k_PublishedFileQueryType_NotYetRated8
k_PublishedFileQueryType_RankedByTotalUniqueSubscriptions9
k_PublishedFileQueryType_RankedByTotalVotesAsc10
k_PublishedFileQueryType_RankedByVotesUp11
k_PublishedFileQueryType_RankedByTextSearch12
k_PublishedFileQueryType_RankedByPlaytimeTrend13
k_PublishedFileQueryType_RankedByTotalPlaytime14
k_PublishedFileQueryType_RankedByAveragePlaytimeTrend15
k_PublishedFileQueryType_RankedByLifetimeAveragePlaytime16
k_PublishedFileQueryType_RankedByPlaytimeSessionsTrend17
k_PublishedFileQueryType_RankedByLifetimePlaytimeSessions18
k_PublishedFileQueryType_RankedByInappropriateContentRating19
k_PublishedFileQueryType_RankedByBanContentCheck20
k_PublishedFileQueryType_RankedByLastUpdatedDate21

EPublishedFileInfoMatchingFileType

共有ファイルをQueryFileによって照会するための方法。

名前説明
k_PFI_MatchingFileType_Items0アイテム
k_PFI_MatchingFileType_Collections1ワークショップアイテムのコレクション
k_PFI_MatchingFileType_Art2アートワーク
k_PFI_MatchingFileType_Videos3動画
k_PFI_MatchingFileType_Screenshots4スクリーンショット
k_PFI_MatchingFileType_CollectionEligible5コレクション内に含むことが可能なアイテム
k_PFI_MatchingFileType_Games6未使用
k_PFI_MatchingFileType_Software7未使用
k_PFI_MatchingFileType_Concepts8未使用
k_PFI_MatchingFileType_GreenlightItems9未使用
k_PFI_MatchingFileType_AllGuides10ガイド
k_PFI_MatchingFileType_WebGuides11Steam Webガイド
k_PFI_MatchingFileType_IntegratedGuides12アプリケーション統合ガイド
k_PFI_MatchingFileType_UsableInGame13
k_PFI_MatchingFileType_Merch14販売を目的とした投票があるワークショップ商品
k_PFI_MatchingFileType_ControllerBindings15Steamコントローラバインド
k_PFI_MatchingFileType_SteamworksAccessInvites16内部使用
k_PFI_MatchingFileType_Items_Mtx17ゲーム内で購入可能なワークショップアイテム
k_PFI_MatchingFileType_Items_ReadyToUse18ユーザーが即時使用可能なワークショップアイテム
k_PFI_MatchingFileType_WorkshopShowcase19
k_PFI_MatchingFileType_GameManagedItems20ユーザーではなく、ゲームによって完全に管理され、Webには表示されません。