让开源，少一点语言距离。
npm包中文文档

@adobe/aio-lib-customer-profile

中文文档
3.0.2发布于 2025/09/04Apache-2.0TypeScriptCommonJS近 30 天下载 2.4万

Adobe I/O 客户简介 Lib

中文使用文档
中文原文
文档目录73 节
  1. 安装
  2. 使用量
  3. 类
  4. 职能
  5. 客户ProfileAPI
  6. 顾客ProfileAPI.tenantId: string
  7. 顾客ProfileAPI.iMSOrgId: string
  8. 顾客ProfileAPI.apiKey : string
  9. 客户ProfileAPI. accessToken: string
  10. 客户端ProfileAPI.sandbox : string
  11. 客户 ProfileAPI.init (tenantId, iMS OrgId, apiKey, accessToke…
  12. 客户名ProfileAPI.getProfile ([参数]) QQ Promise.<Response>
  13. 客户ProfileAPI.get Experence Events ([参数]) QQ Promise.<Respon…
  14. 客户ProfileAPI.list 计算属性([参数]) QQ Promise.<Response>
  15. 客户ProfileAPI.create ComputedAttize([参数]]) QQ Promise.<Respo…
  16. 客户 ProfileAPI. Lookup ComputedAttize ([参数]) QQ Promise.<Res…
  17. 客户 ProfileAPI.update 计算属性([参数]) QQ Promise.<Response>
  18. 客户 ProfileAPI.delete 计算属性([参数]) Promise.<Response>
  19. 客户ProfileAPI.getConfig MorgePolices ([参数]) QQ Promise.<Resp…
  20. 客户 ProfileAPI. post Config MorgePolices ([参数]) QQ Promise.<…
  21. 客户ProfileAPI. GetConfig MorgePolices MorgePolicyId ([参数]) Q…
  22. 客户ProfileAPI.putConfig MorgePolices MorgePolicyId ([参数]) QQ…
  23. 客户 ProfileAPI.patch Config MorgePolices MorgePolicyId([参数])…
  24. 客户ProfileAPI.delete Config MorgePolices MorgePoliticies Mor…
  25. 客户ProfileAPI.Get Access Entities ([参数]) QQ Promise.<Respons…
  26. 客户ProfileAPI.post Accessinities([参数]) QQ Promise.<Response>
  27. 客户 ProfileAPI.delete 访问实体([参数]) Promise.<Response>
  28. 客户ProfileAPI.getScanJobsRoute([参数]) QQ Promise.<Response>
  29. 客户ProfileAPI.postScanJobRoute([参数]) QQ Promise.<Response>
  30. 客户ProfileAPI.getScanJobRoute([参数]) QQ Promise.<Response>
  31. 客户ProfileAPI.cancelScanJobRoute([参数]) QQ Promise.<Response>
  32. 客户 ProfileAPI.getSegments Route([参数]) QQ Promise.<Response>
  33. 客户ProfileAPI.postSegmentRoute([参数]) QQ Promise.<Response>
  34. 客户ProfileAPI.getSegmentRoute([参数]) QQ Promise.<Response>
  35. 客户 ProfileAPI.deleteSegment Route([参数]) QQ Promise.<Respons…
  36. 客户 ProfileAPI.patchSegment Route([参数]) QQ Promise.<Response>
  37. 客户ProfileAPI.postSegment 转换路特([参数]) QQ Promise.<Response>
  38. 客户 ProfileAPI.getSegmentJobs([参数]) QQ Promise.<Response>
  39. 客户 ProfileAPI.postSJRRoute ([参数]) QQ Promise.<Response>
  40. 客户 ProfileAPI.getSegmentJobsSegmentJob Id([参数]]) Promise.<R…
  41. 客户 ProfileAPI.deleteSegment JobsSegmentJob Id([参数]]) Promis…
  42. 客户 ProfileAPI. postlessedPreviewRoute([参数]) QQ Promise.<Res…
  43. 客户 ProfileAPI. 获得无会议审查状态 Route ([参数]) QQ Promise.<Response>
  44. 客户 ProfileAPI.delete SessionLessPreview status Route([参数]) …
  45. 客户 ProfileAPI.getEstimate Status Route([参数]) QQ Promise.<Re…
  46. 客户 ProfileAPI.list Projection 组合([参数]) QQ Promise.<Response>
  47. 客户ProfileAPI.createProject 配置([参数]) QQ Promise.<Response>
  48. 客户ProfileAPI.get Projection 配置([参数]) QQ Promise.<Response>
  49. ([参数])XQ Promise.<Response>
  50. 客户 ProfileAPI.delete Projection 配置([参数]) QQ Promise.<Respon…
  51. 客户ProfileAPI.list 预测([参数]) Promise.<Response>
  52. 客户ProfileAPI.创建Projectestination ([参数]) QQ Promise.<Respons…
  53. 客户ProfileAPI.get Projection Destination ([参数]) QQ Promise.<…
  54. ([参数]) Promise.<Response>
  55. 客户 ProfileAPI.delete Projection Destination ([参数]) QQ Promi…
  56. 客户ProfileAPI.getConfigEventTypes ([参数]) QQ Promise.<Respons…
  57. 客户ProfileAPI.post ConfigEventTypes ([参数]) QQ Promise.<Respo…
  58. 客户ProfileAPI.getConfigEventTypesEventTypeId ([参数]) QQ Promi…
  59. 客户ProfileAPI.putConfigEventTypesEventTypeId ([参数]) QQ Promi…
  60. 客户ProfileAPI.patchConfigEventTypesEventTypeId([参数]) QQ Prom…
  61. 客户 ProfileAPI.delete ConfigEventTypesEventTypeId ([参数]) QQ …
  62. 客户ProfileAPI.get ConfigMacros ([参数]) QQ Promise.<Response>
  63. 客户 ProfileAPI.post ConfigMacros ([参数]) QQ Promise.<Response>
  64. 客户名ProfileAPI.getConfigMacrosMacroId ([参数]) QQ Promise.<Res…
  65. 客户ProfileAPI.putConfigMacrosMacroId([参数]) QQ Promise.<Respo…
  66. 客户 ProfileAPI.patch ConfigMacrosMacroId([参数]) QQ Promise.<R…
  67. 客户 ProfileAPI.delete ConfigMacrosMacroId([参数]) QQ Promise.<…
  68. 客户ProfileAPI.getSchedules([参数]) QQ Promise.<Response>
  69. 客户ProfileAPI.createSchedule ([参数]) QQ Promise.<Response>
  70. 客户ProfileAPI.get ScheduleById([参数]) QQ Promise.<Response>
  71. 客户 ProfileAPI.update 附表([参数]]) Promise.<Response>
  72. 客户 ProfileAPI.delete 附表([参数]) Promise.<Response>
  73. 客户 ProfileAPI.list 删除请求([参数]) QQ Promise.<Response>

Version Downloads/week Node.js CI License Codecov Coverage

Adobe I/O Adobe 体验平台 实时客户简介 SDK

节点 Java 脚本 SDK 包装 Adobe 体验平台实时客户简介 API

安装

$ npm install @adobe/aio-lib-customer-profile

使用量

  1. 初始化 SDK
const sdk = require('@adobe/aio-lib-customer-profile')

async function sdkTest() {
  //initialize sdk
  const client = await sdk.init('<tenant>', '<iMSOrgId>', 'x-api-key', '<valid auth token>', '[sandbox]')
}
  1. 使用已初始化的 SDK 调用方法
const sdk = require('@adobe/aio-lib-customer-profile')

async function sdkTest() {
  // initialize sdk
  const client = await sdk.init('<tenant>', '<iMSOrgId>', 'x-api-key', '<valid auth token>', '[sandbox]')

  // call methods
  try {
    // get profiles by custom filters
    const result = await client.getSegmentRoute({
        segmentId: 'abc123'
    })
    console.log(result)

  } catch (e) {
    console.error(e)
  }
}

类

客户ProfileAPI

此类提供了调用客户ProfileAPI API的方法. 在调用任何方法之前 init 有关方法 包含租户ID、 apiKey 和访问Token 的有效值

打开Api

从 openApi spec 文件创建动态方法

职能

init( tenantId, iMSOrgId, apiKey, accessToken, [sandbox]) 用户名 ⇒ Promise.<CustomerProfileAPI>

返回以新客户ProfileAPI对象解决的保证 .

客户ProfileAPI

此类提供了调用客户ProfileAPI API的方法. 在调用任何方法之前 init 有关方法 包含租户ID、 apiKey 和访问Token 的有效值

仁爱: 全球类

顾客ProfileAPI.tenantId: string

租户身份证

仁爱: 实例财产 CustomerProfileAPI

顾客ProfileAPI.iMSOrgId: string

IMSOrgId (英语)

仁爱: 实例财产 CustomerProfileAPI

顾客ProfileAPI.apiKey : string

您整合时的 api 键

仁爱: 实例财产 CustomerProfileAPI

客户ProfileAPI. accessToken: string

您整合后的访问符

仁爱: 实例财产 CustomerProfileAPI

客户端ProfileAPI.sandbox : string

沙盒名称

仁爱: 实例财产 CustomerProfileAPI

客户 ProfileAPI.init (tenantId, iMS OrgId, apiKey, accessToken, [sandbox]) (中文(简体) ) Promise.<CustomerProfileAPI>

初始化客户ProfileAPI对象并返回它.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<CustomerProfileAPI> - 客户ProfileAPI对象

参数类型说明
租户string租户代号
iMSOrgId (英语)stringiMSOrgId 用于您的整合
键string您的整合 API 密钥
访问脚本string您的整合访问符
[沙箱]string沙盒名称

客户名ProfileAPI.getProfile ([参数]) QQ Promise.<Response>

以身份证获取配置 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数

客户ProfileAPI.get Experence Events ([参数]) QQ Promise.<Response>

获得经验晚会.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数

客户ProfileAPI.list 计算属性([参数]) QQ Promise.<Response>

获取计算属性列表 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数

客户ProfileAPI.create ComputedAttize([参数]]) QQ Promise.<Response>

创建计算属性 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数

客户 ProfileAPI. Lookup ComputedAttize ([参数]) QQ Promise.<Response>

用其ID获取特定的计算属性.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。 备注 IDstring由系统创建属性时生成的计算出属性的独特,只读的ID.

客户 ProfileAPI.update 计算属性([参数]) QQ Promise.<Response>

用其ID更新一个计算属性 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。 备注 IDstring由系统创建属性时生成的计算出属性的独特,只读的ID.

客户 ProfileAPI.delete 计算属性([参数]) Promise.<Response>

删除一个用其ID计算的属性.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。 备注 IDstring由系统创建属性时生成的计算出属性的独特,只读的ID.

客户ProfileAPI.getConfig MorgePolices ([参数]) QQ Promise.<Response>

检索合并政策列表.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数. 'x-request-id']string请求编号
[参数.起string页:1
[参数.限number页面大小
[参数.顺序By]string用于订购的模型属性
[参数.'schema.name']stringSchema 类 ID
[参数.默认]boolean默认旗帜

客户 ProfileAPI. post Config MorgePolices ([参数]) QQ Promise.<Response>

创建新的合并策略 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".
参数string配置实例标识
[参数. 'x-request-id']string请求编号

客户ProfileAPI. GetConfig MorgePolices MorgePolicyId ([参数]) QQ Promise.<Response>

通过 ID 查找合并策略 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string合并政策标识 .
[参数. 'x-request-id']string请求编号

客户ProfileAPI.putConfig MorgePolices MorgePolicyId ([参数]) QQ Promise.<Response>

通过 ID 更新合并策略 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string合并政策标识 .
参数string配置实例标识
[参数. 'x-request-id']string请求编号

客户 ProfileAPI.patch Config MorgePolices MorgePolicyId([参数]) QQ Promise.<Response>

更新由 ID 指定的合并策略的一个或多个属性.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string合并政策标识 .
参数string配置实例标识
[参数. 'x-request-id']string请求编号

客户ProfileAPI.delete Config MorgePolices MorgePoliticies MorgePolicyId ([参数]) QQ Promise.<Response>

用ID删除合并策略 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string合并政策标识 .
[参数. 'x-request-id']string请求编号

客户ProfileAPI.Get Access Entities ([参数]) QQ Promise.<Response>

以 ID 或 namespace 查找一个实体 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。'schema.name'stringXED分级名.
[参数.'相关Schema.name']stringXDM schema class 名称,经验Event与之相关. 在浏览体验节时用过.
[参数.实体 编号string实体身份 用于本地 XID 搜索, 使用 entityId=<XID> 离开 entityIdNS 缺席; 对于 ID:NS 查找, 请同时使用 entityId 财务报告和审定财务报表 entityIdNS 字段.
[参数.entityIdNS]string身份命名空间代码。 用于ID:NS检索. 如果使用这个字段, entityId 无法为空.
[参数.相关实体] 编号string确定与经验活动有关的实体。 看过"经验晚会"时用过 用于本地 XID 搜索, 使用 relatedEntityId=<XID> 离开 relatedEntityIdNS 缺席; 对于 ID:NS 查找, 请同时使用 relatedEntityId 财务报告和审定财务报表 relatedEntityIdNS 字段.
[参数.相关实体IdNS]string相关实体身份命名空间代码 ID of EventureEvent. 看过"经验晚会"时用过 如果使用这个字段, entityId 无法为空.
[参数string模型对象的字段 。 默认情况下, 所有字段都会被取出 。 由逗号分出.
[参数.合并政策] 编号string合并政策的标识 。 合并策略包括身份缝合和密钥值 XDM 对象合并的信息. 如果不在场,将使用默认合并策略.
[参数. starttime]number时间范围过滤器的启动时间 。 应该是在毫秒颗粒。 包含在内。 默认: 从开始.
[参数.结束时间]number结束时间 Experience Events 的时间范围过滤器 。 应该是在毫秒颗粒。 被排除在外。 默认: 到尾.
[参数.限number从结果返回的记录数量。 只针对时间序列对象. 默认: 1000
[参数.订单by]string按时间戳排序的被检索体验事件 。 语法:(+/-)timestamp. 默认: +时间戳

客户ProfileAPI.post Accessinities([参数]) QQ Promise.<Response>

通过ID或命名空间搜索多个实体.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".

客户 ProfileAPI.delete 访问实体([参数]) Promise.<Response>

用ID删除一个实体.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。'schema.name'string关联 XDM 计划的名称 .
[参数.实体 编号string实体身份 用于原生 XID, 使用 entityId=<XID> 离开 entityIdNS 缺席; 对于 ID:NS , 请同时使用 entityId 财务报告和审定财务报表 entityIdNS 字段.
[参数.entityIdNS]string身份命名空间代码。 用于ID:NS. 如果使用这个字段, entityId 无法为空.
[参数.合并政策] 编号string合并政策的标识 。 合并策略包括身份缝合和密钥值 XDM 对象合并的信息. 如果不在场,将使用默认合并策略.

客户ProfileAPI.getScanJobsRoute([参数]) QQ Promise.<Response>

获取所有出口工作的列表 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数.限number限制列表中返回的出口任务数量 .
[参数string抵消返回结果的页面(按创建的资源时间排序)
[参数.状况]string按任务状态过滤返回的导出任务 。 可能的值有"NEW","SUCCEED"和"FAILED"等.

客户ProfileAPI.postScanJobRoute([参数]) QQ Promise.<Response>

创建新的导出任务 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".
[参数.'x-profile-intance-id']string配置实例标识

客户ProfileAPI.getScanJobRoute([参数]) QQ Promise.<Response>

通过身份识别查找导出任务 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。导出JobIdstring导出任务ID

客户ProfileAPI.cancelScanJobRoute([参数]) QQ Promise.<Response>

用 ID 取消或删除导出任务 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。导出JobIdstring导出任务ID

客户 ProfileAPI.getSegments Route([参数]) QQ Promise.<Response>

检索分块定义列表.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。''x- request-id'string每项请求的独特身份
[参数.起number页:1
[参数.限number页面大小
[参数.p]number页码
[参数.sort]string排序参数

客户ProfileAPI.postSegmentRoute([参数]) QQ Promise.<Response>

创建新段定义 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".
参数。''x- request-id'string每项请求的独特身份

客户ProfileAPI.getSegmentRoute([参数]) QQ Promise.<Response>

以 ID 查找分区定义 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string段定义 ID .
参数。''x- request-id'string每项请求的独特身份

客户 ProfileAPI.deleteSegment Route([参数]) QQ Promise.<Response>

用 ID 删除一段定义 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string段定义 ID .
参数。''x- request-id'string每项请求的独特身份

客户 ProfileAPI.patchSegment Route([参数]) QQ Promise.<Response>

覆盖段定义 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string段定义 ID .
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".
参数。''x- request-id'string每项请求的独特身份

客户ProfileAPI.postSegment 转换路特([参数]) QQ Promise.<Response>

在pql/text和pql/json之间转换 PQL 格式.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".
参数。''x- request-id'string每项请求的独特身份

客户 ProfileAPI.getSegmentJobs([参数]) QQ Promise.<Response>

获取所有分部任务请求列表 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数. 'x-request-id']string请求编号
[参数.起number页面偏移 - 根据创建的资源时间
[参数.限number页面大小
[参数.状况]string工作状况

客户 ProfileAPI.postSJRRoute ([参数]) QQ Promise.<Response>

创建新段任务请求 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".
参数string配置实例标识
[参数. 'x-request-id']string请求编号

客户 ProfileAPI.getSegmentJobsSegmentJob Id([参数]]) Promise.<Response>

以 ID 搜索一个分区任务请求 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string任务请求编号 .
[参数. 'x-request-id']string请求编号

客户 ProfileAPI.deleteSegment JobsSegmentJob Id([参数]]) Promise.<Response>

以 ID 方式取消或删除分区任务请求 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string任务请求编号 .
[参数. 'x-request-id']string请求编号

客户 ProfileAPI. postlessedPreviewRoute([参数]) QQ Promise.<Response>

创建新预览任务 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".

客户 ProfileAPI. 获得无会议审查状态 Route ([参数]) QQ Promise.<Response>

通过 ID 查看预览任务的结果 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数. previewIdstring预览工作的标识 .
[参数string页:1
[参数.限number页面中应包含多少条目 。 1000,如果没有指定.

客户 ProfileAPI.delete SessionLessPreview status Route([参数]) Promise.<Response>

用 ID 取消或删除预览任务 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数. previewIdstring预览工作的标识 .

客户 ProfileAPI.getEstimate Status Route([参数]) QQ Promise.<Response>

以身份证查看估计工作的结果.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数. previewIdstring预览工作的标识 .

客户 ProfileAPI.list Projection 组合([参数]) QQ Promise.<Response>

获取边缘投影配置列表 。 最新定义已返回 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.schemaName]stringXDM 计划名称
[参数.名称]string投影名称
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.createProject 配置([参数]) QQ Promise.<Response>

创建新的边缘投影配置 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数.schemaNamestringXDM 计划名称
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.get Projection 配置([参数]) QQ Promise.<Response>

通过 ID 查找边缘投影配置 。 返回最新定义 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string未定义
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

([参数])XQ Promise.<Response>

通过 ID 创建或更新边缘投影配置 。 覆盖整个配置.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string未定义
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户 ProfileAPI.delete Projection 配置([参数]) QQ Promise.<Response>

用 ID 删除边缘投影配置 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string未定义
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.list 预测([参数]) Promise.<Response>

获取边缘投影目的地列表. 最新定义已返回 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.创建Projectestination ([参数]) QQ Promise.<Response>

创建一个新的边缘投影目的地 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.get Projection Destination ([参数]) QQ Promise.<Response>

通过 ID 查找边缘投影目的地 。 返回最新定义 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string未定义
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

([参数]) Promise.<Response>

以 ID 创建或更新边缘投影目的地 。 覆盖整个配置.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string未定义
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户 ProfileAPI.delete Projection Destination ([参数]) QQ Promise.<Response>

以 ID 删除边缘投影目的地 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string未定义
参数。''x-gw-ims- 授权'string网关IMS服务标志.
[参数.'x -user -token']string用户访问符.
[参数. 'x-request-id']string用于调试目的的可选标题,用于客户端流量调查问题。 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.getConfigEventTypes ([参数]) QQ Promise.<Response>

获取事件类型列表 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.
[参数.起number页:1 默认为 0.
[参数.限number页面大小
[参数.顺序By]string用于订购的模型属性 .

客户ProfileAPI.post ConfigEventTypes ([参数]) QQ Promise.<Response>

创建新事件类型 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string配置实例 ID .
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.getConfigEventTypesEventTypeId ([参数]) QQ Promise.<Response>

按 ID 搜索事件类型 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string事件类型 ID.
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.putConfigEventTypesEventTypeId ([参数]) QQ Promise.<Response>

用 ID 覆盖事件类型 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string事件类型 ID.
参数string配置实例 ID .
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.patchConfigEventTypesEventTypeId([参数]) QQ Promise.<Response>

以 ID 更新事件类型的一个或多个属性 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string事件类型 ID.
参数string配置实例 ID .
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户 ProfileAPI.delete ConfigEventTypesEventTypeId ([参数]) QQ Promise.<Response>

按 ID 删除事件类型 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string事件类型 ID.
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.get ConfigMacros ([参数]) QQ Promise.<Response>

为您的组织获取所有宏列表 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数. 'x-request-id']string请求编号
[参数.起string页:1
[参数.限number每页显示的最大对象数.
[参数.顺序By]string用于订购的模型属性 .
[参数.dataSet 编号string数据集编号.
[参数.schemaClass] 编号string司马班身份证.
[参数.值]string事件类型值 .

客户 ProfileAPI.post ConfigMacros ([参数]) QQ Promise.<Response>

创建新的宏 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string配置实例标识
[参数. 'x-request-id']string请求编号

客户名ProfileAPI.getConfigMacrosMacroId ([参数]) QQ Promise.<Response>

通过 ID 查找宏 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数.macroIdstring宏标识. 譬如说, ca8fe8a8-0f38-478a-9905-fd515d1d2988
[参数. 'x-request-id']string请求编号

客户ProfileAPI.putConfigMacrosMacroId([参数]) QQ Promise.<Response>

用 ID 覆盖宏.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数.macroIdstring宏标识. 譬如说, ca8fe8a8-0f38-478a-9905-fd515d1d2988
参数string配置实例标识
[参数. 'x-request-id']string请求编号

客户 ProfileAPI.patch ConfigMacrosMacroId([参数]) QQ Promise.<Response>

通过 ID 更新宏 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数.macroIdstring宏标识. 譬如说, ca8fe8a8-0f38-478a-9905-fd515d1d2988
参数string配置实例标识 .
[参数. 'x-request-id']string申请身份证.

客户 ProfileAPI.delete ConfigMacrosMacroId([参数]) QQ Promise.<Response>

按 ID 删除宏 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数.macroIdstring宏标识. 譬如说, ca8fe8a8-0f38-478a-9905-fd515d1d2988
[参数. 'x-request-id']string申请身份证.

客户ProfileAPI.getSchedules([参数]) QQ Promise.<Response>

获取您的IMS Org 的时间表列表

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.
[参数.起number页:1 譬如说, start=3
[参数.限number限制特定数量对象的响应 。 一定是个正数 譬如说, limit=10

客户ProfileAPI.createSchedule ([参数]) QQ Promise.<Response>

创建一个调度,包括指定该调度应触发的时间 .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数。“Content-Type”string请求正文中发送的内容类型 。 应该是"申请/Json".
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户ProfileAPI.get ScheduleById([参数]) QQ Promise.<Response>

查查身份证的进度表.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string行动时间表的识别.
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户 ProfileAPI.update 附表([参数]]) Promise.<Response>

更新时间表,包括更改触发时间或启用/禁用时间表.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string行动时间表的识别.
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户 ProfileAPI.delete 附表([参数]) Promise.<Response>

以身份证删除时间表.

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
参数string行动时间表的识别.
[参数. 'x-request-id']string在使用工作流程调查问题时可用于调试目的的可选头. 同样的ID可以用来从一流中识别对服务的一个单一请求. 对每项请求应建立新的身份证.

客户 ProfileAPI.list 删除请求([参数]) QQ Promise.<Response>

获取您的组织创建的所有删除请求列表( Profile System Jobs) .

仁爱: 实例方法 CustomerProfileAPI
回返数字 : Promise.<Response> - 反应

参数类型默认说明
[参数]object{}要通过的参数
[参数.sta]

版本与发布记录

@adobe/aio-lib-customer-profile 共发布 13 个版本，首次发布于 2020/03/02；过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.2latest2025/09/041.2 年前
3.0.12024/02/122 年前
3.0.02024/01/102 年前
2.0.2-pre.2024-01-08.sha-ddb21343next2024/01/082 年前
2.0.22023/09/213 年前
2.0.12023/07/103 年前

关于 @adobe/aio-lib-customer-profile 的常见问题

@adobe/aio-lib-customer-profile 是什么？

Adobe I/O 客户简介 Lib

如何安装 @adobe/aio-lib-customer-profile？

在项目目录运行 npm install @adobe/aio-lib-customer-profile，或使用 pnpm add / yarn add / bun add。

@adobe/aio-lib-customer-profile 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@adobe/aio-lib-customer-profile 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。

@adobe/aio-lib-customer-profile 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@adobe/aio-lib-customer-profile 可以商用吗？

@adobe/aio-lib-customer-profile 使用 Apache-2.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

@adobe/aio-lib-customer-profile 的下载量有多少？

根据 npm 官方下载统计，@adobe/aio-lib-customer-profile 在 2026/10/05 – 2026/11/03 这 30 天内被下载 24,229 次，日均约 808 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

@adobe/aio-lib-customer-profile 还在维护吗？

最新版本 3.0.2 发布于 2025/09/04（1.2 年前）；至今共发布 13 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/03/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。