idtype相关--客户数据平台-火山引擎

文档中心

导航

客户数据平台

idtype相关

最近更新时间：2023.10.08 10:43:09首次发布时间：2023.10.08 10:43:09

1. 按租户获取ID类型

基本信息

生效版本	1.12
功能描述	按租户获取ID类型列表
接口模块	IdTypeAPI
接口名称	ListIdTypeMetaByTenant
请求类型	GET

请求参数

Query 参数

名称	数据类型	是否必选	描述
ApiAction	String	是	对应“基本信息”中的“接口名称”
ApiVersion	String	是	版本号： 2023-02-10

Header

名称	数据类型	是否必选	描述
X-Tenant	String	是	项目id
Authorization	String	是	1.3.2中的签名

Body（无）

响应参数

名称	数据类型	描述
subjectId	Int	主体id
subjectName	String	主体名称
subjectType	String	主体类型

date 字段内容

名称	数据类型	描述
subjectId	Int	主体id
subjectName	String	主体名称
subjectType	String	主体类型
idTypes	Array	id 类型列表
id	Int	ID类型唯一标识
code	String	ID类型code
name	String	ID类型名称
dataType	String	数据类型：String, Decimal, Composite
entityType	String	实体类型：BaseId, Phone, Phone_SHA256, IDFA, IDFA_MD5, IMEI, IMEI_MD5, OAID, OAID_MD5, DeviceID, PrivateID, ByteId, DY_MpID_OpenID, DY_MpID_OpenID_MD5, WX_UnionID, WX_AppID_OpenID, DouDian_AppID_OpenID, WX_External_UserID, WX_Group_ChatID
needEncrypt	Bool	是否需要加密
availableMappingIds	Array	可用的idmapping策略
targetEntityId	Int	目标id type标识
strategy	Object	策略
strategyId	Int	策略id
strategyName	String	策略名称
orgId	Int	集团ID

返回示例：

{
  "data": [
    {
      "subjectId": 1, // 主体id 
      "subjectName": "主体1", // 主体名称
      "subjectType": "Person", // 主体类型：Person, Car, Shop, Commodity, Custom
      "idTypes": [
        {
          "id": 1, // ID类型唯一标识
          "code": "baseid", // ID类型code
          "name": "基准", // ID类型名称
          "dataType": "Decimal", // String, Decimal, Composite
          "entityType": "BaseId", // BaseId, Phone, Phone_SHA256, IDFA, IDFA_MD5, IMEI, IMEI_MD5, OAID, OAID_MD5, DeviceID, PrivateID, ByteId, DY_MpID_OpenID, DY_MpID_OpenID_MD5, WX_UnionID, WX_AppID_OpenID, DouDian_AppID_OpenID, WX_External_UserID, WX_Group_ChatID
          "needEncrypt": false, // 是否需要加密
          "subjectId": 1,
          "subjectName": "主体1",
          "availableMappingIds": [ // 可用的idmapping策略
            {
              "targetEntityId": 12, // 目标id type标识
              "strategy": [
                {
                  "strategyId": 6, // 策略id
                  "strategyName": "1-2" // 策略名称
                }
              ]
            }
          ],
          "orgId": 1,
          "subjectType": "Person"
        }
      ],
      "orgId": 1
    }
  ],
  "code": 0
}