Adobe 目标 SDK

节点 Javascription 核心 SDK 包装 Adobe 目标 API。 。 。 .

安装

$ npm install

API目标技术要求

Adobe 目标 1.0 API 需要设置 Accepts 给他们打个头,让他们正常工作 带有版本 2.x 或更多这个SDK, 我们设置适当的 Accepts 呼叫头为 文档。以往版本的 SDK 可能有效,也可能无效,因为对于某些目标 API 来说 Accepts 标题没有一贯执行.

基于用户的 OAuth 键和角色要求

对于使用基于用户的OAuth令牌而不是JWT技术账户的假想,用户可能要求在Adobe目标中指定特定角色/许可,以成功执行API呼叫. 否则,由API客户端执行的Adobe目标API呼叫将导致500个出错.

详情请参见 Adobe 目标企业用户权限文档。 。 。 .

使用量

1. 初始化 SDK

var sdk = require('@adobe/aio-lib-target')

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

Init 方法返回类实例 TargetCoreAPI

2. 使用初始化 sdk 的调用方法

var sdk = require('@adobe/aio-lib-target')

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

    //get activities
    const activities = await targetClient.getActivities({limit:5, offset:0})
    console.log(util.inspect(activities));

    //get offers
    const offers = await targetClient.getOffers({limit:5, offset:0})
    console.log(util.inspect(offers));

     //get offer by id activity
     const offer = await targetClient.getOfferById(123)
     console.log(util.inspect(offer));
}

Sdk 下的所有可用方法都有记录 here

类

目标CoreAPI

这个类提供了调用Adobe目标API的方法. 在调用任何方法之前, 通过调用它的方法初始化实例 带有有效房客、 apiKey 和 认证符

职能

init( 租户、 apiKey、 代号) ⇒ Promise.<TargetCoreAPI>

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

目标CoreAPI

这个类提供了调用Adobe目标API的方法. 在调用任何方法之前, 通过调用它的方法初始化实例 带有有效房客、 apiKey 和 认证符

仁爱: 全球类

• 目标CoreAPI
  • .init( 租户、 apiKey、 代号) ⇒ TargetCoreAPI
  • .get 活动([选项]) ⇒ Promise.<Response>
  • .createAB 活性(机构,[可选 ) ⇒ Promise.<Response>
  • .createXTActivity(机构,[选项]) ⇒ Promise.<Response>
  • .getAB 活动ById(id,[选项]) ⇒ Promise.<Response>
  • .getXT活性ById(id,[选项]) ⇒ Promise.<Response>
  • .updateAB 实际性(d,正文,[可选 ) ⇒ Promise.<Response>
  • .updateXT 活动(id,正文,[可选 ) ⇒ Promise.<Response>
  • 设置活性Name (id, name, [选项]) ⇒ Promise.<Response>
  • .set activity state(id, state,[options]) 状态 ⇒ Promise.<Response>
  • .set Activity Presidentity(id, 优先级, [可选 ) ⇒ Promise.<Response>
  • .set Activity 列表(id, 调度, [选项]) ⇒ Promise.<Response>
  • .删除AB 活动(id,[可选 ) ⇒ Promise.<Response>
  • .去除XT活性(id,[选项]) ⇒ Promise.<Response>
  • .get Activity ChangeLog(id,[选项]) ⇒ Promise.<Response>
  • .getOffers([选项]) ⇒ Promise.<Response>
  • .Get OfferById(id,[选项]) ⇒ Promise.<Response>
  • .create Offer( 机构, [选项]) ⇒ Promise.<Response>
  • .update Offer(id, body, [可选 ) ⇒ Promise.<Response>
  • .去除Offer(id,[可选 ) ⇒ Promise.<Response>
  • .get 观众([可选]) ⇒ Promise.<Response>
  • .createAuditence(机构,[可选 ) ⇒ Promise.<Response>
  • .get Audence ById(id,[可选 ) ⇒ Promise.<Response>
  • .update 观众(id, body, [可选 ) ⇒ Promise.<Response>
  • . deleteAudentence(id,[选项]) ⇒ Promise.<Response>
  • .get 财产([选项]) ⇒ Promise.<Response>
  • .get PropertyById(id,[可选 ) ⇒ Promise.<Response>
  • .getMBoxes([选项]) ⇒ Promise.<Response>
  • .getMBoxByName (名称, [选项]) ⇒ Promise.<Response>
  • .getMBox Profile 属性([选项]) ⇒ Promise.<Response>
  • .get环境([选项]) ⇒ Promise.<Response>
  • .getAB 实际操作(id,[选项]) ⇒ Promise.<Response>
  • .getXT 实际操作(id,[选项]) ⇒ Promise.<Response>
  • .get activityPerformance(id,[可选 ) ⇒ Promise.<Response>
  • 命令报告(id,[可选 ) ⇒ Promise.<Response>
  • 执行批次( 体) ⇒ Promise.<Response>

目标CoreAPI.init(租户, apiKey, 代号) QQ TargetCoreAPI

初始化 sdk.

仁爱: 实例方法 TargetCoreAPI
回返数字 : TargetCoreAPI - 一个目标CoreAPI实例

目标CoreAPI.get activities([可选 ) Promise.<Response>

列出活动. 获取您的目标账户中创建的活动列表, 并具备按属性过滤和排序的能力 .

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.createAB 活性(机构,[可选 ) * Promise.<Response>

创建 AB 活动 . 创建一个包含指定内容的新AB活动,并返回创建的活动.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.createXTActivity(机构,[可选 ) * Promise.<Response>

创建 XT 活动 . 创建一个带有指定内容的新 XT 活动,并返回创建的活动.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.getAB ActivityById(id,[options]) QQ Promise.<Response>

获得AB活动. 如果发现AB活动为 id 引用, 获取当前定义 .

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.getXT activityById(id,[options]) QQ Promise.<Response>

获得XT活动. 如果发现 XT 活动为 id 引用, 请获取当前定义 .

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.updateAB 活性(id, body, [选项]) QQ Promise.<Response>

更新 AB 活动 . 用请求中提供的内容更新AB活动定义。 这可以改变现有活动的状况和行为.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.updateXT 活性(id, body, [选项]) QQ Promise.<Response>

更新 XT 活动 . 更新当前 XT 活动的定义,如果它被找到为 id 引用的话.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI. set activityName (id, name, [options]) Promise.<Response>

更新活动名称 . 更新所提供 ID 引用的 AB 活动名称.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.set activity State(id, state,[options]) * Promise.<Response>

更新活动状态 . 如果发现某项活动为id所引用,则更新活动状态.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

coreAPI.set activity Priority(id,优先级,[可选 ) * Promise.<Response>

更新活动优先级 . 更新某项活动的优先级,如果它被找到为 id 参考.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.set activitySchedule(id, 调度, [选项]) QQ Promise.<Response>

更新活动时间表 . 更新活动时间表,如果发现活动日期为编号.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标 CoreAPI.deleteAB 活动(id,[可选 ) QQ Promise.<Response>

删除AB活动. 删除如果找到 ID 引用的 AB 活动.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.deleteXTActivity(id,[可选 ) QQ Promise.<Response>

删除 XT 活性 . 如果发现 XT 活动为 id 所引用,则删除该活动的现有定义.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标 CoreAPI.get Activity ChangeLog(id,[可选 ) QQ Promise.<Response>

获取活动更改日志 . 返回给定活动 ID 的更改日志.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.getOffers([选项]) QQ Promise.<Response>

名单提供. 检索已创建内容报价列表. 通过查询字符串传递的参数是可选的,用于表示排序和过滤选项.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.get OfferById(id,[可选]) QQ Promise.<Response>

得到报价. 检索要约编号.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.create Offer( body,[可选 ) QQ Promise.<Response>

创建提供 . 创建由请求数据定义的新内容要约.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.update Offer(id, body, [options]) QQ Promise.<Response>

最新提议. 更新 ID 引用的内容.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.deleteOffer(id,[选项]) QQ Promise.<Response>

删除提议. 删除所提供 ID 引用的内容.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标 CoreAPI.get Auditences([可选 ) QQ Promise.<Response>

列出观众名单. 列出所有可用的受众, 并按每个可用的字段进行过滤和排序 .

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.createAuditence(机构,[可选 ) QQ Promise.<Response>

创建观众. 按请求内容指定创建新受众并返回新创建的受众定义.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标 CoreAPI.get AudenceById(id,[选项]) QQ Promise.<Response>

找观众. 获取所提供标识指定的受众定义.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.update 观众(id, body, [options]) QQ Promise.<Response>

更新观众. 以请求数据指定的新规则更新受众.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.deleteAudentence(id,[选项]) QQ Promise.<Response>

删除观众. 删除指定的标识所引用的受众.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.get Properties([选项]) QQ Promise.<Response>

列表属性. 获取属性列表 .

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.get PropertyById(id,[可选]) QQ Promise.<Response>

获取财产. 以地产身份收回地产...

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.getMBoxes([可选 ) QQ Promise.<Response>

列出 MBoxs . 为特定客户端列出所有可用的 mbox , 包含过滤和排序选项 .

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标 CoreAPI.getMBoxBy Name (名称, [选项]) Promise.<Response>

叫MBox来. 获取 mbox 参数列表 .

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.getMBoxProfile 属性([可选 ) QQ Promise.<Response>

获取配置属性 . 获取类型配置的可用配置属性和mbox参数列表.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

coreAPI.get environments([可选 ) Promise.<Response>

获取环境. 列出所有可用的环境, 包括过滤和排序选项 。 使用 Environments API 来获取与客户端设定的各种主机组对应的环境ID.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.getAB 实际操作(id,[可选 ) Promise.<Response>

获得AB活动性能. 由地产Id收回地产.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.getXT activity 性能(id,[可选 ) QQ Promise.<Response>

获得活动性能. 由地产Id收回地产.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.get activityPerformance(id,[选项]) * Promise.<Response>

获得活动性能. 检索所提供编号所参考的自动化个性化活动的执行情况报告数据.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标CoreAPI.get Orders Report(id,[options]) QQ Promise.<Response>

得到命令报告. 检索命令/审计报告AB、XT或自动个性化活动的数据.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

目标 CoreAPI. executeBatch(正体) QQ Promise.<Response>

执行 Batch APIs. 多个Admin API可以作为单批请求执行.

仁爱: 实例方法 TargetCoreAPI
回返数字 : Promise.<Response> - 承诺做出回应

init( 租户, apiKey, 代号) QQ Promise.<TargetCoreAPI>

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

仁爱:全球职能
回返数字 : Promise.<TargetCoreAPI> - 承诺解决目标CoreAPI事件

除错日志

LOG LEVEL = 调试 < your call here >

捐款

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

许可证发放

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