Achievement
概要
使用Achievement API ,可获取Mobage Developers 中设置的 Achievement 的对象。
在Achievement 中,有不指定Achievement ID 的获取方法和指定Achievement ID 的获取方法这 两种,请求方法各不相同。
Achievement 对象字段
表示Achievement 的对象。
| 值 | 说明 | 类型 | 补充 |
|---|---|---|---|
| appId | 应用软件标识符 | string | |
| id | 成就标识符 | string | |
| name | 名称 | string | |
| revealedDescription | REVEALED 时的说明 | string | |
| unlockedDescription | UNLOCKED 时的说明 | string | |
| type | 成就类别 | string | |
| totalSteps | 完成所需的步骤数 | integer | |
| stepFormat | 步骤的显示单位 | string | |
| point | 获得分数 | integer | |
| repeatable | 可反复旗标 | boolean | |
| disclosed | 公开状态旗标 | boolean | |
| defaultState | 初始状态值 | string | |
| revealedIconUrls | REVEALED 时的图片 url 列表 | array | |
| revealedIconUrls[].type | REVEALED 时的图片类型 | string | |
| revealedIconUrls[].value | REVEALED 时的图片 url | string | |
| revealedIconUrls[].primary | REVEALED 时的图片优先等级 | boolean | |
| unlockedIconUrls | UNLOCKED 时的图片 url 列表 | array | |
| unlockedIconUrls[].type | UNLOCKED 时的图片类型 | string | |
| unlockedIconUrls[].value | UNLOCKED 时的图片 url | string | |
| unlockedIconUrls[].primary | UNLOCKED 时的图片优先等级 | boolean | |
| published | 创建时间 | string | |
| updated | 更新时间 | string |
不指定Achievement 的获取方法
API 请求
HTTP 方法
Authorization Code Grant
- GET
- 在不指定Achievement 的状态下获取
Client Credentials Grant
- GET
- 在不指定Achievement 的状态下获取
端点
-
Sandbox 环境
https://sb-app.mobage.jp/social/api/restful/v2/achievements{/appId}{?format,startIndex,count,sortBy,sortOrder,fields}正式环境https://app.mobage.jp/social/api/restful/v2/achievements{/appId}{?format,startIndex,count,sortBy,sortOrder,fields}URI Template 参数
appId
在appId 参数中,指定下述任意一项的值。
值 说明 备注 @app 当前执行的应用软件 ID 必须 {appId} 个别分配的应用软件 ID 必须
查询参数
可指定下述查询参数。
format
可指定响应格式。只能指定json。
| 值 | 说明 | 备注 |
|---|---|---|
| json | "application/json; charset=utf8" | 任意、默认值 |
fields
可指定想要获取的个人简介属性信息。关于可指定的字段名,请参见 Achievement 对象字段。
要指定多个时,使用不带空格的逗号 (,) 分隔指定。
省略fields 参数时,获取下述全部属性信息。
为提高性能,请尽量只获取必要的属性。无任何指定时,可获取的默认字段如下。
["id", "type", "point"]
count
获取类集资源的响应时,可指定最多可获取的条目资源条数。在Selector中已指定@friends, @all时,可指定此项。
默认值为 50 条,最多可指定1000条。
startIndex
指定类集资源的开始值。省略时,自动指定 1 。例如,发送共100条好友信息页面,每页显示8条,想要获取第2页的信息时,count值指定 8,startIndex值指定9。
sortBy
指定sortBy 和 sortOrder 后,可对响应反馈的 Achievement 对象类集添加排序条件。可在sortBy 值中指定排序的关键字段。
可指定的 sortBy 值如下表所示。
| sortBy | 说明 |
|---|---|
| id | 成就标识符 |
| point | 获得分数 |
要指定sortBy ,需要已指定sortOrder。
sortOrder
指定sortBy 和 sortOrder 后,可对响应反馈的 Achievement 对象类集添加排序条件。可在sortOrder 值中指定排序时的升序和降序。
可指定的 sortOrder 值如下表所示。
| sortOrder | 说明 |
|---|---|
| ascending | 升序 |
| descending | 降序 |
要指定sortOrder ,需要已指定sortBy。
API 响应
响应代码
API 的响应代码为以下中的任一项。
| 请求 HTTP 方法 | 响应代码 | 响应信息 | 说明 |
|---|---|---|---|
| GET | 200 | OK | 数据获取正常完成 |
| GET | 400 | Bad Request | 请求数据不当 |
| GET | 401 | Unauthorized | OAuth 验证失败 |
| GET | 403 | Forbidden | 由于认证错误以外的原因导致不能访问的情况 |
| GET | 405 | Method Not Allowed | 方法不允许 |
| GET | 500 | Internal Server Error | API 端的问题导致失败 |
| GET | 503 | Service Unavailable | API 端的暂时性错误 |
响应的数据结构
作为API 响应的 payload ,反馈如下数据结构。
| property | title | type | description |
|---|---|---|---|
| entry | Achievement 资源的列表 | array | |
| entry[].appId | 应用软件标识符 | string | |
| entry[].id | 成就标识符 | string | |
| entry[].name | 名称 | string | |
| entry[].revealedDescription | REVEALED 时的说明 | string | |
| entry[].unlockedDescription | UNLOCKED 时的说明 | string | |
| entry[].type | 成就类别 | string | |
| entry[].totalSteps | 达成所需的步骤数 | integer | |
| entry[].stepFormat | 步骤的显示单位 | string | |
| entry[].point | 获得分数 | integer | |
| entry[].repeatable | 可反复旗标 | boolean | |
| entry[].disclosed | 公开状态旗标 | boolean | |
| entry[].defaultState | 初始状态值 | string | |
| entry[].revealedIconUrls | REVEALED 时的图片 url 列表 | array | |
| entry[].revealedIconUrls[].type | REVEALED 时的图片类型 | string | |
| entry[].revealedIconUrls[].value | REVEALED 时的图片 url | string | |
| entry[].revealedIconUrls[].primary | REVEALED 时的图片优先等级 | boolean | |
| entry[].unlockedIconUrls[] | UNLOCKED 时的图片 url 列表 | array | |
| entry[].unlockedIconUrls[].type | UNLOCKED 时的图片类型 | string | |
| entry[].unlockedIconUrls[].value | UNLOCKED 时的图片 url | string | |
| entry[].unlockedIconUrls[].primary | UNLOCKED 时的图片优先等级 | boolean | |
| entry[].published | 创建时间 | string | |
| entry[].updated | 更新时间 | string | |
| startIndex | 开始索引 | integer | |
| itemsPerPage | 每页的条目数 | integer | |
| totalResults | 总条目数 | integer | |
| sorted | 使用排序的旗标 | boolean | 使用排序时为 true 。(在Default 中按 id 排序,因此总是 true ) |
样例
已指定count 参数时
请求格式
GET /achievements/@app?count=5
Authorization: OAuth oauth_parameters
响应格式
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Pragma: no-cache
{
"entry": [
{ "id": 1, "type": "INCREMENTAL", "point": 1000 },
{ "id": 2, "type": "STANDARD", "point": 250 },
{ "id": 3, "type": "INCREMENTAL", "point": 370 },
{ "id": 4, "type": "INCREMENTAL", "point": 120 },
{ "id": 5, "type": "STANDARD", "point": 110 }
],
"startIndex": 1,
"itemsPerPage": 5,
"totalResults": 12
}
已指定 sortBy, sortOrder 时
请求格式
GET /achievements/@app?sortBy=point&sortOrder=descending&count=5
Authorization: OAuth oauth_parameters
响应格式
200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Pragma: no-cache
{
"entry": [
{ "id": 1, "type": "INCREMENTAL", "point": 1000 },
{ "id": 3, "type": "INCREMENTAL", "point": 370 },
{ "id": 2, "type": "STANDARD", "point": 250 },
{ "id": 4, "type": "INCREMENTAL", "point": 120 },
{ "id": 5, "type": "STANDARD", "point": 110 }
],
"startIndex": 1,
"itemsPerPage": 5,
"totalResults": 12
}