跳到主要内容

文件上传


请求地址

https://api.e.qq.com/v1.1/data_nexus_file/add


请求方法

POST


所属权限

User Actions


请求参数

参数名描述
access_token授权令牌,完成 OAuth 2.0 授权后获得,参考开发者环境
timestamp当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳签名算法。MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59
nonce随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性

请求体类型

multipart/form-data


请求体参数

名称类型必填描述
account_idintegerY推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
file_namestringY文件名称。字段长度最小 1 字节,长度最大 30 字节
file_descstringY文件描述。字段长度最小 1 字节,长度最大 100 字节
filefileY上传文件,UTF-8 编码的 csv 文件,文件每一行内容需要符合您指定的 schema_define 所定义的内容,否则系统可能无法识别,不超过 500M
schema_definestruct[]Y文件 Schema 定义,您的 Schema 定义描述您的文件内容,系统会按照您的 Schema 来解析您的文件。您可以根据文件 Schema 获取接口来了解场景需要的内容字段,来制定您的文件内容和文件 Schema 定义
col_keyenumY文件 Schema 列的 Key 值,该字段反应了您文件中列对应的内容。Key 的选项取决于您选择的场景,您可以通过文件 Schema 获取接口来了解场景下需要的字段内容。枚举列表:{ USERID_QQ, USERID_MD5_QQ, USERID_TEL, USERID_MD5_MOBILE_PHONE, USERID_SHA256_MOBILE_PHONE, USERID_IFA, USERID_MD5_IFA, USERID_MD5_SHA256_IDFA, USERID_IMEI, USERID_MD5_IMEI, USERID_MD5_SHA256_IMEI, USERID_GDT_OPENID, USERID_OAID, USERID_MD5_OAID, USERID_MD5_SHA256_OAID, USERID_WX_OPENID, USERID_WX_UNIONID, USERID_CAID, USERPROPERTY_ACTIONTYPE, USERPROPERTY_ACTIONPARAM, USERPROPERTY_ACTIONTIME, USERPROPERTY_ACTIONCHANNEL }
indexintegerY列的顺序(从 1 开始), 表明列对应内容在一行中的顺序,创建文件时可以根据文件内容实际顺序调整
scenesstruct[]Y文件场景列表。数组最小长度 1,最大长度 50
sceneenumY应用场景;枚举列表:{ DMP, TRANSFORMATION_ATTRIBUTION, PK_AM }
auto_dispathchenumY是否开启自动分发,如打开开关,文件上传后会自动分发给所选应用场景。枚举列表:{ SWITCH_ON, SWITCH_OFF }
attach_infostruct文件分发附属信息
data_source_idintegerDataNexus 数据源 id,创建数据源时分配的唯一 id,如果是分发归因场景,则该参数必传。数据源本身需要开启归因场景的分发,并且配套文件关联的 id 类型
extra_infostruct文件附属信息
open_app_idstring微信 appid,当接入文件中的用户 id 内容为 'USERID_WX_OPENID','USERID_WX_UNIONID' 时需要该参数

请求体示例

curl 'https://api.e.qq.com/v1.1/data_nexus_file/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'file_name=测试文件' \
-d 'file_desc=测试文件' \
-d 'file=@/usr/local/my/file.csv' \
-d 'schema_define=[{"col_key":"USERID_WX_OPENID","index":1},{"col_key":"USERPROPERTY_ACTIONTYPE","index":2},{"col_key":"USERPROPERTY_ACTIONPARAM","index":3},{"col_key":"USERPROPERTY_ACTIONTIME","index":4},{"col_key":"USERPROPERTY_ACTIONCHANNEL","index":5}]' \
-d 'scenes=[{"scene":"transformation_attribution","auto_dispathch":0}]' \
-d 'extra_info={"open_app_id":"123456"}'

应答体结构

名称类型描述
file_idinteger文件 id

应答示例

{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"file_id": 1111111111
}
}