接口说明

请求URI

/audience/tag/v2/batchAdd

功能描述

企业将自有系统中的用户标签导入兔展平台,与兔展平台内的用户进行统一识别与匹配


注意事项

自建应用权限 用户→用户标签

旧地址 /api/integrate/audience/tag/batchAdd 即将废弃

身份类型在工作台中“用户”->“身份类型管理”中配置,需要在运营后台开通

调用方式

HTTPS 调用


POST https://integrate.rabbitpre.com/api/open/audience/tag/v2/batchAdd

请求数据类型

[ "application/json" ]

响应数据类型

[ "application/json" ]


请求头参数


属性

类型

必填

说明

X-Token

string

自建应用访问token


请求体参数


属性

类型

必填

说明

属性

类型

必填

说明

publicParams
Object用户标签导入配置
└─matchingTypestring精确匹配的应用ID
└─optTypestring导入方式(add: 新增, delete: 删除)
data
Array
用户标签。导入数据,每次最大500条
└─identitiesArray用户身份
     └─identityValue


     └─identityType


     └─platform


     └─appid


     └─mpid


     └─isWeChatEcosystem


└─operateTagsArray
运营标签
     └─tagName


     └─tagValues


     └─tagValueType




返回参数


属性

类型

说明

code
string
响应状态码。200-请求成功, 100100-appid、secret错误, 100200-token错误 ,100300-授权code错误
data
long
导入批次ID,用来查询导入结果,查询数据导入结果
errorCode
string
错误码
msg
string消息提示










接口地址 /api/integrate/audience/tag/v2/batchAdd

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 企业级接口,hearer必须携带X-Token

应用权限 用户->用户标签

注意事项 旧地址 /api/integrate/audience/tag/batchAdd 即将废弃

身份类型在工作台中"用户"->"身份类型管理"中配置,需要在运营后台开通

#请求参数


###请求头参数

参数名称参数说明请求类型是否必须数据类型schema
X-Token自建应用访问tokenheadertruestring

###公共参数

参数名称参数说明请求类型是否必须数据类型schema
publicParams导入配置bodytrueobject用户标签导入配置
data导入数据,每次最大500条bodytruearray用户标签

###用户标签导入配置

参数名称参数说明请求类型是否必须数据类型schema
matchingType匹配方式(1: 精准匹配, 2: 模糊匹配)bodyfalseint
optType导入方式(add: 新增, delete: 删除)bodytrueString

###用户标签

参数名称参数说明请求类型是否必须数据类型schema
identities用户身份 必填bodytruearray用户身份
operateTags运营标签bodyfalsearray运营标签

###用户身份 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identityValue | 用户身份值 | body | true | String | identityType | 用户身份类型,如openid(微信openid)、 unionid(微信openid)、phone(手机号)等 | body | true | String | platform | 平台类型,如公众号平台(gzh)、企业微信平台(workwechat)等| body | false | String | appid | 应用id,如公众号appid、小程序appid、自建应用id等 | body | false | String | mpid | 应用id,如公众号appid、小程序appid、自建应用id等 | body | false | String | isWeChatEcosystem | 是否微信生态(传了 appid mpid必须传此参数) | body | false | Boolean

###运营标签

参数名称参数说明请求类型是否必须数据类型schema
tagName标签名称bodyfalsestring
tagValues标签值bodyfalsestring[]
tagValueType标签类型bodyfalsestring默认"TEXT" 文本型; TEXT 文本型、NUMBER 数值型、BOOLEAN 布尔型、DATE 日期型

###请求示例

{
	"publicParams":{
		"isMatching":true,
		"matchingType":2,
		"optType":"add"
	},
	"data":[{
		"identities": [{
			"identityValue": "18888888888",
			"identityType": "phone"
		}],
		"operateTags":[{
			"tagName":"性别",
			"tagValues":["男"]
		}]
	}]
}

#响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data导入批次ID,用来查询导入结果,查询数据导入结果bodytruelong

###响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | |

###响应示例

{
    "code": "500126",
    "errorCode": "IMPORT_DATA_ERROR",
    "msg": "导入失败",
    "data": 15314513451345123
}


  • 无标签