PGOS Extension Data Schema

Download OpenAPI specification:Download

This is the Extension Data Schema document of PGOS.

EventBattleSessionPlacementFailed

The event will be triggered when a battle session placment is failed.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_battle_session_placement_failed`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_battle_session_placement_failed",
"event_time": 1601654400000,
"event_data": {"battle_session_id": "string",
"placer": "string",
"fleet_id": "string",
"battle_session_status": "string",
"battle_session_status_msg": "string",
"created_time": 0,
"terminated_time": 0,
"placing_timeout": 0,
"source_type": "string",
"max_players": 0,
"battle_properties": [{"key": "string",
"value": "string"
}
]
},
"args": { }
}

EventBattleSessionPlacementFulfilled

The event will be triggered when a battle session placment is fulfilled. It is related to UPgosServerAPI::ActivateBattleSession() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_battle_session_placement_fulfilled`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_battle_session_placement_fulfilled",
"event_time": 1601654400000,
"event_data": {"battle_session_id": "string",
"placer": "string",
"fleet_id": "string",
"ip_address": "string",
"port": 0,
"battle_session_status": "string",
"battle_session_status_msg": "string",
"created_time": 0,
"terminated_time": 0,
"placing_timeout": 0,
"source_type": "string",
"max_players": 0,
"battle_properties": [{"key": "string",
"value": "string"
}
],
"player_battle_sessions": [{"player_id": "string",
"player_battle_session_id": "string",
"player_battle_session_status": "string",
"created_time": 0,
"terminated_time": 0
}
]
},
"args": { }
}

EventBattleSessionPlacementTimedout

The event will be triggered when a battle session placemnt is timed out.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_battle_session_placement_timedout`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_battle_session_placement_timedout",
"event_time": 1601654400000,
"event_data": {"battle_session_id": "string",
"placer": "string",
"fleet_id": "string",
"battle_session_status": "string",
"battle_session_status_msg": "string",
"created_time": 0,
"terminated_time": 0,
"placing_timeout": 0,
"source_type": "string",
"max_players": 0,
"battle_properties": [{"key": "string",
"value": "string"
}
]
},
"args": { }
}

EventCurrencyChanged

The event will be triggered when a player's currency changed. For example, SubtractPlayerCurrency, GrantCurrencyToPlayer will triggered the event. If virtual currency is contained in item, OpenContainerInstance, GrantItemsToPlayer and other item APIs might also triggered the event.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_currency_changed`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_currency_changed",
"event_time": 1601654400000,
"event_data": {"player_id": "string",
"currencies": [{"currency_code": "string",
"before_value": 0,
"after_value": 0,
"version": 0
}
],
"reason": "string",
"custom_data": "string"
},
"args": { }
}

EventECTExpired

The EventECTExpired structure represents an event that occurs when an Eventual Consistent Transaction (ECT) expires.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_ectexpired`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_ectexpired",
"event_time": 1601654400000,
"event_data": {"ect_info": {"id": "string",
"name": "string",
"payload": "string",
"player_ids": ["string"
],
"status": 0,
"expiration_and_retry_policy": {"expiration_duration": 0,
"trigger_auto_retry_event": true,
"max_auto_retry_count": 0,
"auto_retry_interval": 0
},
"created_time": 0,
"updated_time": 0,
"actions": [{"id": "string",
"name": "string",
"idempotency_token": "string",
"payload": "string",
"result": "string",
"status": 0,
"updated_time": 0
}
]
},
"expire_time": 0
},
"args": { }
}

EventECTRetry

The EventECTRetry structure represents an event that occurs when an Eventual Consistent Transaction (ECT) is retried.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_ectretry`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_ectretry",
"event_time": 1601654400000,
"event_data": {"ect_info": {"id": "string",
"name": "string",
"payload": "string",
"player_ids": ["string"
],
"status": 0,
"expiration_and_retry_policy": {"expiration_duration": 0,
"trigger_auto_retry_event": true,
"max_auto_retry_count": 0,
"auto_retry_interval": 0
},
"created_time": 0,
"updated_time": 0,
"actions": [{"id": "string",
"name": "string",
"idempotency_token": "string",
"payload": "string",
"result": "string",
"status": 0,
"updated_time": 0
}
]
},
"retry_count": 0,
"retry_time": 0
},
"args": { }
}

EventItemGranted

The event will be triggered when an item granted to player. For example, OpenContainerInstance, GrantItemsToPlayer will triggered the event.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_item_granted`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_item_granted",
"event_time": 1601654400000,
"event_data": {"player_id": "string",
"src_type": "string",
"reason": "string",
"item_instances": [{"instance_id": "string",
"granted_amount": 0,
"left_amount": 0,
"status": 0,
"item_id": "string",
"created_time": 0,
"updated_time": 0,
"expired_time": 0
}
],
"inventory_version": 0,
"custom_data": "string"
},
"args": { }
}

EventItemInstanceRevoked

The event will be triggered when an item instance reduced from player's inventory. For example, OpenContainerInstance, RevokeItemInstance will triggered the event.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_item_instance_revoked`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_item_instance_revoked",
"event_time": 1601654400000,
"event_data": {"player_id": "string",
"src_type": "string",
"reason": "string",
"item_instances": [{"instance_id": "string",
"revoked_amount": 0,
"left_amount": 0,
"status": 0,
"item_id": "string",
"created_time": 0,
"updated_time": 0,
"expired_time": 0
}
],
"inventory_version": 0,
"custom_data": "string"
},
"args": { }
}

EventLobbyCreated

The event will be triggered when a lobby is created. It is related to UPgosClientAPICreateLobby::CreateLobby() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_lobby_created`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_lobby_created",
"event_time": 1601654400000,
"event_data": {"lobby_id": "string",
"lobby_owner_id": "string",
"chat_channel_id": "string"
},
"args": { }
}

EventLobbyDismissed

The event will be triggered when a lobby is dismissed. It is related to UPgosClientAPIDismissLobby::DismissLobby() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_lobby_dismissed`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_lobby_dismissed",
"event_time": 1601654400000,
"event_data": {"lobby_id": "string",
"lobby_owner_id": "string",
"chat_channel_id": "string",
"teams": {"property1": {"players": ["string"
]
},
"property2": {"players": ["string"
]
}
}
},
"args": { }
}

EventLobbyMemberJoined

The event will be triggered when a player has joined a lobby. It is related to UPgosClientAPIJoinLobby::JoinLobby() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_lobby_member_joined`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_lobby_member_joined",
"event_time": 1601654400000,
"event_data": {"lobby_id": "string",
"lobby_owner_id": "string",
"chat_channel_id": "string",
"member_id": "string"
},
"args": { }
}

EventLobbyMemberLeft

The event will be triggered when a player has left a lobby. It is related to UPgosClientAPILeaveLobby::LeaveLobby() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_lobby_member_left`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_lobby_member_left",
"event_time": 1601654400000,
"event_data": {"lobby_id": "string",
"lobby_owner_id": "string",
"chat_channel_id": "string",
"member_id": "string"
},
"args": { }
}

EventLobbyStartBattle

The event will be triggered when a lobby starts battle. It is related to UPgosClientAPISwitchSlot::StartBattle() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_lobby_start_battle`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_lobby_start_battle",
"event_time": 1601654400000,
"event_data": {"lobby_id": "string",
"lobby_owner_id": "string",
"battle_session_id": "string",
"lobby_players": [{"player_id": "string",
"team_name": "string",
"team_slot": 0,
"source": 0,
"ready": true,
"player_info": {"player_id": "string",
"display_name": "string",
"gender": "string",
"avatar_uri": "string",
"custom_info": {"property1": {"value": "string",
"type": 0
},
"property2": {"value": "string",
"type": 0
}
},
"account_platform": "string",
"account_id": "string",
"os": 0,
"account_open_id": "string",
"account_provider": 0
}
}
],
"timestamp": 0,
"configuration_name": "string",
"battle_properties": [{"key": "string",
"value": "string"
}
]
},
"args": { }
}

EventLobbySwitchSlotRequest

The event will be triggered when a player requests to switch slots in alobby. It is related to UPgosClientAPISwitchSlot::SwitchSlot() in the PGOSSDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_lobby_switch_slot_request`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_lobby_switch_slot_request",
"event_time": 1601654400000,
"event_data": {"lobby_id": "string",
"lobby_owner_id": "string",
"chat_channel_id": "string",
"from_member_id": "string",
"from_team_name": "string",
"from_team_slot": "string"
},
"args": { }
}

EventMatchmakingCompleted

The event will be triggered when matchmaking managed to find a battle. This event includes battle session id, players in this battle and other infomation.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_matchmaking_completed`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_matchmaking_completed",
"event_time": 1601654400000,
"event_data": {"battle_session_id": "string",
"matched_players": [{"player_id": "string",
"team": "string",
"match_attributes": [{"name": "string",
"type": 0,
"number_value": 0,
"string_value": "string",
"list_value": ["string"
]
}
],
"region_latencies": [{"region": "string",
"latency": 0,
"send_pkg_cnt": 0,
"recv_pkg_cnt": 0,
"provider": "string",
"player_id": "string"
}
],
"is_new": true,
"extra_data": "string"
}
],
"timestamp": 0,
"configuration_name": "string",
"battle_properties": [{"key": "string",
"value": "string"
}
],
"ruleset_name": "string"
},
"args": { }
}

EventPartyCreated

The event will be triggered when a party is created. It is related to UPgosClientAPICreateParty::CreateParty() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_party_created`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_party_created",
"event_time": 1601654400000,
"event_data": {"party_id": "string",
"party_name": "string",
"party_leader_player_id": "string",
"chat_channel_id": "string"
},
"args": { }
}

EventPartyDismissed

The event will be triggered when a party is dismissed. It is related to UPgosClientAPIDismissParty::DismissParty() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_party_dismissed`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_party_dismissed",
"event_time": 1601654400000,
"event_data": {"party_id": "string",
"party_leader_player_id": "string",
"chat_channel_id": "string"
},
"args": { }
}

EventPartyMemberJoined

The event will be triggered when a player has joined a party. It is related to UPgosClientAPIJoinParty::JoinParty() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_party_member_joined`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_party_member_joined",
"event_time": 1601654400000,
"event_data": {"party_id": "string",
"chat_channel_id": "string",
"member_id": "string"
},
"args": { }
}

EventPartyMemberLeft

The event will be triggered when a player has left a party. It is related to UPgosClientAPILeaveParty::LeaveParty() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_party_member_left`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_party_member_left",
"event_time": 1601654400000,
"event_data": {"party_id": "string",
"chat_channel_id": "string",
"member_id": "string"
},
"args": { }
}

EventPlayerEventChannelAvailable

The event will be triggered when event channel is first time available after a player login PGOS. It indicates that game client is ready to receive event notifications sent from PGOS backend. The content and timming of event is almost the same with EventPlayerLoginPGOS in usual. Subscribe to this event if messages need to be sent to game client through PushMsg HTTP API in virtual server.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_player_event_channel_available`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_player_event_channel_available",
"event_time": 1601654400000,
"event_data": {"session_id": "string",
"player_id": "string",
"platform": "string",
"ip_addr": "string",
"is_new_player": true,
"start_time": 0,
"connected_time": 0,
"custom_data": "string",
"country_code": "string"
},
"args": { }
}

EventPlayerLoginPGOS

The event will be triggered when a player login PGOS. It is related to UPgosPlayerAuthAPI::LoginPGOS() in PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_player_login_pgos`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_player_login_pgos",
"event_time": 1601654400000,
"event_data": {"session_id": "string",
"player_id": "string",
"platform": "string",
"ip_addr": "string",
"is_new_player": true,
"start_time": 0,
"custom_data": "string",
"country_code": "string"
},
"args": { }
}

EventPlayerLogoutPGOS

The event will be triggered when a player logout PGOS. It is related to UPgosPlayerAuthAPI::LogoutPGOS() in the PGOS SDK.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
event_name	string Event name, which is `event_player_logout_pgos`
event_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Event data.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"event_name": "event_player_logout_pgos",
"event_time": 1601654400000,
"event_data": {"session_id": "string",
"player_id": "string",
"platform": "string",
"ip_addr": "string",
"start_time": 0,
"end_time": 0,
"custom_data": "string",
"country_code": "string"
},
"args": { }
}

ItemConsumptionReq

This is the schema of request triggered by economy service, which is sent to binded virtual server and contains item consumption result.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
operation	string Economy operation, such as `item_consume`
trigger_time	string Date and time when event is triggered, expressed as a utc timestamp,in milliseconds.
	object Economy data.

{"trigger_id": "24ea65b9-a6fb-4de7-9622-410e33c73339",
"operation": "item_consume",
"trigger_time": 1636614291,
"data": {"player_id": "50001",
"item_id": "item_ajxv2z94",
"item_instance_id": "95cf24edff51412992101a67d6b55146",
"item_instance": {"instance_id": "95cf24edff51412992101a67d6b55146",
"left_amount": 0,
"consumed_amount": 1,
"status": 2,
"item_id": "item_ajxv2z94",
"item": {"item_id": "item_ajxv2z94",
"display_name": "expired_item",
"icon": "",
"description": "",
"default_custom_data": { },
"tags": { },
"item_type": 1,
"valid_duration": 30,
"is_stackable": true,
"is_consumable": true,
"is_unique": false,
"item_content": [ ],
"currency_content": [ ]
},
"created_time": "1636614261",
"updated_time": "1637030733",
"expired_time": "1636614291",
"time_to_live": 0
}
}
}

ItemConsumptionRsp

There is no specified schema for item consumption's response. The response returned from virtual server will be json serialized and sent back in the field func_result to the client which consume the item.

MatchmakingPostProcessingReq

This is the schema of request triggered by matchmaking service, which is sent to binded virtual server and contains original matchmaking result.

trigger_id	string Trigger ID for the virtual server.
operation	string Event name, which is `matchmaking_post_processing`.
trigger_time	string Timestamp when event is triggered, expressed as a utc timestamp, in milliseconds.
	object (MatchmakingPostProcessingData)

{"trigger_id": "string",
"operation": "string",
"trigger_time": "string",
"data": {"battle": {"tickets": [{"id": "string",
"match_code": "string",
"players": [{"player_id": "string",
"team": "string",
"match_attributes": [{"name": "string",
"type": 0,
"number_value": 0,
"string_value": "string",
"list_value": [null
]
}
],
"region_latencies": [{"region": "string",
"latency": 0,
"send_pkg_cnt": 0,
"recv_pkg_cnt": 0,
"provider": "string",
"player_id": "string"
}
],
"is_new": true,
"extra_data": "string"
}
],
"status": "string",
"status_message": "string",
"start_time": 0,
"requeued_count": 0
}
]
},
"battle_properties": [{"key": "string",
"value": "string"
}
]
}
}

MatchmakingPostProcessingRsp

This is the schema of response from virtual server, which is sent back to matchmaking service to do post-processing business. The HTTP Body returned by the server must follow this JSON specification so that PGOS can correctly understand the matchmaking results processed by VS.

	Array of objects (BattleProposal) Battles after modified. Since virtual server can split the original battle into multiple battles, this is a 2-dimension list.
	Array of objects (MMTicketEntityPublic) Ticket entities dropped by virtual server. These tickets will be reput into matchmaking queue in order to continue matchmaking.

{"battles": [{"tickets": [{"id": "string",
"match_code": "string",
"players": [{"player_id": "string",
"team": "string",
"match_attributes": [{"name": "string",
"type": 0,
"number_value": 0,
"string_value": "string",
"list_value": [null
]
}
],
"region_latencies": [{"region": "string",
"latency": 0,
"send_pkg_cnt": 0,
"recv_pkg_cnt": 0,
"provider": "string",
"player_id": "string"
}
],
"is_new": true,
"extra_data": "string"
}
],
"status": "string",
"status_message": "string",
"start_time": 0,
"requeued_count": 0
}
]
}
],
"requeued_tickets": [{"id": "string",
"match_code": "string",
"players": [{"player_id": "string",
"team": "string",
"match_attributes": [{"name": "string",
"type": 0,
"number_value": 0,
"string_value": "string",
"list_value": ["string"
]
}
],
"region_latencies": [{"region": "string",
"latency": 0,
"send_pkg_cnt": 0,
"recv_pkg_cnt": 0,
"provider": "string",
"player_id": "string"
}
],
"is_new": true,
"extra_data": "string"
}
],
"status": "string",
"status_message": "string",
"start_time": 0,
"requeued_count": 0
}
]
}

Task

Params received in Virtual Server V2 triggered by task.

trigger_id	string The unique `trigger_id` will be spawned every time an event is triggered.
execution_id	string One or more actions can be executed when an event triggerd. The unique `executeion_id` identifies each action executed when an event is triggered.
task_name	string The name of triggered task.
task_time	string Date and time when task is triggered, expressed as a utc timestamp,in milliseconds.
	object Custom args that set by developers on portal.

{"trigger_id": "c9aa5164-f79f-4472-9170-274f97b8dfe5",
"execution_id": "5f9348c3-cdbb-43b8-91d9-2485eb5ab744",
"task_name": "string",
"task_time": 1601654400000,
"args": { }
}