管理 API 参考

GameOn 管理 API 参考

概览

该 API 支持开发者执行管理操作以管理他们的 Amazon GameOn 竞赛。可使用管理 API 密钥访问该 API。管理 API 旨在从管理员计算机运行;它没有像游戏 API 一样整合到游戏中。

方法 类型 路径 描述
添加奖品列表 POST /prizes 添加奖品列表以便在竞赛中使用。
添加要求列表 POST /requirements 添加用于竞赛的要求列表。
添加竞赛 POST /tournaments 添加竞赛供玩家加入并彼此开展竞争。
添加竞赛系列 POST /tournaments/{tournamentId}/series 根据现有竞赛创建一系列周期性竞赛。
关闭竞赛 POST /tournaments/{tournamentId}/close 手动提前关闭竞赛,确定赢家和奖品。
获取奖品列表 GET /prizes 获取奖品列表以便在竞赛中使用。
获取要求列表 GET /requirements 获取用于竞赛的要求列表。
注册玩家 POST /players/register 注册并创建带有标识符的新玩家令牌,使得玩家可以在多个设备上玩游戏。

版本信息

版本:v1

许可证信息

API 和这些材料是需要遵守我们的程序材料许可协议的程序材料。

URI 方案

  • 主机admin-api.amazongameon.com
  • 基本路径/v1
  • 方案HTTPS

路径

添加奖品列表

POST /prizes

描述

添加奖品列表以便在竞赛中使用。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 X-Api-Key
必需
管理 API 密钥。此项在您注册游戏时提供。 字符串
正文 addPrizeListRequest
必需
添加奖品列表所需的信息。 AddPrizeListRequest

响应

HTTP 代码 描述 架构
200 已成功添加至少一个奖品。 AddPrizeListResponse
400 无效的请求参数。 无内容
401 未授权。 无内容
403 禁止访问。无效的 API 密钥。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /prizes
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c
请求正文
{
  "prizes": [
    {
      "description": "这个宝箱里面的宝物比银色宝箱里面的更好。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "title": "金色宝箱",
      "prizeInfo": "GOLDEN_CHEST_0124"
    },
    {
      "description": "有了这个治疗药水包,您永远都会保持健康。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "title": "100 点生命值药水",
      "prizeInfo": "HEALTH_POTIONS_100"
    }
  ]
}

示例 HTTP 响应

响应 200
{
  "addedPrizes": [
    {
      "description": "这个宝箱里面的宝物比银色宝箱里面的更好。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "prizeId": "caf9a785-d6e8-4990-bf63-49f7d485a8d9",
      "title": "Golden Chest",
      "prizeInfoType": "VENDOR"
      "prizeInfo": "GOLDEN_CHEST_0124"
    },
    {
      "description": "有了这个治疗药水包,您永远都会保持健康。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "prizeId": "65d738d1-7e81-450e-97c0-79352284145a",
      "title": "100 点生命值药水",
      "prizeInfoType": "VENDOR",
      "prizeInfo": "HEALTH_POTIONS_100"
    }
  ]
}

添加要求列表

POST /requirements

描述

添加用于竞赛的要求列表。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 X-Api-Key
必需
管理 API 密钥。此项在您注册游戏时提供。 字符串
正文 requirements
必需
要添加到 Amazon GameOn Service 的要求列表。 AddRequirementListRequest

响应

HTTP 代码 描述 架构
200 已成功添加至少一个要求。 AddRequirementListResponse
400 无效的请求参数。 无内容
401 未授权。 无内容
403 禁止访问。无效的 API 密钥。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /prizes
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c
请求正文
{
  "requirements": [
    {
      "name": "玩家是 VIP",
      "description": "玩家具有 VIP 身份。",
      "type": "value",
      "key": "status",
      "value": "VIP"
    },
    {
      "name": "玩家是新手",
      "description": "玩家的技能在 0 到 10 之间。",
      "type": "range",
      "key": "League",
      "high": 10,
      "low": 0
    },
    {
      "name": "大西雅图地区",
      "description": "玩家的 GPS 坐标位于大西雅图地区",
      "type": "gps",
      "key": "gpsCoordinates",
      "permittedAreas": [
        {
          "gpsCoordinates": {
            "latitude": 47.60604,
            "longitude": -122.3328
          },
          "radius": 10,
          "radiusUnits": "KILOMETERS"
        }
      ]
    }
  ]
}

示例 HTTP 响应

响应 200
 {    "addedRequirements"  :         {    “name”  :    ” Player VIP”  ,    ” description”  :    ”游戏具有 VIP 状态。”,
      "type": "value",
      "key": "status",
      "value": "VIP",
      "requirementId": "f17abf7f-df0a-4b78-b28a-ddad30f9abf7"
    },
    {
      "name": "玩家是新手",
      "description": "玩家的技能在 0 到 10 之间。",
      "type": "range",
      "key": "League",
      "high": 10,
      "low": 0,
      "requirementId": "d00d6524-9aaf-4c57-aee3-ec5fe07946ce"
    },
    {
      "name": "大西雅图地区",
      "description": "玩家的 GPS 坐标位于大西雅图地区",
      "type": "gps",
      "key": "gpsCoordinates",
      "permittedAreas": [
        {
          "gpsCoordinates": {
            "latitude": 47.60604,
            "longitude": -122.3328
          },
          "radius": 10,
          "radiusUnits": "KILOMETERS"
        }
      ],
      "requirementId": "7ccbfba8-61b8-4abe-a8f1-59d54e324312",
    }
  ]
}

添加竞赛

POST /tournaments

描述

添加竞赛供玩家加入并彼此开展竞争。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 X-Api-Key
必需
管理 API 密钥。此项在您注册游戏时提供。 字符串
正文 addTournamentRequest
必需
添加竞赛时必须提供的信息。 AddTournamentRequest

响应

HTTP 代码 描述 架构
200 已成功添加竞赛。 AddTournamentResponse
400 无效的请求参数。 无内容
401 未授权。 无内容
403 禁止访问。无效的 API 密钥。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /tournaments
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c
请求正文
{
  "dateEnd": "1515119589135",
  "dateStart": "1515105189135",
  "description": "竞赛描述",
  "entryRequirements": [
    ["99208d38-cac9-45fe-8bfd-954ff7e3ae11"],
    ["35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de"]
  ],
  "visibilityRequirements": [
    ["99208d38-cac9-45fe-8bfd-954ff7e3ae11"],
    ["35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de"]
  ],
  "generateAccessKey": true,
  "imageUrl": "https://amazon.com/image.png",
  "matchesMax": 1,
  "matchesPerPlayer": 1,
  "metadata": "{\"stage\": 5, \"difficulty\": 9}",
  "playerAttemptsPerMatch": 100,
  "playersPerMatch": 500,
  "prizeBundles": [
    {
      "prizeIds": [
        "0031dc56-43e5-440f-9e05-ca747c28150e",
        "a6c0bc2a-d04f-449b-aa11-326072610592"
      ],
      "rankFrom": 1,
      "rankTo": 3,
      "title": "奖品标题",
      "description": "奖品描述",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
    },
    {
      "prizeIds": [ "a6c0bc2a-d04f-449b-aa11-326072610592" ],
      "rankFrom": 4,
      "rankTo": 10,
      "title": "奖品标题 #2",
      "description": "奖品描述 #2",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-2.png"
    }
  ],
  "scoreType": "INDIVIDUAL",
  "subtitle": "竞赛副标题",
  "title": "竞赛标题",
  "winType": "HIGHEST"
}

示例 HTTP 响应

响应 200
{
  "accessKey": "HDLD",
  "dateEnd": 1515119589135,
  "dateStart": 1515105189135,
  "description": "竞赛描述",
  "entryRequirements": [
    [ "99208d38-cac9-45fe-8bfd-954ff7e3ae11" ],
    [ "35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de" ]
  ],
  "visibilityRequirements": [
    [ "99208d38-cac9-45fe-8bfd-954ff7e3ae11" ],
    [ "35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de" ]
  ],
  "imageUrl": "https://amazon.com/image.png",
  "matchesMax": 1,
  "matchesPerPlayer": 1,
  "metadata": "{\"stage\": 5, \"difficulty\": 9}",
  "playerAttemptsPerMatch": 100,
  "playersPerMatch": 500,
  "prizeBundles": [
    {
      "prizeIds": [
        "0031dc56-43e5-440f-9e05-ca747c28150e",
        "a6c0bc2a-d04f-449b-aa11-326072610592"
      ],
      "rankFrom": 1,
      "rankTo": 3,
      "title": "奖品标题",
      "description": "奖品描述",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png"
    },
    {
      "prizeIds": [ "a6c0bc2a-d04f-449b-aa11-326072610592" ],
      "rankFrom": 4,
      "rankTo": 10,
      "title": "奖品标题 #2",
      "description": "奖品描述 #2",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-2.png"
    }
  ],
  "scoreType": "INDIVIDUAL",
  "subtitle": "竞赛副标题",
  "tournamentId": "1fd35e57-ad7a-49b9-8739-c6f64f55ae63",
  "title": "竞赛标题",
  "winType": "HIGHEST"
}

添加竞赛系列

POST /tournaments/{tournamentId}/series

描述

根据现有竞赛创建一系列周期性竞赛。

参数

参数

类型 名称 描述 架构
标头 x-api-key
可选
游戏 adminApi 密钥。 字符串
路径 tournamentId
可选
竞赛 ID 字符串
正文 addTournamentSeriesRequest
可选
AddTournamentSeriesRequest 的 JSON 表示形式 AddTournamentSeriesRequest

响应

HTTP 代码 描述 架构
200 已成功创建竞赛系列。 AddTournamentSeriesResponse
400 无效的请求参数。 无内容
403 禁止访问。无效的 API 密钥。 无内容
404 找不到竞赛 ID。 无内容

使用

  • application/json

生成

  • application/json

示例 HTTP 请求

请求
POST /tournaments/{tournamentId}/series
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c
请求正文
{
    "startTime": 1517518800000,
    "endTime": 1517864400000,
    "duration": 3600000,
    "cadence": 86400000
}

示例 HTTP 响应

响应 200
{
  "seriesId": "26a8a6f7-d090-4ceb-8ff7-88e5ada16a59",
  "tournamentIds": [
      "80e5a7d5-de85-4139-a5c3-0d41c399a145",
      "a899487f-0fc7-4b5a-ae5a-24460360a977",
      "48e28455-9a73-46f5-b87b-75f08d5abb65",
      "09a2bfe8-b8bc-4ea3-b11a-6cc3c85fef63",
      "5344e446-eaad-40d7-a9a4-845af83d9f9e"
  ]
}

关闭竞赛

POST /tournaments/{tournamentId}/close

描述

手动提前关闭竞赛,确定赢家和奖品。

参数

类型 名称 描述 架构
标头 X-Api-Key
必需
管理 API 密钥。此项在您注册游戏时提供。 字符串
路径 tournamentId
必需
所涉及的竞赛的标识符。 字符串

响应

HTTP 代码 描述 架构
202 已成功接受异步关闭竞赛的请求。 无内容
400 无效的请求参数。 无内容
401 未授权。 无内容
403 禁止访问。无效的 API 密钥。 无内容
404 未找到竞赛。 无内容
409 竞赛已关闭。 无内容

示例 HTTP 请求

请求
POST /tournaments/54d8fd8d-e349-49d8-902c-0558365ac22b/close
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c

获取奖品列表

GET /prizes

描述

获取已添加以在竞赛中使用的奖品列表。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 X-Api-Key
必需
管理 API 密钥。此项在您注册游戏时提供。 字符串

响应

HTTP 代码 描述 架构
200 已成功添加至少一个奖品。 GetPrizeListResponse
400 无效的请求参数。 无内容
403 禁止访问。无效的 API 密钥。 无内容

生成

  • application/json

示例 HTTP 请求

请求
GET /prizes
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c

示例 HTTP 响应

响应 200
{
  "prizes": [
    {
      "description": "有了这个治疗药水包,您永远都会保持健康。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "prizeId": "65d738d1-7e81-450e-97c0-79352284145a",
      "title": "100 点生命值药水",
      "prizeInfo": "HEALTH_POTIONS_100"
    },
    {
      "description": "这个宝箱里面的宝物比银色宝箱里面的更好。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "prizeId": "caf9a785-d6e8-4990-bf63-49f7d485a8d9",
      "title": "金色宝箱",
      "prizeInfo": "GOLDEN_CHEST_0124"
    }
  ]
}

获取要求列表

GET /requirements

描述

获取已添加用于竞赛的要求列表。

参数

类型 名称 描述 架构
标头 Content-Type
必需
application/json 字符串
标头 X-Api-Key
必需
管理 API 密钥。此项在您注册游戏时提供。 字符串

响应

HTTP 代码 描述 架构
200 已成功添加至少一个要求。 GetRequirementListResponse
400 无效的请求参数。 无内容
403 禁止访问。无效的 API 密钥。 无内容

生成

  • application/json

示例 HTTP 请求

请求
POST /prizes
Content-Type: application/json
X-Api-Key: d2d0b961-a5ce-45c7-9dbe-a63061ee229c

示例 HTTP 响应

响应 200
{
  "requirements": [
    {
      "key": "status",
      "name": "玩家是 VIP",
      "requirementId": "f17abf7f-df0a-4b78-b28a-ddad30f9abf7",
      "type": "value",
      "value": "VIP"
    },
    {
      "description": "玩家的技能在 0 到 10 之间。",
      "high": 10,
      "key": "League",
      "low": 0,
      "name": "玩家是新手",
      "requirementId": "d00d6524-9aaf-4c57-aee3-ec5fe07946ce",
      "type": "range"
    },
    {
      "name": "大西雅图地区",
      "description": "玩家的 GPS 坐标位于大西雅图地区",
      "type": "gps",
      "key": "gpsCoordinates",
      "permittedAreas": [
        {
          "gpsCoordinates": {
            "latitude": 47.60604,
            "longitude": -122.3328
          },
          "radius": 10,
          "radiusUnits": "KILOMETERS"
        }
      ],
      "requirementId": "7ccbfba8-61b8-4abe-a8f1-59d54e324312",
    }
  ]
}

注册玩家

POST /players/register

描述

与游戏 API 类似,注册玩家会将玩家 (及其设备) 添加到 Amazon GameOn Service,进行密钥交换,并返回 encrytedToken。不过,使用管理 API 版本,您还可以提供 vendorPlayerId 以允许多设备账户注册。有关更多信息,请参阅游戏 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="
}

定义

AddPrizeListRequest

名称 描述 架构
prizes
必需
要添加到 Amazon GameOn Service 的奖品列表。 < AddPrizeListRequest_Prize > 数组

AddPrizeListRequest_Prize

名称 描述 架构
description
必需
奖品的描述。
示例"这个宝箱里面的宝物比银色宝箱里面的更好。"
字符串
imageUrl
可选
奖品图像的 URL。
示例"https://amazon.com/image.png"
字符串
title
必需
奖品的标题。
示例"金色宝箱"
字符串
prizeInfo
必需
领取所获奖品时的信息。
示例"GOLD_CHEST_0123"
字符串

AddPrizeListResponse

名称 描述 架构
addedPrizes
必需
奖品列表已成功添加到 Amazon GameOn Service < AddPrizeListResponse_Prize > 数组
failedPrizes
可选
无法添加到 Amazon GameOn Service 的奖品列表。 < AddPrizeListResponse_Prize > 数组

AddPrizeListResponse_Prize

名称 描述 架构
description
必需
奖品的描述。
示例"这个宝箱里面的宝物比银色宝箱里面的更好。"
字符串
imageUrl
可选
奖品图像的 URL。
示例"https://amazon.com/image.png"
字符串
prizeId
可选
奖品标识符;如果未能添加奖品,则可能为空。
示例eed51953-530d-4516-92c0-401c0995c21d
字符串
title
必需
奖品的标题。
示例"金色宝箱"
字符串
prizeInfo
必需
领取所获奖品时的信息。
示例"GOLD_CHEST_0123"
字符串
prizeInfoType
必需
描述 prizeInfo 中包含的内容
"VENDOR" | "AMAZON_PHYSICAL"
字符串

AddRequirementListRequest

名称 描述 架构
requirements
必需
要添加到 Amazon GameOn Service 的要求列表,可以有多种类型。 < RequirementListType_Value |
RequirementListType_Range |
RequirementListType_GPS |
RequirementListType_Regex > 数组

RequirementListType_GPS

名称 描述 架构
name
必需
要求的名称。
示例"大西雅图地区"
字符串
description
可选
要求的描述。
示例"玩家的 GPS 坐标区域位于大西雅图地区"
字符串
type
必需
要求的类型。
示例"gps"
字符串
key
必需
要求的键。
示例"gpsCoordinates"
字符串
permittedAreas
必需
要求允许的区域。 < RequirementList_PermittedArea > 数组

RequirementListType_Range

名称 描述 架构
name
必需
要求的名称。
示例"玩家是新手"
字符串
description
可选
要求的描述。
示例"玩家的技能在 0 到 10 之间。"
字符串
type
必需
要求的类型。
示例"range"
字符串
high
必需
要求的范围上限 (含)。
示例10
数字 (双精度)
key
必需
要求的键。
示例"skill"
字符串
low
必需
要求的范围下限 (含)。
示例0
数字 (双精度)

RequirementListType_Regex

名称 描述 架构
name
必需
要求的名称。
示例"玩家数量"
字符串
description
可选
要求的描述。
示例"玩家名称只能包含数字。"
字符串
type
必需
要求的类型。
示例"regex"
字符串
key
必需
要求的键。
示例"name"
字符串
value
必需
要求的值。
示例:​"^[0-9]+$"
字符串

RequirementListType_Value

名称 描述 架构
name
必需
要求的名称。
示例"玩家是 VIP"
字符串
description
可选
要求的描述。
示例"玩家具有 VIP 身份。"
字符串
type
必需
要求的类型。
示例"value"
字符串
key
必需
要求的键。
示例"status"
字符串
value
必需
要求的值。
示例"VIP"
字符串

AddRequirementListResponse

名称 描述 架构
addedRequirements
必需
要求列表已成功添加到 Amazon GameOn Service < RequirementListResponse_Requirement > 数组
failedRequirements
可选
无法添加到 Amazon GameOn Service 的要求列表。 < RequirementListResponse_Requirement > 数组

AddTournamentRequest

名称 描述 架构
dateEnd
必需
竞赛结束时间的时间戳。
示例1513943202000
整数 (int64)
dateStart
必需
竞赛开始时间的时间戳。
示例1513899902000
整数 (int64)
description
必需
竞赛的描述。
示例"与最厉害的玩家对战,看看您是否能拔得头筹!"
字符串
entryRequirements
可选
用于确定玩家是否可以参加此竞赛的要求集,采用竞赛要求 ID 列表的形式。内部级别列表要求 ID 使用 AND 组合到一起,外部级别列表要求 ID 使用 OR 组合到一起。
示例[ ["99208d38-cac9-45fe-8bfd-954ff7e3ae11"], ["35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de"] ]
< < 字符串 > 数组 > 数组
visibilityRequirements
可选
用于确定玩家是否可以查看此竞赛的要求集,采用竞赛要求 ID 列表的形式。内部级别列表要求 ID 使用 AND 组合到一起,外部级别列表要求 ID 使用 OR 组合到一起。
示例[ ["99208d38-cac9-45fe-8bfd-954ff7e3ae11"], ["35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de"] ]
< < 字符串 > 数组 > 数组
generateAccessKey
可选
用于确定是否应生成访问密钥的标志。
示例false
布尔值
imageUrl
可选
竞赛图像的 URL。
示例"https://amazon.com/image.png"
字符串
matchesMax
必需
竞赛的最大对战数。上限为 1000。
示例100
整数 (int16)
matchesPerPlayer
必需
玩家可加入的对战的最大数量。
示例3
整数 (int16)
metadata
可选
要与竞赛关联的任意元数据。
示例"{\"stage\": 5, \"difficulty\": 9}"
字符串
playerAttemptsPerMatch
可选
每次对战玩家尝试的最大次数。
示例5
整数 (int32)
playersPerMatch
必需
每次对战的最大玩家数。
示例100
整数 (int32)
prizeBundles
必需
用于奖励获胜玩家的奖品包列表。 < AddTournament_PrizeBundle > 数组
scoreType
可选
指出计分模式是 INDIVIDUAL 还是 CUMULATIVEIndividual 将获取提交的最高得分,而 cumulative 将提交的所有得分求和。
示例"INDIVIDUAL"
字符串
subtitle
可选
竞赛的子标题。
示例"你是不是精英中的精英?"
字符串
title
必需
竞赛的标题。
示例"锦标赛!"
字符串
winType
可选
指示是最低分 (LOWEST) 胜出还是最高分 (HIGHEST) 胜出。
示例"HIGHEST"
字符串

AddTournamentResponse

名称 描述 架构
accessKey
可选
进入竞赛所需的访问密钥值。
示例"BRTC"
字符串
dateEnd
必需
竞赛结束时间的时间戳。
示例1513943202000
整数 (int64)
dateStart
必需
竞赛开始时间的时间戳。
示例1513899902000
整数 (int64)
description
必需
竞赛的标题。
示例"与最厉害的玩家对战,看看您是否能拔得头筹!"
字符串
entryRequirements
可选
用于确定玩家是否可以参加此竞赛的要求集,采用竞赛要求 ID 列表的形式。内部级别列表要求 ID 使用 AND 组合到一起,外部级别列表要求 ID 使用 OR 组合到一起。
示例[ ["99208d38-cac9-45fe-8bfd-954ff7e3ae11"], ["35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de"] ]
< < 字符串 > 数组 > 数组
visibilityRequirements
可选
用于确定玩家是否可以查看此竞赛的要求集,采用竞赛要求 ID 列表的形式。内部级别列表要求 ID 使用 AND 组合到一起,外部级别列表要求 ID 使用 OR 组合到一起。
示例[ ["99208d38-cac9-45fe-8bfd-954ff7e3ae11"], ["35831019-b1d7-461a-9af9-22aa4abff68f", "8e37e627-25de-42cf-83df-4bae958d33de"] ]
< < 字符串 > 数组 > 数组
imageUrl
可选
竞赛图像的 URL。
示例"https://amazon.com/image.png"
字符串
matchesMax
必需
竞赛的最大对战数。上限为 1000。
示例100
整数 (int16)
matchesPerPlayer
必需
玩家可加入的对战的最大数量。
示例3
整数 (int16)
metadata
可选
要与竞赛关联的任意元数据。
示例"{\"stage\": 5, \"difficulty\": 9}"
字符串
playerAttemptsPerMatch
可选
每次对战玩家尝试的最大次数。
示例5
整数 (int32)
playersPerMatch
必需
每次对战的最大玩家数。
示例100
整数 (int32)
prizeBundles
必需
用于奖励获胜玩家的奖品包列表。 < AddTournament_PrizeBundle > 数组
scoreType
可选
指出计分模式是 INDIVIDUAL 还是 CUMULATIVEIndividual 将获取提交的最高得分,而 cumulative 将提交的所有得分求和。
示例"INDIVIDUAL"
字符串
subtitle
可选
竞赛的子标题。
示例"你是不是精英中的精英?"
字符串
title
必需
竞赛的标题。
示例"锦标赛!"
字符串
winType
可选
指示是最低分 (LOWEST) 胜出还是最高分 (HIGHEST) 胜出。
示例"HIGHEST"
字符串

AddTournament_PrizeBundle

名称 描述 架构
description
可选
竞赛的描述。
示例"前 3 位玩家将胜出!"
字符串
imageUrl
可选
奖品包的图像 URL。
示例"https://amazon.com/image.png"
字符串
prizeIds
必需
在奖品包中颁发的奖品 ID 的列表。
示例[be2f5858-5d90-41aa-844b-8862591671ab, 2cbbf9e1-772a-4d01-8ba5-b336c79c8c30]
< string > 数组
rankFrom
必需
将奖品颁发给的最高排名 (含)。
示例1
整数 (int32)
rankTo
必需
将奖品颁发给的最低排名 (含)。
示例3
整数 (int32)
title
必需
奖品包的标题。
示例"金色宝箱"
字符串

AddTournamentSeriesRequest

名称 描述 架构
cadence
必需
竞赛系列频率,每小时一次/每天一次/每周一次/每月一次…
示例86400000
整数 (int64)
duration
必需
竞赛持续时间。
示例3600000
整数 (int64)
endTime
必需
竞赛系列的结束时间。
示例1516654800000
整数 (int64)
startTime
必需
竞赛系列的开始时间。
示例1516482000000
整数 (int64)

AddTournamentSeriesResponse

名称 描述 架构
seriesId
必需
预定竞赛的系列 ID。
示例"8a129f48-6dc6-4b27-9237-6729b1925db1"
字符串
tournamentIds
必需
系列中计划的竞赛的 ID 列表。
示例[ "string" ]
< string > 数组

GetPrizeListResponse

名称 描述 架构
prizes
必需
Amazon GameOn Service 中的奖品列表。 < GetPrizeListResponse_Prize > 数组

GetPrizeListResponse_Prize

名称 描述 架构
description
必需
奖品的描述。
示例"这个宝箱里面的宝物比银色宝箱里面的更好。"
字符串
imageUrl
可选
奖品图像的 URL。
示例"https://amazon.com/image.png"
字符串
prizeId
必需
奖品标识符。
示例eed51953-530d-4516-92c0-401c0995c21d
字符串
title
必需
奖品的标题。
示例"金色宝箱"
字符串
prizeInfoType
必需
描述 prizeInfo 中包含的内容
"VENDOR" | "AMAZON_PHYSICAL"
字符串

GetRequirementListResponse

名称 描述 架构
requirements
必需
已添加到 Amazon GameOn Service 的要求列表,可以有多种类型。 < RequirementListType_Value |
RequirementListType_Range |
RequirementListType_GPS |
RequirementListType_Regex > 数组

RegisterPlayerRequest

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

RegisterPlayerResponse

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

RequirementListResponse_Requirement

名称 描述 架构
name
必需
要求的名称。
示例"玩家是 VIP"
字符串
description
可选
要求的描述。
示例"玩家具有 VIP 身份。"
字符串
type
必需
要求的类型。
示例"[VALUE, RANGE, REGEX, GPS]"
字符串
key
必需
要求的键。
示例"status"
字符串
value
可选
如果为“Value”或“Regex”类型,则为要求的值。
示例"VIP"
字符串
high
可选
如果为“Range”类型,则为要求的范围上限 (含)。
示例10.5
数字 (双精度)
low
可选
如果为“Range”类型,则为要求的范围下限 (含)。
示例1
数字 (双精度)
permittedAreas
可选
如果为“GPS”类型,则为允许的区域。 < RequirementList_PermittedArea > 数组
requirementId
可选
要求标识符,如果未能添加要求,则可能为空。
示例"d6924d17-ff9f-4e86-9a8f-1bb6b8f4d057"
字符串

RequirementList_PermittedArea

名称 描述 架构
gpsCoordinates
必需
允许区域的 GPS 坐标。 RequirementList_GPSCoordinates
radius
必需
表示允许区域的 GPS 坐标周围半径。
示例5.0
数字 (双精度)
radiusUnits
必需
半径值的距离单位。
示例["KILOMETERS", "MILES"]
字符串

RequirementList_GPSCoordinates

名称 描述 架构
latitude
必需
以十进制度数表示的 GPS 经度值。北方的值为正,南方的值为负。
示例47.60604
数字 (双精度)
longitude
必需
以十进制度数表示的 GPS 纬度值。西方的值为正,东方的值为负。
示例-122.3328
数字 (双精度)