响应数据包格式规范


正确输出格式

json**输出格式:**

API调用时如果传递format参数为json(大小写不敏感),则正常响应包符合如下规范的json字符串:

  • http响应头中的Content-Type指定为application/json, charset=utf-8。
  • 字符串编码格式是UTF-8,字符串内容是XML输出数据所对应的PHP数组的标准JSON字符串。

HEAD中的信息:

  • 当前版本会返回如下自定义Header字段,请务必兼容大小写问题:
字段 类型 必须 描述
resultCode 或 Resultcode int Yes 详见错误代码表
quotaCost 或 Quotacost int Yes 本次请求消耗的配额
quotaRemain 或 Quotaremain int Yes 当前推广账户剩余的配额

错误输出格式

Open API

调用失败时平台返回的错误信息包含在failures节点,每一条失败信息包含如下元素:

字段 类型 必须 描述
code int Yes 错误代码,请参考后面的错误码定义一节
message String Yes 错误信息
description String Yes 定位错误位置,采用ognl方式描述,可以定位到哪个输入参数引发错误
  • description 采用ognl的方式来描述产生错误的位置。根据description的这种层级描述,可唯一的定位到该error产生的具体位置,方便用户进行错误定位。
  • 如果一次请求中传入批量数据,并且不止一个数据出现错误,则failures元素为数组,每个元素表示一种出错原因。

错误格式示例

{
  "affectedRecords": [],
  "failures": [
    {
      "id": 1306991942,
      "code": 30503,
      "message": "推广计划每日预算格式不正确",
      "description": "_param.budget"
    },
    {
      "id": 1306991943,
      "code": 30503,
      "message": "推广计划每日预算格式不正确",
      "description": "_param.budget"
    }
  ]
}

results matching ""

    No results matching ""