Adobe I/O Adobe 分析 SDK

节点 Javascription 核心 SDK 包装 Adobe 分析2.0 APIs。 。 。 .

安装

$ npm install

使用量

1. 初始化 SDK

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

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

Init 方法返回类实例 AnalyticsCoreAPI

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

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

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

    //get report suites
    const collections = await analyticsClient.getCollections({limit:5, page:0})

    //get metrics
    const metrics = await analyticsClient.getMetrics(rsid)

    //generate report
    const report = await analyticsClient.getReport(queryJSON)
}

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

类

分析算法

这个类提供了将Adobe Analytics APIs称为的方法. 在调用任何方法之前, 通过调用它的方法初始化实例 带有有效公司代号、 apiKey 和 认证标志

职能

init( companyId, apiKey, 符号) ⇒ Promise.<AnalyticsCoreAPI>

返回以新的 Analytics CoreAPI 对象解析的保证 .

分析算法

这个类提供了将Adobe Analytics APIs称为的方法. 在调用任何方法之前, 通过调用它的方法初始化实例 带有有效公司代号、 apiKey 和 认证标志

仁爱: 全球类

• 分析算法
  • .init( companyId, apiKey, 代号) ⇒ AnalyticsCoreAPI
  • .get计算公式(选项)
  • .get计算公式ById(id,选项)
  • .获得集合(选项)
  • .get CollectionById(rsid, 选项)
  • .GetDate Ranges( 选项)
  • .GetDate RangById(日期 RangId,选项)
  • .Get Dimensions( lisid, 选项)
  • .get DimensionById(dimensionId, rsid, 选项) 主题
  • .Get Metrics( 参数, 选项)
  • .get MetricById(id, rsid, 选项)
  • .get 报告(正文)
  • .getSects(选项)
  • .校正部分(正文,正文)
  • 用户( 选项)
  • .get当前用户()
  • .get UsageLogs( 开始日期、 结束日期、 选项)

分析 CoreAPI.init( companyId, apiKey, 令牌) QQ AnalyticsCoreAPI

初始化 sdk.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get 计算计量(选项)

检索出许多计算出的度量衡. 计算出的度量响应将始终包括这些默认项目: id,名称,描述,rsid,所有者,极性,精度,类型 其他属性可以通过“ 扩展” 字段选择请求:\ n\ n 修改:计量标准被最后一次修改的日期(ISO 8601) 定义:作为 JSON 对象的计算参数定义 相容性: 与该计量标准相容的产品 报告套件Name: 另返回 RSID 的友好报告套件名称 标记 *: 给出所有与已计算度量相关的已存在的标记

关于计算指标的更多信息 这里

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get Calculated MetricById(id,选项)

由 id 获取一个单个计算度量. 计算出的度量响应将始终包括这些默认项目: id,名称,描述,rsid,所有者,极性,精度,类型 其他属性可以通过“ 扩展” 字段选择请求:\ n\ n 修改:计量标准被最后一次修改的日期(ISO 8601) 定义:作为 JSON 对象的计算参数定义 相容性: 与该计量标准相容的产品 报告套件Name: 另返回 RSID 的友好报告套件名称 标记 *: 给出所有与已计算度量相关的已存在的标记

关于计算指标的更多信息 这里

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI. 获得集合( 选项)

检索报告匹配给定过滤器的套件. 在一个集合中返回所有报告套件类型.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get CollectionById(lisid, 选项)

取回身份报告套件. 在一个集合中返回所有报告套件类型.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.getDate Ranges( 选项)

返回用户的日期范围列表. 此功能允许用户存储常用的日期范围, 这样可以在整个产品中重新使用 .

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.getDate RangById(日期RangId,选项)

为 Date Range 获取配置...

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get Dimensions(sid, 选项)

返回特定报告套件的尺寸列表.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get DimensionById(dimensionId, rsid, 选项)

返回给定的报告套件的尺寸和尺寸 Id .

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get Metrics( 参数, 选项)

返回给定的报告套件的衡量标准列表. 这返回主要用于Analytics产品的度量衡列表. 平台身份 API 返回所支持系统所有可能的度量衡列表.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get MetricById(id, rsid, 选项)

返回给定的报告套件的衡量标准. 这返回主要用于Analytics产品的度量衡列表. 平台身份 API 返回所支持系统所有可能的度量衡列表.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get 报告(正文)

为请求运行报告. 见 报告用户指南 详细情况.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.getSegments( 选项)

收回所有部分.

仁爱: 实例方法 AnalyticsCoreAPI

分析器 CoreAPI.validateSecment(sid,正文)

A 验证部分. 返回报告后正文所载段的验证.

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get users( 选项)

返回当前用户登录公司的用户列表 . 为 auth\ntoken 指定的公司检索所有用户列表 .

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.get 当前用户( )

获取当前用户 .

仁爱: 实例方法 AnalyticsCoreAPI

分析 CoreAPI.getUsageLogs( 启动日期、 结束日期、 选项)

检索所提供的搜索标准的使用情况和访问日志. 这个 API 在3 个月内返回指定日期范围的使用和访问日志 。 此 API 用 IMS 用户令牌认证 .

仁爱: 实例方法 AnalyticsCoreAPI

init( companyId, apiKey, 代号) QQ Promise.<AnalyticsCoreAPI>

返回以新的 Analytics CoreAPI 对象解析的保证 .

仁爱:全球职能

除错日志

LOG LEVEL = 调试 < your call here >

捐款

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

许可证发放

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