GetHubSpot

文档中心 › 组件索引 › GetHubSpot

GetHubSpot Processor

类型全限定名:cn.org.acal.lynxus.processors.hubspot.GetHubSpot

所属 Bundle:cn.org.acal.lynxus:lynxus-hubspot-nar:2.11.8

描述

从私有 HubSpot 应用程序检索 JSON 数据。 该处理器仅在主节点上运行。

标签

hubspot

属性

下表中,加粗的属性为必填项;其余为可选项。表格同时标注默认值、是否支持表达式语言,以及是否为敏感属性(值会被加密)。

名称默认值可选值描述
Object Type
  • Companies — 在 HubSpot 中,companies 对象是一个标准 CRM 对象。单个公司记录可用于在公司属性中存储有关企业和组织的信息。
  • Contacts — 在 HubSpot 中,contacts 存储有关个人的信息。从营销自动化到智能内容,contact 记录中的潜在客户特定数据帮助用户利用 HubSpot 的许多功能。
  • Deals — 在 HubSpot 中,deal 表示销售团队正在与某个 contact 或 company 推进的进行中的交易。它会通过管道阶段进行跟踪,直到赢单或输单。
  • Line Items — 在 HubSpot 中,line items 可被视为 products 的子集。当某个 product 附加到 deal 时,它就成为一个 line item。可以创建专属于单个报价的 line items,但它们不会被添加到产品库中。
  • Products — 在 HubSpot 中,products 表示要出售的商品或服务。构建产品库允许用户快速将产品添加到交易、生成报价并报告产品绩效。
  • Tickets — 在 HubSpot 中,ticket 表示客户请求帮助或支持。
  • Quotes — 在 HubSpot 中,quotes 用于与潜在买家分享定价信息。
  • Calls — 获取 CRM 记录以及通话索引页面上的通话。
  • Emails — 获取 CRM 记录上的邮件。
  • Meetings — 获取 CRM 记录上的会议。
  • Notes — 获取 CRM 记录上的备注。
  • Tasks — 获取 CRM 记录上的任务。
请求的 HubSpot 对象类型
Access Token用于验证请求的访问令牌
敏感属性:是
Result Limit每次调用处理器请求的最大结果数
支持表达式语言:是(仅使用环境/系统变量求值)
增量加载true
  • true
  • false
处理器可以增量加载查询的对象,使每个对象仅被查询一次。对于每次查询,处理器在时间窗口内查询在上次运行时间和当前时间之间修改过的对象(可通过增量延迟属性进行调整)。
Incremental Delay30 sec时间窗口的结束时间戳将按此属性配置的量向前调整。例如,属性值为 10 秒时,结束时间戳 12:30:45 将变为 12:30:35。设置此属性可避免本地机器与 HubSpot 服务器时钟不同步时遗漏对象,并防止 HubSpot 在对象创建后更改最后更新时间戳的机制。
支持表达式语言:是(仅使用环境/系统变量求值)
Incremental Initial Start Time此属性指定处理器在运行第一个请求时应用的开始时间。预期格式为 UTC 日期时间,例如 '2011-12-03T10:15:30Z'
支持表达式语言:是(仅使用环境/系统变量求值)
Web Client Service Provider控制器服务 API:
WebClientServiceProvider
cn.org.acal.lynxus-lynxus-standard-services-api-nar-2.11.8
用于 HTTP 客户端操作的Controller Service

关系 (Relationships)

名称描述自动终止
success对于由于成功的 HTTP 请求而创建的 FlowFiles。否

写入的 FlowFile 属性

名称描述
mime.type将 MIME 类型设置为 application/json

状态管理

作用域描述
CLUSTER在增量加载的情况下,上次查询时间窗口的开始和结束时间戳存储在状态中。当设置'结果限制'属性时,执行请求后保存分页游标。仅检索分页游标之后的对象。最大检索对象数可在'结果限制'属性中设置。

受限 (Restricted)

该组件不受限。

输入要求

该组件不允许有传入连接。

详细说明

GetHubSpot

认证方式

该 Processor 适用于 HubSpot 私有应用。必须创建一个 HubSpot 私有应用(参见 HubSpot 私有应用创建), 才能连接到 HubSpot 并发起请求。目前唯一支持的认证方式是 Private App Access Token。

增量加载

HubSpot 对象可以由 Lynxus 增量处理。即只处理在 Processor 上次运行之后创建或修改的对象。可以在上下文菜单中重置 Processor 状态。增量加载基于对象的最后修改时间。

分页

GetHubSpot 同时支持分页和增量。如果结果数量超过 'Result Limit',剩余的 对象会在下一次 Processor 运行时返回。

由于 HubSpot API 的分页处理机制,不支持并行删除。如果在获取两页 之间删除了任何对象,部分对象可能会被遗漏。