steamutils 1.2.51 → 1.2.52

Sign up to get free protection for your applications and to get access to all the features.
Files changed (226) hide show
  1. package/.idea/codeStyles/codeStyleConfig.xml +5 -0
  2. package/.idea/steamutils.iml +1 -1
  3. package/.idea/vcs.xml +1 -1
  4. package/SteamClient.js +16 -12
  5. package/example.js +14 -0
  6. package/helpers/protos.js +21 -0
  7. package/package.json +6 -6
  8. package/protos/{base_gcmessages.proto → csgo/base_gcmessages_csgo.proto} +547 -533
  9. package/protos/csgo/c_peer2peer_netmessages.proto +55 -0
  10. package/protos/csgo/clientmessages.proto +48 -0
  11. package/protos/csgo/connectionless_netmessages.proto +19 -0
  12. package/protos/csgo/cs_gameevents.proto +34 -0
  13. package/protos/csgo/cs_usercmd.proto +34 -0
  14. package/protos/{cstrike15_gcmessages.proto → csgo/cstrike15_gcmessages.proto} +1402 -1344
  15. package/protos/{cstrike15_usermessages.proto → csgo/cstrike15_usermessages.proto} +596 -597
  16. package/protos/csgo/demo.proto +160 -0
  17. package/protos/{econ_gcmessages.proto → csgo/econ_gcmessages.proto} +228 -225
  18. package/protos/{engine_gcmessages.proto → csgo/engine_gcmessages.proto} +14 -16
  19. package/protos/{enums_clientserver.proto → csgo/enums_clientserver.proto} +1529 -1534
  20. package/protos/{fatdemo.proto → csgo/fatdemo.proto} +125 -125
  21. package/protos/csgo/gameevents.proto +120 -0
  22. package/protos/{gcsdk_gcmessages.proto → csgo/gcsdk_gcmessages.proto} +323 -302
  23. package/protos/{gcsystemmsgs.proto → csgo/gcsystemmsgs.proto} +242 -246
  24. package/protos/csgo/netmessages.proto +604 -0
  25. package/protos/csgo/network_connection.proto +126 -0
  26. package/protos/csgo/networkbasetypes.proto +244 -0
  27. package/protos/csgo/networksystem_protomessages.proto +17 -0
  28. package/protos/{steamdatagram_messages_auth.proto → csgo/steamdatagram_messages_auth.proto} +65 -65
  29. package/protos/csgo/steamdatagram_messages_sdr.proto +534 -0
  30. package/protos/{steammessages.proto → csgo/steammessages.proto} +597 -601
  31. package/protos/{steammessages_base.proto → csgo/steammessages_base.proto} +301 -288
  32. package/protos/csgo/steammessages_cloud.steamworkssdk.proto +68 -0
  33. package/protos/{steammessages_gamenetworkingui.proto → csgo/steammessages_gamenetworkingui.proto} +61 -42
  34. package/protos/csgo/steammessages_helprequest.steamworkssdk.proto +22 -0
  35. package/protos/csgo/steammessages_oauth.steamworkssdk.proto +18 -0
  36. package/protos/csgo/steammessages_player.steamworkssdk.proto +254 -0
  37. package/protos/csgo/steammessages_publishedfile.steamworkssdk.proto +233 -0
  38. package/protos/csgo/steammessages_steamlearn.steamworkssdk.proto +357 -0
  39. package/protos/csgo/steammessages_unified_base.steamworkssdk.proto +30 -0
  40. package/protos/{steamnetworkingsockets_messages.proto → csgo/steamnetworkingsockets_messages.proto} +205 -204
  41. package/protos/{steamnetworkingsockets_messages_certs.proto → csgo/steamnetworkingsockets_messages_certs.proto} +39 -38
  42. package/protos/{steamnetworkingsockets_messages_udp.proto → csgo/steamnetworkingsockets_messages_udp.proto} +75 -75
  43. package/protos/csgo/te.proto +259 -0
  44. package/protos/{uifontfile_format.proto → csgo/uifontfile_format.proto} +13 -16
  45. package/protos/csgo/usercmd.proto +38 -0
  46. package/protos/csgo/usermessages.proto +721 -0
  47. package/protos/csgo/valveextensions.proto +17 -0
  48. package/protos/google/protobuf/descriptor.proto +281 -0
  49. package/protos/{clientmetrics.proto → steam/clientmetrics.proto} +45 -45
  50. package/protos/{content_manifest.proto → steam/content_manifest.proto} +62 -62
  51. package/protos/steam/contenthubs.proto +41 -0
  52. package/protos/{encrypted_app_ticket.proto → steam/encrypted_app_ticket.proto} +10 -10
  53. package/protos/{enums.proto → steam/enums.proto} +444 -285
  54. package/protos/steam/enums_clientserver.proto +1539 -0
  55. package/protos/steam/enums_productinfo.proto +13 -0
  56. package/protos/{htmlmessages.proto → steam/htmlmessages.proto} +1027 -993
  57. package/protos/steam/offline_ticket.proto +8 -0
  58. package/protos/{renderer → steam/renderer}/rendermessages.proto +893 -893
  59. package/protos/steam/steamdatagram_messages_auth.proto +65 -0
  60. package/protos/{steamdatagram_messages_sdr.proto → steam/steamdatagram_messages_sdr.proto} +533 -518
  61. package/protos/{steammessages_accounthardware.steamclient.proto → steam/steammessages_accounthardware.steamclient.proto} +201 -188
  62. package/protos/{steammessages_appoverview.proto → steam/steammessages_appoverview.proto} +187 -185
  63. package/protos/steam/steammessages_auth.steamclient.proto +435 -0
  64. package/protos/steam/steammessages_base.proto +332 -0
  65. package/protos/{steammessages_broadcast.steamclient.proto → steam/steammessages_broadcast.steamclient.proto} +759 -756
  66. package/protos/{steammessages_chat.steamclient.proto → steam/steammessages_chat.steamclient.proto} +1281 -1281
  67. package/protos/steam/steammessages_client_objects.proto +645 -0
  68. package/protos/{steammessages_clientlanp2p.proto → steam/steammessages_clientlanp2p.proto} +42 -26
  69. package/protos/{steammessages_clientmetrics.steamclient.proto → steam/steammessages_clientmetrics.steamclient.proto} +194 -176
  70. package/protos/{steammessages_clientnotificationtypes.proto → steam/steammessages_clientnotificationtypes.proto} +231 -129
  71. package/protos/{steammessages_clientserver.proto → steam/steammessages_clientserver.proto} +392 -384
  72. package/protos/{steammessages_clientserver_2.proto → steam/steammessages_clientserver_2.proto} +760 -776
  73. package/protos/{steammessages_clientserver_appinfo.proto → steam/steammessages_clientserver_appinfo.proto} +131 -166
  74. package/protos/{steammessages_clientserver_friends.proto → steam/steammessages_clientserver_friends.proto} +260 -260
  75. package/protos/{steammessages_clientserver_gameservers.proto → steam/steammessages_clientserver_gameservers.proto} +159 -159
  76. package/protos/{steammessages_clientserver_lbs.proto → steam/steammessages_clientserver_lbs.proto} +70 -70
  77. package/protos/{steammessages_clientserver_login.proto → steam/steammessages_clientserver_login.proto} +167 -159
  78. package/protos/{steammessages_clientserver_mms.proto → steam/steammessages_clientserver_mms.proto} +228 -235
  79. package/protos/{steammessages_clientserver_ucm.proto → steam/steammessages_clientserver_ucm.proto} +205 -202
  80. package/protos/{steammessages_clientserver_uds.proto → steam/steammessages_clientserver_uds.proto} +124 -104
  81. package/protos/{steammessages_clientserver_ufs.proto → steam/steammessages_clientserver_ufs.proto} +172 -172
  82. package/protos/{steammessages_clientserver_userstats.proto → steam/steammessages_clientserver_userstats.proto} +80 -80
  83. package/protos/steam/steammessages_clientsettings.proto +168 -0
  84. package/protos/{steammessages_cloud.steamclient.proto → steam/steammessages_cloud.steamclient.proto} +513 -512
  85. package/protos/{steammessages_contentsystem.steamclient.proto → steam/steammessages_contentsystem.steamclient.proto} +115 -77
  86. package/protos/{steammessages_credentials.steamclient.proto → steam/steammessages_credentials.steamclient.proto} +115 -141
  87. package/protos/steam/steammessages_datapublisher.steamclient.proto +116 -0
  88. package/protos/{steammessages_depotbuilder.steamclient.proto → steam/steammessages_depotbuilder.steamclient.proto} +118 -118
  89. package/protos/{steammessages_deviceauth.steamclient.proto → steam/steammessages_deviceauth.steamclient.proto} +203 -200
  90. package/protos/{steammessages_econ.steamclient.proto → steam/steammessages_econ.steamclient.proto} +150 -105
  91. package/protos/{steammessages_friendmessages.steamclient.proto → steam/steammessages_friendmessages.steamclient.proto} +168 -168
  92. package/protos/{steammessages_gamenetworking.steamclient.proto → steam/steammessages_gamenetworking.steamclient.proto} +32 -32
  93. package/protos/steam/steammessages_gamenetworkingui.proto +61 -0
  94. package/protos/{steammessages_gamenotifications.steamclient.proto → steam/steammessages_gamenotifications.steamclient.proto} +156 -156
  95. package/protos/{steammessages_gameservers.steamclient.proto → steam/steammessages_gameservers.steamclient.proto} +152 -152
  96. package/protos/{steammessages_hiddevices.proto → steam/steammessages_hiddevices.proto} +157 -156
  97. package/protos/{steammessages_inventory.steamclient.proto → steam/steammessages_inventory.steamclient.proto} +224 -224
  98. package/protos/{steammessages_linkfilter.steamclient.proto → steam/steammessages_linkfilter.steamclient.proto} +49 -49
  99. package/protos/{steammessages_lobbymatchmaking.steamclient.proto → steam/steammessages_lobbymatchmaking.steamclient.proto} +33 -33
  100. package/protos/{steammessages_market.steamclient.proto → steam/steammessages_market.steamclient.proto} +26 -26
  101. package/protos/steam/steammessages_marketingmessages.steamclient.proto +274 -0
  102. package/protos/{steammessages_offline.steamclient.proto → steam/steammessages_offline.steamclient.proto} +40 -37
  103. package/protos/{steammessages_parental.steamclient.proto → steam/steammessages_parental.steamclient.proto} +228 -186
  104. package/protos/{steammessages_parties.steamclient.proto → steam/steammessages_parties.steamclient.proto} +94 -94
  105. package/protos/{steammessages_partnerapps.steamclient.proto → steam/steammessages_partnerapps.steamclient.proto} +138 -136
  106. package/protos/{steammessages_player.steamclient.proto → steam/steammessages_player.steamclient.proto} +1060 -912
  107. package/protos/{steammessages_publishedfile.steamclient.proto → steam/steammessages_publishedfile.steamclient.proto} +813 -711
  108. package/protos/{steammessages_qms.steamclient.proto → steam/steammessages_qms.steamclient.proto} +125 -125
  109. package/protos/{steammessages_remoteclient.proto → steam/steammessages_remoteclient.proto} +99 -99
  110. package/protos/{steammessages_remoteclient_discovery.proto → steam/steammessages_remoteclient_discovery.proto} +235 -228
  111. package/protos/{steammessages_remoteclient_service.steamclient.proto → steam/steammessages_remoteclient_service.steamclient.proto} +86 -90
  112. package/protos/{steammessages_remoteclient_service_messages.proto → steam/steammessages_remoteclient_service_messages.proto} +217 -196
  113. package/protos/{steammessages_remoteplay.proto → steam/steammessages_remoteplay.proto} +976 -871
  114. package/protos/{steammessages_secrets.steamclient.proto → steam/steammessages_secrets.steamclient.proto} +39 -39
  115. package/protos/{steammessages_shader.steamclient.proto → steam/steammessages_shader.steamclient.proto} +108 -96
  116. package/protos/{steammessages_site_license.steamclient.proto → steam/steammessages_site_license.steamclient.proto} +128 -128
  117. package/protos/{steammessages_sitelicenseclient.proto → steam/steammessages_sitelicenseclient.proto} +38 -38
  118. package/protos/{steammessages_siteserverui.proto → steam/steammessages_siteserverui.proto} +130 -130
  119. package/protos/{steammessages_star.steamclient.proto → steam/steammessages_star.steamclient.proto} +64 -64
  120. package/protos/{steammessages_steamtv.steamclient.proto → steam/steammessages_steamtv.steamclient.proto} +630 -630
  121. package/protos/{steammessages_store.steamclient.proto → steam/steammessages_store.steamclient.proto} +371 -262
  122. package/protos/steam/steammessages_storebrowse.steamclient.proto +402 -0
  123. package/protos/{steammessages_timedtrial.steamclient.proto → steam/steammessages_timedtrial.steamclient.proto} +50 -50
  124. package/protos/{steammessages_twofactor.steamclient.proto → steam/steammessages_twofactor.steamclient.proto} +186 -154
  125. package/protos/{steammessages_unified_base.steamclient.proto → steam/steammessages_unified_base.steamclient.proto} +33 -33
  126. package/protos/{steammessages_unified_test.steamclient.proto → steam/steammessages_unified_test.steamclient.proto} +61 -50
  127. package/protos/{steammessages_useraccount.steamclient.proto → steam/steammessages_useraccount.steamclient.proto} +249 -210
  128. package/protos/{steammessages_vac.steamclient.proto → steam/steammessages_vac.steamclient.proto} +44 -44
  129. package/protos/steam/steammessages_video.steamclient.proto +171 -0
  130. package/protos/{steammessages_virtualcontroller.proto → steam/steammessages_virtualcontroller.proto} +138 -138
  131. package/protos/{steammessages_workshop.steamclient.proto → steam/steammessages_workshop.steamclient.proto} +23 -23
  132. package/protos/steam/steamnetworkingsockets_messages.proto +205 -0
  133. package/protos/steam/steamnetworkingsockets_messages_certs.proto +39 -0
  134. package/protos/steam/steamnetworkingsockets_messages_udp.proto +75 -0
  135. package/protos/steam/webuimessages_base.proto +24 -0
  136. package/protos/steam/webuimessages_gamenotes.proto +21 -0
  137. package/protos/steam/webuimessages_steamengine.proto +32 -0
  138. package/protos/steam/webuimessages_storagedevicemanager.proto +110 -0
  139. package/protos/steam/webuimessages_systemmanager.proto +17 -0
  140. package/protos/steam/webuimessages_transport.proto +18 -0
  141. package/protos/steam/webuimessages_transportvalidation.proto +97 -0
  142. package/protos/webui/common.proto +5508 -0
  143. package/protos/webui/common_base.proto +27 -0
  144. package/protos/webui/service_accountlinking.proto +27 -0
  145. package/protos/webui/service_accountprivacy.proto +42 -0
  146. package/protos/webui/service_auction.proto +97 -0
  147. package/protos/webui/service_authentication.proto +222 -0
  148. package/protos/webui/service_authenticationsupport.proto +74 -0
  149. package/protos/webui/service_broadcast.proto +562 -0
  150. package/protos/webui/service_chat.proto +11 -0
  151. package/protos/webui/service_chatroom.proto +810 -0
  152. package/protos/webui/service_chatusability.proto +107 -0
  153. package/protos/webui/service_clan.proto +41 -0
  154. package/protos/webui/service_clanchatrooms.proto +25 -0
  155. package/protos/webui/service_clanfaqs.proto +202 -0
  156. package/protos/webui/service_clientcomm.proto +150 -0
  157. package/protos/webui/service_clientmetrics.proto +63 -0
  158. package/protos/webui/service_cloud.proto +222 -0
  159. package/protos/webui/service_cloudconfigstore.proto +51 -0
  160. package/protos/webui/service_cloudgaming.proto +30 -0
  161. package/protos/webui/service_community.proto +365 -0
  162. package/protos/webui/service_econ.proto +134 -0
  163. package/protos/webui/service_embedded.proto +24 -0
  164. package/protos/webui/service_experimentservice.proto +6 -0
  165. package/protos/webui/service_fovasvideo.proto +15 -0
  166. package/protos/webui/service_friendmessages.proto +133 -0
  167. package/protos/webui/service_friendslist.proto +70 -0
  168. package/protos/webui/service_gamenotes.proto +15 -0
  169. package/protos/webui/service_helprequestlogs.proto +26 -0
  170. package/protos/webui/service_loyaltyrewards.proto +252 -0
  171. package/protos/webui/service_marketingmessages.proto +184 -0
  172. package/protos/webui/service_mobileapp.proto +18 -0
  173. package/protos/webui/service_mobileauth.proto +24 -0
  174. package/protos/webui/service_mobiledevice.proto +26 -0
  175. package/protos/webui/service_mobileperaccount.proto +31 -0
  176. package/protos/webui/service_news.proto +101 -0
  177. package/protos/webui/service_parental.proto +178 -0
  178. package/protos/webui/service_partnermembershipinvite.proto +29 -0
  179. package/protos/webui/service_partnerstorebrowse.proto +6 -0
  180. package/protos/webui/service_phone.proto +51 -0
  181. package/protos/webui/service_physicalgoods.proto +15 -0
  182. package/protos/webui/service_player.proto +885 -0
  183. package/protos/webui/service_promotioneventinvites.proto +50 -0
  184. package/protos/webui/service_promotionplanning.proto +72 -0
  185. package/protos/webui/service_publishedfile.proto +687 -0
  186. package/protos/webui/service_publishing.proto +119 -0
  187. package/protos/webui/service_quest.proto +127 -0
  188. package/protos/webui/service_salefeature.proto +315 -0
  189. package/protos/webui/service_saleitemrewards.proto +54 -0
  190. package/protos/webui/service_shoppingcart.proto +108 -0
  191. package/protos/webui/service_steamawards.proto +19 -0
  192. package/protos/webui/service_steamcharts.proto +75 -0
  193. package/protos/webui/service_steamengine.proto +36 -0
  194. package/protos/webui/service_steamlearn.proto +727 -0
  195. package/protos/webui/service_steamnotification.proto +84 -0
  196. package/protos/webui/service_steamtv.proto +495 -0
  197. package/protos/webui/service_steamvrvoicechat.proto +67 -0
  198. package/protos/webui/service_steamvrwebrtc.proto +48 -0
  199. package/protos/webui/service_storagedevicemanager.proto +104 -0
  200. package/protos/webui/service_store.proto +289 -0
  201. package/protos/webui/service_storeappsimilarity.proto +76 -0
  202. package/protos/webui/service_storebrowse.proto +73 -0
  203. package/protos/webui/service_storequery.proto +97 -0
  204. package/protos/webui/service_storesales.proto +15 -0
  205. package/protos/webui/service_storetopsellers.proto +44 -0
  206. package/protos/webui/service_systemmanager.proto +11 -0
  207. package/protos/webui/service_test_transporterror.proto +6 -0
  208. package/protos/webui/service_transportauth.proto +12 -0
  209. package/protos/webui/service_transportvalidation.proto +69 -0
  210. package/protos/webui/service_twofactor.proto +181 -0
  211. package/protos/webui/service_useraccount.proto +138 -0
  212. package/protos/webui/service_usergameactivity.proto +34 -0
  213. package/protos/webui/service_usergamenotes.proto +53 -0
  214. package/protos/webui/service_usernews.proto +68 -0
  215. package/protos/webui/service_userreviews.proto +96 -0
  216. package/protos/webui/service_video.proto +128 -0
  217. package/protos/webui/service_voicechat.proto +139 -0
  218. package/protos/webui/service_webrtc.proto +52 -0
  219. package/.idea/deployment.xml +0 -21
  220. package/protos/netmessages.proto +0 -491
  221. package/protos/network_connection.proto +0 -70
  222. package/protos/steamdatagram_messages.proto +0 -205
  223. package/protos/steammessages_auth.steamclient.proto +0 -192
  224. package/protos/steammessages_client_objects.proto +0 -336
  225. package/protos/steammessages_datapublisher.steamclient.proto +0 -67
  226. package/protos/steammessages_video.steamclient.proto +0 -84
@@ -1,912 +1,1060 @@
1
- import "steammessages_base.proto";
2
- import "steammessages_unified_base.steamclient.proto";
3
- import "enums.proto";
4
-
5
- option cc_generic_services = true;
6
-
7
- enum EProfileCustomizationStyle {
8
- k_EProfileCustomizationStyleDefault = 0;
9
- k_EProfileCustomizationStyleSelected = 1;
10
- k_EProfileCustomizationStyleRarest = 2;
11
- k_EProfileCustomizationStyleMostRecent = 3;
12
- k_EProfileCustomizationStyleRandom = 4;
13
- k_EProfileCustomizationStyleHighestRated = 5;
14
- }
15
-
16
- enum EAgreementType {
17
- k_EAgreementType_Invalid = -1;
18
- k_EAgreementType_GlobalSSA = 0;
19
- k_EAgreementType_ChinaSSA = 1;
20
- }
21
-
22
- enum ENotificationSetting {
23
- k_ENotificationSettingNotifyUseDefault = 0;
24
- k_ENotificationSettingAlways = 1;
25
- k_ENotificationSettingNever = 2;
26
- }
27
-
28
- enum ETextFilterSetting {
29
- k_ETextFilterSettingSteamLabOptedOut = 0;
30
- k_ETextFilterSettingEnabled = 1;
31
- k_ETextFilterSettingEnabledAllowProfanity = 2;
32
- k_ETextFilterSettingDisabled = 3;
33
- }
34
-
35
- message CPlayer_GetMutualFriendsForIncomingInvites_Request {
36
- }
37
-
38
- message CPlayer_IncomingInviteMutualFriendList {
39
- optional fixed64 steamid = 1;
40
- repeated uint32 mutual_friend_account_ids = 2;
41
- }
42
-
43
- message CPlayer_GetMutualFriendsForIncomingInvites_Response {
44
- repeated .CPlayer_IncomingInviteMutualFriendList incoming_invite_mutual_friends_lists = 1;
45
- }
46
-
47
- message CPlayer_GetOwnedGames_Request {
48
- optional uint64 steamid = 1 [(description) = "The player we're asking about"];
49
- optional bool include_appinfo = 2 [(description) = "true if we want additional details (name, icon) about each game"];
50
- optional bool include_played_free_games = 3 [(description) = "Free games are excluded by default. If this is set, free games the user has played will be returned."];
51
- repeated uint32 appids_filter = 4 [(description) = "if set, restricts result set to the passed in apps"];
52
- optional bool include_free_sub = 5 [(description) = "Some games are in the free sub, which are excluded by default."];
53
- optional bool skip_unvetted_apps = 6 [default = true, (description) = "if set, skip unvetted store apps"];
54
- }
55
-
56
- message CPlayer_GetOwnedGames_Response {
57
- message Game {
58
- optional int32 appid = 1;
59
- optional string name = 2;
60
- optional int32 playtime_2weeks = 3;
61
- optional int32 playtime_forever = 4;
62
- optional string img_icon_url = 5;
63
- optional bool has_community_visible_stats = 7;
64
- optional int32 playtime_windows_forever = 8;
65
- optional int32 playtime_mac_forever = 9;
66
- optional int32 playtime_linux_forever = 10;
67
- }
68
-
69
- optional uint32 game_count = 1;
70
- repeated .CPlayer_GetOwnedGames_Response.Game games = 2;
71
- }
72
-
73
- message CPlayer_GetPlayNext_Request {
74
- optional uint32 max_age_seconds = 1;
75
- repeated uint32 ignore_appids = 2;
76
- }
77
-
78
- message CPlayer_GetPlayNext_Response {
79
- optional uint32 last_update_time = 1;
80
- repeated uint32 appids = 2;
81
- }
82
-
83
- message CPlayer_GetFriendsGameplayInfo_Request {
84
- optional uint32 appid = 1;
85
- }
86
-
87
- message CPlayer_GetFriendsGameplayInfo_Response {
88
- message FriendsGameplayInfo {
89
- optional fixed64 steamid = 1;
90
- optional uint32 minutes_played = 2;
91
- optional uint32 minutes_played_forever = 3;
92
- }
93
-
94
- message OwnGameplayInfo {
95
- optional fixed64 steamid = 1;
96
- optional uint32 minutes_played = 2;
97
- optional uint32 minutes_played_forever = 3;
98
- optional bool in_wishlist = 4;
99
- optional bool owned = 5;
100
- }
101
-
102
- optional .CPlayer_GetFriendsGameplayInfo_Response.OwnGameplayInfo your_info = 1;
103
- repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo in_game = 2;
104
- repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo played_recently = 3;
105
- repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo played_ever = 4;
106
- repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo owns = 5;
107
- repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo in_wishlist = 6;
108
- }
109
-
110
- message CPlayer_GetGameBadgeLevels_Request {
111
- optional uint32 appid = 1;
112
- }
113
-
114
- message CPlayer_GetGameBadgeLevels_Response {
115
- message Badge {
116
- optional int32 level = 1;
117
- optional int32 series = 2;
118
- optional uint32 border_color = 3;
119
- }
120
-
121
- optional uint32 player_level = 1;
122
- repeated .CPlayer_GetGameBadgeLevels_Response.Badge badges = 2;
123
- }
124
-
125
- message CPlayer_GetProfileBackground_Request {
126
- optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
127
- optional string language = 2;
128
- }
129
-
130
- message ProfileItem {
131
- optional uint64 communityitemid = 1;
132
- optional string image_small = 2 [(description) = "small image used in backpack or selection"];
133
- optional string image_large = 3 [(description) = "the image itself"];
134
- optional string name = 4 [(description) = "english name"];
135
- optional string item_title = 5 [(description) = "localized title"];
136
- optional string item_description = 6 [(description) = "localized description"];
137
- optional uint32 appid = 7;
138
- optional uint32 item_type = 8;
139
- optional uint32 item_class = 9;
140
- optional string movie_webm = 10 [(description) = "URL to webm, if any"];
141
- optional string movie_mp4 = 11 [(description) = "URL to mp4, if any"];
142
- optional string movie_webm_small = 13 [(description) = "URL to small webm, if any"];
143
- optional string movie_mp4_small = 14 [(description) = "URL to small mp4, if any"];
144
- optional uint32 equipped_flags = 12 [(description) = "Special flags set when equipped (EProfileItemEquippedFlag)"];
145
- }
146
-
147
- message CPlayer_GetProfileBackground_Response {
148
- optional .ProfileItem profile_background = 1;
149
- }
150
-
151
- message CPlayer_SetProfileBackground_Request {
152
- optional uint64 communityitemid = 1;
153
- }
154
-
155
- message CPlayer_SetProfileBackground_Response {
156
- }
157
-
158
- message CPlayer_GetMiniProfileBackground_Request {
159
- optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
160
- optional string language = 2;
161
- }
162
-
163
- message CPlayer_GetMiniProfileBackground_Response {
164
- optional .ProfileItem profile_background = 1;
165
- }
166
-
167
- message CPlayer_SetMiniProfileBackground_Request {
168
- optional uint64 communityitemid = 1;
169
- }
170
-
171
- message CPlayer_SetMiniProfileBackground_Response {
172
- }
173
-
174
- message CPlayer_GetAvatarFrame_Request {
175
- optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
176
- optional string language = 2;
177
- }
178
-
179
- message CPlayer_GetAvatarFrame_Response {
180
- optional .ProfileItem avatar_frame = 1;
181
- }
182
-
183
- message CPlayer_SetAvatarFrame_Request {
184
- optional uint64 communityitemid = 1;
185
- }
186
-
187
- message CPlayer_SetAvatarFrame_Response {
188
- }
189
-
190
- message CPlayer_GetAnimatedAvatar_Request {
191
- optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
192
- optional string language = 2;
193
- }
194
-
195
- message CPlayer_GetAnimatedAvatar_Response {
196
- optional .ProfileItem avatar = 1;
197
- }
198
-
199
- message CPlayer_SetAnimatedAvatar_Request {
200
- optional uint64 communityitemid = 1;
201
- }
202
-
203
- message CPlayer_SetAnimatedAvatar_Response {
204
- }
205
-
206
- message CPlayer_GetSteamDeckKeyboardSkin_Request {
207
- optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
208
- optional string language = 2;
209
- }
210
-
211
- message CPlayer_GetSteamDeckKeyboardSkin_Response {
212
- optional .ProfileItem steam_deck_keyboard_skin = 1;
213
- }
214
-
215
- message CPlayer_SetSteamDeckKeyboardSkin_Request {
216
- optional uint64 communityitemid = 1;
217
- }
218
-
219
- message CPlayer_SetSteamDeckKeyboardSkin_Response {
220
- }
221
-
222
- message CPlayer_GetProfileItemsOwned_Request {
223
- optional string language = 1;
224
- repeated .ECommunityItemClass filters = 2;
225
- }
226
-
227
- message CPlayer_GetProfileItemsOwned_Response {
228
- repeated .ProfileItem profile_backgrounds = 1;
229
- repeated .ProfileItem mini_profile_backgrounds = 2;
230
- repeated .ProfileItem avatar_frames = 3;
231
- repeated .ProfileItem animated_avatars = 4;
232
- repeated .ProfileItem profile_modifiers = 5;
233
- repeated .ProfileItem steam_deck_keyboard_skins = 6;
234
- }
235
-
236
- message CPlayer_GetProfileItemsEquipped_Request {
237
- optional fixed64 steamid = 1;
238
- optional string language = 2;
239
- }
240
-
241
- message CPlayer_GetProfileItemsEquipped_Response {
242
- optional .ProfileItem profile_background = 1;
243
- optional .ProfileItem mini_profile_background = 2;
244
- optional .ProfileItem avatar_frame = 3;
245
- optional .ProfileItem animated_avatar = 4;
246
- optional .ProfileItem profile_modifier = 5;
247
- optional .ProfileItem steam_deck_keyboard_skin = 6;
248
- }
249
-
250
- message CPlayer_SetEquippedProfileItemFlags_Request {
251
- optional uint64 communityitemid = 1;
252
- optional uint32 flags = 2 [(description) = "Set of EProfileItemEquippedFlag"];
253
- }
254
-
255
- message CPlayer_SetEquippedProfileItemFlags_Response {
256
- }
257
-
258
- message CPlayer_GetEmoticonList_Request {
259
- }
260
-
261
- message CPlayer_GetEmoticonList_Response {
262
- message Emoticon {
263
- optional string name = 1;
264
- optional int32 count = 2;
265
- optional uint32 time_last_used = 3;
266
- optional uint32 use_count = 4;
267
- optional uint32 time_received = 5;
268
- optional uint32 appid = 6;
269
- }
270
-
271
- repeated .CPlayer_GetEmoticonList_Response.Emoticon emoticons = 1;
272
- }
273
-
274
- message CPlayer_GetAchievementsProgress_Request {
275
- optional uint64 steamid = 1;
276
- optional string language = 2;
277
- repeated uint32 appids = 3;
278
- }
279
-
280
- message CPlayer_GetAchievementsProgress_Response {
281
- message AchievementProgress {
282
- optional uint32 appid = 1;
283
- optional uint32 unlocked = 2;
284
- optional uint32 total = 3;
285
- optional float percentage = 4;
286
- optional bool all_unlocked = 5;
287
- optional uint32 cache_time = 6;
288
- }
289
-
290
- repeated .CPlayer_GetAchievementsProgress_Response.AchievementProgress achievement_progress = 1;
291
- }
292
-
293
- message CPlayer_GetFavoriteBadge_Request {
294
- optional uint64 steamid = 1;
295
- }
296
-
297
- message CPlayer_GetFavoriteBadge_Response {
298
- optional bool has_favorite_badge = 1;
299
- optional uint32 badgeid = 2;
300
- optional uint64 communityitemid = 3;
301
- optional uint32 item_type = 4;
302
- optional uint32 border_color = 5;
303
- optional uint32 appid = 6;
304
- optional uint32 level = 7;
305
- }
306
-
307
- message CPlayer_SetFavoriteBadge_Request {
308
- optional uint64 communityitemid = 1;
309
- optional uint32 badgeid = 2;
310
- }
311
-
312
- message CPlayer_SetFavoriteBadge_Response {
313
- }
314
-
315
- message CPlayer_GetProfileCustomization_Request {
316
- optional fixed64 steamid = 1;
317
- optional bool include_inactive_customizations = 2;
318
- optional bool include_purchased_customizations = 3;
319
- }
320
-
321
- message ProfileCustomizationSlot {
322
- optional uint32 slot = 1;
323
- optional uint32 appid = 2;
324
- optional uint64 publishedfileid = 3;
325
- optional uint64 item_assetid = 4;
326
- optional uint64 item_contextid = 5;
327
- optional string notes = 6;
328
- optional string title = 7;
329
- optional uint32 accountid = 8;
330
- optional uint32 badgeid = 9;
331
- optional uint32 border_color = 10;
332
- optional uint64 item_classid = 11;
333
- optional uint64 item_instanceid = 12;
334
- optional .EBanContentCheckResult ban_check_result = 13 [default = k_EBanContentCheckResult_NotScanned];
335
- }
336
-
337
- message ProfileCustomization {
338
- optional .EProfileCustomizationType customization_type = 1 [default = k_EProfileCustomizationTypeInvalid];
339
- optional bool large = 2;
340
- repeated .ProfileCustomizationSlot slots = 3;
341
- optional bool active = 4;
342
- optional .EProfileCustomizationStyle customization_style = 5 [default = k_EProfileCustomizationStyleDefault];
343
- optional uint64 purchaseid = 6;
344
- optional uint32 level = 7;
345
- }
346
-
347
- message ProfileTheme {
348
- optional string theme_id = 1;
349
- optional string title = 2;
350
- }
351
-
352
- message ProfilePreferences {
353
- optional bool hide_profile_awards = 1;
354
- }
355
-
356
- message CPlayer_GetProfileCustomization_Response {
357
- message PurchasedCustomization {
358
- optional uint64 purchaseid = 1;
359
- optional .EProfileCustomizationType customization_type = 2 [default = k_EProfileCustomizationTypeInvalid];
360
- optional uint32 level = 3;
361
- }
362
-
363
- repeated .ProfileCustomization customizations = 1;
364
- optional uint32 slots_available = 2;
365
- optional .ProfileTheme profile_theme = 3;
366
- repeated .CPlayer_GetProfileCustomization_Response.PurchasedCustomization purchased_customizations = 4;
367
- optional .ProfilePreferences profile_preferences = 5;
368
- }
369
-
370
- message CPlayer_GetPurchasedProfileCustomizations_Request {
371
- optional fixed64 steamid = 1;
372
- }
373
-
374
- message CPlayer_GetPurchasedProfileCustomizations_Response {
375
- message PurchasedCustomization {
376
- optional uint64 purchaseid = 1;
377
- optional .EProfileCustomizationType customization_type = 2 [default = k_EProfileCustomizationTypeInvalid];
378
- }
379
-
380
- repeated .CPlayer_GetPurchasedProfileCustomizations_Response.PurchasedCustomization purchased_customizations = 1;
381
- }
382
-
383
- message CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Request {
384
- optional fixed64 steamid = 1;
385
- }
386
-
387
- message CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response {
388
- message PurchasedCustomization {
389
- optional .EProfileCustomizationType customization_type = 1 [default = k_EProfileCustomizationTypeInvalid];
390
- optional uint32 count = 2;
391
- }
392
-
393
- message UpgradedCustomization {
394
- optional .EProfileCustomizationType customization_type = 1 [default = k_EProfileCustomizationTypeInvalid];
395
- optional uint32 level = 2;
396
- }
397
-
398
- repeated .CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response.PurchasedCustomization purchased_customizations = 1;
399
- repeated .CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response.UpgradedCustomization upgraded_customizations = 2;
400
- }
401
-
402
- message CPlayer_GetProfileThemesAvailable_Request {
403
- }
404
-
405
- message CPlayer_GetProfileThemesAvailable_Response {
406
- repeated .ProfileTheme profile_themes = 1;
407
- }
408
-
409
- message CPlayer_SetProfileTheme_Request {
410
- optional string theme_id = 1;
411
- }
412
-
413
- message CPlayer_SetProfileTheme_Response {
414
- }
415
-
416
- message CPlayer_SetProfilePreferences_Request {
417
- optional .ProfilePreferences profile_preferences = 1;
418
- }
419
-
420
- message CPlayer_SetProfilePreferences_Response {
421
- }
422
-
423
- message CPlayer_PostStatusToFriends_Request {
424
- optional uint32 appid = 1;
425
- optional string status_text = 2;
426
- }
427
-
428
- message CPlayer_PostStatusToFriends_Response {
429
- }
430
-
431
- message CPlayer_GetPostedStatus_Request {
432
- optional uint64 steamid = 1 [(description) = "The player we're asking about"];
433
- optional uint64 postid = 2;
434
- }
435
-
436
- message CPlayer_GetPostedStatus_Response {
437
- optional uint32 accountid = 1;
438
- optional uint64 postid = 2;
439
- optional string status_text = 3;
440
- optional bool deleted = 4;
441
- optional uint32 appid = 5;
442
- }
443
-
444
- message CPlayer_DeletePostedStatus_Request {
445
- optional uint64 postid = 1;
446
- }
447
-
448
- message CPlayer_DeletePostedStatus_Response {
449
- }
450
-
451
- message CPlayer_GetLastPlayedTimes_Request {
452
- optional uint32 min_last_played = 1 [(description) = "The most recent last-played time the client already knows about"];
453
- }
454
-
455
- message CPlayer_GetLastPlayedTimes_Response {
456
- message Game {
457
- optional int32 appid = 1;
458
- optional uint32 last_playtime = 2;
459
- optional int32 playtime_2weeks = 3;
460
- optional int32 playtime_forever = 4;
461
- optional uint32 first_playtime = 5;
462
- optional int32 playtime_windows_forever = 6;
463
- optional int32 playtime_mac_forever = 7;
464
- optional int32 playtime_linux_forever = 8;
465
- optional uint32 first_windows_playtime = 9;
466
- optional uint32 first_mac_playtime = 10;
467
- optional uint32 first_linux_playtime = 11;
468
- optional uint32 last_windows_playtime = 12;
469
- optional uint32 last_mac_playtime = 13;
470
- optional uint32 last_linux_playtime = 14;
471
- }
472
-
473
- repeated .CPlayer_GetLastPlayedTimes_Response.Game games = 1;
474
- }
475
-
476
- message CPlayer_GetTimeSSAAccepted_Request {
477
- }
478
-
479
- message CPlayer_GetTimeSSAAccepted_Response {
480
- optional uint32 time_ssa_accepted = 1;
481
- optional uint32 time_ssa_updated = 2;
482
- optional uint32 time_chinassa_accepted = 3;
483
- }
484
-
485
- message CPlayer_AcceptSSA_Request {
486
- optional .EAgreementType agreement_type = 1 [default = k_EAgreementType_Invalid];
487
- optional uint32 time_signed_utc = 2;
488
- }
489
-
490
- message CPlayer_AcceptSSA_Response {
491
- }
492
-
493
- message CPlayer_GetNicknameList_Request {
494
- }
495
-
496
- message CPlayer_GetNicknameList_Response {
497
- message PlayerNickname {
498
- optional fixed32 accountid = 1;
499
- optional string nickname = 2;
500
- }
501
-
502
- repeated .CPlayer_GetNicknameList_Response.PlayerNickname nicknames = 1;
503
- }
504
-
505
- message CPlayer_GetPerFriendPreferences_Request {
506
- }
507
-
508
- message PerFriendPreferences {
509
- optional fixed32 accountid = 1;
510
- optional string nickname = 2;
511
- optional .ENotificationSetting notifications_showingame = 3 [default = k_ENotificationSettingNotifyUseDefault];
512
- optional .ENotificationSetting notifications_showonline = 4 [default = k_ENotificationSettingNotifyUseDefault];
513
- optional .ENotificationSetting notifications_showmessages = 5 [default = k_ENotificationSettingNotifyUseDefault];
514
- optional .ENotificationSetting sounds_showingame = 6 [default = k_ENotificationSettingNotifyUseDefault];
515
- optional .ENotificationSetting sounds_showonline = 7 [default = k_ENotificationSettingNotifyUseDefault];
516
- optional .ENotificationSetting sounds_showmessages = 8 [default = k_ENotificationSettingNotifyUseDefault];
517
- optional .ENotificationSetting notifications_sendmobile = 9 [default = k_ENotificationSettingNotifyUseDefault];
518
- }
519
-
520
- message CPlayer_GetPerFriendPreferences_Response {
521
- repeated .PerFriendPreferences preferences = 1;
522
- }
523
-
524
- message CPlayer_SetPerFriendPreferences_Request {
525
- optional .PerFriendPreferences preferences = 1;
526
- }
527
-
528
- message CPlayer_SetPerFriendPreferences_Response {
529
- }
530
-
531
- message CPlayer_AddFriend_Request {
532
- optional fixed64 steamid = 1 [(description) = "Steam ID of user to whom to send a friend invite."];
533
- }
534
-
535
- message CPlayer_AddFriend_Response {
536
- optional bool invite_sent = 1 [(description) = "True if the operation was successful, false otherwise."];
537
- optional uint32 friend_relationship = 2 [(description) = "the resulting relationship. Depending on state, may move directly to friends rather than invite sent"];
538
- optional int32 result = 3;
539
- }
540
-
541
- message CPlayer_RemoveFriend_Request {
542
- optional fixed64 steamid = 1 [(description) = "Steam ID of friend to remove."];
543
- }
544
-
545
- message CPlayer_RemoveFriend_Response {
546
- optional uint32 friend_relationship = 1 [(description) = "the resulting relationship"];
547
- }
548
-
549
- message CPlayer_IgnoreFriend_Request {
550
- optional fixed64 steamid = 1;
551
- optional bool unignore = 2 [(description) = "If set, remove from ignore/block list instead of adding "];
552
- }
553
-
554
- message CPlayer_IgnoreFriend_Response {
555
- optional uint32 friend_relationship = 1 [(description) = "the resulting relationship"];
556
- }
557
-
558
- message CPlayer_GetCommunityPreferences_Request {
559
- }
560
-
561
- message CPlayer_CommunityPreferences {
562
- optional bool hide_adult_content_violence = 1 [default = true];
563
- optional bool hide_adult_content_sex = 2 [default = true];
564
- optional bool parenthesize_nicknames = 4 [default = false];
565
- optional .ETextFilterSetting text_filter_setting = 5 [default = k_ETextFilterSettingSteamLabOptedOut];
566
- optional bool text_filter_ignore_friends = 6 [default = true];
567
- optional uint32 text_filter_words_revision = 7;
568
- optional uint32 timestamp_updated = 3;
569
- }
570
-
571
- message CPlayer_GetCommunityPreferences_Response {
572
- optional .CPlayer_CommunityPreferences preferences = 1;
573
- }
574
-
575
- message CPlayer_SetCommunityPreferences_Request {
576
- optional .CPlayer_CommunityPreferences preferences = 1;
577
- }
578
-
579
- message CPlayer_SetCommunityPreferences_Response {
580
- }
581
-
582
- message CPlayer_GetTextFilterWords_Request {
583
- }
584
-
585
- message CPlayer_TextFilterWords {
586
- repeated string text_filter_custom_banned_words = 1;
587
- repeated string text_filter_custom_clean_words = 2;
588
- optional uint32 text_filter_words_revision = 3;
589
- }
590
-
591
- message CPlayer_GetTextFilterWords_Response {
592
- optional .CPlayer_TextFilterWords words = 1;
593
- }
594
-
595
- message CPlayer_GetNewSteamAnnouncementState_Request {
596
- optional int32 language = 1;
597
- }
598
-
599
- message CPlayer_GetNewSteamAnnouncementState_Response {
600
- optional int32 state = 1;
601
- optional string announcement_headline = 2;
602
- optional string announcement_url = 3;
603
- optional uint32 time_posted = 4;
604
- optional uint64 announcement_gid = 5;
605
- }
606
-
607
- message CPlayer_UpdateSteamAnnouncementLastRead_Request {
608
- optional uint64 announcement_gid = 1;
609
- optional uint32 time_posted = 2;
610
- }
611
-
612
- message CPlayer_UpdateSteamAnnouncementLastRead_Response {
613
- }
614
-
615
- message CPlayer_GetPrivacySettings_Request {
616
- }
617
-
618
- message CPrivacySettings {
619
- optional int32 privacy_state = 1;
620
- optional int32 privacy_state_inventory = 2;
621
- optional int32 privacy_state_gifts = 3;
622
- optional int32 privacy_state_ownedgames = 4;
623
- optional int32 privacy_state_playtime = 5;
624
- optional int32 privacy_state_friendslist = 6;
625
- }
626
-
627
- message CPlayer_GetPrivacySettings_Response {
628
- optional .CPrivacySettings privacy_settings = 1;
629
- }
630
-
631
- message CPlayer_GetDurationControl_Request {
632
- optional uint32 appid = 1;
633
- }
634
-
635
- message CPlayer_GetDurationControl_Response {
636
- optional bool is_enabled = 1;
637
- optional int32 seconds = 2;
638
- optional int32 seconds_today = 3;
639
- optional bool is_steamchina_account = 4;
640
- optional bool is_age_verified = 5;
641
- optional uint32 seconds_allowed_today = 6;
642
- optional bool age_verification_pending = 7;
643
- optional bool block_minors = 8;
644
- }
645
-
646
- message CPlayer_LastPlayedTimes_Notification {
647
- repeated .CPlayer_GetLastPlayedTimes_Response.Game games = 1;
648
- }
649
-
650
- message CPlayer_FriendNicknameChanged_Notification {
651
- optional fixed32 accountid = 1;
652
- optional string nickname = 2;
653
- optional bool is_echo_to_self = 3;
654
- }
655
-
656
- message CPlayer_FriendEquippedProfileItemsChanged_Notification {
657
- optional fixed32 accountid = 1;
658
- }
659
-
660
- message CPlayer_NewSteamAnnouncementState_Notification {
661
- optional int32 state = 1;
662
- optional string announcement_headline = 2;
663
- optional string announcement_url = 3;
664
- optional uint32 time_posted = 4;
665
- optional uint64 announcement_gid = 5;
666
- }
667
-
668
- message CPlayer_CommunityPreferencesChanged_Notification {
669
- optional .CPlayer_CommunityPreferences preferences = 1;
670
- }
671
-
672
- message CPlayer_TextFilterWordsChanged_Notification {
673
- optional .CPlayer_TextFilterWords words = 1;
674
- }
675
-
676
- message CPlayer_PerFriendPreferencesChanged_Notification {
677
- optional fixed32 accountid = 1;
678
- optional .PerFriendPreferences preferences = 2;
679
- }
680
-
681
- message CPlayer_PrivacySettingsChanged_Notification {
682
- optional .CPrivacySettings privacy_settings = 1;
683
- }
684
-
685
- service Player {
686
- option (service_description) = "A service for accessing Steam player data";
687
-
688
- rpc GetMutualFriendsForIncomingInvites (.CPlayer_GetMutualFriendsForIncomingInvites_Request) returns (.CPlayer_GetMutualFriendsForIncomingInvites_Response) {
689
- option (method_description) = "Get me the mutual friends for each of my pending incoming invites (individuals and clans).";
690
- }
691
-
692
- rpc GetOwnedGames (.CPlayer_GetOwnedGames_Request) returns (.CPlayer_GetOwnedGames_Response) {
693
- option (method_description) = "Return a list of games owned by the player";
694
- }
695
-
696
- rpc GetPlayNext (.CPlayer_GetPlayNext_Request) returns (.CPlayer_GetPlayNext_Response) {
697
- option (method_description) = "Return suggested games for player to play next.";
698
- }
699
-
700
- rpc GetFriendsGameplayInfo (.CPlayer_GetFriendsGameplayInfo_Request) returns (.CPlayer_GetFriendsGameplayInfo_Response) {
701
- option (method_description) = "Get a list of friends who are playing, have played, own, or want a game";
702
- }
703
-
704
- rpc GetGameBadgeLevels (.CPlayer_GetGameBadgeLevels_Request) returns (.CPlayer_GetGameBadgeLevels_Response) {
705
- option (method_description) = "Returns the Steam Level of a user, the Badge level for the game, and if it's foil";
706
- }
707
-
708
- rpc GetProfileBackground (.CPlayer_GetProfileBackground_Request) returns (.CPlayer_GetProfileBackground_Response) {
709
- option (method_description) = "Gets which profile background is active for a specific user";
710
- }
711
-
712
- rpc SetProfileBackground (.CPlayer_SetProfileBackground_Request) returns (.CPlayer_SetProfileBackground_Response) {
713
- option (method_description) = "Sets the user's profile background";
714
- }
715
-
716
- rpc GetMiniProfileBackground (.CPlayer_GetMiniProfileBackground_Request) returns (.CPlayer_GetMiniProfileBackground_Response) {
717
- option (method_description) = "Gets which mini profile background is active for a specific user";
718
- }
719
-
720
- rpc SetMiniProfileBackground (.CPlayer_SetMiniProfileBackground_Request) returns (.CPlayer_SetMiniProfileBackground_Response) {
721
- option (method_description) = "Sets the user's mini profile background";
722
- }
723
-
724
- rpc GetAvatarFrame (.CPlayer_GetAvatarFrame_Request) returns (.CPlayer_GetAvatarFrame_Response) {
725
- option (method_description) = "Gets which avatar frame is active for a specific user";
726
- }
727
-
728
- rpc SetAvatarFrame (.CPlayer_SetAvatarFrame_Request) returns (.CPlayer_SetAvatarFrame_Response) {
729
- option (method_description) = "Sets the user's avatar frame for their profile";
730
- }
731
-
732
- rpc GetAnimatedAvatar (.CPlayer_GetAnimatedAvatar_Request) returns (.CPlayer_GetAnimatedAvatar_Response) {
733
- option (method_description) = "Gets which animated avatar is active for a specific user";
734
- }
735
-
736
- rpc SetAnimatedAvatar (.CPlayer_SetAnimatedAvatar_Request) returns (.CPlayer_SetAnimatedAvatar_Response) {
737
- option (method_description) = "Sets the user's animated avatar for their profile";
738
- }
739
-
740
- rpc GetSteamDeckKeyboardSkin (.CPlayer_GetSteamDeckKeyboardSkin_Request) returns (.CPlayer_GetSteamDeckKeyboardSkin_Response) {
741
- option (method_description) = "Gets which Steam Deck keyboard skin is active for a specific user";
742
- }
743
-
744
- rpc SetSteamDeckKeyboardSkin (.CPlayer_SetSteamDeckKeyboardSkin_Request) returns (.CPlayer_SetSteamDeckKeyboardSkin_Response) {
745
- option (method_description) = "Sets the user's current Steam Deck keyboard skin";
746
- }
747
-
748
- rpc GetProfileItemsOwned (.CPlayer_GetProfileItemsOwned_Request) returns (.CPlayer_GetProfileItemsOwned_Response) {
749
- option (method_description) = "Returns the items the user can equip on their profile";
750
- }
751
-
752
- rpc GetProfileItemsEquipped (.CPlayer_GetProfileItemsEquipped_Request) returns (.CPlayer_GetProfileItemsEquipped_Response) {
753
- option (method_description) = "Returns the items the user has equipped on their profile";
754
- }
755
-
756
- rpc SetEquippedProfileItemFlags (.CPlayer_SetEquippedProfileItemFlags_Request) returns (.CPlayer_SetEquippedProfileItemFlags_Response) {
757
- option (method_description) = "Sets special flags on the equipped item";
758
- }
759
-
760
- rpc GetEmoticonList (.CPlayer_GetEmoticonList_Request) returns (.CPlayer_GetEmoticonList_Response) {
761
- option (method_description) = "Gets a list of the emoticons a user has with metadata";
762
- }
763
-
764
- rpc GetAchievementsProgress (.CPlayer_GetAchievementsProgress_Request) returns (.CPlayer_GetAchievementsProgress_Response) {
765
- option (method_description) = "Gets the achievement completion stats for the specified list of apps.";
766
- }
767
-
768
- rpc GetFavoriteBadge (.CPlayer_GetFavoriteBadge_Request) returns (.CPlayer_GetFavoriteBadge_Response) {
769
- option (method_description) = "Gets the badge the user has set as their favorite";
770
- }
771
-
772
- rpc SetFavoriteBadge (.CPlayer_SetFavoriteBadge_Request) returns (.CPlayer_SetFavoriteBadge_Response) {
773
- option (method_description) = "Sets the badge as the users favorite";
774
- }
775
-
776
- rpc GetProfileCustomization (.CPlayer_GetProfileCustomization_Request) returns (.CPlayer_GetProfileCustomization_Response) {
777
- option (method_description) = "Returns the customizations (if any) for a profile";
778
- }
779
-
780
- rpc GetPurchasedProfileCustomizations (.CPlayer_GetPurchasedProfileCustomizations_Request) returns (.CPlayer_GetPurchasedProfileCustomizations_Response) {
781
- option (method_description) = "Returns the purchased profile customizations";
782
- }
783
-
784
- rpc GetPurchasedAndUpgradedProfileCustomizations (.CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Request) returns (.CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response) {
785
- option (method_description) = "Returns the purchased and upgraded profile customizations";
786
- }
787
-
788
- rpc GetProfileThemesAvailable (.CPlayer_GetProfileThemesAvailable_Request) returns (.CPlayer_GetProfileThemesAvailable_Response) {
789
- option (method_description) = "Gets themes available for the user.";
790
- }
791
-
792
- rpc SetProfileTheme (.CPlayer_SetProfileTheme_Request) returns (.CPlayer_SetProfileTheme_Response) {
793
- option (method_description) = "Selects a theme for the profile";
794
- }
795
-
796
- rpc SetProfilePreferences (.CPlayer_SetProfilePreferences_Request) returns (.CPlayer_SetProfilePreferences_Response) {
797
- option (method_description) = "Sets profile preferences";
798
- }
799
-
800
- rpc PostStatusToFriends (.CPlayer_PostStatusToFriends_Request) returns (.CPlayer_PostStatusToFriends_Response) {
801
- option (method_description) = "Posts custom status text into the blotter";
802
- }
803
-
804
- rpc GetPostedStatus (.CPlayer_GetPostedStatus_Request) returns (.CPlayer_GetPostedStatus_Response) {
805
- option (method_description) = "Gets a posted status text for a user by id";
806
- }
807
-
808
- rpc DeletePostedStatus (.CPlayer_DeletePostedStatus_Request) returns (.CPlayer_DeletePostedStatus_Response) {
809
- option (method_description) = "Deletes a posted status text for a user by id";
810
- }
811
-
812
- rpc ClientGetLastPlayedTimes (.CPlayer_GetLastPlayedTimes_Request) returns (.CPlayer_GetLastPlayedTimes_Response) {
813
- option (method_description) = "Gets the last-played times for the account";
814
- }
815
-
816
- rpc GetTimeSSAAccepted (.CPlayer_GetTimeSSAAccepted_Request) returns (.CPlayer_GetTimeSSAAccepted_Response) {
817
- option (method_description) = "Gets the time when the user accepted the SSA";
818
- }
819
-
820
- rpc AcceptSSA (.CPlayer_AcceptSSA_Request) returns (.CPlayer_AcceptSSA_Response) {
821
- option (method_description) = "User is accepting the SSA";
822
- }
823
-
824
- rpc GetNicknameList (.CPlayer_GetNicknameList_Request) returns (.CPlayer_GetNicknameList_Response) {
825
- option (method_description) = "Gets the list of nicknames this user has for other users";
826
- }
827
-
828
- rpc GetPerFriendPreferences (.CPlayer_GetPerFriendPreferences_Request) returns (.CPlayer_GetPerFriendPreferences_Response) {
829
- option (method_description) = "Gets the list of per-friend preferences this user has set for other users";
830
- }
831
-
832
- rpc SetPerFriendPreferences (.CPlayer_SetPerFriendPreferences_Request) returns (.CPlayer_SetPerFriendPreferences_Response) {
833
- option (method_description) = "Sets the logged in user's per-friend preferences for the given user";
834
- }
835
-
836
- rpc AddFriend (.CPlayer_AddFriend_Request) returns (.CPlayer_AddFriend_Response) {
837
- option (method_description) = "Invites another Steam user to be a friend";
838
- }
839
-
840
- rpc RemoveFriend (.CPlayer_RemoveFriend_Request) returns (.CPlayer_RemoveFriend_Response) {
841
- option (method_description) = "Removes a friend or ignores a friend suggestion";
842
- }
843
-
844
- rpc IgnoreFriend (.CPlayer_IgnoreFriend_Request) returns (.CPlayer_IgnoreFriend_Response) {
845
- option (method_description) = "Blocks or unblocks communication with the user. Despite name, can be a non-friend.";
846
- }
847
-
848
- rpc GetCommunityPreferences (.CPlayer_GetCommunityPreferences_Request) returns (.CPlayer_GetCommunityPreferences_Response) {
849
- option (method_description) = "Returns the player's community preferences";
850
- }
851
-
852
- rpc SetCommunityPreferences (.CPlayer_SetCommunityPreferences_Request) returns (.CPlayer_SetCommunityPreferences_Response) {
853
- option (method_description) = "Sets the player's community preferences";
854
- }
855
-
856
- rpc GetTextFilterWords (.CPlayer_GetTextFilterWords_Request) returns (.CPlayer_GetTextFilterWords_Response) {
857
- option (method_description) = "Get the custom text filtering dictionary for this user";
858
- }
859
-
860
- rpc GetNewSteamAnnouncementState (.CPlayer_GetNewSteamAnnouncementState_Request) returns (.CPlayer_GetNewSteamAnnouncementState_Response) {
861
- option (method_description) = "Calculates and returns what to display for UI that renders new steam announcement available";
862
- }
863
-
864
- rpc UpdateSteamAnnouncementLastRead (.CPlayer_UpdateSteamAnnouncementLastRead_Request) returns (.CPlayer_UpdateSteamAnnouncementLastRead_Response) {
865
- option (method_description) = "Marks latest announcement timestamp read by user";
866
- }
867
-
868
- rpc GetPrivacySettings (.CPlayer_GetPrivacySettings_Request) returns (.CPlayer_GetPrivacySettings_Response) {
869
- option (method_description) = "Get current privacy settings.";
870
- }
871
-
872
- rpc GetDurationControl (.CPlayer_GetDurationControl_Request) returns (.CPlayer_GetDurationControl_Response) {
873
- option (method_description) = "Get gameplay duration control settings.";
874
- }
875
- }
876
-
877
- service PlayerClient {
878
- option (service_description) = "Steam player data client notifications";
879
- option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
880
-
881
- rpc NotifyLastPlayedTimes (.CPlayer_LastPlayedTimes_Notification) returns (.NoResponse) {
882
- option (method_description) = "Notification from server to client of more recent play time";
883
- }
884
-
885
- rpc NotifyFriendNicknameChanged (.CPlayer_FriendNicknameChanged_Notification) returns (.NoResponse) {
886
- option (method_description) = "Notification from server to client that a friend's nickname has changed";
887
- }
888
-
889
- rpc NotifyFriendEquippedProfileItemsChanged (.CPlayer_FriendEquippedProfileItemsChanged_Notification) returns (.NoResponse) {
890
- option (method_description) = "Notification from server to client that a friend's equipped profile items have changed";
891
- }
892
-
893
- rpc NotifyNewSteamAnnouncementState (.CPlayer_NewSteamAnnouncementState_Notification) returns (.NoResponse) {
894
- option (method_description) = "Notifies client of changes to steam announcement state for user";
895
- }
896
-
897
- rpc NotifyCommunityPreferencesChanged (.CPlayer_CommunityPreferencesChanged_Notification) returns (.NoResponse) {
898
- option (method_description) = "Notification from server to client that their community preferences have changed";
899
- }
900
-
901
- rpc NotifyTextFilterWordsChanged (.CPlayer_TextFilterWordsChanged_Notification) returns (.NoResponse) {
902
- option (method_description) = "Notification from server to client that their text filtering dictionary has changed";
903
- }
904
-
905
- rpc NotifyPerFriendPreferencesChanged (.CPlayer_PerFriendPreferencesChanged_Notification) returns (.NoResponse) {
906
- option (method_description) = "Notification from server that per-friend preferences have changed";
907
- }
908
-
909
- rpc NotifyPrivacyPrivacySettingsChanged (.CPlayer_PrivacySettingsChanged_Notification) returns (.NoResponse) {
910
- option (method_description) = "Notification from server that privacy settings changed";
911
- }
912
- }
1
+ import "steammessages_base.proto";
2
+ import "steammessages_unified_base.steamclient.proto";
3
+ import "enums.proto";
4
+
5
+ option cc_generic_services = true;
6
+
7
+ enum EProfileCustomizationStyle {
8
+ k_EProfileCustomizationStyleDefault = 0;
9
+ k_EProfileCustomizationStyleSelected = 1;
10
+ k_EProfileCustomizationStyleRarest = 2;
11
+ k_EProfileCustomizationStyleMostRecent = 3;
12
+ k_EProfileCustomizationStyleRandom = 4;
13
+ k_EProfileCustomizationStyleHighestRated = 5;
14
+ }
15
+
16
+ enum EAgreementType {
17
+ k_EAgreementType_Invalid = -1;
18
+ k_EAgreementType_GlobalSSA = 0;
19
+ k_EAgreementType_ChinaSSA = 1;
20
+ }
21
+
22
+ enum ENotificationSetting {
23
+ k_ENotificationSettingNotifyUseDefault = 0;
24
+ k_ENotificationSettingAlways = 1;
25
+ k_ENotificationSettingNever = 2;
26
+ }
27
+
28
+ enum ETextFilterSetting {
29
+ k_ETextFilterSettingSteamLabOptedOut = 0;
30
+ k_ETextFilterSettingEnabled = 1;
31
+ k_ETextFilterSettingEnabledAllowProfanity = 2;
32
+ k_ETextFilterSettingDisabled = 3;
33
+ }
34
+
35
+ message CPlayer_GetPlayerLinkDetails_Request {
36
+ repeated uint64 steamids = 1;
37
+ }
38
+
39
+ message CPlayer_GetPlayerLinkDetails_Response {
40
+ message PlayerLinkDetails {
41
+ message AccountPublicData {
42
+ required fixed64 steamid = 1;
43
+ optional int32 visibility_state = 2;
44
+ optional int32 privacy_state = 3;
45
+ optional int32 profile_state = 4;
46
+ optional uint32 ban_expires_time = 7;
47
+ optional uint32 account_flags = 8;
48
+ optional bytes sha_digest_avatar = 9;
49
+ optional string persona_name = 10;
50
+ optional string profile_url = 11;
51
+ optional bool content_country_restricted = 12;
52
+ }
53
+
54
+ message AccountPrivateData {
55
+ optional int32 persona_state = 1;
56
+ optional uint32 persona_state_flags = 2;
57
+ optional uint32 time_created = 3;
58
+ optional fixed64 game_id = 4;
59
+ optional fixed64 game_server_steam_id = 5;
60
+ optional uint32 game_server_ip_address = 6;
61
+ optional uint32 game_server_port = 7;
62
+ optional string game_extra_info = 8;
63
+ optional string account_name = 9;
64
+ optional fixed64 lobby_steam_id = 10;
65
+ optional string rich_presence_kv = 11;
66
+ optional fixed64 broadcast_session_id = 12;
67
+ optional uint32 watching_broadcast_accountid = 13;
68
+ optional uint32 watching_broadcast_appid = 14;
69
+ optional uint32 watching_broadcast_viewers = 15;
70
+ optional string watching_broadcast_title = 16;
71
+ optional uint32 last_logoff_time = 17;
72
+ optional uint32 last_seen_online = 18;
73
+ optional int32 game_os_type = 19;
74
+ optional int32 game_device_type = 20;
75
+ optional string game_device_name = 21;
76
+ }
77
+
78
+ optional .CPlayer_GetPlayerLinkDetails_Response.PlayerLinkDetails.AccountPublicData public_data = 1;
79
+ optional .CPlayer_GetPlayerLinkDetails_Response.PlayerLinkDetails.AccountPrivateData private_data = 2;
80
+ }
81
+
82
+ repeated .CPlayer_GetPlayerLinkDetails_Response.PlayerLinkDetails accounts = 1;
83
+ }
84
+
85
+ message CPlayer_GetMutualFriendsForIncomingInvites_Request {
86
+ }
87
+
88
+ message CPlayer_IncomingInviteMutualFriendList {
89
+ optional fixed64 steamid = 1;
90
+ repeated uint32 mutual_friend_account_ids = 2;
91
+ }
92
+
93
+ message CPlayer_GetMutualFriendsForIncomingInvites_Response {
94
+ repeated .CPlayer_IncomingInviteMutualFriendList incoming_invite_mutual_friends_lists = 1;
95
+ }
96
+
97
+ message CPlayer_GetOwnedGames_Request {
98
+ optional uint64 steamid = 1 [(description) = "The player we're asking about"];
99
+ optional bool include_appinfo = 2 [(description) = "true if we want additional details (name, icon) about each game"];
100
+ optional bool include_played_free_games = 3 [(description) = "Free games are excluded by default. If this is set, free games the user has played will be returned."];
101
+ repeated uint32 appids_filter = 4 [(description) = "if set, restricts result set to the passed in apps"];
102
+ optional bool include_free_sub = 5 [(description) = "Some games are in the free sub, which are excluded by default."];
103
+ optional bool skip_unvetted_apps = 6 [default = true, (description) = "if set, skip unvetted store apps"];
104
+ optional string language = 7 [(description) = "Will return appinfo in this language"];
105
+ optional bool include_extended_appinfo = 8 [(description) = "true if we want even more details (capsule, sortas, and capabilities) about each game. include_appinfo must also be true."];
106
+ }
107
+
108
+ message CPlayer_GetOwnedGames_Response {
109
+ message Game {
110
+ optional int32 appid = 1;
111
+ optional string name = 2;
112
+ optional int32 playtime_2weeks = 3;
113
+ optional int32 playtime_forever = 4;
114
+ optional string img_icon_url = 5;
115
+ optional bool has_community_visible_stats = 7;
116
+ optional int32 playtime_windows_forever = 8;
117
+ optional int32 playtime_mac_forever = 9;
118
+ optional int32 playtime_linux_forever = 10;
119
+ optional uint32 rtime_last_played = 11;
120
+ optional string capsule_filename = 12;
121
+ optional string sort_as = 13;
122
+ optional bool has_workshop = 14;
123
+ optional bool has_market = 15;
124
+ optional bool has_dlc = 16;
125
+ optional bool has_leaderboards = 17;
126
+ repeated uint32 content_descriptorids = 18;
127
+ optional int32 playtime_disconnected = 19;
128
+ }
129
+
130
+ optional uint32 game_count = 1;
131
+ repeated .CPlayer_GetOwnedGames_Response.Game games = 2;
132
+ }
133
+
134
+ message CPlayer_GetPlayNext_Request {
135
+ optional uint32 max_age_seconds = 1;
136
+ repeated uint32 ignore_appids = 2;
137
+ }
138
+
139
+ message CPlayer_GetPlayNext_Response {
140
+ optional uint32 last_update_time = 1;
141
+ repeated uint32 appids = 2;
142
+ }
143
+
144
+ message CPlayer_GetFriendsGameplayInfo_Request {
145
+ optional uint32 appid = 1;
146
+ }
147
+
148
+ message CPlayer_GetFriendsGameplayInfo_Response {
149
+ message FriendsGameplayInfo {
150
+ optional fixed64 steamid = 1;
151
+ optional uint32 minutes_played = 2;
152
+ optional uint32 minutes_played_forever = 3;
153
+ }
154
+
155
+ message OwnGameplayInfo {
156
+ optional fixed64 steamid = 1;
157
+ optional uint32 minutes_played = 2;
158
+ optional uint32 minutes_played_forever = 3;
159
+ optional bool in_wishlist = 4;
160
+ optional bool owned = 5;
161
+ }
162
+
163
+ optional .CPlayer_GetFriendsGameplayInfo_Response.OwnGameplayInfo your_info = 1;
164
+ repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo in_game = 2;
165
+ repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo played_recently = 3;
166
+ repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo played_ever = 4;
167
+ repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo owns = 5;
168
+ repeated .CPlayer_GetFriendsGameplayInfo_Response.FriendsGameplayInfo in_wishlist = 6;
169
+ }
170
+
171
+ message CPlayer_GetGameBadgeLevels_Request {
172
+ optional uint32 appid = 1;
173
+ }
174
+
175
+ message CPlayer_GetGameBadgeLevels_Response {
176
+ message Badge {
177
+ optional int32 level = 1;
178
+ optional int32 series = 2;
179
+ optional uint32 border_color = 3;
180
+ }
181
+
182
+ optional uint32 player_level = 1;
183
+ repeated .CPlayer_GetGameBadgeLevels_Response.Badge badges = 2;
184
+ }
185
+
186
+ message CPlayer_GetProfileBackground_Request {
187
+ optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
188
+ optional string language = 2;
189
+ }
190
+
191
+ message ProfileItem {
192
+ message ProfileColor {
193
+ optional string style_name = 1 [(description) = "EProfileColorStyle string version"];
194
+ optional string color = 2 [(description) = "hex color to apply"];
195
+ }
196
+
197
+ optional uint64 communityitemid = 1;
198
+ optional string image_small = 2 [(description) = "small image used in backpack or selection"];
199
+ optional string image_large = 3 [(description) = "the image itself"];
200
+ optional string name = 4 [(description) = "english name"];
201
+ optional string item_title = 5 [(description) = "localized title"];
202
+ optional string item_description = 6 [(description) = "localized description"];
203
+ optional uint32 appid = 7;
204
+ optional uint32 item_type = 8;
205
+ optional uint32 item_class = 9;
206
+ optional string movie_webm = 10 [(description) = "URL to webm, if any"];
207
+ optional string movie_mp4 = 11 [(description) = "URL to mp4, if any"];
208
+ optional string movie_webm_small = 13 [(description) = "URL to small webm, if any"];
209
+ optional string movie_mp4_small = 14 [(description) = "URL to small mp4, if any"];
210
+ optional uint32 equipped_flags = 12 [(description) = "Special flags set when equipped (EProfileItemEquippedFlag)"];
211
+ repeated .ProfileItem.ProfileColor profile_colors = 15 [(description) = "Game profile css colors"];
212
+ }
213
+
214
+ message CPlayer_GetProfileBackground_Response {
215
+ optional .ProfileItem profile_background = 1;
216
+ }
217
+
218
+ message CPlayer_SetProfileBackground_Request {
219
+ optional uint64 communityitemid = 1;
220
+ }
221
+
222
+ message CPlayer_SetProfileBackground_Response {
223
+ }
224
+
225
+ message CPlayer_GetMiniProfileBackground_Request {
226
+ optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
227
+ optional string language = 2;
228
+ }
229
+
230
+ message CPlayer_GetMiniProfileBackground_Response {
231
+ optional .ProfileItem profile_background = 1;
232
+ }
233
+
234
+ message CPlayer_SetMiniProfileBackground_Request {
235
+ optional uint64 communityitemid = 1;
236
+ }
237
+
238
+ message CPlayer_SetMiniProfileBackground_Response {
239
+ }
240
+
241
+ message CPlayer_GetAvatarFrame_Request {
242
+ optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
243
+ optional string language = 2;
244
+ }
245
+
246
+ message CPlayer_GetAvatarFrame_Response {
247
+ optional .ProfileItem avatar_frame = 1;
248
+ }
249
+
250
+ message CPlayer_SetAvatarFrame_Request {
251
+ optional uint64 communityitemid = 1;
252
+ }
253
+
254
+ message CPlayer_SetAvatarFrame_Response {
255
+ }
256
+
257
+ message CPlayer_GetAnimatedAvatar_Request {
258
+ optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
259
+ optional string language = 2;
260
+ }
261
+
262
+ message CPlayer_GetAnimatedAvatar_Response {
263
+ optional .ProfileItem avatar = 1;
264
+ }
265
+
266
+ message CPlayer_SetAnimatedAvatar_Request {
267
+ optional uint64 communityitemid = 1;
268
+ }
269
+
270
+ message CPlayer_SetAnimatedAvatar_Response {
271
+ }
272
+
273
+ message CPlayer_GetSteamDeckKeyboardSkin_Request {
274
+ optional fixed64 steamid = 1 [(description) = "The player we're asking about"];
275
+ optional string language = 2;
276
+ }
277
+
278
+ message CPlayer_GetSteamDeckKeyboardSkin_Response {
279
+ optional .ProfileItem steam_deck_keyboard_skin = 1;
280
+ }
281
+
282
+ message CPlayer_SetSteamDeckKeyboardSkin_Request {
283
+ optional uint64 communityitemid = 1;
284
+ }
285
+
286
+ message CPlayer_SetSteamDeckKeyboardSkin_Response {
287
+ }
288
+
289
+ message CPlayer_GetProfileItemsOwned_Request {
290
+ optional string language = 1;
291
+ repeated .ECommunityItemClass filters = 2;
292
+ }
293
+
294
+ message CPlayer_GetProfileItemsOwned_Response {
295
+ repeated .ProfileItem profile_backgrounds = 1;
296
+ repeated .ProfileItem mini_profile_backgrounds = 2;
297
+ repeated .ProfileItem avatar_frames = 3;
298
+ repeated .ProfileItem animated_avatars = 4;
299
+ repeated .ProfileItem profile_modifiers = 5;
300
+ repeated .ProfileItem steam_deck_keyboard_skins = 6;
301
+ repeated .ProfileItem steam_deck_startup_movies = 7;
302
+ }
303
+
304
+ message CPlayer_GetProfileItemsEquipped_Request {
305
+ optional fixed64 steamid = 1;
306
+ optional string language = 2;
307
+ }
308
+
309
+ message CPlayer_GetProfileItemsEquipped_Response {
310
+ optional .ProfileItem profile_background = 1;
311
+ optional .ProfileItem mini_profile_background = 2;
312
+ optional .ProfileItem avatar_frame = 3;
313
+ optional .ProfileItem animated_avatar = 4;
314
+ optional .ProfileItem profile_modifier = 5;
315
+ optional .ProfileItem steam_deck_keyboard_skin = 6;
316
+ }
317
+
318
+ message CPlayer_SetEquippedProfileItemFlags_Request {
319
+ optional uint64 communityitemid = 1;
320
+ optional uint32 flags = 2 [(description) = "Set of EProfileItemEquippedFlag"];
321
+ }
322
+
323
+ message CPlayer_SetEquippedProfileItemFlags_Response {
324
+ }
325
+
326
+ message CPlayer_GetEmoticonList_Request {
327
+ }
328
+
329
+ message CPlayer_GetEmoticonList_Response {
330
+ message Emoticon {
331
+ optional string name = 1;
332
+ optional int32 count = 2;
333
+ optional uint32 time_last_used = 3;
334
+ optional uint32 use_count = 4;
335
+ optional uint32 time_received = 5;
336
+ optional uint32 appid = 6;
337
+ }
338
+
339
+ repeated .CPlayer_GetEmoticonList_Response.Emoticon emoticons = 1;
340
+ }
341
+
342
+ message CPlayer_GetTopAchievementsForGames_Request {
343
+ optional uint64 steamid = 1;
344
+ optional string language = 2;
345
+ optional uint32 max_achievements = 3 [(description) = "The max achievements to load. Max 8"];
346
+ repeated uint32 appids = 4;
347
+ }
348
+
349
+ message CPlayer_GetTopAchievementsForGames_Response {
350
+ message Achievement {
351
+ optional uint32 statid = 1;
352
+ optional uint32 bit = 2;
353
+ optional string name = 3;
354
+ optional string desc = 4;
355
+ optional string icon = 5;
356
+ optional string icon_gray = 6;
357
+ optional bool hidden = 7;
358
+ optional string player_percent_unlocked = 8 [(description) = "Formatted to one decimal place, min value is 0.1, max value 100"];
359
+ }
360
+
361
+ message Game {
362
+ optional uint32 appid = 1;
363
+ optional uint32 total_achievements = 2;
364
+ repeated .CPlayer_GetTopAchievementsForGames_Response.Achievement achievements = 3;
365
+ }
366
+
367
+ repeated .CPlayer_GetTopAchievementsForGames_Response.Game games = 1;
368
+ }
369
+
370
+ message CPlayer_GetAchievementsProgress_Request {
371
+ optional uint64 steamid = 1;
372
+ optional string language = 2;
373
+ repeated uint32 appids = 3;
374
+ }
375
+
376
+ message CPlayer_GetAchievementsProgress_Response {
377
+ message AchievementProgress {
378
+ optional uint32 appid = 1;
379
+ optional uint32 unlocked = 2;
380
+ optional uint32 total = 3;
381
+ optional float percentage = 4;
382
+ optional bool all_unlocked = 5;
383
+ optional uint32 cache_time = 6;
384
+ }
385
+
386
+ repeated .CPlayer_GetAchievementsProgress_Response.AchievementProgress achievement_progress = 1;
387
+ }
388
+
389
+ message CPlayer_GetGameAchievements_Request {
390
+ optional uint32 appid = 1;
391
+ optional string language = 2 [(description) = "Lowercase, language shortnames"];
392
+ }
393
+
394
+ message CPlayer_GetGameAchievements_Response {
395
+ message Achievement {
396
+ optional string internal_name = 1 [(description) = "Will come uppercase, internal facing name set by the partner; needed to associate with user unlock"];
397
+ optional string localized_name = 2;
398
+ optional string localized_desc = 3;
399
+ optional string icon = 4;
400
+ optional string icon_gray = 5;
401
+ optional bool hidden = 6;
402
+ optional string player_percent_unlocked = 7 [(description) = "Formatted to one decimal place, min value is 0.1, max value 100"];
403
+ }
404
+
405
+ repeated .CPlayer_GetGameAchievements_Response.Achievement achievements = 1;
406
+ }
407
+
408
+ message CPlayer_GetFavoriteBadge_Request {
409
+ optional uint64 steamid = 1;
410
+ }
411
+
412
+ message CPlayer_GetFavoriteBadge_Response {
413
+ optional bool has_favorite_badge = 1;
414
+ optional uint32 badgeid = 2;
415
+ optional uint64 communityitemid = 3;
416
+ optional uint32 item_type = 4;
417
+ optional uint32 border_color = 5;
418
+ optional uint32 appid = 6;
419
+ optional uint32 level = 7;
420
+ }
421
+
422
+ message CPlayer_SetFavoriteBadge_Request {
423
+ optional uint64 communityitemid = 1;
424
+ optional uint32 badgeid = 2;
425
+ }
426
+
427
+ message CPlayer_SetFavoriteBadge_Response {
428
+ }
429
+
430
+ message CPlayer_GetProfileCustomization_Request {
431
+ optional fixed64 steamid = 1;
432
+ optional bool include_inactive_customizations = 2;
433
+ optional bool include_purchased_customizations = 3;
434
+ }
435
+
436
+ message ProfileCustomizationSlot {
437
+ optional uint32 slot = 1;
438
+ optional uint32 appid = 2;
439
+ optional uint64 publishedfileid = 3;
440
+ optional uint64 item_assetid = 4;
441
+ optional uint64 item_contextid = 5;
442
+ optional string notes = 6;
443
+ optional string title = 7;
444
+ optional uint32 accountid = 8;
445
+ optional uint32 badgeid = 9;
446
+ optional uint32 border_color = 10;
447
+ optional uint64 item_classid = 11;
448
+ optional uint64 item_instanceid = 12;
449
+ optional .EBanContentCheckResult ban_check_result = 13 [default = k_EBanContentCheckResult_NotScanned];
450
+ optional uint32 replay_year = 14;
451
+ }
452
+
453
+ message ProfileCustomization {
454
+ optional .EProfileCustomizationType customization_type = 1 [default = k_EProfileCustomizationTypeInvalid];
455
+ optional bool large = 2;
456
+ repeated .ProfileCustomizationSlot slots = 3;
457
+ optional bool active = 4;
458
+ optional .EProfileCustomizationStyle customization_style = 5 [default = k_EProfileCustomizationStyleDefault];
459
+ optional uint64 purchaseid = 6;
460
+ optional uint32 level = 7;
461
+ }
462
+
463
+ message ProfileTheme {
464
+ optional string theme_id = 1;
465
+ optional string title = 2;
466
+ }
467
+
468
+ message ProfilePreferences {
469
+ optional bool hide_profile_awards = 1;
470
+ }
471
+
472
+ message CPlayer_GetProfileCustomization_Response {
473
+ message PurchasedCustomization {
474
+ optional uint64 purchaseid = 1;
475
+ optional .EProfileCustomizationType customization_type = 2 [default = k_EProfileCustomizationTypeInvalid];
476
+ optional uint32 level = 3;
477
+ }
478
+
479
+ repeated .ProfileCustomization customizations = 1;
480
+ optional uint32 slots_available = 2;
481
+ optional .ProfileTheme profile_theme = 3;
482
+ repeated .CPlayer_GetProfileCustomization_Response.PurchasedCustomization purchased_customizations = 4;
483
+ optional .ProfilePreferences profile_preferences = 5;
484
+ }
485
+
486
+ message CPlayer_GetPurchasedProfileCustomizations_Request {
487
+ optional fixed64 steamid = 1;
488
+ }
489
+
490
+ message CPlayer_GetPurchasedProfileCustomizations_Response {
491
+ message PurchasedCustomization {
492
+ optional uint64 purchaseid = 1;
493
+ optional .EProfileCustomizationType customization_type = 2 [default = k_EProfileCustomizationTypeInvalid];
494
+ }
495
+
496
+ repeated .CPlayer_GetPurchasedProfileCustomizations_Response.PurchasedCustomization purchased_customizations = 1;
497
+ }
498
+
499
+ message CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Request {
500
+ optional fixed64 steamid = 1;
501
+ }
502
+
503
+ message CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response {
504
+ message PurchasedCustomization {
505
+ optional .EProfileCustomizationType customization_type = 1 [default = k_EProfileCustomizationTypeInvalid];
506
+ optional uint32 count = 2;
507
+ }
508
+
509
+ message UpgradedCustomization {
510
+ optional .EProfileCustomizationType customization_type = 1 [default = k_EProfileCustomizationTypeInvalid];
511
+ optional uint32 level = 2;
512
+ }
513
+
514
+ repeated .CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response.PurchasedCustomization purchased_customizations = 1;
515
+ repeated .CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response.UpgradedCustomization upgraded_customizations = 2;
516
+ }
517
+
518
+ message CPlayer_GetProfileThemesAvailable_Request {
519
+ }
520
+
521
+ message CPlayer_GetProfileThemesAvailable_Response {
522
+ repeated .ProfileTheme profile_themes = 1;
523
+ }
524
+
525
+ message CPlayer_SetProfileTheme_Request {
526
+ optional string theme_id = 1;
527
+ }
528
+
529
+ message CPlayer_SetProfileTheme_Response {
530
+ }
531
+
532
+ message CPlayer_SetProfilePreferences_Request {
533
+ optional .ProfilePreferences profile_preferences = 1;
534
+ }
535
+
536
+ message CPlayer_SetProfilePreferences_Response {
537
+ }
538
+
539
+ message CPlayer_PostStatusToFriends_Request {
540
+ optional uint32 appid = 1;
541
+ optional string status_text = 2;
542
+ }
543
+
544
+ message CPlayer_PostStatusToFriends_Response {
545
+ }
546
+
547
+ message CPlayer_GetPostedStatus_Request {
548
+ optional uint64 steamid = 1 [(description) = "The player we're asking about"];
549
+ optional uint64 postid = 2;
550
+ }
551
+
552
+ message CPlayer_GetPostedStatus_Response {
553
+ optional uint32 accountid = 1;
554
+ optional uint64 postid = 2;
555
+ optional string status_text = 3;
556
+ optional bool deleted = 4;
557
+ optional uint32 appid = 5;
558
+ }
559
+
560
+ message CPlayer_DeletePostedStatus_Request {
561
+ optional uint64 postid = 1;
562
+ }
563
+
564
+ message CPlayer_DeletePostedStatus_Response {
565
+ }
566
+
567
+ message CPlayer_GetLastPlayedTimes_Request {
568
+ optional uint32 min_last_played = 1 [(description) = "The most recent last-played time the client already knows about"];
569
+ }
570
+
571
+ message CPlayer_GetLastPlayedTimes_Response {
572
+ message Game {
573
+ optional int32 appid = 1;
574
+ optional uint32 last_playtime = 2;
575
+ optional int32 playtime_2weeks = 3;
576
+ optional int32 playtime_forever = 4;
577
+ optional uint32 first_playtime = 5;
578
+ optional int32 playtime_windows_forever = 6;
579
+ optional int32 playtime_mac_forever = 7;
580
+ optional int32 playtime_linux_forever = 8;
581
+ optional uint32 first_windows_playtime = 9;
582
+ optional uint32 first_mac_playtime = 10;
583
+ optional uint32 first_linux_playtime = 11;
584
+ optional uint32 last_windows_playtime = 12;
585
+ optional uint32 last_mac_playtime = 13;
586
+ optional uint32 last_linux_playtime = 14;
587
+ optional uint32 playtime_disconnected = 15;
588
+ }
589
+
590
+ repeated .CPlayer_GetLastPlayedTimes_Response.Game games = 1;
591
+ }
592
+
593
+ message CPlayer_GetTimeSSAAccepted_Request {
594
+ }
595
+
596
+ message CPlayer_GetTimeSSAAccepted_Response {
597
+ optional uint32 time_ssa_accepted = 1;
598
+ optional uint32 time_ssa_updated = 2;
599
+ optional uint32 time_chinassa_accepted = 3;
600
+ }
601
+
602
+ message CPlayer_AcceptSSA_Request {
603
+ optional .EAgreementType agreement_type = 1 [default = k_EAgreementType_Invalid];
604
+ optional uint32 time_signed_utc = 2;
605
+ }
606
+
607
+ message CPlayer_AcceptSSA_Response {
608
+ }
609
+
610
+ message CPlayer_GetNicknameList_Request {
611
+ }
612
+
613
+ message CPlayer_GetNicknameList_Response {
614
+ message PlayerNickname {
615
+ optional fixed32 accountid = 1;
616
+ optional string nickname = 2;
617
+ }
618
+
619
+ repeated .CPlayer_GetNicknameList_Response.PlayerNickname nicknames = 1;
620
+ }
621
+
622
+ message CPlayer_GetPerFriendPreferences_Request {
623
+ }
624
+
625
+ message PerFriendPreferences {
626
+ optional fixed32 accountid = 1;
627
+ optional string nickname = 2;
628
+ optional .ENotificationSetting notifications_showingame = 3 [default = k_ENotificationSettingNotifyUseDefault];
629
+ optional .ENotificationSetting notifications_showonline = 4 [default = k_ENotificationSettingNotifyUseDefault];
630
+ optional .ENotificationSetting notifications_showmessages = 5 [default = k_ENotificationSettingNotifyUseDefault];
631
+ optional .ENotificationSetting sounds_showingame = 6 [default = k_ENotificationSettingNotifyUseDefault];
632
+ optional .ENotificationSetting sounds_showonline = 7 [default = k_ENotificationSettingNotifyUseDefault];
633
+ optional .ENotificationSetting sounds_showmessages = 8 [default = k_ENotificationSettingNotifyUseDefault];
634
+ optional .ENotificationSetting notifications_sendmobile = 9 [default = k_ENotificationSettingNotifyUseDefault];
635
+ }
636
+
637
+ message CPlayer_GetPerFriendPreferences_Response {
638
+ repeated .PerFriendPreferences preferences = 1;
639
+ }
640
+
641
+ message CPlayer_SetPerFriendPreferences_Request {
642
+ optional .PerFriendPreferences preferences = 1;
643
+ }
644
+
645
+ message CPlayer_SetPerFriendPreferences_Response {
646
+ }
647
+
648
+ message CPlayer_AddFriend_Request {
649
+ optional fixed64 steamid = 1 [(description) = "Steam ID of user to whom to send a friend invite."];
650
+ }
651
+
652
+ message CPlayer_AddFriend_Response {
653
+ optional bool invite_sent = 1 [(description) = "True if the operation was successful, false otherwise."];
654
+ optional uint32 friend_relationship = 2 [(description) = "the resulting relationship. Depending on state, may move directly to friends rather than invite sent"];
655
+ optional int32 result = 3;
656
+ }
657
+
658
+ message CPlayer_RemoveFriend_Request {
659
+ optional fixed64 steamid = 1 [(description) = "Steam ID of friend to remove."];
660
+ }
661
+
662
+ message CPlayer_RemoveFriend_Response {
663
+ optional uint32 friend_relationship = 1 [(description) = "the resulting relationship"];
664
+ }
665
+
666
+ message CPlayer_IgnoreFriend_Request {
667
+ optional fixed64 steamid = 1;
668
+ optional bool unignore = 2 [(description) = "If set, remove from ignore/block list instead of adding "];
669
+ }
670
+
671
+ message CPlayer_IgnoreFriend_Response {
672
+ optional uint32 friend_relationship = 1 [(description) = "the resulting relationship"];
673
+ }
674
+
675
+ message CPlayer_GetCommunityPreferences_Request {
676
+ }
677
+
678
+ message CPlayer_CommunityPreferences {
679
+ optional bool parenthesize_nicknames = 4 [default = false];
680
+ optional .ETextFilterSetting text_filter_setting = 5 [default = k_ETextFilterSettingSteamLabOptedOut];
681
+ optional bool text_filter_ignore_friends = 6 [default = true];
682
+ optional uint32 text_filter_words_revision = 7;
683
+ optional uint32 timestamp_updated = 3;
684
+ }
685
+
686
+ message CPlayer_GetCommunityPreferences_Response {
687
+ optional .CPlayer_CommunityPreferences preferences = 1;
688
+ optional .UserContentDescriptorPreferences content_descriptor_preferences = 2;
689
+ }
690
+
691
+ message CPlayer_SetCommunityPreferences_Request {
692
+ optional .CPlayer_CommunityPreferences preferences = 1;
693
+ }
694
+
695
+ message CPlayer_SetCommunityPreferences_Response {
696
+ }
697
+
698
+ message CPlayer_GetTextFilterWords_Request {
699
+ }
700
+
701
+ message CPlayer_TextFilterWords {
702
+ repeated string text_filter_custom_banned_words = 1;
703
+ repeated string text_filter_custom_clean_words = 2;
704
+ optional uint32 text_filter_words_revision = 3;
705
+ }
706
+
707
+ message CPlayer_GetTextFilterWords_Response {
708
+ optional .CPlayer_TextFilterWords words = 1;
709
+ }
710
+
711
+ message CPlayer_GetNewSteamAnnouncementState_Request {
712
+ optional int32 language = 1;
713
+ }
714
+
715
+ message CPlayer_GetNewSteamAnnouncementState_Response {
716
+ optional .ENewSteamAnnouncementState state = 1 [default = k_ENewSteamAnnouncementState_Invalid];
717
+ optional string announcement_headline = 2;
718
+ optional string announcement_url = 3;
719
+ optional uint32 time_posted = 4;
720
+ optional uint64 announcement_gid = 5;
721
+ }
722
+
723
+ message CPlayer_UpdateSteamAnnouncementLastRead_Request {
724
+ optional uint64 announcement_gid = 1;
725
+ optional uint32 time_posted = 2;
726
+ }
727
+
728
+ message CPlayer_UpdateSteamAnnouncementLastRead_Response {
729
+ }
730
+
731
+ message CPlayer_GetPrivacySettings_Request {
732
+ }
733
+
734
+ message CPrivacySettings {
735
+ optional int32 privacy_state = 1;
736
+ optional int32 privacy_state_inventory = 2;
737
+ optional int32 privacy_state_gifts = 3;
738
+ optional int32 privacy_state_ownedgames = 4;
739
+ optional int32 privacy_state_playtime = 5;
740
+ optional int32 privacy_state_friendslist = 6;
741
+ }
742
+
743
+ message CPlayer_GetPrivacySettings_Response {
744
+ optional .CPrivacySettings privacy_settings = 1;
745
+ }
746
+
747
+ message CPlayer_GetDurationControl_Request {
748
+ optional uint32 appid = 1;
749
+ }
750
+
751
+ message CPlayer_GetDurationControl_Response {
752
+ optional bool is_enabled = 1;
753
+ optional int32 seconds = 2;
754
+ optional int32 seconds_today = 3;
755
+ optional bool is_steamchina_account = 4;
756
+ optional bool is_age_verified = 5;
757
+ optional uint32 seconds_allowed_today = 6;
758
+ optional bool age_verification_pending = 7;
759
+ optional bool block_minors = 8;
760
+ }
761
+
762
+ message CPlayer_RecordDisconnectedPlaytime_Request {
763
+ message PlayHistory {
764
+ optional uint32 appid = 1;
765
+ optional uint32 session_time_start = 2;
766
+ optional uint32 seconds = 3;
767
+ optional bool offline = 4;
768
+ optional uint32 owner = 5;
769
+ }
770
+
771
+ repeated .CPlayer_RecordDisconnectedPlaytime_Request.PlayHistory play_sessions = 3;
772
+ }
773
+
774
+ message CPlayer_RecordDisconnectedPlaytime_Response {
775
+ }
776
+
777
+ message CPlayer_LastPlayedTimes_Notification {
778
+ repeated .CPlayer_GetLastPlayedTimes_Response.Game games = 1;
779
+ }
780
+
781
+ message CPlayer_FriendNicknameChanged_Notification {
782
+ optional fixed32 accountid = 1;
783
+ optional string nickname = 2;
784
+ optional bool is_echo_to_self = 3;
785
+ }
786
+
787
+ message CPlayer_FriendEquippedProfileItemsChanged_Notification {
788
+ optional fixed32 accountid = 1;
789
+ }
790
+
791
+ message CPlayer_NewSteamAnnouncementState_Notification {
792
+ optional .ENewSteamAnnouncementState state = 1 [default = k_ENewSteamAnnouncementState_Invalid];
793
+ optional string announcement_headline = 2;
794
+ optional string announcement_url = 3;
795
+ optional uint32 time_posted = 4;
796
+ optional uint64 announcement_gid = 5;
797
+ }
798
+
799
+ message CPlayer_CommunityPreferencesChanged_Notification {
800
+ optional .CPlayer_CommunityPreferences preferences = 1;
801
+ optional .UserContentDescriptorPreferences content_descriptor_preferences = 2;
802
+ }
803
+
804
+ message CPlayer_TextFilterWordsChanged_Notification {
805
+ optional .CPlayer_TextFilterWords words = 1;
806
+ }
807
+
808
+ message CPlayer_PerFriendPreferencesChanged_Notification {
809
+ optional fixed32 accountid = 1;
810
+ optional .PerFriendPreferences preferences = 2;
811
+ }
812
+
813
+ message CPlayer_PrivacySettingsChanged_Notification {
814
+ optional .CPrivacySettings privacy_settings = 1;
815
+ }
816
+
817
+ service Player {
818
+ option (service_description) = "A service for accessing Steam player data";
819
+
820
+ rpc GetPlayerLinkDetails (.CPlayer_GetPlayerLinkDetails_Request) returns (.CPlayer_GetPlayerLinkDetails_Response) {
821
+ option (method_description) = "Replacement for WG GetPlayerLinkDetails";
822
+ }
823
+
824
+ rpc GetMutualFriendsForIncomingInvites (.CPlayer_GetMutualFriendsForIncomingInvites_Request) returns (.CPlayer_GetMutualFriendsForIncomingInvites_Response) {
825
+ option (method_description) = "Get me the mutual friends for each of my pending incoming invites (individuals and clans).";
826
+ }
827
+
828
+ rpc GetOwnedGames (.CPlayer_GetOwnedGames_Request) returns (.CPlayer_GetOwnedGames_Response) {
829
+ option (method_description) = "Return a list of games owned by the player";
830
+ }
831
+
832
+ rpc GetPlayNext (.CPlayer_GetPlayNext_Request) returns (.CPlayer_GetPlayNext_Response) {
833
+ option (method_description) = "Return suggested games for player to play next.";
834
+ }
835
+
836
+ rpc GetFriendsGameplayInfo (.CPlayer_GetFriendsGameplayInfo_Request) returns (.CPlayer_GetFriendsGameplayInfo_Response) {
837
+ option (method_description) = "Get a list of friends who are playing, have played, own, or want a game";
838
+ }
839
+
840
+ rpc GetGameBadgeLevels (.CPlayer_GetGameBadgeLevels_Request) returns (.CPlayer_GetGameBadgeLevels_Response) {
841
+ option (method_description) = "Returns the Steam Level of a user, the Badge level for the game, and if it's foil";
842
+ }
843
+
844
+ rpc GetProfileBackground (.CPlayer_GetProfileBackground_Request) returns (.CPlayer_GetProfileBackground_Response) {
845
+ option (method_description) = "Gets which profile background is active for a specific user";
846
+ }
847
+
848
+ rpc SetProfileBackground (.CPlayer_SetProfileBackground_Request) returns (.CPlayer_SetProfileBackground_Response) {
849
+ option (method_description) = "Sets the user's profile background";
850
+ }
851
+
852
+ rpc GetMiniProfileBackground (.CPlayer_GetMiniProfileBackground_Request) returns (.CPlayer_GetMiniProfileBackground_Response) {
853
+ option (method_description) = "Gets which mini profile background is active for a specific user";
854
+ }
855
+
856
+ rpc SetMiniProfileBackground (.CPlayer_SetMiniProfileBackground_Request) returns (.CPlayer_SetMiniProfileBackground_Response) {
857
+ option (method_description) = "Sets the user's mini profile background";
858
+ }
859
+
860
+ rpc GetAvatarFrame (.CPlayer_GetAvatarFrame_Request) returns (.CPlayer_GetAvatarFrame_Response) {
861
+ option (method_description) = "Gets which avatar frame is active for a specific user";
862
+ }
863
+
864
+ rpc SetAvatarFrame (.CPlayer_SetAvatarFrame_Request) returns (.CPlayer_SetAvatarFrame_Response) {
865
+ option (method_description) = "Sets the user's avatar frame for their profile";
866
+ }
867
+
868
+ rpc GetAnimatedAvatar (.CPlayer_GetAnimatedAvatar_Request) returns (.CPlayer_GetAnimatedAvatar_Response) {
869
+ option (method_description) = "Gets which animated avatar is active for a specific user";
870
+ }
871
+
872
+ rpc SetAnimatedAvatar (.CPlayer_SetAnimatedAvatar_Request) returns (.CPlayer_SetAnimatedAvatar_Response) {
873
+ option (method_description) = "Sets the user's animated avatar for their profile";
874
+ }
875
+
876
+ rpc GetSteamDeckKeyboardSkin (.CPlayer_GetSteamDeckKeyboardSkin_Request) returns (.CPlayer_GetSteamDeckKeyboardSkin_Response) {
877
+ option (method_description) = "Gets which Steam Deck keyboard skin is active for a specific user";
878
+ }
879
+
880
+ rpc SetSteamDeckKeyboardSkin (.CPlayer_SetSteamDeckKeyboardSkin_Request) returns (.CPlayer_SetSteamDeckKeyboardSkin_Response) {
881
+ option (method_description) = "Sets the user's current Steam Deck keyboard skin";
882
+ }
883
+
884
+ rpc GetProfileItemsOwned (.CPlayer_GetProfileItemsOwned_Request) returns (.CPlayer_GetProfileItemsOwned_Response) {
885
+ option (method_description) = "Returns the items the user can equip on their profile";
886
+ }
887
+
888
+ rpc GetProfileItemsEquipped (.CPlayer_GetProfileItemsEquipped_Request) returns (.CPlayer_GetProfileItemsEquipped_Response) {
889
+ option (method_description) = "Returns the items the user has equipped on their profile";
890
+ }
891
+
892
+ rpc SetEquippedProfileItemFlags (.CPlayer_SetEquippedProfileItemFlags_Request) returns (.CPlayer_SetEquippedProfileItemFlags_Response) {
893
+ option (method_description) = "Sets special flags on the equipped item";
894
+ }
895
+
896
+ rpc GetEmoticonList (.CPlayer_GetEmoticonList_Request) returns (.CPlayer_GetEmoticonList_Response) {
897
+ option (method_description) = "Gets a list of the emoticons a user has with metadata";
898
+ }
899
+
900
+ rpc GetTopAchievementsForGames (.CPlayer_GetTopAchievementsForGames_Request) returns (.CPlayer_GetTopAchievementsForGames_Response) {
901
+ option (method_description) = "Gets the best achievements the user has gotten for the specified list of apps.";
902
+ }
903
+
904
+ rpc GetAchievementsProgress (.CPlayer_GetAchievementsProgress_Request) returns (.CPlayer_GetAchievementsProgress_Response) {
905
+ option (method_description) = "Gets the achievement completion stats for the specified list of apps.";
906
+ }
907
+
908
+ rpc GetGameAchievements (.CPlayer_GetGameAchievements_Request) returns (.CPlayer_GetGameAchievements_Response) {
909
+ option (method_description) = "Get a games available achievements for display purposes.";
910
+ }
911
+
912
+ rpc GetFavoriteBadge (.CPlayer_GetFavoriteBadge_Request) returns (.CPlayer_GetFavoriteBadge_Response) {
913
+ option (method_description) = "Gets the badge the user has set as their favorite";
914
+ }
915
+
916
+ rpc SetFavoriteBadge (.CPlayer_SetFavoriteBadge_Request) returns (.CPlayer_SetFavoriteBadge_Response) {
917
+ option (method_description) = "Sets the badge as the users favorite";
918
+ }
919
+
920
+ rpc GetProfileCustomization (.CPlayer_GetProfileCustomization_Request) returns (.CPlayer_GetProfileCustomization_Response) {
921
+ option (method_description) = "Returns the customizations (if any) for a profile";
922
+ }
923
+
924
+ rpc GetPurchasedProfileCustomizations (.CPlayer_GetPurchasedProfileCustomizations_Request) returns (.CPlayer_GetPurchasedProfileCustomizations_Response) {
925
+ option (method_description) = "Returns the purchased profile customizations";
926
+ }
927
+
928
+ rpc GetPurchasedAndUpgradedProfileCustomizations (.CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Request) returns (.CPlayer_GetPurchasedAndUpgradedProfileCustomizations_Response) {
929
+ option (method_description) = "Returns the purchased and upgraded profile customizations";
930
+ }
931
+
932
+ rpc GetProfileThemesAvailable (.CPlayer_GetProfileThemesAvailable_Request) returns (.CPlayer_GetProfileThemesAvailable_Response) {
933
+ option (method_description) = "Gets themes available for the user.";
934
+ }
935
+
936
+ rpc SetProfileTheme (.CPlayer_SetProfileTheme_Request) returns (.CPlayer_SetProfileTheme_Response) {
937
+ option (method_description) = "Selects a theme for the profile";
938
+ }
939
+
940
+ rpc SetProfilePreferences (.CPlayer_SetProfilePreferences_Request) returns (.CPlayer_SetProfilePreferences_Response) {
941
+ option (method_description) = "Sets profile preferences";
942
+ }
943
+
944
+ rpc PostStatusToFriends (.CPlayer_PostStatusToFriends_Request) returns (.CPlayer_PostStatusToFriends_Response) {
945
+ option (method_description) = "Posts custom status text into the blotter";
946
+ }
947
+
948
+ rpc GetPostedStatus (.CPlayer_GetPostedStatus_Request) returns (.CPlayer_GetPostedStatus_Response) {
949
+ option (method_description) = "Gets a posted status text for a user by id";
950
+ }
951
+
952
+ rpc DeletePostedStatus (.CPlayer_DeletePostedStatus_Request) returns (.CPlayer_DeletePostedStatus_Response) {
953
+ option (method_description) = "Deletes a posted status text for a user by id";
954
+ }
955
+
956
+ rpc ClientGetLastPlayedTimes (.CPlayer_GetLastPlayedTimes_Request) returns (.CPlayer_GetLastPlayedTimes_Response) {
957
+ option (method_description) = "Gets the last-played times for the account";
958
+ }
959
+
960
+ rpc GetTimeSSAAccepted (.CPlayer_GetTimeSSAAccepted_Request) returns (.CPlayer_GetTimeSSAAccepted_Response) {
961
+ option (method_description) = "Gets the time when the user accepted the SSA";
962
+ }
963
+
964
+ rpc AcceptSSA (.CPlayer_AcceptSSA_Request) returns (.CPlayer_AcceptSSA_Response) {
965
+ option (method_description) = "User is accepting the SSA";
966
+ }
967
+
968
+ rpc GetNicknameList (.CPlayer_GetNicknameList_Request) returns (.CPlayer_GetNicknameList_Response) {
969
+ option (method_description) = "Gets the list of nicknames this user has for other users";
970
+ }
971
+
972
+ rpc GetPerFriendPreferences (.CPlayer_GetPerFriendPreferences_Request) returns (.CPlayer_GetPerFriendPreferences_Response) {
973
+ option (method_description) = "Gets the list of per-friend preferences this user has set for other users";
974
+ }
975
+
976
+ rpc SetPerFriendPreferences (.CPlayer_SetPerFriendPreferences_Request) returns (.CPlayer_SetPerFriendPreferences_Response) {
977
+ option (method_description) = "Sets the logged in user's per-friend preferences for the given user";
978
+ }
979
+
980
+ rpc AddFriend (.CPlayer_AddFriend_Request) returns (.CPlayer_AddFriend_Response) {
981
+ option (method_description) = "Invites another Steam user to be a friend";
982
+ }
983
+
984
+ rpc RemoveFriend (.CPlayer_RemoveFriend_Request) returns (.CPlayer_RemoveFriend_Response) {
985
+ option (method_description) = "Removes a friend or ignores a friend suggestion";
986
+ }
987
+
988
+ rpc IgnoreFriend (.CPlayer_IgnoreFriend_Request) returns (.CPlayer_IgnoreFriend_Response) {
989
+ option (method_description) = "Blocks or unblocks communication with the user. Despite name, can be a non-friend.";
990
+ }
991
+
992
+ rpc GetCommunityPreferences (.CPlayer_GetCommunityPreferences_Request) returns (.CPlayer_GetCommunityPreferences_Response) {
993
+ option (method_description) = "Returns the player's community preferences";
994
+ }
995
+
996
+ rpc SetCommunityPreferences (.CPlayer_SetCommunityPreferences_Request) returns (.CPlayer_SetCommunityPreferences_Response) {
997
+ option (method_description) = "Sets the player's community preferences";
998
+ }
999
+
1000
+ rpc GetTextFilterWords (.CPlayer_GetTextFilterWords_Request) returns (.CPlayer_GetTextFilterWords_Response) {
1001
+ option (method_description) = "Get the custom text filtering dictionary for this user";
1002
+ }
1003
+
1004
+ rpc GetNewSteamAnnouncementState (.CPlayer_GetNewSteamAnnouncementState_Request) returns (.CPlayer_GetNewSteamAnnouncementState_Response) {
1005
+ option (method_description) = "Calculates and returns what to display for UI that renders new steam announcement available";
1006
+ }
1007
+
1008
+ rpc UpdateSteamAnnouncementLastRead (.CPlayer_UpdateSteamAnnouncementLastRead_Request) returns (.CPlayer_UpdateSteamAnnouncementLastRead_Response) {
1009
+ option (method_description) = "Marks latest announcement timestamp read by user";
1010
+ }
1011
+
1012
+ rpc GetPrivacySettings (.CPlayer_GetPrivacySettings_Request) returns (.CPlayer_GetPrivacySettings_Response) {
1013
+ option (method_description) = "Get current privacy settings.";
1014
+ }
1015
+
1016
+ rpc GetDurationControl (.CPlayer_GetDurationControl_Request) returns (.CPlayer_GetDurationControl_Response) {
1017
+ option (method_description) = "Get gameplay duration control settings.";
1018
+ }
1019
+
1020
+ rpc RecordDisconnectedPlaytime (.CPlayer_RecordDisconnectedPlaytime_Request) returns (.CPlayer_RecordDisconnectedPlaytime_Response) {
1021
+ option (method_description) = "Submit playtime records that happened while the client was disconnected from steam (whether marked offline or not)";
1022
+ }
1023
+ }
1024
+
1025
+ service PlayerClient {
1026
+ option (service_description) = "Steam player data client notifications";
1027
+ option (service_execution_site) = k_EProtoExecutionSiteSteamClient;
1028
+
1029
+ rpc NotifyLastPlayedTimes (.CPlayer_LastPlayedTimes_Notification) returns (.NoResponse) {
1030
+ option (method_description) = "Notification from server to client of more recent play time";
1031
+ }
1032
+
1033
+ rpc NotifyFriendNicknameChanged (.CPlayer_FriendNicknameChanged_Notification) returns (.NoResponse) {
1034
+ option (method_description) = "Notification from server to client that a friend's nickname has changed";
1035
+ }
1036
+
1037
+ rpc NotifyFriendEquippedProfileItemsChanged (.CPlayer_FriendEquippedProfileItemsChanged_Notification) returns (.NoResponse) {
1038
+ option (method_description) = "Notification from server to client that a friend's equipped profile items have changed";
1039
+ }
1040
+
1041
+ rpc NotifyNewSteamAnnouncementState (.CPlayer_NewSteamAnnouncementState_Notification) returns (.NoResponse) {
1042
+ option (method_description) = "Notifies client of changes to steam announcement state for user";
1043
+ }
1044
+
1045
+ rpc NotifyCommunityPreferencesChanged (.CPlayer_CommunityPreferencesChanged_Notification) returns (.NoResponse) {
1046
+ option (method_description) = "Notification from server to client that their community preferences have changed";
1047
+ }
1048
+
1049
+ rpc NotifyTextFilterWordsChanged (.CPlayer_TextFilterWordsChanged_Notification) returns (.NoResponse) {
1050
+ option (method_description) = "Notification from server to client that their text filtering dictionary has changed";
1051
+ }
1052
+
1053
+ rpc NotifyPerFriendPreferencesChanged (.CPlayer_PerFriendPreferencesChanged_Notification) returns (.NoResponse) {
1054
+ option (method_description) = "Notification from server that per-friend preferences have changed";
1055
+ }
1056
+
1057
+ rpc NotifyPrivacyPrivacySettingsChanged (.CPlayer_PrivacySettingsChanged_Notification) returns (.NoResponse) {
1058
+ option (method_description) = "Notification from server that privacy settings changed";
1059
+ }
1060
+ }