IMarketingMessagesService – Steam Web API Documentation

This page is just a reference of all the known Steam APIs, I do not know how they work. Please do not email me with questions.

UNDOCUMENTEDPOSTCreateMarketingMessage

Create a new marketing message.

https://api.steampowered.com/IMarketingMessagesService/CreateMarketingMessage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
message		CMarketingMessageProto	No
↳ gid		fixed64	No
↳ title		string	No
↳ type		EMarketingMessageType	No	enum
↳ visibility		EMarketingMessageVisibility	No	enum
↳ priority		uint32	No
↳ association_type		EMarketingMessageAssociationType	No	enum
↳ associated_id		uint32	No
↳ associated_name		string	No
↳ start_date		uint32	No
↳ end_date		uint32	No
↳ country_allow		string	No
↳ country_deny		string	No
↳ ownership_restrictions_overridden		bool	No
↳ must_own_appid		uint32	No
↳ must_not_own_appid		uint32	No
↳ must_own_packageid		uint32	No
↳ must_not_own_packageid		uint32	No
↳ must_have_launched_appid		uint32	No
↳ additional_restrictions		string	No
↳ template_type		string	No
↳ template_vars		string	No
↳ flags		uint32	No
↳ creator_name		string	No
↳ template_vars_json		string	No
↳ additional_restrictions_json		string	No
from_json		bool	No	If set, then overwrite the template_vars and additional_restrictions keyvalues from json

UNDOCUMENTEDPOSTDeleteMarketingMessage

Delete a marketing message.

https://api.steampowered.com/IMarketingMessagesService/DeleteMarketingMessage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No

UNDOCUMENTEDDoesUserHavePendingMarketingMessages

Returns a boolean if the user has pending marketing messages. Intended to be fast.

https://api.steampowered.com/IMarketingMessagesService/DoesUserHavePendingMarketingMessages/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
country_code		string	No
elanguage		int32	No
operating_system		int32	No	EOSType from client
client_package_version		int32	No

UNDOCUMENTEDPOSTFindMarketingMessages

Search for marketing messages by name, type, etc.

https://api.steampowered.com/IMarketingMessagesService/FindMarketingMessages/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
lookup_type		EMarketingMessageLookupType	No	enum
gid		fixed64	No
message_type		EMarketingMessageType	No	enum
gidlist[0]		fixed64[]	No
title		string	No

UNDOCUMENTEDGetActiveMarketingMessages

Get a list of active marketing messages.

https://api.steampowered.com/IMarketingMessagesService/GetActiveMarketingMessages/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
country		string	No
anonymous_user		bool	No	Will not return any marketing message that requires ownership/playtime/wishlist

UNDOCUMENTEDGetDisplayMarketingMessage

Get a single marketing message, cacheable.

https://api.steampowered.com/IMarketingMessagesService/GetDisplayMarketingMessage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
context		StoreBrowseContext	No
↳ language		string	No
↳ elanguage		int32	No
↳ country_code		string	No
data_request		StoreBrowseItemDataRequest	No	If passed, item data will be returned
↳ include_assets		bool	No
↳ include_release		bool	No
↳ include_platforms		bool	No
↳ include_all_purchase_options		bool	No
↳ include_screenshots		bool	No
↳ include_trailers		bool	No
↳ include_ratings		bool	No
↳ include_tag_count		int32	No
↳ include_reviews		bool	No
↳ include_basic_info		bool	No
↳ include_supported_languages		bool	No
↳ include_full_description		bool	No
↳ include_included_items		bool	No
↳ included_item_data_request		StoreBrowseItemDataRequest	No
↳ include_assets_without_overrides		bool	No
↳ apply_user_filters		bool	No
↳ include_links		bool	No

UNDOCUMENTEDGetDisplayMarketingMessageAdmin

Get a single marketing message, cacheable.

https://api.steampowered.com/IMarketingMessagesService/GetDisplayMarketingMessageAdmin/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
context		StoreBrowseContext	No
↳ language		string	No
↳ elanguage		int32	No
↳ country_code		string	No
data_request		StoreBrowseItemDataRequest	No	If passed, item data will be returned
↳ include_assets		bool	No
↳ include_release		bool	No
↳ include_platforms		bool	No
↳ include_all_purchase_options		bool	No
↳ include_screenshots		bool	No
↳ include_trailers		bool	No
↳ include_ratings		bool	No
↳ include_tag_count		int32	No
↳ include_reviews		bool	No
↳ include_basic_info		bool	No
↳ include_supported_languages		bool	No
↳ include_full_description		bool	No
↳ include_included_items		bool	No
↳ included_item_data_request		StoreBrowseItemDataRequest	No
↳ include_assets_without_overrides		bool	No
↳ apply_user_filters		bool	No
↳ include_links		bool	No

UNDOCUMENTEDGetDisplayMarketingMessageForUser

Get a single marketing message, which can be customized per user.

https://api.steampowered.com/IMarketingMessagesService/GetDisplayMarketingMessageForUser/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
context		StoreBrowseContext	No
↳ language		string	No
↳ elanguage		int32	No
↳ country_code		string	No
data_request		StoreBrowseItemDataRequest	No	If passed, item data will be returned
↳ include_assets		bool	No
↳ include_release		bool	No
↳ include_platforms		bool	No
↳ include_all_purchase_options		bool	No
↳ include_screenshots		bool	No
↳ include_trailers		bool	No
↳ include_ratings		bool	No
↳ include_tag_count		int32	No
↳ include_reviews		bool	No
↳ include_basic_info		bool	No
↳ include_supported_languages		bool	No
↳ include_full_description		bool	No
↳ include_included_items		bool	No
↳ included_item_data_request		StoreBrowseItemDataRequest	No
↳ include_assets_without_overrides		bool	No
↳ apply_user_filters		bool	No
↳ include_links		bool	No

UNDOCUMENTEDPOSTGetMarketingMessage

Get a single marketing message. Admin account needed for non-active messages

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No

UNDOCUMENTEDPOSTGetMarketingMessageClickedStats

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessageClickedStats/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No

UNDOCUMENTEDPOSTGetMarketingMessageViewerStats

For a specific marketing message, then all of the viewership stats for the date range it was intended to be visible to customers

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessageViewerStats/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No

UNDOCUMENTEDPOSTGetMarketingMessagesForApps

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesForApps/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
appids[0]		uint32[]	No

UNDOCUMENTEDGetMarketingMessagesForPartner

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesForPartner/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
partnerid		uint32	No

UNDOCUMENTEDGetMarketingMessagesForUser

Get a list of active marketing messages filtered for a specific user.

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesForUser/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
include_seen_messages		bool	No
country_code		string	No
elanguage		int32	No
operating_system		int32	No	EOSType from client
client_package_version		int32	No
context		StoreBrowseContext	No	Optional, server can fill in from country code/language if not set
↳ language		string	No
↳ elanguage		int32	No
↳ country_code		string	No
data_request		StoreBrowseItemDataRequest	No	If passed, item data will be returned
↳ include_assets		bool	No
↳ include_release		bool	No
↳ include_platforms		bool	No
↳ include_all_purchase_options		bool	No
↳ include_screenshots		bool	No
↳ include_trailers		bool	No
↳ include_ratings		bool	No
↳ include_tag_count		int32	No
↳ include_reviews		bool	No
↳ include_basic_info		bool	No
↳ include_supported_languages		bool	No
↳ include_full_description		bool	No
↳ include_included_items		bool	No
↳ included_item_data_request		StoreBrowseItemDataRequest	No
↳ include_assets_without_overrides		bool	No
↳ apply_user_filters		bool	No
↳ include_links		bool	No

UNDOCUMENTEDPOSTGetMarketingMessagesViewerRangeStats

For a time range, return the seen stats across all of the marketing messages

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesViewerRangeStats/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
rt_start_time		uint32	No
rt_end_time		uint32	No

UNDOCUMENTEDGetPartnerMessagePreview

partner endpoint to get a marketing message preview that is approved for publishing

https://api.steampowered.com/IMarketingMessagesService/GetPartnerMessagePreview/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
partnerid		uint32	No

UNDOCUMENTEDGetPartnerReadyToPublishMessages

Are there any marketing messages that are staged for this partner to control publishing and visibility upon?

https://api.steampowered.com/IMarketingMessagesService/GetPartnerReadyToPublishMessages/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
partnerid		uint32	No

UNDOCUMENTEDGetPastMarketingMessages

https://api.steampowered.com/IMarketingMessagesService/GetPastMarketingMessages/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
start_past_days		uint32	No
upto_past_days		uint32	No

UNDOCUMENTEDPOSTMarkMessageClicked

https://api.steampowered.com/IMarketingMessagesService/MarkMessageClicked/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
display_index		uint32	No
template_type		int32	No	enum
click_location		int32	No	enum

UNDOCUMENTEDPOSTMarkMessageSeen

Mark that a user has viewed a message (so we won't show it again)'.

https://api.steampowered.com/IMarketingMessagesService/MarkMessageSeen/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
display_index		uint32	No	Where in the stack was the marketing message, 1-based, zero means we don't know
template_type		EMarketingMessageTemplateType	No	Which type of template did they see

UNDOCUMENTEDPublishPartnerMessage

partner endpoint to publish a marketing message

https://api.steampowered.com/IMarketingMessagesService/PublishPartnerMessage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
partnerid		uint32	No

UNDOCUMENTEDPOSTUpdateMarketingMessage

Modify a marketing message.

https://api.steampowered.com/IMarketingMessagesService/UpdateMarketingMessage/v1/

Name	Value	Type	Required	Description
key	click to set	string	Yes	Access key
gid		fixed64	No
message		CMarketingMessageProto	No
↳ gid		fixed64	No
↳ title		string	No
↳ type		EMarketingMessageType	No	enum
↳ visibility		EMarketingMessageVisibility	No	enum
↳ priority		uint32	No
↳ association_type		EMarketingMessageAssociationType	No	enum
↳ associated_id		uint32	No
↳ associated_name		string	No
↳ start_date		uint32	No
↳ end_date		uint32	No
↳ country_allow		string	No
↳ country_deny		string	No
↳ ownership_restrictions_overridden		bool	No
↳ must_own_appid		uint32	No
↳ must_not_own_appid		uint32	No
↳ must_own_packageid		uint32	No
↳ must_not_own_packageid		uint32	No
↳ must_have_launched_appid		uint32	No
↳ additional_restrictions		string	No
↳ template_type		string	No
↳ template_vars		string	No
↳ flags		uint32	No
↳ creator_name		string	No
↳ template_vars_json		string	No
↳ additional_restrictions_json		string	No
from_json		bool	No	If set, then overwrite the template_vars and additional_restrictions keyvalues from json