游戏玩家匹配数据结构 - API 文档

VIEW CONTENTS

摘要: AttributeMap玩家属性字典类型值被如下接口引用：DescribeMatchingProgress,StartMatching。名称类型必选描述KeyString是属性字典key[a-zA-Z

点击领取2000元阿里云代金券，付款抵现金用，云服务器69元/年限时抢>>>    点击咨询成为阿里云VIP客户享永久折扣>>>
点击领取2860元腾讯云代金券，付款抵现金用，云服务器88元/年限时抢>>>    点击成为腾讯云VIP客户享永久折扣优惠>>>
点击进入华为云最新优惠活动现场>>>    点击成为华为云VIP客户享永久折扣优惠>>>

AttributeMap

玩家属性字典类型值

被如下接口引用：DescribeMatchingProgress, StartMatching。

名称	类型	必选	描述
Key	String	是	属性字典 key [a-zA-Z0-9-.]*
Value	Integer	是	属性字典 value

MTicket

matchCode和匹配票据 ID组合结构

被如下接口引用：DescribeMatchingProgress。

名称	类型	必选	描述
MatchCode	String	是	匹配Code
MatchTicketId	String	是	匹配票据 ID

MatchAttribute

玩家匹配属性

被如下接口引用：DescribeMatchingProgress, StartMatching。

名称	类型	必选	描述
Name	String	是	属性名长度 128 [a-zA-Z0-9-.]*
Type	Integer	是	属性类型: 0 数值; 1 string; 默认 0
NumberValue	Float	否	数字属性值默认 0.0
StringValue	String	否	字符串属性值长度 128 默认 ""
ListValue	Array of String	否	list 属性值
MapValue	Array of AttributeMap	否	字典属性值

MatchCodeAttr

匹配code

被如下接口引用：DescribeMatchCodes。

名称	类型	描述
MatchCode	String	匹配code 注意：此字段可能返回 null，表示取不到有效值。

MatchInfo

匹配信息

被如下接口引用：CreateMatch, DescribeMatch, DescribeMatches, ModifyMatch。

名称	类型	必选	描述
MatchCode	String	是	匹配code
MatchName	String	是	匹配名称
MatchDesc	String	是	匹配描述注意：此字段可能返回 null，表示取不到有效值。
RuleCode	String	是	规则code
CreateTime	String	是	创建时间
Timeout	Integer	是	超时时间
NotifyUrl	String	是	接收通知地址
ServerType	Integer	是	是否为匹配结果请求服务器资源，0否，1请求GSE资源
ServerRegion	String	是	服务器队列所在地域注意：此字段可能返回 null，表示取不到有效值。
ServerQueue	String	是	服务器队列注意：此字段可能返回 null，表示取不到有效值。
CustomPushData	String	是	自定义推送数据注意：此字段可能返回 null，表示取不到有效值。
ServerSessionData	String	是	游戏服务器会话数据注意：此字段可能返回 null，表示取不到有效值。
GameProperties	Array of StringKV	是	游戏属性注意：此字段可能返回 null，表示取不到有效值。
LogSwitch	Integer	是	日志开关，0表示关，1表示开
LogsetId	String	是	日志集id 注意：此字段可能返回 null，表示取不到有效值。
LogsetName	String	是	日志集名称注意：此字段可能返回 null，表示取不到有效值。
LogTopicId	String	是	日志主题id 注意：此字段可能返回 null，表示取不到有效值。
LogTopicName	String	是	日志主题名称注意：此字段可能返回 null，表示取不到有效值。
Tags	Array of StringKV	是	标签注意：此字段可能返回 null，表示取不到有效值。
Region	String	是	地区注意：此字段可能返回 null，表示取不到有效值。
AppId	String	是	用户AppId 注意：此字段可能返回 null，表示取不到有效值。
Uin	String	是	用户主账号Uin 注意：此字段可能返回 null，表示取不到有效值。
CreateUin	String	是	用户创建账号Uin 注意：此字段可能返回 null，表示取不到有效值。
RuleName	String	是	规则名称注意：此字段可能返回 null，表示取不到有效值。
LogStatus	Integer	否	日志状态，0表示正常，1表示日志集不存在，2表示日志主题不存在，3表示日志集和日志主题都不存在。注意：此字段可能返回 null，表示取不到有效值。

MatchTicket

匹配票据信息

被如下接口引用：DescribeMatchingProgress。

名称	类型	描述
Id	String	匹配票据 ID长度 128 [a-zA-Z0-9-.]*
MatchCode	String	匹配 Code
MatchResult	String	根据 MatchType 取不同的结构序列化结果注意：此字段可能返回 null，表示取不到有效值。
MatchType	String	表示不同的匹配类型,NORMAL \| GSE 注意：此字段可能返回 null，表示取不到有效值。
Players	Array of Player	玩家信息列表
Status	String	匹配状态: SEARCHING 匹配中; PLACING 匹配放置中; COMPLETED 匹配完成; CANCELLED 匹配取消; TIMEDOUT 匹配超时; FAILED 匹配失败
StatusMessage	String	匹配状态信息注意：此字段可能返回 null，表示取不到有效值。
StatusReason	String	匹配状态原因注意：此字段可能返回 null，表示取不到有效值。
StartTime	String	收到发起匹配请求的时间 eg: "2020-08-17T08:14:38.077Z"
EndTime	String	匹配请求因完成、失败、超时、被取消而停止执行的时间 eg: "2020-08-17T08:14:38.077Z" 注意：此字段可能返回 null，表示取不到有效值。

Player

玩家信息。

被如下接口引用：DescribeMatchingProgress, StartMatching。

名称	类型	必选	描述
Id	String	是	玩家 PlayerId 长度 128 [a-zA-Z\d-._]*
Name	String	是	玩家昵称，长度 128
MatchAttributes	Array of MatchAttribute	是	玩家匹配属性，最多 10 条
Team	String	否	队伍名，可以传递不同队伍名，长度 128 [a-zA-Z0-9-.]*
CustomPlayerStatus	Integer	否	自定义玩家状态透传参数 [0, 99999]
CustomProfile	String	否	自定义玩家信息透传参数长度 1024
RegionLatencies	Array of RegionLatency	否	各区域延迟，最多 20 条

RegionLatency

玩家到各区域的延迟

被如下接口引用：DescribeMatchingProgress, StartMatching。

名称	类型	必选	描述
Region	String	是	地域 ap-beijing 华北地区(北京) ap-chengdu 西南地区(成都) ap-guangzhou 华南地区(广州) ap-hongkong 港澳台地区(中国香港) ap-SEOul 亚太地区(首尔) ap-shanghai 华东地区(上海) ap-singapore 东南亚地区(新加坡) eu-frankfurt 欧洲地区(法兰克福) na-siliconvalley 美国西部(硅谷) na-toronto 北美地区(多伦多) ap-mumbai 亚太地区(孟买) na-ashburn 美国东部(弗吉尼亚) ap-bangkok 亚太地区(曼谷) eu-moscow 欧洲地区(莫斯科) ap-tokyo 亚太地区(东京)
Latency	Integer	是	毫秒延迟 0～999999

ReportOverviewData

匹配概况

被如下接口引用：DescribeData。

名称	类型	描述
TotalTimes	String	总次数
SuccessPercent	Float	成功率
TimeoutPercent	Float	超时率
FailPercent	Float	失败率
AverageSec	Float	平均匹配时间

ReportTrendData

统计数据之趋势数据

被如下接口引用：DescribeData。

名称	类型	描述
TotalList	Array of String	总次数
CancelList	Array of String	被取消次数
SuccessList	Array of String	成功次数
FailList	Array of String	失败次数
TimeoutList	Array of String	超时次数
TimeList	Array of String	时间数组，单位：秒

RuleBriefInfo

规则简单信息

被如下接口引用：DescribeRules。

名称	类型	描述
RuleName	String	规则名称 [a-zA-Z\d-.]*
MatchCodeList	Array of StringKV	关联匹配
CreateTime	String	创建时间
RuleCode	String	规则code

RuleInfo

规则信息

被如下接口引用：CreateRule, DescribeRule, ModifyRule。

名称	类型	描述
RuleName	String	规则名称 [a-zA-Z0-9-.]*
CreateTime	String	创建时间
RuleDesc	String	规则描述注意：此字段可能返回 null，表示取不到有效值。
RuleScript	String	规则脚本
Tags	Array of StringKV	标签注意：此字段可能返回 null，表示取不到有效值。
MatchCodeList	Array of StringKV	关联匹配注意：此字段可能返回 null，表示取不到有效值。
RuleCode	String	规则code
Region	String	地区注意：此字段可能返回 null，表示取不到有效值。
AppId	String	用户AppId 注意：此字段可能返回 null，表示取不到有效值。
Uin	String	用户Uin 注意：此字段可能返回 null，表示取不到有效值。
CreateUin	String	用户OwnerUin 注意：此字段可能返回 null，表示取不到有效值。