开发指引
1 前置条件
完成 API 接入流程 文档阅读
2 接入开发
2.1 按接口清单调试接口
2.1.1 发起请求
请求环境
「DataNexus」数据上报 API 使用腾讯广告 Marketing API ，请求 URL 约定了使用的协议、域名、模块、版本、资源及动作，详细定义如下：
- 正式环境的域名为 https://api.e.qq.com/v1.3/
「DataNexus」 数据上报 API 通过域名区分环境，不通过 access_token 区分环境。如需使用 DataNexus 沙盒环境，请见「沙盒环境」描述。
HTTP Method
调用方应根据具体接口的要求设置 HTTP Method为 GET或POST。
HTTP Header
调用方应遵循 HTTP 协议设置相应的 Header，目前支持的Header有：Content-Type，用于指定数据格式。例如：
Content-Type: application/json
编码方式
Marketing API 支持的编码方式为 UTF-8。
请求通用参数
| 名称 | 类型 | 必填 | 限制 | 描述 |
|---|---|---|---|---|
| access_token | string | Y | 以Query Parameter方式在请求路径中传递 | 授权令牌，如上文描述可在 DataNexus 的 数据源 - 【查看密钥】获取 |
| timestamp | timestamp | Y | 以Query Parameter方式在请求路径中传递 | 当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。 MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳。MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59 |
| nonce | string | Y | 以Query Parameter方式在请求路径中传递 | 随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性 |
2.1.2 接收应答
HTTP 状态码
应答 Headers 中支持 HTTP 标准状态码，具体如下。
| 状态码 | 名称 | 描述 |
|---|---|---|
| 200 | 成功 | 当 Marketing API 请求被正确处理，且能按设计获取结果时，返回该状态码 |
| 3xx | 跳转 | 在特定情况下，Marketing API 可能会返回这些状态码，建议调用方按照HTTP标准来处理 |
| 4xx | 客户端错误 | 由客户端原因造成的错误 |
| 5xx | 服务器端错误 | Marketing API 或其下层服务发生内部错误 |
完整 状态码 。
响应头结构
X-TSA-Trace-Id：全局唯一id，通过该id可帮助技术支持快速定位问题，所以反馈问题时，请告知该id。 X-RateLimit-Remaining：当前应用对于当前请求接口的频次余量百分比，以“,”分割，顺序为“天,分钟”，可以此作为依据调整接口调用频率。
响应数据结构
响应数据中的结构定义如下表所示。
| 名称 | 类型 | 是否一定返回 | 限制 | 描述 |
|---|---|---|---|---|
| code | int64 | 是 | 等于0表示成功，不等于0表示错误，具体见返回码 | 返回码 |
| message | string | 是 | code不等于0时，message为错误描述 | 错误描述 |
| message_cn | string | 否 | code不等于0时，message_cn为错误情况的中文描述 | 中文错误描述 |
| data | object | 否 | 具体返回内容见各接口定义，只在code等于0时可能返回 | 资源数据 |
| errors | object | 否 | 只在code不等于0时可能返回 | 详细错误信息 |
2.2 分行业上报数据
以行为数据为例。
a. 行为类型（ActionType）
全量 行为枚举值 。
b. 行为参数（ActionParam）
- 行为参数是 "Key-Value" 类型；Key 只可以为 String 类型，只能包含字母、数字和下划线，必须以字母开头，长度不能超过255；Value可以是 String/Number/Boolean/JSONArray 其中一种，当 Value 为 JSONArray 时，它的元素只能为 String/Number/Boolean 中的一种，且所有元素必须是同一个类型。
- 广告主在上报时需要做自定义去重时可以在 ActionParam 中设置 outer_action_id 的 Key，value 为任意自定义如订单号的字符串作为自定义去重id，系统会根据该 id 进行去重。
- 当用户需要指定上报用户次日留存指标时，可以在上报 START_APP 行为时，在 ActionParam 中设置 length_of_stay 的 key，值为1，系统会指定该次上报为留存数据。
为优化广告投放效果，不同行业需上报特定的行为类型，且需携带对应行为的相关参数。详见 应用规范 。
FAQ
Q：使用「DataNexus」的密钥信息，接口返回“The API you requested is out of the scope of authority”，该如何处理？
A：该信息意为您的接口超出了授权范围。请按照本文的「查看接口权限集」描述自查权限集是否为”数据上报（User Actions）“。
Q：调用上报数据接口返回 code 码 51000
A：当开发者使用模拟器运行 App 通过 SDK 上报数据时，服务端会对上报的数据做检测，判断该数据为无效数据，接口返回 code 码 51000。
Q：上报到数据源的数据不归因
A：根据 日志查询 的页面提示，请在 资产分发 中确认该数据源是否已开启「转化归因」分发开关，开启后，上报的数据才会进入归因。
Q：非”数据上报（User Actions）“的接口获取 access_token 遇到问题，该如何处理？
A：可点击右下角的【反馈工单】寻求技术答疑支持。