Adobe I/O Adobe运动标准SDK

节点 Javascription SDK 包装 Adobe 运动标准 API。 。 。 .

安装

$ npm install

使用量

1. 初始化 SDK

const sdk = require('@adobe/aio-lib-campaign-standard')

async function sdkTest() {
  //initialize sdk
  const campaignStandardClient = await sdk.init('<tenant>', 'x-api-key', '<valid auth token>')
}

Init 方法返回一个类实例 CampaignStandardCoreAPI

2. 使用已初始化的 SDK 调用方法

const sdk = require('@adobe/aio-lib-campaign-standard')

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

  // call methods
  try {
    // get profiles by custom filters
    result = await campaignStandardClient.getAllProfiles({
      filters: [
        'byCRMId'
      ],
      hasCustomFilter: true
    })
    console.log(result)

    // get a workflow
    result = await campaignStandardClient.getWorkflow('myWkfId')
    console.log(result)

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

SDK下的所有可用方法都有文件记录 here

类

标准化组织

这个班级提供了将Adobe Campaign Standard APIs称为的方法. 在调用任何方法之前 init 有关方法 包含租户ID、 apiKey 和访问Token 的有效值

职能

init( tenantId, apiKey, 访问托肯) ⇒ Promise.<CampaignStandardCoreAPI>

返回以新的 CampatyStandard CoreAPI 对象解决的保证 .

标准化组织

这个班级提供了将Adobe Campaign Standard APIs称为的方法. 在调用任何方法之前 init 有关方法 包含租户ID、 apiKey 和访问Token 的有效值

仁爱: 全球类

• 标准化组织
  • 租户
  • 键
  • 。访问文件夹
  • .init( tenantId, apiKey, accessToken) (英语) ⇒ CampaignStandardCoreAPI
  • .get AllProfiles ([参数])
  • .createProfile(描述对象)
  • .update Profile( profilePKey, profile Object) 主题
  • .getProfile( profilePKey) (中文(简体) )
  • .get AllServices([参数])
  • 创建服务对象
  • .getService( 服务密钥)
  • .getHistoryOfProfile( profilePKey) (中文(简体) )
  • .getMetadata ForResource(资源)
  • .get Metadata ForResourceExt(资源)
  • .get海关资源()
  • 创建 GDPR 请求( gdpr request)
  • .getGDPR 请求()
  • .get GDPRDataFile( 隐私请求DataUrl, 请求InternalName)
  • .send 交易事件(事件Id,事件Body)
  • .send 交易事件ForMacTenantId(macTenantId,事件Id,事件Body)
  • .Get Transactional Event(事件、事件PKey)
  • .Get TransactionalEventForMacTenantId(macTenantId,事件Id,事件PKey) 互联网档案馆的存檔,存档日期2013-12-20
  • 工作流程( 工作流程) (d) 国家
  • .trigger 信号活性(活性流 TriggerUrl, [活性流Paramems])
  • 控制工作流程(workflowId,命令)
  • .get AllOrg 单元([参数])
  • .get Profile With Org Unit( profilePKey) 服务器
  • .update ProfileOrg Unit( profilePKey, org UnitPKey) (PagePKey, org UnitPKey) 互联网档案馆的存檔,存档日期2014-12-21
  • .update Org Unit( org UnitPKey, org UnitOrg Object) 主题
  • . postDataToUrl( url, 机构)
  • 从RelativeUrl(相对Url)获取数据
  • .get AllCustomResources(客户资源,[参数])
  • .get All Basic CustomResources(资源)
  • .get AllProfileAndServicesExt(客户资源,[参数])
  • .updateCustomResource(自定义资源,自定义资源PKey,自定义资源对象)
  • .create自定义资源( CustomResource,自定义资源对象)
  • .delateCustomResource(客户资源,自定义资源PKey,自定义资源对象)

标准CoreAPI.tenantId 互联网档案馆的存檔,存档日期2013-12-02

(您个人组织在竞选标准中)

仁爱: 实例财产 CampaignStandardCoreAPI

标准CoreAPI.apiKey

adobe I/O 运动标准集成中的 api 键

仁爱: 实例财产 CampaignStandardCoreAPI

标准CoreAPI. 访问Token

从您的 Adobe I/O 运动标准集成的存取符

仁爱: 实例财产 CampaignStandardCoreAPI

commandard CoreAPI.init( tenantId, apiKey, access Token) \\\fn微软雅黑 CampaignStandardCoreAPI

初始化此对象.

仁爱: 实例方法 CampaignStandardCoreAPI

c. get AllProfiles ([参数])

获取所有配置文件记录

仁爱: 实例方法 CampaignStandardCoreAPI
见: 获取元数据资源

活动标准CoreAPI.createProfile(简介对象)

创建配置文件记录

仁爱: 实例方法 CampaignStandardCoreAPI

活动标准 CoreAPI.update Profile( profilePKey, profile 对象)

更新配置文件记录

仁爱: 实例方法 CampaignStandardCoreAPI

活动标准CoreAPI.getProfile( profilePKey)

获取配置文件记录

仁爱: 实例方法 CampaignStandardCoreAPI

标准CoreAPI.get AllServices ([参数])

获取所有服务记录

仁爱: 实例方法 CampaignStandardCoreAPI
见: 获取元数据资源

创建服务对象

创建服务记录

仁爱: 实例方法 CampaignStandardCoreAPI

c. get Service( 服务PKey)

获取服务记录

仁爱: 实例方法 CampaignStandardCoreAPI

标准 CoreAPI.getHistoryOfProfile( profilePKey) 活动 常规

获取一个配置的营销历史

仁爱: 实例方法 CampaignStandardCoreAPI

标准CoreAPI.getMetadata ForResource(资源)

获取一个资源的元数据信息 .

仁爱: 实例方法 CampaignStandardCoreAPI

活动标准CoreAPI.getMetadata ForResourceExt(资源)

获取与配置表链接的自定义资源

仁爱: 实例方法 CampaignStandardCoreAPI

标准CoreAPI.getCustom资源( )

将所有自定义资源集链接到配置表.

仁爱: 实例方法 CampaignStandardCoreAPI

创建 GDPR 请求( gdpr request)

创建一个新的 GDPR 请求 .

仁爱: 实例方法 CampaignStandardCoreAPI

标准CoreAPI.getGDPR请求()

获取当前 GDPR 请求的数据 .

仁爱: 实例方法 CampaignStandardCoreAPI

property Standard CoreAPI. get GDPRDataFile( privacy RequestDataUrl, request InternalName) 互联网档案馆的存檔,存档日期2013-12-21

获取GDPR数据文件.

仁爱: 实例方法 CampaignStandardCoreAPI
见: 获取 GDPR 请求

活动标准CoreAPI.send Transactional Event(事件,事件Body)

折旧

发送交易事件 . 自 2. 1. 0 起折旧 。 使用 send Contactal EventForMacTenantId 代替 .

仁爱: 实例方法 CampaignStandardCoreAPI

活动标准 CoreAPI. send Transactional EventForMacTenantId(macTenantId, 事件Id, 事件Body) 活动程序

发送一个交易活动, 用于营销云租户ID

仁爱: 实例方法 CampaignStandardCoreAPI

活动标准 CoreAPI.get Transportactional Event(事件,事件PKey)

折旧

获取交易事件( 状态、 属性) 的数据 自 2. 1. 0 起贬值。 使用 Get Contactal EventForMacTenantId 代替 .

仁爱: 实例方法 CampaignStandardCoreAPI
见: 发送交易事件

常规 CoreAPI.get Transactional EventForMacTenantId(macTenantId,事件Id,事件PKey)

获取关于营销云租户身份(状态、属性)交易事件的数据

仁爱: 实例方法 CampaignStandardCoreAPI
见: 发送交易事件

工作流程( 工作流程) (d) 国家

获得工作流程的属性.

仁爱: 实例方法 CampaignStandardCoreAPI

signal Activity (workflow TrigggerUrl, [workflowPaaremets]) (英语)

触发一个工作流程.

仁爱: 实例方法 CampaignStandardCoreAPI
见: 获得工作流程

controlWorkflow(工作流程,命令)

控制工作流程的执行.

仁爱: 实例方法 CampaignStandardCoreAPI

c. get AllOrg Units ([参数])

获取所有可用的 org 单元

仁爱: 实例方法 CampaignStandardCoreAPI
见: 获取元数据资源

标准 CoreAPI.get Profile With Org Unit( profilePKey)

获取配置文件记录( 带有 Org Unit 属性)

仁爱: 实例方法 CampaignStandardCoreAPI

标准 CoreAPI.update ProfileOrg Unit( profilePKey, org UnitPKey) 操作程序

更新配置文件的 Org 单位

仁爱: 实例方法 CampaignStandardCoreAPI

活动标准CoreAPI.updateOrg Unit(org UnitPKey, org UnitObject) 互联网档案馆的存檔,存档日期2013-12-21

更新 Org UnitBase 的属性 .

仁爱: 实例方法 CampaignStandardCoreAPI

标准CoreAPI.postData ToUrl(url,正文)

贴到绝对url.

仁爱: 实例方法 CampaignStandardCoreAPI

标准CoreAPI.getData fromRelativeUrl(相对Url)

从相对的url获取数据. 帮助功能.

仁爱: 实例方法 CampaignStandardCoreAPI

customResources(客户资源,[参数])

折旧

获取所有自定义资源记录 要么使用 Get All BasicCustomResources () 获取自定义资源, 要么 获取 AllProfileAnd ServicesExt () 获取扩展的资源数据

仁爱: 实例方法 CampaignStandardCoreAPI
见: 获取元数据资源

c. get All BasicCustomResources( 资源)

获取所有自定义资源记录

仁爱: 实例方法 CampaignStandardCoreAPI

profileAnd ServicesExt( 客户资源, [参数])

获取所有自定义资源记录

仁爱: 实例方法 CampaignStandardCoreAPI
见: 获取元数据资源

commandard CoreAPI.updateCustomResources(自定义资源,自定义资源PKey,自定义资源对象)

更新自定义资源记录

仁爱: 实例方法 CampaignStandardCoreAPI

customResource( 定制资源, 自定义资源对象)

创建自定义资源记录

仁爱: 实例方法 CampaignStandardCoreAPI

commandard CoreAPI.deleteCustomResource(客户资源,自定义资源PKey,自定义资源对象)

删除自定义资源记录

仁爱: 实例方法 CampaignStandardCoreAPI

init( tenantId, apiKey, access Token) Promise.<CampaignStandardCoreAPI>

返回以新的 CampatyStandard CoreAPI 对象解决的保证 .

仁爱:全球职能

除错日志

LOG_LEVEL=debug <your_call_here>

预留 LOG_LEVEL 环境变量和 debug 值到引用您函数的调用,在命令行上。 这将为您的 SDK 电话输出大量调试数据 .

捐款

欢迎捐款! 读取 贡献指南 更多信息.

许可证发放

这个项目根据Apache V2许可证获得许可. 见 自由主义 更多信息.