`tap-hubspot` 是一个用于 tap-hubspot 的 Singer 插件，使用 Meltano Singer SDK 构建。
项目描述
tap-hubspot
tap-hubspot 是一个用于 Hubspot 的 Singer 插件。
使用 Meltano Singer SDK 构建。
功能
目录状态发现关于流映射模式展平批量
设置
| 设置 | 必需 | 默认 | 描述 |
|---|---|---|---|
| access_token | False | None | 用于验证 API 服务的令牌 |
| client_id | False | None | OAuth 应用客户端 ID。 |
| client_secret | False | None | OAuth 应用客户端密钥。 |
| refresh_token | False | None | OAuth 应用刷新令牌。 |
| start_date | False | None | 同步的最早记录日期 |
| end_date | False | None | 同步的最新记录日期 |
| stream_maps | False | None | 流映射功能的配置对象。更多信息请参阅 Stream Maps。 |
| stream_map_config | False | None | 在映射表达式中使用的用户定义的配置值。 |
| flattening_enabled | False | None | 'True' 以启用模式展平并自动扩展嵌套属性。 |
| flattening_max_depth | False | None | 展平模式的最大深度。 |
| batch_config | False | None |
通过运行 tap-hubspot --about 可获取支持的设置和功能的完整列表。
Elastic License 2.0
许可方授予您非排他性、免版税、全球性、不可转授、不可转让的使用、复制、分发、提供和创建衍生作品的软件许可。
安装
pipx install git+https://github.com/ryan-miranda-partners/tap-hubspot.git
使用环境变量进行配置
此 Singer 水龙头会自动导入工作目录中 .env 文件内的任何环境变量，如果提供了 --config=ENV，则配置值将被考虑，如果终端上下文或 .env 文件中设置了匹配的环境变量。
源身份验证和授权
进行 API 请求需要 Hubspot 访问令牌。（更多信息请参阅 Hubspot API 文档）
权限
要将以下作用域添加到您的访问令牌以访问以下端点
- 联系人：
crm.schemas.contacts.read或crm.objects.contacts.read - 用户：
settings.users.read - 票务流水线：
media_bridge.read或crm.schemas.custom.read或timeline或tickets或e-commerce或crm.objects.goals.read - 交易流水线：
media_bridge.read或crm.schemas.custom.read或timeline或tickets或e-commerce或crm.objects.goals.read - 属性：所有
票务、crm.objects.deals.read、sales-email-read、crm.objects.contacts.read、crm.objects.companies.read、e-commerce、crm.objects.quotes.read - 所有者：
crm.objects.owners.read - 公司：
crm.objects.companies.read - 交易：
crm.objects.deals.read - 反馈提交：
crm.objects.contacts.read - 行项目：
e-commerce - 产品：
e-commerce - 票务：
tickets - 报价：
crm.objects.quotes.read或crm.schemas.quotes.read - 目标：
crm.objects.goals.read - 电子邮件：
sales-email-read
有关流和权限的更多信息，请查看 Hubspot API 文档。
用法
您可以使用 Meltano 或单独运行 tap-hubspot。
使用 v1 端点的流
以下流使用 Hubspot API 中的 v1（旧版）端点
- 票务流水线 & 交易流水线：v3 端点需要管道 ID 参数来调用 API。因此，您只能从 v3 中拉取单个管道 ID 的数据，而 v1 API 允许您从所有管道中拉取数据。
- 电子邮件订阅：v3 端点需要您设置单个电子邮件地址以拉取订阅数据，而 v1 端点允许您从所有电子邮件中拉取数据。
流继承
此项目使用父子流。更多关于它们的信息请参见 这里。
直接执行水龙头
tap-hubspot --version
tap-hubspot --help
tap-hubspot --config CONFIG --discover > ./catalog.json
开发者资源
按照以下说明为该项目做出贡献。
初始化您的开发环境
pipx install poetry
poetry install
创建和运行测试
在 tests 子文件夹中创建测试，然后运行
poetry run pytest
您还可以使用 poetry run 直接测试 tap-hubspot CLI 接口
poetry run tap-hubspot --help
使用 Meltano 进行测试
注意：此水龙头在任何 Singer 环境中都可以工作，无需 Meltano。此处所示示例仅用于方便和简化端到端编排场景。
您的项目已附带一个自定义的 meltano.yml 项目文件，已创建。打开 meltano.yml 并遵循文件中列出的任何 "TODO" 项。
接下来，安装 Meltano（如果尚未安装）和任何需要的插件
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-hubspot
meltano install
现在您可以使用 Meltano 进行测试和编排
# Test invocation:
meltano invoke tap-hubspot --version
# OR run a test `elt` pipeline:
meltano elt tap-hubspot target-jsonl
SDK 开发指南
有关如何使用 SDK 开发自己的 taps 和目标的更多信息，请参阅 开发指南。
下载文件
下载您平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源分布
构建分布
meltano_tap_hubspot-0.5.0.post1.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 1c09b467bf0c88a167b2f8a8bfc7df09be78b628af44c055490c5c9e559562ef |
|
| MD5 | bec2a1520c06d80cecc6650a908f9715 |
|
| BLAKE2b-256 | d9716f8319679c9b89e9d943b94000cf8b1c57656e039d91fbcf7797b3eb8929 |
meltano_tap_hubspot-0.5.0.post1-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | dbb2cfd240196442d9159ba3b649c919af21bb33f8914b159d408afb9ade34cc |
|
| MD5 | 7f9720323eafa27c1ead34562efdcca8 |
|
| BLAKE2b-256 | ac125b0715f1693539b52af1dadda742c9117fc9eae3ed61afe8f4187b7cacb4 |