. [*] The type passed to this function must match the type listed in the App Admin panel of the Steamworks website. [/list] [subsection=RequestUserStats]RequestUserStats[/subsection] [code=cpp]SteamAPICall_t RequestUserStats( CSteamID steamIDUser );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]steamIDUser[/b][/td][td][apitype]steam_api::CSteamID[/apitype][/td][td]The Steam ID of the user to request the stats for.…

[list] [*] The specified stat exists in App Admin on the Steamworks website, and the changes are published. [*] [api]ISteamGameServerStats::RequestUserStats[/api] has completed and successfully returned its callback for the specified user. [*] The type passed to this function must match the type listed in the App Admin panel of the Steamworks website. [*] The stat must be allowed to be set by game server. [/list] [subsection=StoreUserStats]StoreUserStats[/subsection] [code=cpp]SteamAPICall_t StoreUserStats( CSteamID steamIDUser );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]steamIDUser[/b][/td][td][apitype]steam_api::CSteamID[/apitype][/td][td]The Steam ID of the user to store the stats of.…

Your game will see a [api]ISteamUserStats::UserStatsStored_t[/api] callback, plus one [api]ISteamUserStats::UserAchievementStored_t[/api] callback for each unlocked achievement. The Steam Game Overlay will display a notification panel to the user. [/list] [subsection=AVGRATE]The AVGRATE stat type[/subsection] This type of stat provides some unique and very useful functionality, but it requires a little bit more detail to explain. …

[/callout] Each achievement is listed with the appropriate icon, and the name and description as set in the Steamworks control panel. If the achievement name and description have been localized into the language the user has selected, then they will display in that language. …

Mousing over a post will reveal post-specific options, while the [i]Moderator Tools[/i] panel on the right side of the page contains broader options for thread management. [h4]Customizing Subforums[/h4] When your community hub goes live, three forums are created by default: [i]General Discussions[/i]: The landing page and primary forum in your discussion hub; [i]Trading[/i]: A dedicated forum where players can post trade offers and requests without spamming your main forum; [i]Reported Posts[/i]: A hidden forum where your moderators and developers can review content reported by your community. …

Developers can overwrite previously answered threads, but unless the post is misleading or false, it's generally not a good idea to overwrite it. [h4]Bulk Actions[/h4] By opening the Moderator Tools panel on the right side of the page, multiple actions can be applied to multiple threads at the same time. This is very useful when merging or moving threads. …

You can set up your achievement localization data in the [url=https://partner.steamgames.com/apps/loc/]Achievement Localization[/url] section of the App Admin panel. [section]Gold Master Language Support[/section] The Gold Master tool can customize the self installing package to the user language. …

Max size - 128 characters[/td][/tr] [/table] [b]Example response: [/b] [code] "response": { "results": [ { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "Package", "packageid": 123, "bundleid":777 "package_sale_type": "Steam", "platform": "Windows", "country_code": "AU", "base_price": "3995", "sale_price": "1995", "currency": "AUD", "gross_units_sold": 10, "gross_units_returned": -2, "gross_sales_usd": "311.7201", "gross_returns_usd": "-25.5322", "net_tax_usd": "26.0431", "primary_appid": 999, "additional_revenue_share_tier": 0, "net_units_sold": 8, "net_sales_usd": "260.1448", "combined_discount_id": 8888, "total_discount_percentage": 50 }, { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "Package", "packageid": 456, "package_sale_type": "Steam", "platform": "Windows", "country_code": "CA", "base_price": "5999", "sale_price": "5999", "currency": "CAD", "gross_units_sold": 100, "gross_units_returned": 0, "gross_sales_usd": "4309.0101", "gross_returns_usd": "0.0000", "net_tax_usd": "517.0812", "primary_appid": 1099, "additional_revenue_share_tier": 1, "viw_grant_partnerid": "5200", "net_units_sold": 100, "net_sales_usd": "3791.9288", }, { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "MicroTxn", "appid": 1099, "game_item_id": 1, "country_code": "US", "currency": "USD", "gross_units_sold": 2, "gross_units_returned": 0, "gross_sales_usd": "9.9800", "gross_returns_usd": "0.0000", "net_tax_usd": "0.9980", "primary_appid": 1099, "additional_revenue_share_tier": 1, "net_units_sold": 2, "net_sales_usd": "8.9820", "avg_sale_price_usd": "4.9900" }, { "partnerid": "10500", "date": "2025/05/01", "line_item_type": "Package", "packageid": 123, "package_sale_type": "Retail", "platform": "Unknown", "country_code": "AE", "primary_appid": 999, "key_request_id": 7100, "gross_units_activated": 10 }, ], "key_request_info": [ { "key_request_id": 7100, "key_request_notes": "Keys for Key Markets", "game_code_id": 842, "game_code_description": "Retail Distribution - Middle East & North Africa", "territory_code_id": 0, "territory_code_description": "UNUSED" } ], "package_info": [ { "packageid": 123, "package_name": "Grate Expectations: Cheese Preparation Simulator - Deluxe Edition" }, { "packageid": 456, "package_name": "Grate Expectations 2: Curd Your Loins - Launch Edition" } ] "app_info": [ { "appid": 999, "app_name": "Grate Expectations: Cheese Preparation Simulator }, { "appid": 1099, "app_name": "Grate Expectations 2: Curd Your Loins" } ], "bundle_info": [ { "bundleid": 777, "bundle_name": "Grate Expectations Deluxe Bundle" }, ], "combined_discount_info": [ { "combined_discount_id": 8888, "combined_discount_name": "Bundle Discount", "total_discount_percentage": 50, "discount_ids": [11111] }, ], "game_item_info": [ { "appid": 1099, "game_item_id": 1, "game_item_description": "500 Grams of Whey", "game_item_category": "Essential Cheese Product" } ], "country_info": [ { "country_code": "AE", "country_name": "United Arab Emirates", "region": "Middle East & North Africa" }, { "country_code": "AU", "country_name": "Australia", "region": "Oceania" }, { "country_code": "CA", "country_name": "Canada", "region": "North America" }, { "country_code": "US", "country_name": "United States", "region": "North America" }, ], "max_id": "29481179373" [/code] [section=GetAppWishlistReporting]GetAppWishlistReporting[/section] [code=http]GET https://partner.steam-api.com/IPartnerFinancialsService/GetAppWishlistReporting/v001/[/code] [b]Request values[/b][table] [tr][th]Name[/th][th]Type[/th][th]Required[/th][th]Description[/th][/tr] [tr] [td][b]key[/b][/td][td]string[/td] [td]✔[/td] [td]Steamworks Web API [url=https://partner.steamgames.com/doc/webapi_overview/auth#publisher-keys]publisher key[/url] with [b]Financial[/b] permissions.…

It is available for game depots and game language selection in the per-game settings panel. But the Steam UI itself is not currently translated into Arabic and players cannot select Arabic as one of the languages to run Steam in. …

This feature is enabled the default location (near top of the page) via the 'General Page Configuration' panel within the right hand panel 'Show creator capsule for this event'. This is off by default, however, you can enable it. You can also control the location where this widget appears by creating a regular sale section and then changing what should be featured in this section to "Curator or Creator Home section". …

Spoiler and archived achievements aren't shown in the achievements panel on your store page. [subsection]Completion[/subsection] Completion is tracked per set: [list] [*] A player completes a set by unlocking every achievement in it that is still available. …

[/td] [/tr] [tr] [/tr] [/table] [subsection]Store Pages[/subsection] The achievements panel on your store page shows achievements from your game, excluding spoiler and archived achievements. DLC store pages show achievements from that DLC's set. …

[doclink=store/assets/overrides]More about Artwork Overrides[/doclink] [*][b]Post an Announcement[/b] - When you post an event or announcement, it will appear to any customer that is following your game (which they can do from your community hub or store page), on your store page, within the Steam library, and will be accessible from the Steam client 'downloads' panel. More about [doclink=marketing/event_tools]Events and Announcements[/doclink] [*][b]Run a discount[/b] - To get the most out of a major content update, you may want to think about timing it with a discount on your game. …

The Steam Cloud Quota can be configured with the following steps: [olist] [*] Navigate to the [url=https://partner.steamgames.com/apps/cloud/]Steam Cloud Settings[/url] page in the App Admin panel. [*] Set the [b]Byte quota per user[/b] and [b]Number of files allowed per user[/b] to appropriate values for preview image storage [*] Click Save [*] From the [b]Publish[/b] tab, click [b]Prepare for Publishing[/b] [*] Click [b]Publish to Steam[/b] and complete the process to publish the change. [/olist] Enabling the [api]ISteamUGC[/api] API can be accomplished with the following steps: [olist] [*] Navigate to the [url=https://partner.steamgames.com/apps/workshop/]Steam Workshop Configuration[/url] page in the App Admin panel. [*] Find the [b]Additional Configuration Options[/b] section. [*] Check [b]Enable ISteamUGC for file transfer[/b]. [*] Click [b]Save[/b]. [*] From the [b]Publish[/b] tab, click [b]Prepare for Publishing[/b]. [*] Click [b]Publish to Steam[/b] and complete the process to publish the change. …

This can be done from the [url=https://partner.steamgames.com/apps/vac/]Anti-Cheat Configuration[/url] page in the App Admin panel. [b]NOTE:[/b] This is a Service interface, methods in this interface should be called with the [code-inline]input_json[/code-inline] parameter. …

[docimg=Events_FeaturedEventExample.png]Events_FeaturedEventExample.png[/docimg] [section]Creating New Events[/section] To create a new event or announcement, you can follow the same paths you're accustomed to: [list] [*]From your app landing page in Steamworks, click your Hub Admin panel: [docimg=post_announcement_1.JPG]post_announcement_1.JPG[/docimg] [/list] [subsection=categorization]Categorization[/subsection] To create a new event, you'll first be asked to select a category and sub-category. …

[/td][/tr] [/table] Returns the set of all item definition IDs which are defined in the App Admin panel of the Steamworks website. These item definitions may not necessarily be contiguous integers. This should be called in response to a [apitype]ISteamInventory::SteamInventoryDefinitionUpdate_t[/apitype] callback. …

[code-inline]pchPropertyName[/code-inline] set to [b]"name"[/b]: [code-inline]SW_DECORATION_HAT[/code-inline] [b]NOTE:[/b] Call [api]ISteamInventory::LoadItemDefinitions[/api] first, to ensure that items are ready to be used before calling GetItemDefinitionProperty. …

[section=initial-setup]Initial Setup[/section] To set up Steam Cloud you must set the [code-inline]Byte quota per user[/code-inline] and [code-inline]Number of files allowed per user[/code-inline] options on the [url=https://partner.steamgames.com/apps/cloud/]Steam Cloud Settings[/url] page in the Steamworks App Admin panel. This quota is enforced on each Cloud-enabled game, on a per-user-per-game basis. It's recommended to set the values to reasonable amounts for your game title. …

. [*] Use [api]ISteamInput::GetDigitalActionOrigins[/api] and [api]ISteamInput::GetAnalogActionOrigins[/api] to get the origin(s) that the player has assigned to your in-game actions, and show the appropriate glyphs in your onscreen UI. [*] Use [api]ISteamInput::ShowBindingPanel[/api] to pop up the Steam overlay directly into the controller configuration for a specified controller. This means you won't need to make a customization UI. [*] Use [api]ISteamInput::GetInputTypeForHandle[/api] if you want to identify each controller's device model so you can use matching art in game. …