账号说明
信息
DataNeuxs 使用腾讯广告平台账号体系,分为广告主账号类型和非广告主账号类型,广告主账号接入完数据后可直接使用该账号登录 DataNexus、投放端、腾讯广告知数,进行相关操作;非广告主账号类型只供接入数据使用,可登录 DataNexus,并将数据分发给其他应用或授权给其他账号使用。
字段 | 释义 | 描述 |
---|---|---|
accountId | 客户账号id | 每个客户在腾讯广告平台上可能有一个或多个帐号,每个帐号对应唯一的 account_id,不区分环境 |
发起请求
请求环境
DataNexus 数据上报API使用腾讯广告 Marketing API ,请求URL约定了使用的协议、域名、模块、版本、资源及动作,详细定义如下:
信息
MarketingAPI 通过 access_token 区分环境,不通过域名区分环境。
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个字符,由调用方自行生成,需保证全局唯一性 |
进入<数据接入>-<工具箱>-<密钥信息>页面,查看 access_token 信息。
接收应答
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时可能返回 | 详细错误信息 |