游戏 API 参考

GameOn 游戏 API 参考

概览

该 API 使开发者能够将其游戏与 Amazon GameOn 竞赛集成。使用此 API,开发人员可以向玩家展示竞赛以及竞赛详情,让玩家进入竞赛,提交得分,向玩家显示排行榜以及让玩家领取奖品。

方法 类型 路径 描述
注册玩家 POST /players/register 注册和创建新的玩家令牌。
对玩家进行身份验证 POST /players/auth 身份验证和创建新玩家会话。
获取竞赛 GET /tournaments 获取所需期间的竞赛列表,可以选择按竞赛状态筛选。
获取竞赛详情 GET /tournaments/{tournamentId} 获取竞赛详情,从而允许玩家查看有关竞赛的更多信息。
获取奖品详情 GET /prizes/{prizeId} 获取奖品详情,这些信息随后可以与竞赛或对战详情一起显示,让玩家知道获胜之后会赢得的奖励。
进入竞赛 POST /tournaments/{tournamentId}/enter 第一次进入竞赛。这会根据每个竞赛的最大对战数以及每个对战的最大玩家数,在竞赛中查找开放的对战。
获取对战 GET /matches 获取所需期间的对战列表,可以选择按照玩家在对战中的名次筛选。
获取对战详情 GET /matches/{matchId} 获取请求玩家的对战详情,包括剩余尝试次数、上次得分、最高得分以及竞赛详情。
进入对战 POST /matches/{matchId}/enter 如果某个对战允许多次尝试,则重新进入竞赛中的对战。
提交得分 PUT /matches/{matchId}/score 为每次对战尝试提交玩家的得分。
添加尝试次数 POST /matches/{matchId}/attempts 为某个对战中的一位玩家添加更多尝试。
获取排行榜 GET /matches/{matchId}/leaderboard 获取对战的前 n 个玩家,并且可使用选项来获取玩家在排行榜中的位置,即使玩家并非这些前 n 个玩家之一。
领取奖品 POST /prizes/claim 允许玩家领取奖品。
兑现奖品 POST /prizes/fulfill 将标记的奖品交付给玩家。
更新玩家 PATCH /players 更新玩家信息。
添加玩家竞赛 POST /player-tournaments 将玩家竞赛添加到系统。
获取玩家竞赛 GET /player-tournaments 获取所需期间的玩家竞赛列表,可以选择按竞赛状态筛选。
获取玩家竞赛详情 GET /player-tournaments/{tournamentId} 获取玩家竞赛详情,以允许玩家查看有关竞赛的更多信息。
更新玩家竞赛 PATCH /player-tournaments/{tournamentId} 更新玩家竞赛的特定属性。
进入玩家竞赛 POST /player-tournaments/{tournamentId}/enter 第一次进入玩家竞赛。这将查找玩家竞赛的对战并进入。

版本信息

版本:v1

许可证信息

许可证:API 和这些材料是需要遵守我们的程序材料许可协议的程序材料。许可证 URL:https://developer.amazon.com/public/support/pml.html

URI 方案

主机:api.amazongameon.com 基本路径:/v1 方案:HTTPS

路径

注册玩家

POST /players/register

描述

注册玩家会将玩家 (及其设备) 添加到 GameOn 系统,进行密钥交换,并返回加密的玩家令牌。

下图显示了事件流,包括需要在流程中的不同点加密和解密的密钥。有关更多信息,请参阅 Game API 工作流

序列图
单击以放大

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 X-Api-Key
必需
游戏 API 密钥。此项在您注册游戏时提供。 字符串
正文 registerPlayerRequest
必需
注册玩家所需的信息。 RegisterPlayerRequest

响应

HTTP 代码 描述 架构
200 已成功注册玩家。 RegisterPlayerResponse
400 无效的请求参数。 无内容
401 未授权。 无内容
403 禁止访问。无效的 API 密钥。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /players/register
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c
请求正文
{
  "advertisingId" : "54d8fd8d-e349-49d8-902c-0558365ac22b",
  "encryptedPayload" : "Iq6nXfcoDYQEKZEDBhiHefKJLn2Q70iU09DKD7lMsEyFwUguI5w5+WYkM4b0MBfagRFsOltocwsyy0ujzYJ7F3QyRjCIdUc0IP8P6OQmU6fuU43u/AKpNLT4HphCzFOFiQwY4Jf6eIyfaClBiuZkB1apXz1qAhaQd5PdrUQ1JTT2dmEIQZF+lXz1bLpOBDbuKMcOVW55xn7CXC0LcyX6Y58ydZ2bFuNFNchY/mK5ubsbvg+b/8k1cdZDS7dtT9LEwgHUI77ZlmyU+dE/91BlM2nRuqyK8yCv+juA4/MvQ+nSeXtGZROkFZmmX45kh3ngrCQp1dqDVWHA749fFew0pg=="
}

示例 HTTP 响应

响应 200
{
  "encryptedPlayerToken" : "gIBkQDL6yDAcMC5eMnDBoC+MypR6fbmf4oTEtzDAh27LOhLeO5tow4gXIQ/0rmzom+IqtXVZxtRUJAhLIoWbEwtHJ4Xze8LVU3rXZ1NyJX26tE6pu9SvE5CARcpDJtRc20EGQ965fxt6PWlkFwvn4BJkHzXQ/pEGONpEDTKuhXM="
}

对玩家进行身份验证

POST /players/auth

描述

身份验证和创建新玩家会话。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 X-Api-Key
可选
游戏 API 密钥。此项在您注册游戏时提供。 字符串
正文 authPlayerRequest
必需
对玩家进行身份验证所需的信息。 AuthPlayerRequest

响应

HTTP 代码 描述 架构
200 已成功对玩家进行身份验证。 AuthPlayerResponse
400 无效的请求参数。 无内容
401 未授权。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /players/auth HTTP/1.1
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c
请求正文
{
  "advertisingId" : "54d8fd8d-e349-49d8-902c-0558365ac22b",
  "encryptedPayload" : "TKGkmEcD2F03j2L+nyZsZMKOdF06tJROVinq49Qfy8eQ+Hn7mBcJQrQOnMxASulQ1pDyZ0nMQexejo6K05EKPG7SkAdsFKcovZoJQhHleBYtLOI2/ppEQmyzD719ML2Svx+FrSL1ig9uv9br+q9fwCtJVNFX06fQ2CTa9MDdu1duNTkbwuGCShSqivdyvgdt4cmi/eLLqm8J9eMV8DGpHA0GW+jAUm38HPfcSmkH5vWbWLKn8RfFu33C5jDehnCBMOuvL3eYFJKQ6m1Cajg25T65ULNU8UFyKyz2ACj15TPLSKtZ9KMwU7fh5hknrjS1PuFZGjKzMh8qTnabXByWPA==",
  "playerName" : "hunkdory",
  "devicePushNotificationToken" : "392340e57e4a7c646326b1cf96931d97f22ab163f23b3d3605fc5698d3788xx9",
  "deviceOSType" : "iOS",
  "appBuildType" : "development"
}

示例 HTTP 响应

响应 200
{
  "sessionApiKey" : "9a8f707f-a09e-4710-8cf2-7cb5a7b0de57",
  "sessionExpirationDate": 1607760000000,
  "sessionId" : "034721fb-f384-4cb1-a46d-d96cea8198b6"
}

获取竞赛

GET /tournaments

描述

获取所需期间的竞赛列表,可以选择按竞赛状态筛选。

参数

类型 名称 描述 架构 默认
标头 Session-Id
必需
活动会话 ID。 字符串  
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串  
查询 filterBy
可选
按竞赛状态筛选。
upcoming:已计划竞赛,但尚未开始。
live:竞赛正在进行中。
枚举:
upcoming
live
live
查询 limit
可选
返回的竞赛的最大数量。 数字 返回所有竞赛。
查询 period
可选
filterBy 结合使用。
filterBy=upcoming 一起使用时,此方法返回将在从现在开始的指定时间段内开始的竞赛列表。
例如 period=week, filterBy=upcoming => 获得即将在下周开始的竞赛列表。
如果随 filterBy=live 一起提供,则忽略。
枚举:
day
week
month
all
all
查询 playerAttributes
可选
玩家的属性。 字符串  

响应

HTTP 代码 描述 架构
200 已成功获取与指定标准匹配的竞赛列表。 GetDeveloperTournamentListResponse
204 没有满足指定标准的竞赛。 无内容
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /tournaments?limit=10&filterBy=upcoming&period=week&playerAttributes={ "status": "vip", "skill": 1, "isActive": true, "gpsCoordinates" : "{\"latitude\": 33.652275, \"longitude\": -117.750495}" } HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
  "tournaments" : [ {
    "canEnter": true,
    "dateEnd" : 1506322800000,
    "dateStart" : 1505335200000,
    "hasAccessKey": false,
    "imageUrl" : "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
    "matchesPerPlayer" : 100,
    "playerAttemptsPerMatch" : 3,
    "playersPerMatch" : 1000,
    "prizeBundles" : [ {
      "description" : "这个宝箱里面的宝物比银色宝箱里面的更好!",
      "imageUrl" : "https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png",
      "prizeIds" : [ "1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2", "979e4402-bd33-45ef-add9-2b8fb812d912" ],
      "rankFrom" : 1,
      "rankTo" : 3,
      "title" : "金色奖励宝箱"
    } ],
    "title" : "寻宝",
    "scoreType" : "Individual",
    "subtitle" : "海盗的战利品",
    "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80",
    "winType" : "highest"
  } ]
}

获取竞赛详情

GET /tournaments/{tournamentId}

描述

获取竞赛的详情,以允许玩家查看有关竞赛的更多信息。

参数

类型 名称 描述 架构
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
路径 tournamentId
必需
竞赛 ID。 字符串
查询 playerAttributes
可选
玩家的属性。 字符串

响应

HTTP 代码 描述 架构
200 已成功获取竞赛详情。 GetDeveloperTournamentDetailsResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 找不到竞赛 ID。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /tournaments/00230795-b4bd-40ef-b181-720ee0ec3d80?playerAttributes={ "status": "vip", "skill": 1, "isActive": true, "gpsCoordinates" : "{\"latitude\": 33.652275, \"longitude\": -117.750495}" } HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
  "canEnter": true,
  "dateEnd" : 1506322800000,
  "dateStart" : 1505335200000,
  "description" : "这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。",
  "hasAccessKey": false,
  "imageUrl" : "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
  "matchesPerPlayer" : 100,
  "playerAttemptsPerMatch" : 3,
  "playersPerMatch" : 1000,
  "prizeBundles" : [ {
    "description" : "这个宝箱里面的宝物比银色宝箱里面的更好!",
    "imageUrl" : "https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png",
    "prizeIds" : [ "1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2", "979e4402-bd33-45ef-add9-2b8fb812d912" ],
    "rankFrom" : 1,
    "rankTo" : 3,
    "title" : "金色奖励宝箱"
  } ],
  "title" : "大人物",
  "scoreType" : "Individual",
  "subtitle" : "海盗的战利品",
  "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80",
  "winType" : "highest"
}

获取奖品详情

GET /prizes/{prizeId}

描述

获取奖品详情,这些信息随后可以与竞赛或对战详情一起显示,让玩家知道获胜之后会赢得的奖励。

参数

类型 名称 描述 架构
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
路径 prizeId
必需
奖品 ID。 字符串

响应

HTTP 代码 描述 架构
200 已成功获取奖品详情。 GetPrizeDetailsResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 未找到奖品 ID。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /prizes/1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2 HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
  "dateCreated" : 1505890800000,
  "dateExpired" : 1506322800000,
  "description" : "上帝赐予了你将触摸到的一切变为黄金的能力。",
  "imageUrl" : "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
  "prizeId" : "1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2",
  "prizeInfoType": "VENDOR",
  "title" : "黄金盔甲"
}

进入竞赛

POST /tournaments/{tournamentId}/enter

描述

第一次进入竞赛。这会根据每个竞赛的最大对战数以及每个对战的最大玩家数,在竞赛中查找开放的对战。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
路径 tournamentId
必需
玩家想要进入的竞赛的 ID。 字符串
正文 enterTournamentRequest
可选
为进入竞赛提供的可选信息。 EnterTournamentRequest

响应

HTTP 代码 描述 架构
200 玩家已成功进入竞赛。 EnterTournamentResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 找不到竞赛 ID。 无内容
409 有多种原因可能导致冲突异常:
- 竞赛已满员。
- 没有可以进入的对战。
- 玩家未达到竞赛要求。
- 玩家没有竞赛的正确访问密钥。
- 无法在竞赛启动之前进入。
- 无法在竞赛结束之后进入。
无内容

生成

  • application/json

示例 HTTP 请求

请求
/tournaments/00230795-b4bd-40ef-b181-720ee0ec3d80/enter HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
    "playerAttributes" : {
        "status" : "vip",
        "skill" : 1,
        "isActive" : true,
        "gpsCoordinates" : "{\"latitude\": 33.652275, \"longitude\": -117.750495}"
    },
    "accessKey" : "ADEF"
}

示例 HTTP 响应

响应 200
{
  "attemptsRemaining" : 2,
  "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
}

获取对战

GET /matches

描述

获取所需期间的对战列表,可以选择按照玩家在对战中的名次筛选。

参数

类型 名称 描述 架构 默认
标头 Session-Id
必需
活动会话 ID。 字符串  
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串  
查询 filterBy
可选
按玩家在对战中的状态筛选。
claimed-prizes:玩家已经赢得任意奖品并领取了所有这些奖品的对战。
unclaimed-prizes:玩家已经赢得任意奖品但至少有一件奖品未领取的对战。
fulfilled-prizes:玩家已兑现所有奖品的对战。
prizes-won:玩家赢得了任意奖品 (包括已领取、未领取和已兑现的奖品) 的对战。
no-prizes-won:玩家未赢得奖品的对战。
live:玩家正在进行的对战。
all:玩家过去和正在进行的对战。
枚举:
claimed-prizes
unclaimed-prizes
fulfilled-prizes
prizes-won
no-prizes-won
live
all
live
查询 limit
可选
返回的对战的最大数量。 数字 如果未提供,则返回所有对战。
查询 matchType
可选
根据竞赛生成器类型筛选对战。
developer:这将返回开发者生成的竞赛中的对战。
player-generated:这将返回玩家生成的竞赛中的对战。
all:这将返回所有竞赛中的对战。
枚举:
developer
player-generated
all
all
查询 period
可选
filterBy 结合使用。
filterBy=claimed 一起使用时,此方法返回从现在开始的指定期间内,玩家领取了所有奖品的对战列表。
例如 period=weekfilterBy=claimed => 获取上周玩家领取了所有奖品的对战列表。
如果随 filterBy=live 一起提供,则忽略。
枚举:
day
week
month
all
all
查询 playerAttributes
可选
玩家的属性。 字符串  

响应

HTTP 代码 描述 架构
200 已成功获取满足指定标准的对战。 GetMatchListResponse
204 没有满足指定标准的对战。 无内容
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /matches?filterBy=prizes-won&period=week&limit=10&matchType=all&playerAttributes={ "status": "vip", "skill": 1, "isActive": true, "gpsCoordinates" : "{\"latitude\": 33.652275, \"longitude\": -117.750495}" } HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
  "matches" : [ {
    "attemptsRemaining" : 2,
    "canEnter" : true,
    "dateEnd" : 1506322800000,
    "dateStart" : 1505335200000,
    "imageUrl" : "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
    "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
    "matchesPerPlayer" : 100,
    "playerAttemptsPerMatch" : 3,
    "playersPerMatch" : 1000,
    "prizeBundles" : [ {
      "description" : "这个宝箱里面的宝物比银色宝箱里面的更好。",
      "imageUrl" : "https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png",
      "prizeIds" : "[ \"1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2\", \"979e4402-bd33-45ef-add9-2b8fb812d912\" ]",
      "rankFrom" : 1,
      "rankTo" : 3,
      "title" : "金色奖励宝箱"
    } ],
    "subtitle" : "海盗的战利品",
    "title" : "寻宝",
    "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80"
  } ],
  "playerMatches" : [ {
    "attemptsRemaining" : 2,
    "creatorPlayerName" : "Bee",
    "dateEnd" : 1506322800000,
    "dateStart" : 1505335200000,
    "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
    "playerAttemptsPerMatch" : 3,
    "playersPerMatch" : 1000,
    "subtitle" : "海盗的战利品",
    "title" : "寻宝",
    "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80"
  } ]
}

获取对战详情

GET /matches/{matchId}

描述

获取请求玩家的对战详情,包括剩余尝试次数、上次得分、最高得分以及竞赛详情。

参数

类型 名称 描述 架构
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
路径 matchId
必需
对战 ID。 字符串
查询 playerAttributes
可选
玩家的属性。 字符串

响应

HTTP 代码 描述 架构
200 已成功获取对战详情。 GetMatchDetailsResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 未找到对战 ID。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /matches/e7bcece8-9f1b-11e7-abc4-cec278b6b50a?playerAttributes={ "status": "vip", "skill": 1, "isActive": true, "gpsCoordinates" : "{\"latitude\": 33.652275, \"longitude\": -117.750495}" } HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
  "awardedPrizes" : [ {
    "awardedPrizeId" : "f284c1ea-70a7-4670-b43d-874402acae5f",
    "status" : "未领取",
    "prizeTitle" : "黄金战斧"
  } ],
  "attemptsRemaining" : 2,
  "canEnter": true,
  "highScore" : 26.0,
  "highScoreDate" : 1505718000000,
  "lastScore" : 20.0,
  "lastScoreDate" : 1505977200000,
  "playerName" : "foo1990",
  "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
  "tournamentDetails" : {
    "dateEnd" : 1506322800000,
    "dateStart" : 1505335200000,
    "description" : "这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。",
    "imageUrl" : "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
    "playerAttemptsPerMatch" : 3,
    "playersPerMatch" : 1000,
    "prizeBundles" : [ {
      "description" : "这个宝箱里面的宝物比银色宝箱里面的更好!",
      "imageUrl" : "https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png",
      "prizeIds" : [ "1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2", "979e4402-bd33-45ef-add9-2b8fb812d912" ],
      "rankFrom" : 1,
      "rankTo" : 3,
      "title" : "金色奖励宝箱"
    } ],
    "title" : "大人物",
    "subtitle" : "海盗的战利品",
    "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80"
  }
}

进入对战

POST /matches/{matchId}/enter

描述

如果某个对战允许多次尝试,则重新进入竞赛中的对战。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
路径 matchId
必需
玩家想要进入的对战的 ID。 字符串
正文 enterMatchRequest
可选
为进入对战提供的可选信息。 EnterMatchRequest

响应

HTTP 代码 描述 架构
200 玩家已成功进入对战。 EnterMatchResponse
400 对战 ID 无效。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 未找到对战 ID。 无内容
409 有多种原因可能导致冲突异常:
- 玩家不在对战中。
- 玩家没有剩余的尝试次数。
- 玩家未达到竞赛要求。
- 无法在对战启动之前进入。
- 无法在对战结束之后进入。
无内容

生成

  • application/json

示例 HTTP 请求

请求
POST /matches/e7bcece8-9f1b-11e7-abc4-cec278b6b50a/enter HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
    "playerAttributes" : {
        "status" : "vip",
        "skill" : 1,
        "isActive" : true,
        "gpsCoordinates" : "{\"latitude\": 33.652275, \"longitude\": -117.750495}"
    }
}

示例 HTTP 响应

响应 200
{
  "attemptsRemaining" : 2,
  "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
}

提交得分

PUT /matches/{matchId}/score

描述

为每次对战尝试提交玩家的得分。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
路径 matchId
必需
玩家尝试进入的对战的 ID。 字符串
正文 submitScoreRequest
必需
要提交的玩家得分。 SubmitScoreRequest

响应

HTTP 代码 描述 架构
200 已成功提交得分。 无内容
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 未找到对战 ID。 无内容
409 有多种原因可能导致冲突异常:
- 玩家不在对战中。
- 玩家已达到提交得分的最大次数。
- 玩家应重新进入对战,然后才能再次提交得分。
- 无法在对战开始之前提交对分。
- 由于竞赛已关闭,无法提交得分。
无内容

生成

  • application/json

示例 HTTP 请求

请求
PUT /matches/e7bcece8-9f1b-11e7-abc4-cec278b6b50a/score HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
  "score" : "50"
}

添加尝试次数

POST /matches/{matchId}/attempts

描述

为某个对战中的一位玩家添加更多尝试。

参数

类型 名称 描述 架构
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
路径 matchId
必需
玩家尝试进入的对战的 ID。 字符串
正文 addAttemptsRequest
必需
添加尝试信息。 AddAttemptsRequest

响应

HTTP 代码 描述 架构
200 已成功为对战中的玩家添加尝试次数。 AddAttemptsResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 未找到对战 ID。 无内容
409 有多种原因可能导致冲突异常:
- 玩家没有参与对战或尝试次数已超过 32,767 的限制。
无内容
429 请求过多。 无内容

生成

  • application/json

示例 HTTP 请求

请求
POST /matches/e7bcece8-9f1b-11e7-abc4-cec278b6b50a/attempts HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
  "addAttempts" : 1
}

示例 HTTP 响应

响应 200
{
  "attemptsRemaining" : 12
}
请求正文
{
  "score" : "26"
}

获取排行榜

GET /matches/{matchId}/leaderboard

描述

获取某个对战的排行榜,并且可使用选项来获取玩家在排行榜中位置。

参数

类型 名称 描述 架构 默认
标头 Session-Id
可选
活动会话 ID。 字符串  
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串  
路径 matchId
必需
对战 ID。 字符串  
查询 currentPlayerNeighbors
可选
显示当前玩家在排行榜中的位置以及当前玩家上下的 n 个玩家。 数字  
查询 limit
可选
单个请求中可以返回的排行榜中的最大玩家数。最大值:100。 数字 25

响应

HTTP 代码 描述 架构
200 已成功获取对战的排行榜。 GetMatchLeaderboardResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 未找到对战 ID。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /matches/e7bcece8-9f1b-11e7-abc4-cec278b6b50a/leaderboard?limit=2 HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
    "leaderboard": [
        {
            "externalPlayerId": "5ff9cd4a-435a-483e-8152-9a55c32199f7",
            "playerName": "player278",
            "score": 70,
            "isCurrentPlayer": true,
            "rank": 1
        },
        {
            "externalPlayerId": "1a91fe23-a39c-412e-bec2-43f7a3cd1fed",
            "playerName": "player5846",
            "score": 50,
            "rank": 2
        }
    ],
    "next": "/matches/f106bf39-adc2-4a19-8934-fdaf482738e6/leaderboard?limit=2&cursor=QHxmZWQyMjZhNy1hM2NlLTQyNzktYTI0NC00ZGNhOTE1NjU5ZTUsMnwwMDAwMDAxNzk3NjkzMTM0ODYyMzE1NzA4MTQ1Mjc0MjM3MzE3MDQzNTY3OTgwNzA1Njc1MjU4NDQ5OTY1OTg5MTc0NzY4MDMxNTcyNjA3ODAwMjg1Mzg3NjA1ODk1NTg2MzI3NjY4NzgxNzE1NDA0NTg5NTM1MTQzODI0NjQyMzQzMjEzMjY4ODk0NjQxODI3Njg0Njc1NDY3MDM1Mzc1MTY5ODYwNDk5MTA1NzY1NTEyODIwNzYyNDU0OTAwOTAzODkzMjg5NDQwNzU4Njg1MDg0NTUxMzM5NDIzMDQ1ODMyMzY5MDMyMjI5NDgxNjU4MDg1NTkzMzIxMjMzNDgyNzQ3OTc4MjYyMDQxNDQ3MjMxNjg3MzgxNzcxODA5MTkyOTk4ODEyNTA0MDQwMjYxODQxMjQ4NTgzMTgwMDAxNTE4MzY2Mjg3MzUxfDVmNGY1ZDI2LWFhNWQtNDNmYi05Mjg2LTQ2OGM4YmQyNzE3ZHxmMTA2YmYzOS1hZGMyLTRhMTktODkzNC1mZGFmNDgyNzM4ZTY="
}

示例 HTTP 请求 (不含 Session-Id)

请求
GET /matches/e7bcece8-9f1b-11e7-abc4-cec278b6b50a/leaderboard?limit=2 HTTP/1.1
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
    "leaderboard": [
        {
            "externalPlayerId": "5ff9cd4a-435a-483e-8152-9a55c32199f7",
            "playerName": "player278",
            "score": 70,
            "rank": 1
        },
        {
            "externalPlayerId": "1a91fe23-a39c-412e-bec2-43f7a3cd1fed",
            "playerName": "player5846",
            "score": 50,
            "rank": 2
        }
    ],
    "next": "/matches/f106bf39-adc2-4a19-8934-fdaf482738e6/leaderboard?limit=2&cursor=QHw0MWVjMWFhZC1kNTk2LTQ5YWQtOGYyZS1kZDExZjEzNzFjNjMsMnwwMDAwMDAxNzk3NjkzMTM0ODYyMzE1NzA4MTQ1Mjc0MjM3MzE3MDQzNTY3OTgwNzA1Njc1MjU4NDQ5OTY1OTg5MTc0NzY4MDMxNTcyNjA3ODAwMjg1Mzg3NjA1ODk1NTg2MzI3NjY4NzgxNzE1NDA0NTg5NTM1MTQzODI0NjQyMzQzMjEzMjY4ODk0NjQxODI3Njg0Njc1NDY3MDM1Mzc1MTY5ODYwNDk5MTA1NzY1NTEyODIwNzYyNDU0OTAwOTAzODkzMjg5NDQwNzU4Njg1MDg0NTUxMzM5NDIzMDQ1ODMyMzY5MDMyMjI5NDgxNjU4MDg1NTkzMzIxMjMzNDgyNzQ3OTc4MjYyMDQxNDQ3MjMxNjg3MzgxNzcxODA5MTkyOTk4ODEyNTA0MDQwMjYxODQxMjQ4NTgzMTgwMDAxNTE4MzY2Mjg3MzUxfDVmNGY1ZDI2LWFhNWQtNDNmYi05Mjg2LTQ2OGM4YmQyNzE3ZHxmMTA2YmYzOS1hZGMyLTRhMTktODkzNC1mZGFmNDgyNzM4ZTY="
}

示例 HTTP 请求(含 currentPlayerNeighbors

请求
GET /matches/e7bcece8-9f1b-11e7-abc4-cec278b6b50a/leaderboard?limit=2&currentPlayerNeighbors=1 HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
    "currentPlayer": {
        "externalPlayerId": "1a91fe23-a39c-412e-bec2-43f7a3cd1fed",
        "playerName": "player5846",
        "score": 50,
        "rank": 2
    },
    "neighbors": [
        {
            "externalPlayerId": "5ff9cd4a-435a-483e-8152-9a55c32199f7",
            "playerName": "player278",
            "score": 70,
            "rank": 1
        },
        {
            "externalPlayerId": "1a91fe23-a39c-412e-bec2-43f7a3cd1fed",
            "playerName": "player5846",
            "score": 50,
            "isCurrentPlayer": true,
            "rank": 2
        },
        {
            "externalPlayerId": "d1849f1b-d5e7-4ba2-8dd8-222d8edd009b",
            "playerName": "player1210",
            "score": 20,
            "rank": 3
        }
    ]
}

领取奖品

POST /prizes/claim

描述

对于已完成对战中的玩家,将颁发的奖品标记为已领取。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
正文 claimPrizeListRequest
必需
已颁发奖品 ID 的列表。 ClaimPrizeListRequest

响应

HTTP 代码 描述 架构
200 已成功领取奖品。 ClaimPrizeListResponse
207 只有部分已颁发奖品 ID 可以领取。 无内容
400 没有任何已颁发的奖品可以领取。它们无效或未找到。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST/prizes/claim HTTP/1.1Session-Id:81f15ed6-82e2-4f99-8d2e-0cadeaeeb1caX-Api-Key:4710-8cf2-7cb5a7b0de57 9a8f707f-a09e-
请求正文
{
  "awardedPrizeIds" : [ "78793fda-9f1b-11e7-abc4-cec278b6b50a", "787943fe-9f1b-11e7-abc4-cec278b6b50a" ]
}

示例 HTTP 响应

响应 200
{
  "externalPlayerId" : "445f49ac-b920-45b5-ae3b-4255cb9f5388",
  "failedAwardedPrizeIds" : [ "787943fe-9f1b-11e7-abc4-cec278b6b50a" ],
  "prizes" : [ {
    "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
    "encryptedPrizeInfo" : "XS3lOskHFJffZr3HN2vAAemmQxbj47Ojc8yP68dptb12dkTVeD86nhFsDX4QEkSi/v3e+B0roDTa21OH02sj3j6v7XtLjLcUnFFUJlEOHKR1Qd3BPYN+erVjQG40/N/Jn0yghgPlDnRnNGNt+rbGLdF1tRJ43eoIFx13KhJivTw=",
    "prizeInfoType": "VENDOR",
    "status": "CLAIMED"
  } ]
}

示例 HTTP 重复响应

响应 200
{
  "externalPlayerId" : "445f49ac-b920-45b5-ae3b-4255cb9f5388",
  "failedAwardedPrizeIds" : [ "787943fe-9f1b-11e7-abc4-cec278b6b50a" ],
  "prizes" : [ {
    "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
    "encryptedPrizeInfo" : "XS3lOskHFJffZr3HN2vAAemmQxbj47Ojc8yP68dptb12dkTVeD86nhFsDX4QEkSi/v3e+B0roDTa21OH02sj3j6v7XtLjLcUnFFUJlEOHKR1Qd3BPYN+erVjQG40/N/Jn0yghgPlDnRnNGNt+rbGLdF1tRJ43eoIFx13KhJivTw=",
    "prizeInfoType": "VENDOR",
    "status": "重复领取"
  } ]
}

兑现奖品

POST /prizes/fulfill

描述

对于在已完成对战中的玩家,将颁发的奖品标记为已兑现。

参数

类型 名称 描述 架构
标头 Session-Id
必需
活动会话 ID。 字符串
正文 fulfillPrizeListRequest
必需
已颁发奖品 ID 的列表。 FulfillPrizeListRequest

响应

HTTP 代码 描述 架构
200 成功将奖品标记为已兑现。 FulfillPrizeListResponse
207 只有部分已颁发奖品 ID 可以兑现。 无内容
400 没有任何已颁发的奖品可以兑现。它们无效或未找到。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /prizes/fulfill HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
  "awardedPrizeIds" : [ "78793fda-9f1b-11e7-abc4-cec278b6b50a", "787943fe-9f1b-11e7-abc4-cec278b6b50a" ]
}

示例 HTTP 响应

响应 200
{
  "externalPlayerId" : "445f49ac-b920-45b5-ae3b-4255cb9f5388",
  "failedAwardedPrizeIds" : [ "787943fe-9f1b-11e7-abc4-cec278b6b50a" ],
  "prizes" : [ {
    "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
	"encryptedPrizeInfo" : "XS3lOskHFJffZr3HN2vAAemmQxbj47Ojc8yP68dptb12dkTVeD86nhFsDX4QEkSi/v3e+B0roDTa21OH02sj3j6v7XtLjLcUnFFUJlEOHKR1Qd3BPYN+erVjQG40/N/Jn0yghgPlDnRnNGNt+rbGLdF1tRJ43eoIFx13KhJivTw=",
    "prizeInfoType": "VENDOR",
  	"status": "已兑现"
  } ]
}

更新玩家

PATCH /players

描述

更新玩家信息。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 Session-Id
必需
活动会话 ID。 字符串
标头 X-Api-Key
必需
身份验证期间生成的会话 API 密钥。 字符串
正文 updatePlayerRequest
必需
可以作为玩家数据一部分更新的字段列表。 UpdatePlayerRequest

响应

HTTP 代码 描述 架构
204 已成功更新玩家信息。 无内容
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
PATCH /players HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
  "playerName" : "hunkydory",
  "devicePushNotificationToken" : "392340e57e4a7c646326b1cf96931d97f22ab163f23b3d3605fc5698d3788xx9"
}

添加玩家竞赛

POST /player-tournaments

描述

将玩家竞赛添加到系统。

参数

类型 名称 描述 架构
标头 session-id
必需
活动会话 ID。 字符串
正文 addPlayerTournamentRequest
必需
要添加的玩家竞赛信息。 AddPlayerTournamentRequest

响应

HTTP 代码 描述 架构
200 正常 AddPlayerTournamentResponse
400 无效的请求参数。 无内容
401 未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /player-tournaments HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
  "title" : "寻宝",
  "subtitle" : "海盗的战利品",
  "description" : "这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。",
  "metadata" : "stage=green",
  "dateStart" : 1505335200000,
  "dateEnd" : 1506322800000,
  "playersPerMatch" : 1000,
  "playerAttemptsPerMatch" : 3,
  "generateAccessKey" : true
}

示例 HTTP 响应

响应 200
{
  "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80",
  "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
  "accessKey" : "BCDF"
}

获取玩家竞赛

GET /player-tournaments

描述

获取所需期间的玩家竞赛列表,可以选择按竞赛状态筛选。

参数

类型 名称 描述 架构 默认    
标头 session-id
必需
活动会话 ID。 字符串      
查询 filterBy
可选
按竞赛状态筛选。
upcoming:已计划竞赛,但尚未开始。
live:竞赛正在进行中。
枚举:
upcoming
live
live   "live"
查询 limit
可选
返回的玩家竞赛的最大数量。 数字 返回 100 个玩家竞赛。    
查询 period
可选
filterBy 结合使用。
filterBy=upcoming 一起使用时,此方法返回将在从现在开始的指定时间段内开始的竞赛列表。
例如 period=week, filterBy=upcoming => 获得即将在下周开始的竞赛列表。
如果随 filterBy=live 一起提供,则忽略。
枚举:
day
week
month
all
all    

响应

HTTP 代码 描述 架构
200 已成功获取与指定标准匹配的玩家竞赛列表。 GetPlayerTournamentListResponse
204 没有与指定标准匹配的玩家竞赛。 无内容
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /player-tournaments?limit=10&filterBy=upcoming&period=week HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
  "tournaments" : [ {
    "accessKey" : "BCDF",
    "creatorPlayerName" : "Bee",
    "creatorExternalPlayerId" : "445f49ac-b920-45b5-ae3b-4255cb9f5388",
    "dateEnd" : 1506322800000,
    "dateStart" : 1505335200000,
    "hasAccessKey": true,
    "playerAttemptsPerMatch" : 3,
    "playersPerMatch" : 1000,
    "scoreType" : "Individual",
    "subtitle" : "海盗的战利品",
    "title" : "寻宝",
    "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80",,
    "winType" : "highest"
  } ]
}

获取玩家竞赛详情

GET /player-tournaments/{tournamentId}

描述

获取玩家竞赛详情,以允许玩家查看有关竞赛的更多信息。

参数

类型 名称 描述 架构
标头 session-id
必需
活动会话 ID。 字符串
路径 tournamentId
必需
要获取其详情的竞赛 ID。 字符串

响应

HTTP 代码 描述 架构
200 已成功获取竞赛详情。 GetPlayerTournamentDetailsResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 找不到竞赛 ID。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /player-tournaments/00230795-b4bd-40ef-b181-720ee0ec3d80 HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57

示例 HTTP 响应

响应 200
{
  "accessKey" : "BCDF",
  "creatorPlayerName" : "Bee",
  "creatorExternalPlayerId" : "445f49ac-b920-45b5-ae3b-4255cb9f5388",
  "dateEnd" : 1506322800000,
  "dateStart" : 1505335200000,
  "description" : "这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。",
  "hasAccessKey": true,
  "playerAttemptsPerMatch" : 3,
  "playersPerMatch" : 10,
  "scoreType" : "Individual",
  "subtitle" : "海盗的战利品",
  "title" : "寻宝",
  "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80",
  "winType" : "highest"
}

更新玩家竞赛

PATCH /player-tournaments/{tournamentId}

描述

更新玩家竞赛的特定属性。

参数

类型 名称 描述 架构
标头 session-id
必需
活动会话 ID。 字符串
路径 tournamentId
必需
要更新的玩家竞赛 ID。 字符串
正文 updatePlayerTournamentRequest
必需
要更新的一组竞赛属性。 UpdatePlayerTournamentRequest

响应

HTTP 代码 描述 架构
200 已成功更新玩家竞赛。 UpdatePlayerTournamentResponse
400 无效的请求参数。 无内容
401 有多种原因可能导致未授权异常:
- 未提供有效的会话 ID。
- 玩家无权更新竞赛。
无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 找不到玩家竞赛 ID。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
PATCH /player-tournaments/00230795-b4bd-40ef-b181-720ee0ec3d80 HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
  "title" : "寻宝",
  "subtitle" : "海盗的战利品",
  "description" : "这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。",
  "metadata" : "eyJiaXJkQ29sb3IiOiJyZWQiLCAiY2FjdGkiOiAicmFuZG9tIn0=",
  "generateAccessKey" : true
}

示例 HTTP 响应

响应 200
{
  "accessKey" : "BCDF",
  "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80"
}

进入玩家竞赛

POST /player-tournaments/{tournamentId}/enter

参数

类型 名称 描述 架构
标头 session-id
必需
活动会话 ID。 字符串
路径 tournamentId
必需
玩家想要进入的竞赛的 ID。 字符串
正文 enterPlayerTournamentRequest
可选
为进入玩家竞赛提供的可选信息。 EnterPlayerTournamentRequest

响应

HTTP 代码 描述 架构
200 玩家已成功进入竞赛。 EnterPlayerTournamentResponse
400 无效的请求参数。 无内容
401 未授权。未提供有效的会话 ID。 无内容
403 禁止访问。已禁止无效的 API 密钥或玩家。 无内容
404 找不到竞赛 ID。 无内容
409 有多种原因可能导致冲突异常:
- 竞赛已满员。
- 玩家没有竞赛的访问密钥。
- 无法在竞赛启动之前进入。
- 无法在竞赛结束之后进入。
无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
/tournaments/00230795-b4bd-40ef-b181-720ee0ec3d80/enter HTTP/1.1
Session-Id: 81f15ed6-82e2-4f99-8d2e-0cadeaeeb1ca
X-Api-Key: 9a8f707f-a09e-4710-8cf2-7cb5a7b0de57
请求正文
{
  "accessKey" : "BCDF"
}

示例 HTTP 响应

响应 200
{
  "attemptsRemaining" : 100,
  "matchId" : "e7bcece8-9f1b-11e7-abc4-cec278b6b50a",
  "metadata" : "eyJiaXJkQ29sb3IiOiJyZWQiLCAiY2FjdGkiOiAicmFuZG9tIn0=",
  "tournamentId" : "00230795-b4bd-40ef-b181-720ee0ec3d80"
}

定义

RegisterPlayerRequest

名称 描述 架构
advertisingId
必需
操作系统提供的设备的 advertisingId
示例"54d8fd8d-e349-49d8-902c-0558365ac22b"
字符串
encryptedPayload
必需
由设备创建的公有密钥,在注册您的游戏时使用提供的公有密钥对该设备进行加密。
示例"Iq6nXfcoDYQEKZED...749fFew0pg=="
字符串

RegisterPlayerResponse

名称 描述 架构
encryptedPlayerToken
必需
用于对玩家设备进行身份验证。在使用前,通过请求中提供的证书的私有密钥进行解密。
示例"gIBkQDL6yDAcMC5e...ONpEDTKuhXM="
字符串
externalPlayerId
必需
用于标识这个独特玩家的 GameOn 玩家 ID。
示例"445f49ac-b920-45b5-ae3b-4255cb9f5388"
字符串

AuthPlayerRequest

名称 描述 架构
advertisingId
必需
操作系统提供的设备的 advertisingId
示例"54d8fd8d-e349-49d8-902c-0558365ac22b"
字符串
appBuildType
必需
仅为 deviceOSType=ios 设置此项。将通知发送到 iOS 设备时需要此项
示例"development"
枚举:
development
release
deviceOSType
必需
玩家设备上运行的操作系统
示例"ios"
枚举:
fireos
android
ios
pc
mac
linux
xbox
playstation
nintendo
html
devicePushNotificationToken
可选
用于推送通知的 PNS/GCM/FCM/ADM 令牌。
示例"392340e57e4a7c646326b1cf96931d97f22ab163f23b3d3605fc5698d3788xx9"
字符串
encryptedPayload
必需
由设备创建的公有密钥,在注册您的游戏时使用提供的公有密钥对该设备进行加密。
示例"TKGkmEcD2F03j2LZ...qTnabByWPA=="
字符串
playerName
可选
玩家名称。
示例"hunkdory"
字符串

AuthPlayerResponse

名称 描述 架构
sessionApiKey
必需
要用于会话的 API 密钥。
示例"9a8f707f-a09e-4710-8cf2-7cb5a7b0de57"
字符串
sessionExpirationDate
必需
要用于会话的 API 密钥。
示例1607760000000
字符串
sessionId
必需
已激活会话的标识符。
示例"034721fb-f384-4cb1-a46d-d96cea8198b6"
字符串

GetTournamentListResponse_PrizeBundle

名称 描述 架构
description
可选
奖品包描述。
示例"这个宝箱里面的宝物比银色宝箱里面的更好!"
字符串
imageUrl
可选
奖品包图标。
示例"https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png"
字符串
prizeIds
必需
作为此包的一部分颁发的奖品 ID 列表。
示例[ "1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2", "979e4402-bd33-45ef-add9-2b8fb812d912" ]
< string > 数组
rankFrom
必需
将赢得此奖品包的最高排名。
示例2
整数 (int32)
rankTo
必需
将赢得此奖品包的最低排名。
示例4
整数 (int32)
title
必需
奖品包标题。
示例"金色奖励宝箱"
字符串

GetTournamentListResponse_Tournament

名称 描述 架构
canEnter
必需
指示玩家是否符合进入竞赛的条件:玩家满足竞赛要求,还有空位,并且竞赛处于活动状态。
示例true
布尔值
dateEnd
必需
竞赛结束日期。
示例1506322800000
整数 (int64)
dateStart
必需
竞赛开始日期。
示例1505335200000
整数 (int64)
imageUrl
可选
竞赛的图标。
示例"https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
字符串
matchesPerPlayer
必需
每个玩家允许的最大对战数。
示例100
整数 (int32)
playerAttemptsPerMatch
必需
每个玩家每次对战允许的最大尝试次数。
示例3
整数 (int32)
playersPerMatch
必需
一个对战中允许参与的最大玩家数。
示例1000
整数 (int32)
prizeBundles
必需
奖品包的列表。 < GetTournamentListResponse_PrizeBundle > 数组
title
必需
竞赛标题。
示例"寻宝"
字符串
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
tournamentId
必需
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

GetDeveloperTournamentDetailsResponse

名称 描述 架构
canEnter
必需
指示玩家是否符合进入竞赛的条件:玩家满足竞赛要求,还有空位,并且竞赛处于活动状态。
示例true
布尔值
dateEnd
必需
竞赛结束日期。
示例1506322800000
整数 (int64)
dateStart
必需
竞赛开始日期。
示例1505335200000
整数 (int64)
description
可选
竞赛的描述。
示例"这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。"
字符串
hasAccessKey
必需
确定竞赛是否需要访问密钥才能进入的值。
示例false
布尔值
imageUrl
可选
竞赛的图标
示例"https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
字符串
matchesPerPlayer
必需
每个玩家允许的最大对战数。
示例100
整数 (int32)
playerAttemptsPerMatch
必需
每个玩家每次对战允许的最大尝试次数。
示例3
整数 (int32)
playersPerMatch
必需
一个对战中允许参与的最大玩家数。
示例1000
整数 (int32)
prizeBundles
必需
奖品包的列表。
示例[ "[getdevelopertournamentdetailsresponse_prizebundle](#getdevelopertournamentdetailsresponse_prizebundle)" ]
< GetDeveloperTournamentDetailsResponse_PrizeBundle > 数组
scoreType
必需
是保存单个分数还是累积提交的分数。
示例"individual"
字符串
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
title
必需
竞赛标题。
示例"寻宝"
字符串
tournamentId
必需
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串
winType
必需
指示将最高分还是最低分视为最佳得分。
示例"highest"
字符串

GetDeveloperTournamentDetailsResponse_PrizeBundle

名称 描述 架构
description
可选
奖品包描述。
示例"这个宝箱里面的宝物比银色宝箱里面的更好!"
字符串
imageUrl
可选
奖品包图标。
示例"https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png"
字符串
prizeIds
必需
作为此包的一部分颁发的奖品 ID 列表。
示例"[ \"1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2\", \"979e4402-bd33-45ef-add9-2b8fb812d912\" ]"
< string > 数组
rankFrom
必需
将赢得此奖品包的最高排名。
示例2
整数 (int32)
rankTo
必需
将赢得此奖品包的最低排名。
示例4
整数 (int32)
title
必需
奖品包标题。
示例"金色奖励宝箱"
字符串

GetDeveloperTournamentListResponse

名称 描述 架构
tournaments
可选
竞赛的列表。 < GetTournamentListResponse_Tournament > 数组

GetPrizeDetailsResponse

名称 描述 架构
dateCreated
必需
创建奖品的日期。
示例1505890800000
整数 (int64)
dateExpired
可选
奖品过期的日期。
示例1506322800000
整数 (int64)
description
可选
奖品描述。
示例"隐藏的宝藏。真金白银。"
字符串
imageUrl
可选
奖品图标。
示例"https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
字符串
prizeId
必需
奖品 ID。
示例"1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2"
字符串
prizeInfoType
必需
描述 prizeInfo 中包含的内容
"VENDOR" | "AMAZON_PHYSICAL"
字符串
title
必需
奖品标题。
示例"黄金盔甲"
字符串

EnterTournamentRequest

名称 描述 架构
accessKey
可选
在进入时使用的访问密钥。
示例"BCDF"
字符串
playerAttributes
可选
确定玩家是否能进入的玩家属性。
示例{ "status": "vip", "skill": 1, "isActive": true }
< string, string > 映射

EnterTournamentResponse

名称 描述 架构
attemptsRemaining
必需
玩家可以重新进入对战的次数。
示例2
整数 (int32)
matchId
必需
玩家进入的对战的 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
metadata
可选
竞赛元数据在创建竞赛时传递。
示例"eyJiaXJkQ29sb3IiOiJyZWQiLCAiY2FjdGkiOiAicmFuZG9tIn0="
字符串
tournamentId
必需
竞赛的 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

GetMatchListResponse

名称 描述 架构
matches
可选
来自开发人员竞赛的对战的列表。 < GetMatchListResponse_Match > 数组
playerMatches
可选
来自玩家竞赛的对战的列表。 < GetMatchListResponse_PlayerGeneratedMatch > 数组

GetMatchListResponse_Match

名称 描述 架构
attemptsRemaining
可选
当玩家已进入对战时的剩余尝试次数。
示例2
整数 (int32)
canEnter
必需
指示玩家是否符合进入竞赛的条件:玩家满足竞赛要求,还有空位,并且竞赛处于活动状态。
示例true
布尔值
dateEnd
必需
竞赛结束日期。
示例1506322800000
整数 (int64)
dateStart
必需
竞赛开始日期。
示例1505335200000
整数 (int64)
imageUrl
可选
竞赛的图标
示例"https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
字符串
matchId
必需
对战 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
matchesPerPlayer
必需
每个玩家允许的最大对战数。
示例100
整数 (int32)
playerAttemptsPerMatch
必需
每个玩家每次对战允许的最大尝试次数。
示例3
整数 (int32)
playersPerMatch
必需
一个对战中允许参与的最大玩家数。
示例1000
整数 (int32)
prizeBundles
必需
奖品包的列表。
示例[ "[getmatchlistresponse_prizebundle](#getmatchlistresponse_prizebundle)" ]
< GetMatchListResponse_PrizeBundle > 数组
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
title
必需
竞赛标题。
示例"寻宝"
字符串
tournamentId
必需
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

GetMatchListResponse_PlayerGeneratedMatch

名称 描述 架构
attemptsRemaining
可选
当玩家已进入对战时的剩余尝试次数。
示例2
整数 (int32)
creatorPlayerName
必需
创建玩家竞赛的玩家的 PlayerId。
示例"Bee"
字符串
dateEnd
必需
竞赛结束日期。
示例1506322800000
整数 (int64)
dateStart
必需
竞赛开始日期。
示例1505335200000
整数 (int64)
imageUrl
可选
竞赛的图标
示例"https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
字符串
matchId
必需
对战 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
playerAttemptsPerMatch
必需
每个玩家每次对战允许的最大尝试次数。
示例3
整数 (int32)
playersPerMatch
必需
一个对战中允许参与的最大玩家数。
示例1000
整数 (int32)
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
title
必需
竞赛标题。
示例"寻宝"
字符串
tournamentId
必需
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

GetMatchListResponse_PrizeBundle

名称 描述 架构
description
可选
奖品包描述。
示例"这个宝箱里面的宝物比银色宝箱里面的更好!"
字符串
imageUrl
可选
奖品包图标。
示例"https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png"
字符串
prizeIds
必需
作为此包的一部分颁发的奖品 ID 列表。
示例[ "1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2", "979e4402-bd33-45ef-add9-2b8fb812d912" ]
< string > 数组
rankFrom
必需
将赢得此奖品包的最高排名。
示例2
整数 (int32)
rankTo
必需
将赢得此奖品包的最低排名。
示例4
整数 (int32)
title
必需
奖品包标题。
示例"金色奖励宝箱"
字符串

GetMatchDetailsResponse

名称 描述 架构
attemptsRemaining
可选
当玩家已进入对战时的剩余尝试次数。
示例2
整数 (int32)
awardedPrizes
可选
颁发给玩家的奖品。 < GetMatchDetailsResponse_AwardedPrize > 数组
canEnter
必需
指示玩家是否符合进入竞赛的条件:玩家满足竞赛要求,还有空位,并且竞赛处于活动状态。
示例true
布尔值
lastScore
可选
玩家上次尝试的得分。
示例20
整数 (int32)
lastScoreDate
可选
提交上一个得分的日期。
示例1506322800000
整数 (int64)
matchId
必需
对战 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
score
可选
玩家在所有尝试中的得分。
示例26
整数 (int32)
scoreDate
可选
提交得分的日期。
示例1505335200000
整数 (int64)
tournamentDetails
必需
竞赛详情。 GetMatchDetailsResponse_TournamentDetails

GetMatchDetailsResponse_AwardedPrize

名称 描述 架构
awardedPrizeId
必需
所颁发奖品的 ID。
示例"f284c1ea-70a7-4670-b43d-874402acae5f"
字符串
status
必需
描述所获奖品的状态。
示例"未领取"
枚举:
未领取
已领取
已兑现
prizeTitle
必需
奖品标题。
示例"黄金战斧"
字符串

GetMatchDetailsResponse_PrizeBundle

名称 描述 架构
description
可选
奖品包描述。
示例"这个宝箱里面的宝物比银色宝箱里面的更好!"
字符串
imageUrl
可选
奖品包图标。
示例"https://images-na.ssl-images-amazon.com/images/I/51J6cQ63OJL._AC_US218_.png"
字符串
prizeIds
必需
作为此包的一部分颁发的奖品 ID 列表。
示例[ "1a3ea1ef-0e8f-4cfc-91fc-bd3fd70a6ab2", "979e4402-bd33-45ef-add9-2b8fb812d912" ]
< string > 数组
rankFrom
必需
将赢得此奖品包的排名上限。
示例2
整数 (int32)
rankTo
必需
将赢得此奖品包的排名下限。
示例4
整数 (int32)
title
必需
奖品包标题。
示例"金色奖励宝箱"
字符串

GetMatchDetailsResponse_TournamentDetails

名称 描述 架构
accessKey
可选
进入玩家竞赛时使用的访问密钥。
示例"BCDF"
字符串
creatorPlayerName
可选
创建玩家竞赛的玩家的名称。
示例"Bee"
字符串
creatorExternalPlayerId
可选
创建玩家竞赛的玩家的 GameOn playerId。
示例"445f49ac-b920-45b5-ae3b-4255cb9f5388"
字符串
dateEnd
必需
竞赛结束日期。
示例1506322800000
整数 (int64)
dateStart
必需
竞赛开始日期。
示例1505335200000
整数 (int64)
description
可选
竞赛的描述。
示例"这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。"
字符串
imageUrl
可选
竞赛的图标。
示例"https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
字符串
playerAttemptsPerMatch
必需
每个玩家每次对战允许的最大尝试次数。
示例3
整数 (int32)
playersPerMatch
必需
一个对战中允许参与的最大玩家数。
示例1000
整数 (int32)
prizeBundles
可选
奖品包的列表。 < GetMatchDetailsResponse_PrizeBundle > 数组
title
必需
竞赛标题。
示例"大人物"
字符串
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
tournamentId
必需
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

EnterMatchRequest

名称 描述 架构
playerAttributes
可选
确定玩家是否能进入的玩家属性。
示例{ "status": "vip", "skill": 1, "isActive": true }
< string, string > 映射

EnterMatchResponse

名称 描述 架构
attemptsRemaining
必需
玩家可以重新进入对战的次数。
示例2
整数 (int32)
matchId
必需
玩家重新进入的对战的 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
metadata
可选
竞赛元数据在创建竞赛时传递。
示例"eyJiaXJkQ29sb3IiOiJyZWQiLCAiY2FjdGkiOiAicmFuZG9tIn0="
字符串
tournamentId
必需
竞赛的 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

SubmitScoreRequest

名称 描述 架构
score
必需
玩家在尝试中得到的分数。
示例50
整数 (int32)

SubmitScoreResponse

名称 描述 架构
score
必需
将用于排行榜的分数。
示例50
整数 (int32)

AddAttemptsRequest

名称 描述 架构
addAttempts
必需
将为玩家添加的尝试次数。
示例1
整数 (int32)

AddAttemptsResponse

名称 描述 架构
attemptsRemaining
必需
添加之后剩余的尝试次数。
示例12
整数 (int32)

GetMatchLeaderboardResponse

名称 描述 架构
currentPlayer
可选
当前玩家。 GetMatchLeaderboardResponse_LeaderboardItem
leaderboard
可选
排行榜项目的列表。 < GetMatchLeaderboardResponse_LeaderboardItem > 数组
neighbors
可选
当前玩家的周围玩家。 < GetMatchLeaderboardResponse_LeaderboardItem > 数组
next
可选
下一页结果的 Url。您可以原样使用以请求下一页。当此项不可用时,它指示结果的末尾。 字符串

GetMatchLeaderboardResponse_LeaderboardItem

名称 描述 架构
externalPlayerId
必需
用于标识这个独特玩家的 GameOn 玩家 ID。
示例"445f49ac-b920-45b5-ae3b-4255cb9f5388"
字符串
isCurrentPlayer
optional
指示此排行榜项目是否表示当前玩家的名次。
示例true
布尔值
playerName
必需
玩家名称。
示例"foo1990"
字符串
rank
必需
玩家在对战中的排名。
示例3
整数 (int32)
score
必需
玩家在所有尝试中的得分。
示例26
整数 (int32)

ClaimPrizeListRequest

名称 描述 架构
awardedPrizeIds
必需
所颁发奖品的 ID。
示例[ "78793fda-9f1b-11e7-abc4-cec278b6b50a", "787943fe-9f1b-11e7-abc4-cec278b6b50a" ]
< string > 数组

ClaimPrizeListResponse

名称 描述 架构
externalPlayerId
可选
用于标识这个独特玩家的 GameOn 玩家 ID。
示例"445f49ac-b920-45b5-ae3b-4255cb9f5388"
字符串
failedAwardedPrizeIds
可选
无法标记为已领取的所颁发奖品 ID。
示例[ "787943fe-9f1b-11e7-abc4-cec278b6b50a" ]
< string > 数组
prizes
可选
标记为已领取的已颁发奖品。 < ClaimPrizeListResponse_ClaimedPrize > 数组

ClaimPrizeListResponse_ClaimedPrize

名称 描述 架构
matchId
必需
已颁发奖品的对战的 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
encryptedPrizeInfo
必需
获奖时用于领取奖品的信息,将针对调用方进行加密。
示例"B004S2UAKG"
字符串
prizeInfoType
必需
描述 prizeInfo 中包含的内容
"VENDOR" | "AMAZON_PHYSICAL"
字符串
status
必需
描述所颁发奖品的状态,在第一次被调用时将返回已领取,后续的领取调用将产生重复领取响应。
"已领取" | "重复领取"
字符串

FulfillPrizeListRequest

名称 描述 架构
awardedPrizeIds
必需
所颁发奖品的 ID。
示例[ "78793fda-9f1b-11e7-abc4-cec278b6b50a", "787943fe-9f1b-11e7-abc4-cec278b6b50a" ]
< string > 数组

FulfillPrizeListResponse

名称 描述 架构
externalPlayerId
可选
用于标识这个独特玩家的 GameOn 玩家 ID。
示例"445f49ac-b920-45b5-ae3b-4255cb9f5388"
字符串
failedAwardedPrizeIds
可选
无法标记为已兑现的所颁发奖品 ID。
示例[ "787943fe-9f1b-11e7-abc4-cec278b6b50a" ]
< string > 数组
prizes
可选
标记为已兑现的已颁发奖品。 < FulfillPrizeListResponse_FulfilledPrize > 数组

FulfillPrizeListResponse_FulfilledPrize

名称 描述 架构
matchId
必需
已颁发奖品的对战的 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
encryptedPrizeInfo
必需
获奖时用于领取奖品的信息,将针对调用方进行加密。
示例"B004S2UAKG"
字符串
prizeInfoType
必需
描述 prizeInfo 中包含的内容
"VENDOR" | "AMAZON_PHYSICAL"
字符串
status
必需
描述所颁发奖品的状态,所有调用都将导致已兑现响应。
"已兑现"
字符串

UpdatePlayerRequest

名称 描述 架构
devicePushNotificationToken
可选
与会话 ID 关联的设备的 APNS/FCM/GCM/ADM 推送通知令牌。
示例"392340e57e4a7c646326b1cf96931d97f22ab163f23b3d3605fc5698d3788xx9"
字符串
playerName
可选
玩家名称。
示例"hunkydory"
字符串

AddPlayerTournamentRequest

名称 描述 架构
dateEnd
必需
竞赛结束日期。
示例1506322800000
整数 (int64)
dateStart
必需
竞赛开始日期。
示例1505335200000
整数 (int64)
description
可选
竞赛的描述。
示例"这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。"
字符串
generateAccessKey
可选
是否要为玩家竞赛生成访问密钥。默认值为 false。
示例true
布尔值
metadata
可选
竞赛的元数据
示例"stage=green"
字符串
playerAttemptsPerMatch
必需
在玩家竞赛中,每位玩家允许的最大尝试次数。
示例3
整数 (int32)
playersPerMatch
必需
允许参与玩家竞赛的最大玩家数。
示例1000
整数 (int32)
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
title
必需
竞赛标题。
示例"寻宝"
字符串

AddPlayerTournamentResponse

名称 描述 架构
accessKey
可选
访问密钥
示例"BCDF"
字符串
matchId
必需
对战 ID
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
scoreType
必需
指示是保存单个分数还是累积提交的分数。默认值为“Individual”。
示例"INDIVIDUAL"
字符串
tournamentId
必需
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

GetPlayerTournamentListResponse

名称 描述 架构
tournaments
可选
玩家竞赛的列表。 < GetTournamentListResponse_Tournament > 数组

GetPlayerTournamentDetailsResponse

名称 描述 架构
accessKey
可选
进入玩家竞赛时使用的访问密钥。
示例"BCDF"
字符串
creatorPlayerName
必需
创建玩家竞赛的玩家的 PlayerName。
示例"Bee"
字符串
creatorExternalPlayerId
可选
创建玩家竞赛的玩家的 GameOn playerId。
示例"445f49ac-b920-45b5-ae3b-4255cb9f5388"
字符串
dateEnd
必需
竞赛结束日期。
示例1506322800000
整数 (int64)
dateStart
必需
竞赛开始日期。
示例1505335200000
整数 (int64)
description
可选
竞赛的描述。
示例"这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。"
字符串
hasAccessKey
必需
确定竞赛是否需要访问密钥才能进入的值。
示例false
布尔值
playerAttemptsPerMatch
必需
每个玩家每次对战允许的最大尝试次数。
示例3
整数 (int32)
playersPerMatch
必需
一个对战中允许参与的最大玩家数。
示例10
整数 (int32)
scoreType
必需
是保存单个分数还是累积提交的分数。
示例"individual"
字符串
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
title
必需
竞赛标题。
示例"寻宝"
字符串
tournamentId
必需
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串
winType
必需
指示将最高分还是最低分视为最佳得分。
示例"highest"
字符串

EnterPlayerTournamentRequest

名称 描述 架构
accessKey
可选
在进入时使用的访问密钥。
示例"BCDF"
字符串

EnterPlayerTournamentResponse

名称 描述 架构
attemptsRemaining
必需
玩家可以重新进入对战的次数。
示例2
整数 (int32)
matchId
必需
玩家进入的对战的 ID。
示例"e7bcece8-9f1b-11e7-abc4-cec278b6b50a"
字符串
metadata
可选
竞赛元数据在创建竞赛时传递。
示例"eyJiaXJkQ29sb3IiOiJyZWQiLCAiY2FjdGkiOiAicmFuZG9tIn0="
字符串
tournamentId
必需
竞赛的 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串

UpdatePlayerTournamentRequest

名称 描述 架构
description
可选
竞赛的描述。
示例"这无关于雇佣最强的军队或者赢得 PvP 战斗,而是战胜所有困难。"
字符串
generateAccessKey
可选
是否创建新的访问密钥。默认值为 false。
示例true
布尔值
metadata
可选
竞赛元数据。
示例"eyJiaXJkQ29sb3IiOiJyZWQiLCAiY2FjdGkiOiAicmFuZG9tIn0="
字符串
subtitle
可选
竞赛子标题。
示例"海盗的战利品"
字符串
title
可选
竞赛标题。新标题不能为空。
示例"寻宝"
字符串

UpdatePlayerTournamentResponse

名称 描述 架构
accessKey
可选
访问密钥
示例"BCDF"
字符串
tournamentId
可选
竞赛 ID。
示例"00230795-b4bd-40ef-b181-720ee0ec3d80"
字符串