标签画像API功能,需要在包含"标签画像"产品且版本大于v3.7.0+才支持该功能,旨在将标签画像的标签或者群组的数据创建为API,实现与应用层营销系统等的数据互通,补齐产品短板,增强产品能力。

标签画像API在获取数据时与新建API存在差异,当标签画像API创建完成后,支持复用其他功能,包括复制、API升级、锁定、版本历史管理(暂不支持下载pdf或者excel文件)等功能。

新建标签画像API

在新建下拉中选择"标签画像API"进入API创建页面。

配置基础信息

第一步需要配置标签画像API的基础信息,包括类型、名称、请求方式等。

若标签画像API类型选择"标签API",支持设置入参;若标签画像API类型选择"群组API",则不需要设置入参,仅选择返回参数即可。其他字段内容同"新建API"流程,包括API协助管理者、传输加密等字段均通用。

配置标签参数

第二步需要选择当前项目所属项目组-集群下的工作组中的标签或者群组数据,用来配置参数信息。

若在第一步选择的标签画像API类型是"标签API",支持设置入参后配置查询条件;若在第一步选择的标签画像API类型是"群组API",则无需设置查询条件。

字段选择说明如下:

字段 说明
查询引擎 默认只有Impala
Impala集群 选择平台中支持的Impala集群
执行队列 选择Impala的执行队列,用于查询存储在Hive数据源中的标签数据
选择集群 由于标签画像产品侧的管理单位以"项目组-集群"下创建工作组管理标签,而数据服务侧以项目为基本管理单位,故需要先选择当前项目归属的项目组下对应的集群信息,用来确定标签画像侧工作组范围
工作组 选择标签画像侧项目组-集群下对应的工作组
归属对象 选择标签或者群组归属的对象
群组 若在第一步选择的标签画像API是"群组API",则第二步还需要选择归属对象下对应的群组

配置返回和排序参数以及配置查询条件,交互方式同"新建API",从弹窗中选择对应标签或者群组下的标签字段作为参数即可。

测试API

标签画像API基本信息和参数配置完成之后,第三步可以对API进行在线测试,测试步骤同"新建API"流程。

标签画像API其他功能

标签画像API创建成功之后,发布、上线、绑定应用授权、复制、锁定、查看版本历史(下载word或者excel暂不支持标签画像API)等操作同 新建API