跳到主要内容
未列出页
此页面未列出。搜索引擎不会对其索引,只有拥有直接链接的用户才能访问。

Achievement

概要​

使用Achievement API ,可获取Mobage Developers 中设置的 Achievement 的对象。

在Achievement 中,有不指定Achievement ID 的获取方法和指定Achievement ID 的获取方法这 两种,请求方法各不相同。

Achievement 对象字段​

表示Achievement 的对象。

值说明类型补充
appId应用软件标识符string
id成就标识符string
name名称string
revealedDescriptionREVEALED 时的说明string
unlockedDescriptionUNLOCKED 时的说明string
type成就类别string
totalSteps完成所需的步骤数integer
stepFormat步骤的显示单位string
point获得分数integer
repeatable可反复旗标boolean
disclosed公开状态旗标boolean
defaultState初始状态值string
revealedIconUrlsREVEALED 时的图片 url 列表array
revealedIconUrls[].typeREVEALED 时的图片类型string
revealedIconUrls[].valueREVEALED 时的图片 urlstring
revealedIconUrls[].primaryREVEALED 时的图片优先等级boolean
unlockedIconUrlsUNLOCKED 时的图片 url 列表array
unlockedIconUrls[].typeUNLOCKED 时的图片类型string
unlockedIconUrls[].valueUNLOCKED 时的图片 urlstring
unlockedIconUrls[].primaryUNLOCKED 时的图片优先等级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 方法响应代码响应信息说明
GET200OK数据获取正常完成
GET400Bad Request请求数据不当
GET401UnauthorizedOAuth 验证失败
GET403Forbidden由于认证错误以外的原因导致不能访问的情况
GET405Method Not Allowed方法不允许
GET500Internal Server ErrorAPI 端的问题导致失败
GET503Service UnavailableAPI 端的暂时性错误

响应的数据结构​

作为API 响应的 payload ,反馈如下数据结构。

propertytitletypedescription
entryAchievement 资源的列表array
entry[].appId应用软件标识符string
entry[].id成就标识符string
entry[].name名称string
entry[].revealedDescriptionREVEALED 时的说明string
entry[].unlockedDescriptionUNLOCKED 时的说明string
entry[].type成就类别string
entry[].totalSteps达成所需的步骤数integer
entry[].stepFormat步骤的显示单位string
entry[].point获得分数integer
entry[].repeatable可反复旗标boolean
entry[].disclosed公开状态旗标boolean
entry[].defaultState初始状态值string
entry[].revealedIconUrlsREVEALED 时的图片 url 列表array
entry[].revealedIconUrls[].typeREVEALED 时的图片类型string
entry[].revealedIconUrls[].valueREVEALED 时的图片 urlstring
entry[].revealedIconUrls[].primaryREVEALED 时的图片优先等级boolean
entry[].unlockedIconUrls[]UNLOCKED 时的图片 url 列表array
entry[].unlockedIconUrls[].typeUNLOCKED 时的图片类型string
entry[].unlockedIconUrls[].valueUNLOCKED 时的图片 urlstring
entry[].unlockedIconUrls[].primaryUNLOCKED 时的图片优先等级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
}