跳到主要内容

文件schema获取


请求地址​

https://api.e.qq.com/v1.1/file_schema/get


请求方法​

GET


所属权限​

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或 DataNexus 账号 id
scenesenum[]Y应用场景id，[枚举详情]

请求体示例​

curl -G 'https://api.e.qq.com/v1.1/file_schema/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'scenes=["DMP"]'

应答体结构​

名称类型描述
scenesenum[]文件场景列表。数组最小长度 1，最大长度 50；枚举列表：{ DMP, TRANSFORMATION_ATTRIBUTION, PK_AM }
schemastruct[]场景组合后的文件 Schema 定义, 这决定了您的在该场景下接入的文件的文件内容格式应该按照什么格式来上传。您需要严格遵照定义来创建文件内容，否则系统可能无法识别
namestring文件 Schema 列中文名称
col_keyenum文件 Schema 列的 Key 值，该字段标明了文件列对应的内容，如果该字段为空，则需要从 options 选项中选择
indexinteger列的顺序（从 1 开始), 表明列对应内容在一行中的顺序，创建文件时可以根据文件内容实际顺序调整
requiredboolean是否必须（如必须，则在创建文件的 schema 定义中必须要包含该列且文件内容需要含有此项内容），true 或 false
optionsstruct[]Schema 列选项列表，当 col_key 为空时返回，表示这一列可以有多种数据类型选择，您需要选择其中一种
namestring文件 Schema 列中文名称
col_keyenum文件 Schema 列的 Key 值，该字段标明了文件列对应的内容

请求体示例​

{
  "code": 0,
  "message": "",
  "message_cn": "",
  "data": {
    "scenes": ["DMP"],
    "schema": [
      {
        "index": 1,
        "name": "用户 id",
        "options": [
          {
            "col_key": "USERID_QQ",
            "index": 1,
            "name": "QQ 号",
            "required": false
          },
          {
            "col_key": "USERID_MD5_QQ",
            "index": 1,
            "name": "QQ 号 - MD5",
            "required": false
          },
          {
            "col_key": "USERID_TEL",
            "index": 1,
            "name": "手机号",
            "required": false
          },
          {
            "col_key": "USERID_MD5_MOBILE_PHONE",
            "index": 1,
            "name": "手机号 - MD5",
            "required": false
          },
          {
            "col_key": "USERID_SHA256_MOBILE_PHONE",
            "index": 1,
            "name": "手机号 - SHA256",
            "required": false
          },
          {
            "col_key": "USERID_IFA",
            "index": 1,
            "name": "IDFA",
            "required": false
          },
          {
            "col_key": "USERID_MD5_IFA",
            "index": 1,
            "name": "IDFA - MD5",
            "required": false
          },
          {
            "col_key": "USERID_MD5_SHA256_IDFA",
            "index": 1,
            "name": "IDFA - MD5_SHA256",
            "required": false
          },
          {
            "col_key": "USERID_IMEI",
            "index": 1,
            "name": "IMEI",
            "required": false
          },
          {
            "col_key": "USERID_MD5_IMEI",
            "index": 1,
            "name": "IMEI - MD5",
            "required": false
          },
          {
            "col_key": "USERID_MD5_SHA256_IMEI",
            "index": 1,
            "name": "IMEI - MD5_SHA256",
            "required": false
          },
          {
            "col_key": "USERID_GDT_OPENID",
            "index": 1,
            "name": "广点通 OpenID",
            "required": false
          },
          {
            "col_key": "USERID_OAID",
            "index": 1,
            "name": "OAID",
            "required": false
          },
          {
            "col_key": "USERID_MD5_OAID",
            "index": 1,
            "name": "OAID-MD5",
            "required": false
          },
          {
            "col_key": "USERID_MD5_SHA256_OAID",
            "index": 1,
            "name": "OAID - MD5_SHA256",
            "required": false
          },
          {
            "col_key": "USERID_WX_OPENID",
            "index": 1,
            "name": "微信 OpenID",
            "required": false
          },
          {
            "col_key": "USERID_WX_UNIONID",
            "index": 1,
            "name": "微信 UnionID",
            "required": false
          },
          {
            "col_key": "USERID_CAID",
            "index": 1,
            "name": "CAID",
            "required": false
          }
        ],
        "required": true
      },
      {
        "col_key": "USERPROPERTY_ACTIONTYPE",
        "index": 2,
        "name": "行为类型",
        "required": false
      },
      {
        "col_key": "USERPROPERTY_ACTIONPARAM",
        "index": 3,
        "name": "行为参数",
        "required": false
      },
      {
        "col_key": "USERPROPERTY_ACTIONTIME",
        "index": 4,
        "name": "时间",
        "required": false
      },
      {
        "col_key": "USERPROPERTY_ACTIONCHANNEL",
        "index": 5,
        "name": "来源渠道",
        "required": false
      }
    ]
  }
}