steamutils 1.2.50 → 1.2.52

package/protos/{steammessages_market.steamclient.proto → steam/steammessages_market.steamclient.proto}

@@ -1,26 +1,26 @@
-import "steammessages_base.proto";
-import "steammessages_unified_base.steamclient.proto";
-
-option cc_generic_services = true;
-
-message CEconMarket_IsMarketplaceAllowed_Request {
-	optional string webcookie = 1 [(description) = "The user's Steam Guard machine auth cookie."];
-}
-
-message CEconMarket_IsMarketplaceAllowed_Response {
-	optional bool allowed = 1 [(description) = "Whether or not the user is allowed to use the market"];
-	optional uint32 reason = 2 [(description) = "The reason the user can't use the market, if applicable"];
-	optional uint32 allowed_at_time = 3 [(description) = "The time the user will be allowed to use the market"];
-	optional uint32 steamguard_required_days = 4 [(description) = "The number of days any user is required to have had Steam Guard before they can use the market"];
-	optional bool forms_requested = 7 [(description) = "Whether or not we've requested the user fill out tax forms"];
-	optional bool forms_require_verification = 8 [(description) = "True if we've received forms but they require verification first"];
-	optional uint32 new_device_cooldown_days = 9 [(description) = "The number of days after initial device authorization a user must wait before using the market on that device"];
-}
-
-service EconMarket {
-	option (service_description) = "A service to use market functions";
-
-	rpc IsMarketplaceAllowed (.CEconMarket_IsMarketplaceAllowed_Request) returns (.CEconMarket_IsMarketplaceAllowed_Response) {
-		option (method_description) = "Checks whether or not the authed account is allowed to use the market";
-	}
-}
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+
+option cc_generic_services = true;
+
+message CEconMarket_IsMarketplaceAllowed_Request {
+	optional string webcookie = 1 [(description) = "The user's Steam Guard machine auth cookie."];
+}
+
+message CEconMarket_IsMarketplaceAllowed_Response {
+	optional bool allowed = 1 [(description) = "Whether or not the user is allowed to use the market"];
+	optional uint32 reason = 2 [(description) = "The reason the user can't use the market, if applicable"];
+	optional uint32 allowed_at_time = 3 [(description) = "The time the user will be allowed to use the market"];
+	optional uint32 steamguard_required_days = 4 [(description) = "The number of days any user is required to have had Steam Guard before they can use the market"];
+	optional bool forms_requested = 7 [(description) = "Whether or not we've requested the user fill out tax forms"];
+	optional bool forms_require_verification = 8 [(description) = "True if we've received forms but they require verification first"];
+	optional uint32 new_device_cooldown_days = 9 [(description) = "The number of days after initial device authorization a user must wait before using the market on that device"];
+}
+
+service EconMarket {
+	option (service_description) = "A service to use market functions";
+
+	rpc IsMarketplaceAllowed (.CEconMarket_IsMarketplaceAllowed_Request) returns (.CEconMarket_IsMarketplaceAllowed_Response) {
+		option (method_description) = "Checks whether or not the authed account is allowed to use the market";
+	}
+}

package/protos/steam/steammessages_marketingmessages.steamclient.proto

@@ -0,0 +1,274 @@
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+import "steammessages_storebrowse.steamclient.proto";
+
+option cc_generic_services = true;
+
+enum EMarketingMessageType {
+	k_EMarketingMessageInvalid = 0;
+	k_EMarketingMessageNowAvailable = 1;
+	k_EMarketingMessageWeekendDeal = 2;
+	k_EMarketingMessagePrePurchase = 3;
+	k_EMarketingMessagePlayNow = 4;
+	k_EMarketingMessagePreloadNow = 5;
+	k_EMarketingMessageGeneral = 6;
+	k_EMarketingMessageDemoQuit = 7;
+	k_EMarketingMessageGifting = 8;
+	k_EMarketingMessageEJsKorner = 9;
+	k_EMarketingMessageUpdate = 10;
+	k_EMarketingMessageMidweekDeal = 11;
+	k_EMarketingMessageDailyDeal = 12;
+}
+
+enum EMarketingMessageVisibility {
+	k_EMarketingMessageVisibleBeta = 1;
+	k_EMarketingMessageVisiblePublic = 2;
+}
+
+enum EMarketingMessageAssociationType {
+	k_EMarketingMessageNoAssociation = 0;
+	k_EMarketingMessageAppAssociation = 1;
+	k_EMarketingMessageSubscriptionAssociation = 2;
+	k_EMarketingMessagePublisherAssociation = 3;
+	k_EMarketingMessageGenreAssociation = 4;
+	k_EMarketingMessageBundleAssociation = 5;
+}
+
+enum EMarketingMessageTemplateType {
+	k_EMarketingMessageTemplate_Unknown = 0;
+	k_EMarketingMessageTemplate_Image = 1;
+	k_EMarketingMessageTemplate_Animated = 2;
+	k_EMarketingMessageTemplate_Featured_Video = 3;
+	k_EMarketingMessageTemplate_DLC_Override = 4;
+	k_EMarketingMessageTemplate_Replay = 5;
+	k_EMarketingMessageTemplate_MAX = 6;
+}
+
+enum EMarketingMessageLookupType {
+	k_EMarketingMessageLookupInvalid = 0;
+	k_EMarketingMessageLookupByGID = 1;
+	k_EMarketingMessageLookupActive = 2;
+	k_EMarketingMessageLookupByTitleWithType = 3;
+	k_EMarketingMessageLookupByGIDList = 4;
+}
+
+message CMarketingMessages_GetActiveMarketingMessages_Request {
+	optional string country = 1;
+	optional bool anonymous_user = 2 [(description) = "Will not return any marketing message that requires ownership/playtime/wishlist"];
+}
+
+message CMarketingMessageProto {
+	optional fixed64 gid = 1;
+	optional string title = 2;
+	optional .EMarketingMessageType type = 3 [default = k_EMarketingMessageInvalid];
+	optional .EMarketingMessageVisibility visibility = 4 [default = k_EMarketingMessageVisibleBeta];
+	optional uint32 priority = 5;
+	optional .EMarketingMessageAssociationType association_type = 6 [default = k_EMarketingMessageNoAssociation];
+	optional uint32 associated_id = 7;
+	optional string associated_name = 8;
+	optional uint32 start_date = 9;
+	optional uint32 end_date = 10;
+	optional string country_allow = 11;
+	optional string country_deny = 12;
+	optional bool ownership_restrictions_overridden = 13;
+	optional uint32 must_own_appid = 14;
+	optional uint32 must_not_own_appid = 15;
+	optional uint32 must_own_packageid = 16;
+	optional uint32 must_not_own_packageid = 17;
+	optional uint32 must_have_launched_appid = 18;
+	optional string additional_restrictions = 19;
+	optional string template_type = 20;
+	optional string template_vars = 21;
+	optional uint32 flags = 22;
+	optional string creator_name = 23;
+	optional string template_vars_json = 24;
+	optional string additional_restrictions_json = 25;
+}
+
+message CMarketingMessages_GetActiveMarketingMessages_Response {
+	repeated .CMarketingMessageProto messages = 1;
+	optional uint32 time_next_message_age = 2;
+}
+
+message CMarketingMessages_GetMarketingMessagesForUser_Request {
+	optional bool include_seen_messages = 1;
+	optional string country_code = 2;
+	optional int32 elanguage = 3;
+	optional int32 operating_system = 4 [(description) = "EOSType from client"];
+	optional int32 client_package_version = 5;
+	optional .StoreBrowseContext context = 6 [(description) = "Optional, server can fill in from country code/language if not set"];
+	optional .StoreBrowseItemDataRequest data_request = 7 [(description) = "If passed, item data will be returned"];
+}
+
+message CDisplayMarketingMessage {
+	optional fixed64 gid = 1;
+	optional string title = 2;
+	optional .EMarketingMessageType type = 3 [default = k_EMarketingMessageInvalid];
+	optional .StoreItemID associated_item_id = 4;
+	optional .StoreItem associated_item = 5;
+	optional string associated_name = 6;
+	optional string template_type = 10;
+	optional string template_vars_json = 11;
+}
+
+message CMarketingMessages_GetMarketingMessagesForUser_Response {
+	message MarketingMessageForUser {
+		optional bool already_seen = 1;
+		optional .CDisplayMarketingMessage message = 2;
+	}
+
+	repeated .CMarketingMessages_GetMarketingMessagesForUser_Response.MarketingMessageForUser messages = 1;
+}
+
+message CMarketingMessages_DoesUserHavePendingMarketingMessages_Request {
+	optional string country_code = 2;
+	optional int32 elanguage = 3;
+	optional int32 operating_system = 4 [(description) = "EOSType from client"];
+	optional int32 client_package_version = 5;
+}
+
+message CMarketingMessages_DoesUserHavePendingMarketingMessages_Response {
+	optional bool has_pending_messages = 1;
+	optional int32 pending_message_count = 2;
+}
+
+message CMarketingMessages_GetDisplayMarketingMessage_Request {
+	optional fixed64 gid = 1;
+	optional .StoreBrowseContext context = 2;
+	optional .StoreBrowseItemDataRequest data_request = 3 [(description) = "If passed, item data will be returned"];
+}
+
+message CMarketingMessages_GetDisplayMarketingMessage_Response {
+	optional .CDisplayMarketingMessage message = 1;
+}
+
+message CMarketingMessages_MarkMessageSeen_Notification {
+	optional fixed64 gid = 1;
+	optional uint32 display_index = 2 [default = 0, (description) = "Where in the stack was the marketing message, 1-based, zero means we don't know"];
+	optional .EMarketingMessageTemplateType template_type = 3 [default = k_EMarketingMessageTemplate_Unknown, (description) = "Which type of template did they see"];
+}
+
+message CMarketingMessages_GetMarketingMessage_Request {
+	optional fixed64 gid = 1;
+}
+
+message CMarketingMessages_GetMarketingMessage_Response {
+	optional .CMarketingMessageProto message = 1;
+}
+
+message CMarketingMessages_CreateMarketingMessage_Request {
+	optional .CMarketingMessageProto message = 1;
+	optional bool from_json = 2 [(description) = "If set, then overwrite the template_vars and additional_restrictions keyvalues from json"];
+}
+
+message CMarketingMessages_CreateMarketingMessage_Response {
+	optional fixed64 gid = 1;
+}
+
+message CMarketingMessages_UpdateMarketingMessage_Request {
+	optional fixed64 gid = 1;
+	optional .CMarketingMessageProto message = 2;
+	optional bool from_json = 3 [(description) = "If set, then overwrite the template_vars and additional_restrictions keyvalues from json"];
+}
+
+message CMarketingMessages_UpdateMarketingMessage_Response {
+}
+
+message CMarketingMessages_DeleteMarketingMessage_Request {
+	optional fixed64 gid = 1;
+}
+
+message CMarketingMessages_DeleteMarketingMessage_Response {
+}
+
+message CMarketingMessages_FindMarketingMessages_Request {
+	optional .EMarketingMessageLookupType lookup_type = 1 [default = k_EMarketingMessageLookupInvalid];
+	optional fixed64 gid = 2;
+	optional .EMarketingMessageType message_type = 3 [default = k_EMarketingMessageInvalid];
+	repeated fixed64 gidlist = 4;
+	optional string title = 5;
+}
+
+message CMarketingMessages_FindMarketingMessages_Response {
+	repeated .CMarketingMessageProto messages = 1;
+}
+
+message CMarketingMessages_GetMarketingMessageViewerStats_Request {
+	optional fixed64 gid = 1;
+}
+
+message CMarketingMessageHourlyStats {
+	optional uint32 rt_time_hour = 1;
+	optional uint32 seen_count = 2 [(description) = "within the hour period"];
+	optional .EMarketingMessageTemplateType template_type = 3 [default = k_EMarketingMessageTemplate_Unknown, (description) = "Which template type was shown, usually just IMAGE"];
+	optional uint32 display_index = 4 [(description) = "Zero is invalid/we don't have information; 1 based index"];
+}
+
+message CMarketingMessages_GetMarketingMessageViewerStats_Response {
+	repeated .CMarketingMessageHourlyStats stats = 1;
+}
+
+message CMarketingMessages_GetMarketingMessagesViewerRangeStats_Request {
+	optional uint32 rt_start_time = 1;
+	optional uint32 rt_end_time = 2;
+}
+
+message CMarketingMessages_GetMarketingMessagesViewerRangeStats_Response {
+	repeated .CMarketingMessageHourlyStats stats = 1 [(description) = "Flatterns results for the range of time"];
+}
+
+service MarketingMessages {
+	option (service_description) = "Marketing message data (\"Steam News\" updates at client startup).";
+
+	rpc GetActiveMarketingMessages (.CMarketingMessages_GetActiveMarketingMessages_Request) returns (.CMarketingMessages_GetActiveMarketingMessages_Response) {
+		option (method_description) = "Get a list of active marketing messages.";
+	}
+
+	rpc GetMarketingMessagesForUser (.CMarketingMessages_GetMarketingMessagesForUser_Request) returns (.CMarketingMessages_GetMarketingMessagesForUser_Response) {
+		option (method_description) = "Get a list of active marketing messages filtered for a specific user.";
+	}
+
+	rpc DoesUserHavePendingMarketingMessages (.CMarketingMessages_DoesUserHavePendingMarketingMessages_Request) returns (.CMarketingMessages_DoesUserHavePendingMarketingMessages_Response) {
+		option (method_description) = "Returns a boolean if the user has pending marketing messages.  Intended to be fast.";
+	}
+
+	rpc GetDisplayMarketingMessage (.CMarketingMessages_GetDisplayMarketingMessage_Request) returns (.CMarketingMessages_GetDisplayMarketingMessage_Response) {
+		option (method_description) = "Get a single marketing message, cacheable.";
+	}
+
+	rpc GetDisplayMarketingMessageAdmin (.CMarketingMessages_GetDisplayMarketingMessage_Request) returns (.CMarketingMessages_GetDisplayMarketingMessage_Response) {
+		option (method_description) = "Get a single marketing message for Admin, not cacheable.";
+	}
+
+	rpc MarkMessageSeen (.CMarketingMessages_MarkMessageSeen_Notification) returns (.NoResponse) {
+		option (method_description) = "Mark that a user has viewed a message (so we won't show it again)'.";
+	}
+
+	rpc GetMarketingMessage (.CMarketingMessages_GetMarketingMessage_Request) returns (.CMarketingMessages_GetMarketingMessage_Response) {
+		option (method_description) = "Get a single marketing message.  Admin account needed for non-active messages";
+	}
+
+	rpc CreateMarketingMessage (.CMarketingMessages_CreateMarketingMessage_Request) returns (.CMarketingMessages_CreateMarketingMessage_Response) {
+		option (method_description) = "Create a new marketing message.";
+	}
+
+	rpc UpdateMarketingMessage (.CMarketingMessages_UpdateMarketingMessage_Request) returns (.CMarketingMessages_UpdateMarketingMessage_Response) {
+		option (method_description) = "Modify a marketing message.";
+	}
+
+	rpc DeleteMarketingMessage (.CMarketingMessages_DeleteMarketingMessage_Request) returns (.CMarketingMessages_DeleteMarketingMessage_Response) {
+		option (method_description) = "Delete a marketing message.";
+	}
+
+	rpc FindMarketingMessages (.CMarketingMessages_FindMarketingMessages_Request) returns (.CMarketingMessages_FindMarketingMessages_Response) {
+		option (method_description) = "Search for marketing messages by name, type, etc.";
+	}
+
+	rpc GetMarketingMessageViewerStats (.CMarketingMessages_GetMarketingMessageViewerStats_Request) returns (.CMarketingMessages_GetMarketingMessageViewerStats_Response) {
+		option (method_description) = "For a specific marketing message, then all of the viewership stats for the date range it was intended to be visible to customers";
+	}
+
+	rpc GetMarketingMessagesViewerRangeStats (.CMarketingMessages_GetMarketingMessagesViewerRangeStats_Request) returns (.CMarketingMessages_GetMarketingMessagesViewerRangeStats_Response) {
+		option (method_description) = "For a time range, return the seen stats across all of the marketing messages";
+	}
+}

package/protos/{steammessages_offline.steamclient.proto → steam/steammessages_offline.steamclient.proto}

@@ -1,37 +1,40 @@
-import "steammessages_base.proto";
-import "steammessages_unified_base.steamclient.proto";
-
-option cc_generic_services = true;
-
-message COffline_GetOfflineLogonTicket_Request {
-	optional uint32 priority = 1;
-}
-
-message COffline_GetOfflineLogonTicket_Response {
-	optional bytes serialized_ticket = 1;
-	optional bytes signature = 2;
-}
-
-message COffline_GetUnsignedOfflineLogonTicket_Request {
-}
-
-message COffline_OfflineLogonTicket {
-	optional uint32 accountid = 1;
-	optional fixed32 rtime32_creation_time = 2;
-}
-
-message COffline_GetUnsignedOfflineLogonTicket_Response {
-	optional .COffline_OfflineLogonTicket ticket = 1;
-}
-
-service Offline {
-	option (service_description) = "Offline settings service";
-
-	rpc GetOfflineLogonTicket (.COffline_GetOfflineLogonTicket_Request) returns (.COffline_GetOfflineLogonTicket_Response) {
-		option (method_description) = "Get a serialized and signed offline logon ticket for the current user";
-	}
-
-	rpc GetUnsignedOfflineLogonTicket (.COffline_GetUnsignedOfflineLogonTicket_Request) returns (.COffline_GetUnsignedOfflineLogonTicket_Response) {
-		option (method_description) = "Get an unsigned offline logon ticket for the current user";
-	}
-}
+import "steammessages_base.proto";
+import "steammessages_unified_base.steamclient.proto";
+import "offline_ticket.proto";
+
+option cc_generic_services = true;
+
+message COffline_GetOfflineLogonTicket_Request {
+	optional uint32 priority = 1;
+	optional bool perform_encryption = 2;
+}
+
+message COffline_GetOfflineLogonTicket_Response {
+	optional bytes serialized_ticket = 1;
+	optional bytes signature = 2;
+	optional .Offline_Ticket encrypted_ticket = 3;
+}
+
+message COffline_GetUnsignedOfflineLogonTicket_Request {
+}
+
+message COffline_OfflineLogonTicket {
+	optional uint32 accountid = 1;
+	optional fixed32 rtime32_creation_time = 2;
+}
+
+message COffline_GetUnsignedOfflineLogonTicket_Response {
+	optional .COffline_OfflineLogonTicket ticket = 1;
+}
+
+service Offline {
+	option (service_description) = "Offline settings service";
+
+	rpc GetOfflineLogonTicket (.COffline_GetOfflineLogonTicket_Request) returns (.COffline_GetOfflineLogonTicket_Response) {
+		option (method_description) = "Get a serialized and signed offline logon ticket for the current user";
+	}
+
+	rpc GetUnsignedOfflineLogonTicket (.COffline_GetUnsignedOfflineLogonTicket_Request) returns (.COffline_GetUnsignedOfflineLogonTicket_Response) {
+		option (method_description) = "Get an unsigned offline logon ticket for the current user";
+	}
+}