Data Types

Last updated: 2021-04-06 14:12:07

AttributeMap

The map key and map value of the player attribute

Used by actions: DescribeMatchingProgress, StartMatching.

Name Type Required Description
Key String Yes Map key, supporting [a-zA-Z0-9-.]*
Value Integer Yes Map value

MTicket

The combination of MatchCode and MatchTicket ID.

Used by actions: DescribeMatchingProgress.

Name Type Required Description
MatchCode String Yes MatchCode
MatchTicketId String Yes MatchTicket ID

MatchAttribute

Player attributes for matching

Used by actions: DescribeMatchingProgress, StartMatching.

Name Type Required Description
Name String Yes Attribute name. It can contain up to 128 characters, supporting [a-zA-Z0-9-.]*.
Type Integer Yes Attribute type. 0: number, 1: string. Default value: 0
NumberValue Float No Numeric attribute value. Default value: 0.0
StringValue String No String attribute value. Up to 128 characters are allowed. Default value: ""
ListValue Array of String No List attribute value
MapValue Array of AttributeMap No Map attribute value

MatchCodeAttr

MatchCode

Used by actions: DescribeMatchCodes.

Name Type Description
MatchCode String MatchCode
Note: this field may return null, indicating that no valid value is obtained.

MatchInfo

Matchmaking information

Used by actions: CreateMatch, DescribeMatch, DescribeMatches, ModifyMatch.

Name Type Required Description
MatchCode String Yes MatchCode
MatchName String Yes Match name
MatchDesc String Yes Matchmaking description
Note: this field may return null, indicating that no valid value is obtained.
RuleCode String Yes RuleCode
CreateTime String Yes Creation time
Timeout Integer Yes Timeout period
NotifyUrl String Yes Receiving notification address
ServerType Integer Yes Whether to request server resources for the match results. 0: no, 1: request GSE resources
ServerRegion String Yes Region of the server queue
Note: this field may return null, indicating that no valid value is obtained.
ServerQueue String Yes Server queue
Note: this field may return null, indicating that no valid value is obtained.
CustomPushData String Yes Custom push data
Note: this field may return null, indicating that no valid value is obtained.
ServerSessionData String Yes Game server session data
Note: this field may return null, indicating that no valid value is obtained.
GameProperties Array of StringKV Yes Game attributes
Note: this field may return null, indicating that no valid value is obtained.
LogSwitch Integer Yes Enable or disable the log. 0: disable, 1: enable
LogsetId String Yes Logset ID
Note: this field may return null, indicating that no valid value is obtained.
LogsetName String Yes Logset name
Note: this field may return null, indicating that no valid value is obtained.
LogTopicId String Yes Log topic ID
Note: this field may return null, indicating that no valid value is obtained.
LogTopicName String Yes Log topic name
Note: this field may return null, indicating that no valid value is obtained.
Tags Array of StringKV Yes Tag
Note: this field may return null, indicating that no valid value is obtained.
Region String Yes Region
Note: this field may return null, indicating that no valid value is obtained.
AppId String Yes User AppId
Note: this field may return null, indicating that no valid value is obtained.
Uin String Yes User root account UIN
Note: this field may return null, indicating that no valid value is obtained.
CreateUin String Yes Create user account UIN
Note: this field may return null, indicating that no valid value is obtained.
RuleName String Yes Rule Name
Note: this field may return null, indicating that no valid value is obtained.
LogStatus Integer No Log status. 0: normal, 1: the log set does not exist, 2: the log topic does not exist, 3: neither the log set nor the log topic exists.
Note: this field may return null, indicating that no valid value is obtained.

MatchTicket

MatchTicket information

Used by actions: DescribeMatchingProgress.

Name Type Description
Id String MatchTicket ID. It can contain up to 128 characters, supporting [a-zA-Z0-9-.]*.
MatchCode String MatchCode
MatchResult String Different structure serialized results will be returned according to the MatchType.
Note: this field may return null, indicating that no valid value is obtained.
MatchType String Matchmaking type. Valid values: NORMAL, GSE
Note: this field may return null, indicating that no valid value is obtained.
Players Array of Player Player information list
Status String Matching status. Valid values: SEARCHING (matching), PLACING (pending match), COMPLETED (match completed), CANCELLED (match cancelled), TIMEDOUT (match timeouts), FAILED (match failed)
StatusMessage String Matching status descriptions
Note: this field may return null, indicating that no valid value is obtained.
StatusReason String Reason for the matching status
Note: this field may return null, indicating that no valid value is obtained.
StartTime String The time when the GPM received the matchmaking request, for example "2020-08-17T08:14:38.077Z".
EndTime String The time when the matchmaking request stopped executing due to the completion, failure, timeout, or cancellation, for example "2020-08-17T08:14:38.077Z".
Note: this field may return null, indicating that no valid value is obtained.

Player

Player information

Used by actions: DescribeMatchingProgress, StartMatching.

Name Type Required Description
Id String Yes Player ID. It can contain up to 128 characters, supporting [a-zA-Z\d-._]*.
Name String Yes Player nickname. Up to 128 characters are allowed.
MatchAttributes Array of MatchAttribute Yes Player attribute for matching. Up to 10 attributes are supported.
Team String No Team name. A player can pass in a different team name, which can contain up to 128 characters, and support [a-zA-Z0-9-.]*.
CustomPlayerStatus Integer No Custom player status. This parameter will be passed through. Value range: [0, 99999]
CustomProfile String No Custom player information. Up to 1024 characters are allowed. This parameter will be passed through.
RegionLatencies Array of RegionLatency No Number of delays in each area. Up to 20 delays are supported.

RegionLatency

The network delay time for players to reach different regions.

Used by actions: DescribeMatchingProgress, StartMatching.

Name Type Required Description
Region String Yes Region
ap-beijing North China (Beijing)
ap-chengdu Southwest China (Chengdu)
ap-guangzhou South China (Guangzhou)
ap-hongkong Hong Kong/Macao/Taiwan (Hong Kong, China)
ap-seoul Asia Pacific (Seoul)
ap-shanghai East China (Shanghai)
ap-singapore Southeast Asia (Singapore)
eu-frankfurt Europe (Frankfurt)
na-siliconvalley Western US (Silicon Valley)
na-toronto North America (Toronto)
ap-mumbai Asia Pacific (Mumbai)
na-ashburn Eastern US (Virginia)
ap-bangkok Asia Pacific (Bangkok)
eu-moscow Europe (Moscow)
ap-tokyo Asia Pacific (Tokyo)
Latency Integer Yes Delay time in ms. Value range: 0 - 999999

ReportOverviewData

Matchmaking statistics overview

Used by actions: DescribeData.

Name Type Description
TotalTimes String Total count
SuccessPercent Float Success rate
TimeoutPercent Float Timeout rate
FailPercent Float Failure rate
AverageSec Float Average matching time

ReportTrendData

Trend data

Used by actions: DescribeData.

Name Type Description
TotalList Array of String Total count
CancelList Array of String Number of requests cancelled
SuccessList Array of String Number of successes
FailList Array of String Number of failures
TimeoutList Array of String Number of request timeout
TimeList Array of String Time array in seconds

RuleBriefInfo

Brief rule information

Used by actions: DescribeRules.

Name Type Description