跳到主要内容

请求相关的性能指南

在向API 服务器发送请求时,如果获取到不需要的数据,那么不仅会造成服务器资源的无谓使用,还会造成应用软件的响应延迟,影响用户的操作感。

此文档是尽可能避免无谓请求,提高应用软件速度所需的指南。

当判断来自合作伙伴的 API 请求次数异常,请求方式效率不佳时,可能会直接要求合作伙伴进行改善。另外,出于紧急需要,可能会转至维护模式或限制使用 API 。敬请知悉。

关于使用People API 的 @all, @friends 进行访问​

在Mobage 中,未规定好友数量的上限值,因此有的用户会有几万名好友。为了获取此类用户的好友列表, API 请求可能需要一定以上的执行时间,因此对随时需要好友列表的服务,请考虑以下几点。

  1. 使用用户登录等时机从平台传递来的 Access Token 或 Refresh Token,在后端访问 API
  2. API 的执行结果在24小时左右的话,允许保存在数据库中并重复使用保存的数据

API 访问每次最多可获取1000条。如果要获取此类用户的全部好友,请执行API 直至符合以下条件。

startIndex x itemsPerPage > totalResults

要多次访问 API 时,需要对平台传递来的 Access Token 和 Refresh Token,按每个 user 附带 expire 进行管理。

使用count, fields 参数,明确需要获取的数据​

对获取类 API ,可使用 count, fields 参数。例如,如果People API 中使用的字段只是 id, nickname, thumbnailUrl, profileUrl ,每页只显示 7 条,那么请进行以下指定。
 
fields
  id,nickname,thumbnailUrl,profileUrl
count
  7

进而,如果只想筛选已安装应用软件的用户,那么请使用 filter ,设置为只筛选 hasApp 为 true 的用户。

请求样例

GET /api/restful/v2/people/@me/@friends?count=7&fields=id,nickname,thumbnailUrl,profileUrl&format=json&filterBy=hasApp&filterOp=equals&filterValue=true

响应样例

200 OK

{
"entry" : [
{
"nickname" : "OFF SUZUKI",
"thumbnailUrl" : "http://sp.mbga.jp/img_u/10033/0.0.gif",
"id" : "mbga.jp:10033",
"profileUrl" : "http://sp.mbga.jp/_u?u=10033"
},
{
"nickname" : "E☆MARU",
"thumbnailUrl" : "http://sp.mbga.jp/img_u/10059/0.0.gif",
"id" : "mbga.jp:10059",
"profileUrl" : "http://sp.mbga.jp/_u?u=10059"
}
],
"startIndex" : 1,
"sorted" : false,
"itemsPerPage" : 7,
"updatedSince": false,
"totalResults" : 2,
"filtered": true
}

也就是说,在获取类 API 中,请求前应考虑:

  • 使用count ,只获取需要的条数
  • 使用fields ,只获取需要的属性
  • 使用filter ,只获取符合希望条件的数据

关于Message API 的执行间隔​

在Message API 中,对不同的执行间隔有限制,受到限制时,会反馈 503 Service Unavailable。
 
关于限制的指南汇总如下。

API访问模式限制
MessageAuthorization Code Grant从特定用户向某用户发送信息时,最多1分钟一次
MessageClient Credentials Grant从应用软件向特定用户发送信息时,最多4小时一次

关于Authorization Code Grant 时的限制,不宜向用户大量发送 Message 。

请根据应用软件的需求,适用必要的最低限度且有效的部分。另外如果技术可行,请在应用软件端对上述限制进行控制,不对API发送请求。

今后,上述限制可能根据API等的负载情况而有所更改,因此请采取灵活的应对措施。

使用了 Client Credentials Grant 的 Message API 的请求间隔宜为4小时,请设置适当的间隔 (1秒左右)发送请求。并列访问会造成在API 服务器端发生锁定,不能得到想要的速度,而且还可能对其他应用软件造成影响。

如上所述,在Message API 中,请:

  • 尽量少发不需要的 Message
  • 可能的话,为避免受到上述限制,应在应用软件端抑制对 API 的请求
  • 使用Client Credentials Grant 发送 Message 时,不要同时访问,请设置适当的间隔

关于API 响应的缓存​

TextData API 为了确认内容,在合作伙伴方不能带有内容缓存,但对于其他不具有实时性的GET 类 API 相应,允许进行 24 小时左右的缓存。

例如用户个人简介或 Avatar 图片的 URL 等,如果不影响执行应用软件,请积极设置缓存。

关于使用TextData API 获取数据​

合作伙伴在使用TextData API 时,预计会保存TextData#id 值在自己所有的数据库中。
此时,建议也同样保存TextData#status 值。同时在对 TextData API 进行 PUT 和 DELETE 时请更新您手上的 status 值。
此时的反馈值可能与您手上的 status 类似值不同,这是因为我公司客服判定为发帖违规,此时请显示“已被管理员删除”等语句。
 
另外,请尽量在 POST 时指定 ownerId, writerId 。请通过ownerId, writerId 的组合,设计最低必要限度的数据集。如果在GET 访问中不使用filterBy ,那么在数据量增多时会变得非常慢,敬请注意。

在TextData API 中,可使用id, updated 值进行排序,同时以writerId, ownerId 值为条件获取类集资源,但可直接指定多个 id 来获取指定的类集。这样可获得直观快速的响应,请积极使用。

请求样例

GET /api/restful/v2/textdata/@app/messages/@all/100;1107;1108?format=json

响应样例

200 OK

{
"entry" : [
{
"status" : "0",
"data" : "已得到无限1up",
"writerId" : "sb.mbga.jp:10001",
"published" : "2010-01-19T06:29:57",
"parentId" : "0",
"id" : "1107",
"updated" : "2010-01-19T06:29:57",
"groupName":"messages",
"ownerId" : "sb.mbga.jp:0"
},
{
"status" : "0",
"data" : "我想越过这个竿子!",
"writerId" : "sb.mbga.jp:12003",
"published" : "2010-01-19T06:30:03",
"parentId" : "0",
"id" : "1108",
"updated" : "2010-01-19T06:30:03",
"groupName":"messages",
"ownerId" : "sb.mbga.jp:0"
}
],
"startIndex" : 1,
"itemsPerPage" : 50,
"totalResults" : 2
}

更新履历​

  • 2015/02/05
    • 新建