OPEN API

OPEN API

简述

开发者可以通过开放接口实现特定功能需求。

查询画像

开发者可以通过用户id列表获取画像信息。

接口定义

  • 接口地址: $BaseUrl/query_tag
  • 请求方式: POST
  • content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称 类型 是否必须 默认值 描述
token String 接口访问凭据,获取方式请参考获取鉴权token

body参数说明

  • 入参字段定义
名称 类型 是否必须 默认值 描述
userIdList List<String> 用户id列表,size最大支持200
  • 入参示例
{
    "userIdList":[
      "xxxxxx--1","xxxxxx--2"
    ]
}

Response响应说明

  • 出参data字段定义
名称 类型 是否必须 默认值 描述
validTags List<Object> 有效标签返回列表
invalidTags List<Object> 无效标签
{
  "data": {
    "validTags": [            // 有效标签列表
      {
        "userId": "gtcid1",            // 用户id
        "tags": {            // 标签信息
          "custom": [            // 自定义标签code列表
            "自定义标签code1",
            "自定义标签code2"
          ],
          "gt": [            // 个推标签code列表
            "个推标签code1",
            "个推标签code1"
          ],
          "external": [            // 客户自有标签code列表(暂不支持)
            "客户自有标签code"
          ]
        }
      }
    ],
    "invalidTags": [            // 无效标签列表
      {
        "userId": "gtcid2",            // 用户id
        "msg": "用户暂无画像",            // 错误信息
        "code": 105            // 错误码
      }
    ]
  },
  "code": "0",            // 响应code码
  "msg": "成功"                // 响应信息
}

请求示例

curl $BaseUrl/query_tag \
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
     "userIdList":[
          "gtcid1","gtcid2"
     ]
 }'

数据导入

开发者可以通过接口导入数据。

接口定义

  • 接口地址: $BaseUrl/import
  • 请求方式: POST
  • content-type:application/json;charset=utf-8

Request请求说明

Header参数说明

名称 类型 是否必须 默认值 描述
token String 接口访问凭据,获取方式请参考获取鉴权token

body参数说明

  • 入参字段定义
名称 类型 是否必须 默认值 描述
appId String 应用id
templateId Long 模版id
dataList List<String> 导入数据列表,size最大支持200
  • 入参示例
{
    "templateId":3124,
    "dataList":[
      "xxxxxx--1","xxxxxx--2"
    ]
}

Response响应说明

{
    "msg": "成功",            // 响应信息
    "code": 0            // 响应code码
}

请求示例

curl $BaseUrl/import \
-X POST \
-H "Content-Type: application/json;charset=utf-8" \
-H "token: $token" \
-d '{
     "templateId":1324,
     "dataList":[
          "xxxxxx--1","xxxxxx--2"
     ]
 }'
在这篇文章中: 简述 查询画像 数据导入

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询