通用参数
本节将为您介绍 Marketing API 中每个接口必备的请求通用参数以及响应数据结构。
特别注意,由于本章节已经介绍通用参数的用法,之后各接口的描述部分将不再赘述。
请求通用参数
请求中的通用参数详细定义如下表所示:
名称 | 类型 | 必填 | 限制 | 描述 |
access_token | string | 是 | 以Query Parameter方式在请求路径中传递。 | 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节。 |
timestamp | timestamp | 是 | 以Query Parameter方式在请求路径中传递。 | 当前的时间戳,单位为秒,允许客户端请求最大时间误差为300秒。
|
nonce | string | 是 | 以Query Parameter方式在请求路径中传递。 | 随机字串标识,不超过32个字符,由调用方自行生成,需保证全局唯一性。 |
响应数据结构
响应数据中的结构定义如下表所示:
名称 | 类型 | 是否一定返回 | 限制 | 描述 |
code | int64 | 是 | 等于0表示成功,不等于0表示错误,具体见文档附录【返回码定义】 | 返回码 |
message | string | 是 | code不等于0时,message为错误描述 | 错误描述 |
data | object | 否 | 具体返回内容见各接口定义,只在code等于0时可能返回 | 资源数据 |
errors | object | 否 | 只在code不等于0时可能返回 | 详细错误信息 |