(see [doclink=features/inventory/schema#PlaytimeDrops]Playtime Item Drops[/doclink] below)[/td][/tr] [tr][td]granted_manually[/td][td]false / true. If true, will only be granted when AddPromoItem() or AddPromoItems() are called with the explicit item definition id. Otherwise, it may be granted via the GrantPromoItems() call. …

[/list] The promotional item checks are done by Steam - so these items can be requested safely from the client; see [api]ISteamInventory::AddPromoItem[/api] and [api]ISteamInventory::GrantPromoItems[/api]. To define a promotional item, set one or more rules for granting the item in the "promo" property of the item definition. …

This can be useful if your game has custom UI for showing a specific promo item to the user otherwise if you want to grant multiple promotional items then use [api]ISteamInventory::AddPromoItems[/api] or [api]ISteamInventory::GrantPromoItems[/api]. …

If you want to grant a single promotional item then use [api]ISteamInventory::AddPromoItem[/api]. If you want to grant all possible promo items then use [api]ISteamInventory::GrantPromoItems[/api]. Any items that can be granted MUST have a "promo" attribute in their itemdef. …

[section]Joining Third-Party Sales Events as a Participant[/section] If you're here because your game has been invited to join one of these events, please take a look at our [b]Participating in Third-Party Events[/b] page here: https://partner.steamgames.com/doc/store/promo/thirdpartyevents [section]Hosting Third-Party Sales Events[/section] If you're here because you'd like to host your own third-party event on Steam, or expand your existing gaming event with an on-Steam presence, please read further here: https://partner.steamgames.com/doc/store/promo/organizers [section]Tutorials & Tips[/section] Sale Page Editor Tools: https://partner.steamgames.com/doc/resources/Sales_Feature_Beta Graphical Assets: https://partner.steamgames.com/doc/store/assets Example Timeline: https://partner.steamgames.com/doc/store/promo/planning …

Why does my tax information show two withholding rates - one for royalty copyright and one for royalty film?[/h4] [b]A.[/b] These are separate tax rates that are applied depending on the content type of your sales. The royalty copyright rate will apply to US sourced sales on games and related DLCs. The royalty film rate will apply to US sourced sales on film and video. These rates do not accumulate for a higher rate of withholding and only one rate will be applied depending on the type of sales. [*][h4]Q. …

[section]Before you start[/section] In order to make use of this feature, you will need to: [list] [*]Review the [doclink=store/promo]rules and guidelines[/doclink] for the type of event you are running. [*]At the bottom of each rules page, find the link under "Getting started" and submit a support ticket with information about your event. [*]Once enabled, you'll need to add your games, configure sections and finish most of the merchandising work to organize the games in your sale. [*]Flip over to the 'preview' of your sale page, and you'll see the controls to enable background groupings. …

If so, Steam can equip you with tools to create your own [doclink=store/promo/thirdpartyevents]Third-Party Sales Event[/doclink]. These allow you to build and manage your own custom event landing pages on Steam. …

Reviews typically take 2–3 business days, during which the team will ensure your event complies with the [doclink=/store/promo/organizers#10]Event Hosting Rules[/doclink]. [subsection]6. Publish Your Event[/subsection] Once your sales event has been approved, you’re free to publish it whenever you’re ready. …

[/list] [/list] [/list] [b]Example Response:[/b] [code=json] { "response": { "result": "OK", "params": { "count": 4, "orders": [ { "orderid": "1233", "transid": "1234567890123456788", "steamid": "76561197972751825", "status": "PartialRefund", "currency": "USD", "time": "2024-01-23T18:30:00Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:15:00Z", "items": [ { "itemid": 100, "qty": 1, "amount": 99, "vat": 9, "itemstatus": "Refunded" }, { "itemid": 101, "qty": 1, "amount": 1299, "vat": 116, "itemstatus": "Succeeded" } ] }, { "orderid": "1234", "transid": "1234567890123456789", "steamid": "76561197972751825", "status": "Failed", "currency": "USD", "time": "2024-01-23T18:40:30Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:39:00Z", "items": [ { "itemid": 100, "qty": 1, "amount": 99, "vat": 9, "itemstatus": "Failed" } ] }, { "orderid": "1235", "transid": "1234567890123456790", "steamid": "76561197972751825", "status": "Succeeded", "currency": "USD", "time": "2024-01-23T18:40:40Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:39:30Z", "items": [ { "itemid": 101, "qty": 1, "amount": 1299, "vat": 116, "itemstatus": "Succeeded" } ] }, { "orderid": "1236", "transid": "1234567890123456791", "steamid": "76561197972751825", "status": "Chargedback", "currency": "USD", "time": "2024-01-23T19:55:00Z", "country": "US", "usstate": "WA", "timecreated": "2024-01-23T18:40:00Z", "items": [ { "itemid": 102, "qty": 1, "amount": 999, "vat": 89, "itemstatus": "Chargedback" } ] } ] } } } [/code] [section=GetUserAgreementInfo]GetUserAgreementInfo[/section] [code=http]GET https://partner.steam-api.com/ISteamMicroTxn/GetUserAgreementInfo/v2/[/code] [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]Microtransaction[/b] permissions.…

[/list] [/list] [/list] [b]Example Response:[/b] [code=xml] <response> <result>OK</result> <params> <state>WA</state> <country>US</country> <currency>USD</currency> </params> </response> [/code] [section=InitTxn]InitTxn[/section] [code=http]POST https://partner.steam-api.com/ISteamMicroTxn/InitTxn/v3/[/code] [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]Microtransaction[/b] permissions.…

[subsection]Hosting events on Steam[/subsection] If you are looking for information on hosting a sale event on Steam, please see [doclink=store/promo/organizers][/doclink] [subsection]Getting Started With Sale Editor Tools[/subsection] The best place to start with familiarizing yourself with the sale page editing tools is this overview page here: [doclink=marketing/event_tools/sales/tools][/doclink] For more details on various topics within the sale page editors, please see the following documentation: [list] [*][doclink=marketing/event_tools/sales/groups][/doclink] [*][doclink=marketing/event_tools/sales/livestream][/doclink] [*][doclink=marketing/event_tools/sales/minimum][/doclink] [*][doclink=marketing/event_tools/sales/sections][/doclink] [/list] …

Text will be laid over the bottom automatically [doclink=store/assets/promos#spotlight]See details[/doclink][/td] [td]Some events are also featured on the store homepage. If you have already discussed that with your Valve contact, then we may be using this image to do so. …

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". …

[/b] - The documentation on this page is tailored mainly for event participants, but, if you're interested in bringing your own third-party sales event to Steam, we'd love to hear from you. Please read [doclink=store/promo/organizers]Hosting Third-Party Sales Events[/doclink] to get started.[/callout] [section]Event Visibility for Participants[/section] [subsection]Off-Steam Visibility[/subsection] Your event organizer should have more details about how they plan to feature or market their event off of Steam. …

A select few may even qualify for curated featuring on the Store in promotional placements such as Takeunders or Daily, Midweek and Weekend Deals. This is covered in greater detail in [doclink=store/promo/organizers#15]Event Visibility on Steam[/doclink]. If an event is chosen for curated featuring on the Store, the Steam Events Team will let the event organizer know who can then share the information with their participants. …

If your game has lots of happy customers and hundreds of thousands of revenue over past few months, feel free to [url=https://help.steampowered.com/en/wizard/HelpWithPublishing]contact us any time[/url] to discuss promotion options. There are three main types of curated promo slots for products. The default discount length for all three promo slots is one week, but we're happy to be flexible with shorter or longer discounts, within our existing discount policies. …

The artwork used for the Midweek promotion requires custom asset sizes detailed [doclink=store/assets/promos]here[/doclink], which will be localized by Valve. Midweek discounts default to one week, but by publisher request we can run those discounts anywhere from 3 to 14 days. …

[h4]Dropping in-game items for registering your third-party key[/h4] If you are using the [doclink=features/inventory]Steam Inventory Service[/doclink], make sure the item's itemdef is configured correctly as a promo item and call [api]ISteamInventory::AddPromoItem[/api] from the client. If you have your own item backend, you can call [api]ISteamUser::GetAuthSessionTicket[/api] from the game client and then use [webapi]ISteamUserAuth/AuthenticateUserTicket[/webapi] with [webapi]ISteamUser/CheckAppOwnership[/webapi] to verify ownership. [doclink=#client_to_backend_webapi]More Information...[/doclink] [h4]The key controls which version of the software is unlocked[/h4] Each version of your game should have its own AppID. From the game client, call [api]ISteamUser::GetAuthSessionTicket[/api] and then use [webapi]ISteamUserAuth/AuthenticateUserTicket[/webapi] with [webapi]ISteamUser/CheckAppOwnership[/webapi] to verify ownership. …

The only difference is the steam controller only has one. [docimg=steam_controller_joystick.png]steam_controller_joystick.png[/docimg] [subsection=BackStart]Back and Start[/subsection] [b]Digital[/b] The Back and Start buttons are on either side of the Steam "home" button. …

[docimg=steam_controller_touchpads.png]steam_controller_touchpads.png[/docimg] [subsection=Gyro]Gyro[/subsection] [b]Analog, 3 axes[/b] Last but not least, the Steam Controller features an internal gyroscope for motion sensing. …

[/list] [/list] [b]Example Response:[/b] [code=xml] { "response": { "item_json": "[{ \"accountid\":\"148618792083651397\",\"itemid\":\"17209346500926339\",\"Timestamp\":\"\",\"originalitemid\":\"17209346500926339\",\"itemdefid\":\"120\",\"appid\":480,\"position\":0,\"quantity\":1,\"transid\":\"\",\"state\":\"\",\"origin\":\"external\",\"price\":\"\",\"acquired\":\"20140912T195537Z\"}]" } } [/code] [b]Calling Example:[/b] [code] curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d appid=480 \ -d steamid=292733980074050545 \ -d itemdefid[0]=4111 \ -d itemdefid[1]=4112 \ "http://api.steampowered.com/IInventoryService/AddItem/v1?key=xxxxxx" [/code] [section=AddPromoItem]AddPromoItem[/section] [code=http]POST https://partner.steam-api.com/IInventoryService/AddPromoItem/v1/[/code] [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]Economy[/b] permissions.…

When a requestid is resubmitted, it will not cause the work to be performed again; the response message will be the current state of items affected by the original successful execution.[/td][td][/td][/tr] [/table] Adds a promo item to a user's inventory. If called without the itemdefid parameter, checks for and grants available promo items for the given player. …

In contrast to the PlayStation 4 controller and Steam controller, it has neither trackpads nor gyroscope. A slight evolution of the Xbox 360 controller, it features identical input capabilities in a revised form factor. [docimg=xboxone_controller.png]xboxone_controller.png[/docimg] The physical inputs are identical to the [doclink=features/steam_controller/device/x360_controller]Xbox 360 Controller[/doclink], with a few small cosmetic differences: [*] The face buttons have a darker color scheme [*] The Dpad has a more traditional form factor [*] The Xbox guide (aka "home") button has a new design [*] The BACK and START buttons are now called VIEW and MENU and have new labels (two overlapping windows and a 3-line "hamburger menu"). …

In contrast to the Playstation 4 controller and Steam controller, it has neither trackpads nor gyroscope. It was the flagship device for Microsoft's highly influential XInput control standard and has traditionally been the most widely-supported controller for PC gaming. [docimg=xbox360_controller.png]xbox360_controller.png[/docimg] [subsection=FaceButtons]Face buttons[/subsection] [b]Digital[/b] The Xbox 360 controller features four standard face buttons labeled A, B, X, and Y. …

[/td][/tr] [tr][td][b]handlesOut[/b][/td][td][apitype]ISteamController::ControllerActionSetHandle_t[/apitype]*[/td][td]This must point to a [apitype]ISteamController::STEAM_CONTROLLER_MAX_COUNT[/apitype] sized array of ControllerHandle_t.…

[b]Example:[/b] [code=cpp]ControllerHandle_t *controllerHandles = new ControllerHandle_t[ STEAM_CONTROLLER_MAX_COUNT ]; SteamController()->GetConnectedControllers( controllerHandles );[/code] [subsection=GetControllerForGamepadIndex]GetControllerForGamepadIndex[/subsection] [code=cpp]ControllerHandle_t GetControllerForGamepadIndex( int nIndex );[/code] [table] [tr][th]Name[/th][th]Type[/th][th]Description[/th][/tr] [tr][td][b]nIndex[/b][/td][td]int[/td][td]The index of the emulated gamepad you want to get a controller handle for.…

Any of these configurations can be used in the same way as the Steam controller's trackpads, with the exception of haptic feedback. [docimg=ds4_controller_touchpad.png]ds4_controller_touchpad.png[/docimg] [subsection=GYRO]Gyro sensor[/subsection] [b]Analog, 3 axes[/b] Like the Steam controller, the PlayStation 4 controller also has a built-in gyro sensor with similar functionality, and likewise has 3 axes of motion (pitch, yaw, and roll). [docimg=ds4_controller_gyro.png]ds4_controller_gyro.png[/docimg] …

issueid=938]submit a ticket[/url] to get the process started. Once you've confirmed that you've [doclink=/store/promo/organizers#10]read the rules[/doclink], Steam will enable a sale page so you can begin building your event. At this time, your event will be reviewed for any potential curated homepage featuring. …

Let's go into general controller settings first: [docimg=controller_settings_desktop.png]controller_settings_desktop.png[/docimg] If you are using a PlayStation 4, Xbox One, Xbox 360, or generic controller, make sure you have the corresponding configuration support boxes checked. …

The four buttons at the top -- Editor Controls, Battle Controls, Map Controls, and Menu Controls -- are [i]action sets[/i]. Whenever you bring up an in-game menu, the game sends a signal via the API to activate the "Menu Controls" action set. …