角色 OpenAPI--增长分析（私有化）-火山引擎

文档中心

导航

角色 OpenAPI

最近更新时间：2024.11.08 10:44:04首次发布时间：2024.11.08 10:44:04

概述

本文档提供火山引擎增长分析中用户角色相关接口的说明。角色相关接口自私有化4.10.0版本开始支持，能力包括：

接口列表	功能说明
获取角色详情获取角色列表修改角色级别编辑角色的功能权限编辑角色的数据范围删除角色的数据-事件列表编辑角色的属性脱敏修改角色的属性脱敏删除角色的属性脱敏	这些OpenAPI的调用操作结果与私有化环境管理中心按角色授权的界面操作结果大部分是一致的。

公共参数

Context-path: /datarangers
Path-parameters:

Parameter	Type	Required	Description
org_id	int	true	集团ID，您可以在私有化管理中心>集团信息中查看到集团ID信息。
project_id	int	true	项目ID，您可以在私有化管理中心>项目管理中查看到项目ID信息。
role_id	int	true（获取角色列表OpenAPI不需要）	角色ID，您可以在私有化管理中心>权限授予>按角色中查看到某个角色的角色ID信息；或者您也可以使用本文的获取角色列表OpenAPI直接获取全量角色列表，即可查看对应角色的ID。

获取角色详情

method：GET
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/info
Response：

{
    "code": 200,
    "message": "成功",
    "data": {
        "id": 1000, # 角色id
        "description": "", # 描述
        "status": 1, # 角色状态，目前status只有1
        "is_preset": false, # 是否预置
        "risk_level": 1, # 风险级别
        "rank": 3,  # 级别 2:管理员 3: 成员
        "name": "test", # 名称
        "is_project_manager_role": false, # 是否是管理员角色
        "is_role_admin": false, # 当前用户是否是角色负责人
        "role_admins": [] # 角色负责人列表
    }
}

获取角色列表

method：GET
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/queries
Response：

{
    "code": 200,
    "message": "成功",
    "data": {
        "roles": [
            {
                "id": 1000,
                "description": "",
                "status": 1,
                "rank": 3,
                "creator_id": 0,
                "name": "test",
                "is_role_admin": false,
                "is_project_manager": true,
                "is_preset": false,
                "role_admins": []
            }
        ]
    }
}

修改角色级别

method：PATCH
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/basic_info

名称	类型	是否必须	备注
rank	int	是	修改后的角色级别，只允许 2：修改为管理员（DataFinder内的概念，项目粒度，拥有者有项目的全部管理权限） 3：修改为成员（DataFinder内概念，项目粒度，具体使用权限由配置决定，没有部分特定管理权限）

名称

类型

是否必须

备注

rank

int

是

修改后的角色级别，只允许

2：修改为管理员（DataFinder内的概念，项目粒度，拥有者有项目的全部管理权限）
3：修改为成员（DataFinder内概念，项目粒度，具体使用权限由配置决定，没有部分特定管理权限）

Response:

{
    "code": 200,
    "message": "更新成功"
}

编辑角色的功能权限

method：PUT
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/function

名称		类型	是否必须	备注
function_ids		array	否	修改角色可查看的功能id列表（元素的类型为number），支持配置的各功能和对应的ID列表请参见下文功能列表（function_id）。
features		object	否	修改角色可管理的功能权限。
	manage	array	否	可管理的功能id列表（元素的类型为number），支持配置的各功能和对应的ID列表请参见下文管理权限列表（feature_id）。

Response:

{
    "code": 200,
    "message": "更新成功"
}

编辑角色的数据范围

method：PUT
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/data_permission

名称			类型	是否必须	备注
event_param			object	否	事件属性列表
	conditions		array	否	表达式列表(元素的类型为object)
		property_name	string	否	属性名
		property_display_name	string	否	属性展示名
		property_compose_type	string	否	属性组成类型
		property_operation	string	否	计算符
		property_values	array	否	值(元素的类型为string)
		property_type	string	否	属性类型
	logic		string	否	各过滤条件间的逻辑关系：and/or 支持两层过滤条件且分别支持配置逻辑关系。
profile			object	否	用户属性
	conditions		array	否	表达式列表(元素的类型为object)
		property_name	string	否	属性名
		property_display_name	string	否	属性展示名
		property_compose_type	string	否	属性组成类型
		property_operation	string	否	计算符
		property_values	array	否	值(元素的类型为number)
		property_type	string	否	值的数据类型不限
	logic		string	否	and/or
events			object	否	事件列表
	operation		string	否	include/exclude
	event_names		array	否	事件名列表(元素的类型为string)

Request：
请求示例如下所示。

{
    "event_param": {
        "expressions": [
            {
                "logic": "or",
                "conditions": [
                    {
                        "property_type": "common_param",
                        "property_name": "platform",
                        "property_compose_type": "origin",
                        "property_operation": "=",
                        "property_values": [
                            "mp"
                        ]
                    },
                    {
                        "property_type": "event_param",
                        "property_name": "referer_type",
                        "property_compose_type": "origin",
                        "property_operation": "=",
                        "property_values": [
                            "direct"
                        ]
                    }
                ]
            },
            {
                "logic": "or",
                "conditions": [
                    {
                        "property_type": "event_param",
                        "property_name": "scene",
                        "property_compose_type": "origin",
                        "property_operation": "=",
                        "property_values": [
                            1037
                        ]
                    }
                ]
            }
        ],
        "logic": "and"
    },
    "profile": {
        "expressions": [],
        "logic": "and"
    }
}

Response:

{
    "code": 200,
    "message": "更新成功"
}

删除角色的数据-事件列表

method：DELETE
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/events

名称		类型	是否必须	备注
events		object	否	删除事件
	delete_event_names	array	否	事件名列表(元素的类型为string)
	operation	string	否	include/exclude

Response:

{
    "code": 200,
    "message": "更新成功"
}

编辑角色的属性脱敏

method：PUT
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/property_desensitization

名称		类型	是否必须	备注
property_desensitization		array	是	属性脱敏(元素的类型为object)
	property_name	string	是	属性名
	property_display_name	string	否	属性展示名
	property_type	string	是	属性类型，包括： item_param: 业务对象 user_profile：用户属性 common_param：公共事件属性 common_param：虚拟属性（对应property_compose_type=virtual） event_param：事件属性
	property_compose_type	string	是	属性来源类型 virtual：虚拟属性 origin：默认
	desensitization_type	integer	是	脱敏方式，1:脱敏显示，2:不可过滤和分组
	data_type	string	否	数据类型

Response:

{
    "code": 200,
    "message": "更新成功"
}

修改角色的属性脱敏

method：PATCH
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/property_desensitization
描述：修改单个角色的单条属性脱敏记录

名称	类型	是否必须	备注
property_name	string	是	属性名
property_type	string	是	属性类型
property_compose_type	string	是	属性组成类型
desensitization_type	number	是	脱敏类型

Response:

{
    "code": 200,
    "message": "更新成功"
}

删除角色的属性脱敏

method：DELETE
api路径：/datarangers/openapi/v2/org/{org_id}/project/{project_id}/role/{role_id}/property_desensitization
描述：删除单个角色的属性脱敏记录

名称		类型	是否必须	备注
property_desensitization		array	否	属性脱敏记录列表(元素的类型为object)
	property_name	string	否	属性名
	property_display_name	string	否	属性展示名
	property_type	string	否	属性类型
	property_compose_type	string	否	属性组成类型
	data_type	string	否	数据类型
	desensitization_type	number	否	脱敏方式

Response:

{
    "code": 200,
    "message": "更新成功"
}

附录

功能列表（function_id）

id	功能名称
1149	看板（查看）
1150	角色管理
1151	用户管理
1157	公共空间管理权限（编辑权）
1161	事件分析
1162	留存分析
1163	转化分析
1164	分布分析
1165	成分分析
1166	用户路径
1167	归因分析
1168	用户生命周期
1169	热力图分析
1170	LTV分析
1171	业务维度分析
1172	SQL自定义查询
1174	用户细查
1175	用户画像
1176	用户分群
1177	用户标签
1179	应用概况
1180	基础指标
1181	来源分析
1182	基本留存
1183	终端分析
1184	网页访问
1186	小程序访问
1187	场景值分析
1188	二维码统计
1189	二维码管理
1190	分享趋势
1191	分享裂变图
1192	分享用户
1193	分享页面
1196	推送任务管理
1197	流程画布
1198	推送通道管理
1199	通用设置
1220	事件分类
1221	一般事件
1222	事件属性
1223	用户属性
1224	虚拟事件
1225	圈选事件
1226	虚拟属性
1227	业务维度
1228	分析主体
1229	自定义 Session
1230	会话管理
1232	数据质量
1234	数据接入
1236	数据输出
1239	通用设置
1240	合并页管理
1241	日期批注
1243	监控管理
1244	查询任务列表
1246	看板管理
1248	场景模板
1250	Webhook管理
1251	埋点实时验证
2102	埋点治理说明购买使用埋点治理时才有此功能
2107	数据入库明细
2108	SDK设置
2113	操作日志
2241	指标管理
2260	行业分析
2263	渠道分析

管理权限列表（feature_id）

id	名称
3	一般事件
4	事件属性
5	用户属性
6	会话管理
7	圈选事件
8	业务维度
9	分析主体
10	自定义会话
15	微信公众号
16	虚拟属性
19	SDK设置
20	自定义属性分组
24	下载数据说明场景分析下的下载权限
25	下载数据说明高级分析下的下载权限
26	用户导出
27	用户浏览
28	下载数据说明看板下的下载权限
29	虚拟事件
31	埋点治理-创建说明购买使用埋点治理时才有此功能
32	埋点治理-审批说明购买使用埋点治理时才有此功能