跳转到主要内容

`tap-linkedin-ads` 是一个基于Meltano SDK构建的Singer tap,用于LinkedIn。

项目描述

tap-linkedin-ads

Singer tap用于从LinkedIn Ads营销API中提取数据。

使用Meltano Singer SDK构建。

功能

  • 目录
  • 状态
  • 发现
  • 关于
  • 流映射
  • 模式展平

设置

设置 必需 默认 描述
access_token True None 用于验证API服务的令牌
start_date True None 同步的最早记录日期
end_date False 2023-05-09 02:04:18.151589 同步的最新记录日期
user_agent False tap-linkedin-ads <api_user_email@your_company.com> API ID
api_version False 202207 LinkedInAds API版本
accounts True None LinkedInAds账户ID
campaign True None LinkedInAds活动ID
owner True None LinkedInAds所有者ID
stream_maps False None 用于流映射功能的配置对象。有关更多信息,请参阅Stream Maps
stream_map_config False None 在映射表达式中使用的用户定义配置值。
flattening_enabled False None 'True'以启用模式展平并自动展开嵌套属性。
flattening_max_depth False None 展平模式的最大深度。

通过运行以下命令可以获得支持的设置和功能的完整列表: tap-linkedin-ads --about

所有者

对于从VideoAds端点提取数据,需要`owner`设置。您可以通过对adAccounts端点进行请求来找到所有者ID。

https://api.linkedin.com/rest/adAccounts?q=search&start=0&count=10

所有者ID可以在响应的"reference"下找到:"urn:li:organization:{OWNER}"

安装

pipx install git+https://github.com/MeltanoLabs/tap-linkedin-ads.git@main

身份验证

此应用需要LinkedInAds OAuth 2.0访问令牌来发送API请求

访问令牌需要以下权限

r_ads:读取广告 rw_ads:读写广告 r_ads_reporting:读取广告报告

访问令牌60天后过期,用户需要手动再次进行身份验证。更多信息请参阅LinkedInAds API文档

使用方法

AdAnalytics API列限制

LinkedInAds API中的AdAnalytics端点一次最多可调用20列,我们可以创建包含20列的子类,然后可以使用get records函数合并它们的输出。

SDK X-Restli-Protocol限制

creatives端点需要将X-Restli-Protocol设置为2.0.0。使用tap-linkedin-ads的请求URL使用括号‘()’。在请求URL中通常对括号进行编码,但当X-Restli-Protocol为2.0.0时则不进行编码。目前正在进行的SDK更新是为了扩展转义字符[GitHub问题链接]

元数据列

  • add_metadata_columns: 将此配置设置为'true'将添加_SDC_BATCHED_AT_SDC_DELETED_AT_SDC_EXTRACTED_AT元数据列到加载的表中

Elastic License 2.0

许可方授予您一项非独占的、免费的、全球性的、不可再分发的、不可转让的使用、复制、分发、提供和制作衍生作品的软件许可权。

直接执行Tap

tap-linkedin-ads --version
tap-linkedin-ads --help
tap-linkedin-ads --config CONFIG --discover > ./catalog.json

贡献

此项目使用父子流。了解更多信息在这里

初始化开发环境

pipx install poetry
poetry install

创建和运行测试

lib_tap_linkedin_ads_sdk/tests子文件夹中创建测试,然后运行

poetry run pytest

您也可以使用poetry run直接测试tap-linkedin-ads CLI界面

poetry run tap-linkedin-ads --help

使用Meltano进行测试

注意:此Tap可以在任何Singer环境中运行,且不需要Meltano。此处所示示例仅为方便和简化端到端编排场景。

接下来,安装Meltano(如果您尚未安装)和所需插件

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-linkedin-ads
meltano install tap-linkedin-ads

现在您可以使用Meltano进行测试和编排

# Test invocation:
meltano invoke tap-linkedin-ads --version
# OR run a test `elt` pipeline:
meltano elt tap-linkedin-ads target-jsonl

SDK开发指南

请参阅开发指南以获取有关如何使用SDK开发自己的Tap和目标的更多说明。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装软件包的信息。

源代码发行版

meltano_tap_linkedin_ads-0.0.1a2.tar.gz (15.4 kB 查看哈希值)

上传时间

构建发行版

meltano_tap_linkedin_ads-0.0.1a2-py3-none-any.whl (15.4 kB 查看哈希值)

上传时间 Python 3

支持者