标签画像实验手册 - 标签画像API案例演示 - 《标签画像用户手册-v3.7.3》

标签画像API

标签画像API

本节将通过一个实际案例，对标签画像API功能的使用方法及流程进行梳理，更好的方便用户了解标签画像API的使用流程。

背景

标签服务API功能是标签画像在服务层的重点功能之一，可以通过API的方式将标签和群组的数据进行共享，实现与应用层营销系统的数据互通。

标签画像API的功能借助Easydata产品体系下的"数据服务"产品实现，"数据服务"是一款提供安全稳定的API快速构建能力、提高数据开发和运维效率的产品，复用数据服务丰富的调用数据监控、报警机制、流控策略等功能实现标签画像API的构建和使用。

准备工作

标签画像API功能由于涉及到"标签画像"和"数据服务"两款产品，且由于两个产品间的管理单位不一样，故需要做好以下功能权限的管理工作：

在标签画像产品侧：需要有新建标签、发布标签、新建群组、对群组进行计算的功能权限；可在"安全中心-角色管理-项目组"级别针对标签画像，赋权对应功能：

在数据服务产品侧：需要有新建集合、新建API、发布API的功能权限；可在"安全中心-角色管理-项目"级别针对数据服务，赋权对应功能：

其次，标签画像API功能只在标签工作组为"Hive"执行引擎才支持，"ES"执行引擎的工作组暂不支持标签画像API功能。

标签画像API创建流程

创建标签画像API步骤说明

在标签画像侧：
- 前提：
  1. 管理员或负责人已经在安全中心授权了新建标签、新建群组、发布标签的权限，或原本自己就是管理员角色，已经有对应的权限；
  2. 标签画像已有创建成功的Hive执行引擎的工作组。
- 步骤：
  1. 在标签画像侧，hive执行引擎的工作组下，创建对象，或基于创建好的对象创建标签，标签类型为基础标签、复合标签或者人工标签均可。
  2. 基于创建好的标签创建群组，或者基于创建好的群组再创建新的群组，创建好的群组保证最新一次实例计算为"计算成功"；
  3. 【可选】计算成功的群组，可在群组详情页的"覆盖数历史详情"列表查看每次实例运行成功对应生成的Hive表。
  4. 【可选】对于最新一次计算实例为"计算成功"的群组，在群组列表操作列的"更多"选项中支持点击"生成群组API"快捷的进入数据服务的新建标签画像API的页面。
在数据服务侧：
- 前提：
  1. 管理员或负责人已经在安全中心授权了新建API、发布API的权限，或原本自己就是管理员角色，已经有对应的权限；
  2. easydata平台有可用的impala队列，标签画像API查询需要使用impala执行引擎。
- 步骤：
  1. 创建API集合，用于创建标签画像API时作为API的归属，也可以通过集合URL地址快速的分辨属于同一集合下的API；
  2. 创建标签画像API，在第一步，支持选择类型是"标签API"或"群组API"；
  3. 若在第一步选择的是"标签API"，则在第一步支持入参设置，在第二步创建时可以选择工作组下归属对象已发布的标签设置返回参数和排序参数，也可以根据入参设置请求参数；
  4. 若在第一步选择的是"群组API"，则不需要设置入参，在第二步只要创建工作组下归属对象下最新实例计算成功的群组，选择群组中的标签作为返回参数或排序参数即可。
  5. 不管是标签API还是群组API，在第三步测试阶段，均支持在线测试，同数据服务的其他API类型。
  6. 测试成功的标签API可以发布，发布后的标签画像API就和其他API类型功能一致了，支持下线、删除、升级、复制、版本历史管理等操作。