快手广告数据集成解决方案
最近更新时间:2022-07-27
一、集成方案介绍
请注意,第三方数据集成产生的数据会被纳入集群的消耗数据量
概要
本文将介绍如何将快手磁力引擎广告数据回传到 Agentic Engine(后文简称 AE 系统) ,本方案支持:
- 通过快手 Marketing API 回传聚合指标数据,数据中包含曝光、点击、安装、成本、转化指标
在开始接入快手广告数据前,请确保您已经阅读 AE 系统数据规则,理解 AE 的数据结构。另外,建议您将拉取数据所需的信息交给我们的客户成功经理,格式可参考数据集成配置信息模板。
流程
-
注册快手开发者账号,并创建应用
-
向 ThinkingAI 工作人员提供快手应用的 APP_ID,以及需要接入的 AE 项目的 APP ID,ThinkingAI 工作人员将提供回调链接,请将该链接设置为快手应用的回调链接
-
打开 ThinkingAI 工作人员提供的授权地址,完成授权
-
确定数据拉取的方式:
- 广告主数据
- 广告创意数据(自定义)
- 程序化创意 2.0 数据
- 流量助推订单数据
-
确定数据拉取的数据维度、指标类型、拉取频率以及拉取时间范围
-
由 ThinkingAI 工作人员完成数据拉取开发工作
-
在 AE 后台搭建看板、报表,并完成数据验收
二、集成前准备工作
2.1 注册快手开发者账号
在调用快手 Marketing API 前,您需要准备一个快手开发者账号,此处建议您按照快手官方文档的流程,完成开发者账号的注册。
2.2 配置回调地址并完成授权
- 在完成快手开发者账号的注册后,接下来您需要在应用管理中填写应用内容生成对应应用
- 应用内容中包含授权回调链接,您需要向 ThinkingAI 工作人员提供申请应用后快手返回的应用 app_id 以及您需要接入的 AE 项目的 APP ID。ThinkingAI 工作人员将提供给您回调链接,请将该地址填入快手应用管理的相应位置。
- 完成设置后,ThinkingAI 工作人员将提供给您授权链接,点击授权链接后,将跳出以下页面。请记录此处的「快手 ID」,并将其提供给 ThinkingAI 工作人员。接着点击「基于用户授权」,勾选「同意使用协议」后,点击「确认授权」完成授权工作
三、数据拉取
快手 Marketing API 提供了多种数据类型,目前 AE 系统支持的数据类型有:
- 广告主数据
- 广告创意数据(自定义)
- 程序化创意 2.0 数据
- 流量助推订单数据
3.1 广告主数据
接口基本信息
| 接口名 | API 类型 | 产品化 | 数据粒度 | 归因数据 | 成本数据 | 收益数据 | 展示数据 | 点击数据 | 转化数据 |
|---|---|---|---|---|---|---|---|---|---|
| 广告主数据 | 拉式 | 否 | 聚合数据 | 是 | 是 | 是 | 是 |
3.1.1 接口参数
-
广告主账户:
- 需要指定需要拉取数据的广告主账号 ID
-
时间:
- 以整天或小时为时间单位的数据
- 指标的时间粒度可选天粒度或小时粒度
3.1.2 涵盖字段
广告主数据的指标包含了多种业态(比如网店、直播带货等)的指标数据,本节仅选取部分常用指标,如需了解完整的指标列表,可以查看【广告主数据】文档:
- 指标字段
| 指标 | 描述 |
|---|---|
| charge | 花费(元) |
| show | 封面曝光数 |
| photo_click | 封面点击数 |
| aclick | 素材曝光数 |
| bclick | 行为数 |
| photo_click_ratio | 封面点击率 |
| impression_1k_cost | 平均千次曝光花费(元) |
| photo_click_cost | 平均点击单价(元) |
| action_cost | 平均行为单价(元) |
| share | 分享数 |
| comment | 评论数 |
| like | 点赞数 |
| follow | 新增关注数 |
| cancel_follow | 取消关注数 |
| report | 举报数 |
| block | 拉黑数 |
| negative | 减少此类作品数 |
| download_started | 应用下载数据-安卓下载开始数 |
| download_completed | 应用下载数据-安卓下载完成数 |
| activation | 应用下载数据-激活数 |
| event_pay_first_day | 应用下载数据-首日付费次数 |
| event_pay_purchase_amount_first_day | 应用下载数据-首日付费金额 |
| event_pay_first_day_roi | 应用下载数据-首日 ROI |
| event_pay | 应用下载数据-付费次数 |
| event_pay_purchase_amount | 应用下载数据-付费金额 |
| event_pay_roi | 应用下载数据-ROI |
| event_register | 应用下载数据-注册数 |
| event_register_cost | 应用下载数据-注册成本 |
| event_register_ratio | 应用下载数据-注册率 |
| event_order_paid | 应用下载数据-付款成功数 |
| event_order_paid_purchase_amount | 应用下载数据-付款成功金额 |
| event_order_paid_cost | 应用下载数据-单次付款成本 |
| played_end | 播放完成 |
| played_three_seconds | 有效播放数 |
| click_1k_cost | 平均千次素材曝光花费(元) |
| event_button_click | 按钮点击数 |
| event_button_click_cost | 按钮点击成本:当日消耗 / 按钮点击数 |
| event_button_click_ratio | 按钮点击率:按钮点击数 / 行为数 |
| play_end_ratio | 完播率:按钮点击数 / 行为数 |
| event_watch_app_ad | 广告观看 |
| event_ad_watch_times | 广告观看次数 |
| event_ad_watch_times_ratio | 广告观看次数转化率 |
| event_ad_watch_times_cost | 广告观看次数成本 |
| ad_show | 广告曝光 |
| click_conversion_ratio | 点击激活率 |
| conversion_cost | 激活单价 |
| download_completed_cost | 安卓下载完成单价(元) |
| download_completed_ratio | 安卓下载完成率 |
| download_conversion_ratio | 下载完成激活率 |
| download_started_cost | 安卓下载开始单价(元) |
| download_started_ratio | 安卓下载开始率 |
| conversion_num | 转化数(回传时间归因) |
| conversion_num_cost | 转化成本(回传时间归因) |
| conversion_ratio | 转化率(回传时间归因) |
- 维度字段
| 维度 | 描述 |
|---|---|
| advertiser_id | 广告账号 ID |
| campaign_id | 广告计划 ID |
| campaign_name | 广告计划名称 |
| unit_id | 广告组 ID |
| unit_name | 广告组名称 |
| creative_id | 广告创意 ID |
| creative_name | 广告创意名称 |
| status | 1 - 投放中;2 - 已暂停;3 - 已删除 |
3.1.3 入库规则
默认情况下,我们会将拉取的数据以事件形式写入 AE 项目中:
- 由于广告主数据是聚合数据,因此我们将使用一个固定值作为其用户标识,您可以认为所有数据挂载在一个虚拟用户上
- 使用数据中的 stat_date 与 stat_hour 字段,即日期与小时的拼接值,作为数据的 #event_time
- 数据事件名为 -- kuaishou_ads_account_report
- 其余字段都将会入库
3.2 广告创意数据(自定义)
接口基本信息
| 接口名 | API 类型 | 产品化 | 数据粒度 | 归因数据 | 成本数据 | 收益数据 | 展示数据 | 点击数据 | 转化数据 |
|---|---|---|---|---|---|---|---|---|---|
| 广告创意数据(自定义) | 拉式 | 否 | 聚合数据 | 是 | 是 | 是 | 是 |
如果您在磁力引擎后台配置了一个「创意制作方式」为「自定义」的广告,可以使用本接口获取数据:
3.2.1 接口参数
-
广告主账户:
- 需要指定需要拉取数据的广告主账号 ID
-
时间:
- 以整天或小时为时间单位的数据
- 指标的时间粒度可选天粒度或小时粒度
3.2.2 涵盖字段
广告创意数据的指标包含了多种业态(比如网店、直播带货等)的指标数据,本节仅选取部分常用指标,如需了解完整的指标列表,可以查看【广告创意数据-自定义】文档:
- 指标字段
| 指标 | 描述 |
|---|---|
| charge | 花费(元) |
| show | 封面曝光数 |
| photo_click | 封面点击数 |
| aclick | 素材曝光数 |
| bclick | 行为数 |
| photo_click_ratio | 封面点击率 |
| impression_1k_cost | 平均千次曝光花费(元) |
| photo_click_cost | 平均点击单价(元) |
| action_cost | 平均行为单价(元) |
| share | 分享数 |
| comment | 评论数 |
| like | 点赞数 |
| follow | 新增关注数 |
| cancel_follow | 取消关注数 |
| report | 举报数 |
| block | 拉黑数 |
| negative | 减少此类作品数 |
| download_started | 应用下载数据-安卓下载开始数 |
| download_completed | 应用下载数据-安卓下载完成数 |
| activation | 应用下载数据-激活数 |
| event_pay_first_day | 应用下载数据-首日付费次数 |
| event_pay_purchase_amount_first_day | 应用下载数据-首日付费金额 |
| event_pay_first_day_roi | 应用下载数据-首日 ROI |
| event_pay | 应用下载数据-付费次数 |
| event_pay_purchase_amount | 应用下载数据-付费金额 |
| event_pay_roi | 应用下载数据-ROI |
| event_register | 应用下载数据-注册数 |
| event_register_cost | 应用下载数据-注册成本 |
| event_register_ratio | 应用下载数据-注册率 |
| event_order_paid | 应用下载数据-付款成功数 |
| event_order_paid_purchase_amount | 应用下载数据-付款成功金额 |
| event_order_paid_cost | 应用下载数据-单次付款成本 |
| click_1k_cost | 平均千次素材曝光花费(元) |
| event_button_click | 按钮点击数 |
| event_button_click_cost | 按钮点击成本:当日消耗 / 按钮点击数 |
| event_button_click_ratio | 按钮点击率:按钮点击数 / 行为数 |
| play_end_ratio | 完播率:按钮点击数 / 行为数 |
| event_watch_app_ad | 广告观看 |
| event_ad_watch_times | 广告观看次数 |
| event_ad_watch_times_ratio | 广告观看次数转化率 |
| event_ad_watch_times_cost | 广告观看次数成本 |
| ad_show | 广告曝光 |
| click_conversion_ratio | 点击激活率 |
| conversion_cost | 激活单价 |
| download_completed_cost | 安卓下载完成单价(元) |
| download_completed_ratio | 安卓下载完成率 |
| download_conversion_ratio | 下载完成激活率 |
| download_started_cost | 安卓下载开始单价(元) |
| download_started_ratio | 安卓下载开始率 |
| conversion_num | 转化数(回传时间归因) |
| conversion_num_cost | 转化成本(回传时间归因) |
| conversion_ratio | 转化率(回传时间归因) |
- 维度字段
| 维度 | 描述 |
|---|---|
| advertiser_id | 广告账号 ID |
| campaign_id | 广告计划 ID |
| campaign_name | 广告计划名称 |
| unit_id | 广告组 ID |
| unit_name | 广告组名称 |
| creative_id | 广告创意 ID |
| creative_name | 广告创意名称 |
| status | 1 - 投放中;2 - 已暂停;3 - 已删除 |
3.2.3 入库规则
默认情况下,我们会将拉取的数据以事件形式写入 AE 项目中:
- 由于广告创意数据是聚合数据,因此我们将使用一个固定值作为其用户标识,您可以认为所有数据挂载在一个虚拟用户上
- 使用数据中的 stat_date 与 stat_hour 字段,即日期与小时的拼接值,作为数据的 #event_time
- 数据事件名为 -- kuaishou_ads_creative_report
- 其余字段都将会入库
3.3 程序化创意 2.0 数据
接口基本信息
| 接口名 | API 类型 | 产品化 | 数据粒度 | 归因数据 | 成本数据 | 收益数据 | 展示数据 | 点击数据 | 转化数据 |
|---|---|---|---|---|---|---|---|---|---|
| 程序化创意 2.0 数据 | 拉式 | 否 | 聚合数据 | 是 | 是 | 是 | 是 |
如果您在磁力引擎后台配置了「创意制作方式」为「程序化创意」的广告,可使用本接口获取数据:
3.3.1 接口参数
-
广告主账户:
- 需要指定需要拉取数据的广告主账号 ID
-
时间:
- 精确到小时的时间范围的数据
- 指标的时间粒度可选天粒度或小时粒度
3.3.2 涵盖字段
程序化创意数据的指标包含了多种业态(比如网店、直播带货等)的指标数据,本节仅选取部分常用指标,如需了解完整的指标列表,可以查看【程序化创意 2.0 数据】文档:
- 指标字段
| 指标 | 描述 |
|---|---|
| charge | 花费(元) |
| show | 封面曝光数 |
| photo_click | 封面点击数 |
| aclick | 素材曝光数 |
| bclick | 行为数 |
| photo_click_ratio | 封面点击率 |
| impression_1k_cost | 平均千次曝光花费(元) |
| photo_click_cost | 平均点击单价(元) |
| action_cost | 平均行为单价(元) |
| share | 分享数 |
| comment | 评论数 |
| like | 点赞数 |
| follow | 新增关注数 |
| cancel_follow | 取消关注数 |
| report | 举报数 |
| block | 拉黑数 |
| negative | 减少此类作品数 |
| download_started | 应用下载数据-安卓下载开始数 |
| download_completed | 应用下载数据-安卓下载完成数 |
| activation | 应用下载数据-激活数 |
| event_pay_first_day | 应用下载数据-首日付费次数 |
| event_pay_purchase_amount_first_day | 应用下载数据-首日付费金额 |
| event_pay_first_day_roi | 应用下载数据-首日 ROI |
| event_pay | 应用下载数据-付费次数 |
| event_pay_purchase_amount | 应用下载数据-付费金额 |
| event_pay_roi | 应用下载数据-ROI |
| event_register | 应用下载数据-注册数 |
| event_register_cost | 应用下载数据-注册成本 |
| event_register_ratio | 应用下载数据-注册率 |
| event_order_paid | 应用下载数据-付款成功数 |
| event_order_paid_purchase_amount | 应用下载数据-付款成功金额 |
| event_order_paid_cost | 应用下载数据-单次付款成本 |
| played_end | 播放完成 |
| played_three_seconds | 有效播放数 |
| click_1k_cost | 平均千次素材曝光花费(元) |
| event_button_click | 按钮点击数 |
| event_button_click_cost | 按钮点击成本:当日消耗 / 按钮点击数 |
| event_button_click_ratio | 按钮点击率:按钮点击数 / 行为数 |
| play_end_ratio | 完播率:按钮点击数 / 行为数 |
| event_watch_app_ad | 广告观看 |
| event_ad_watch_times | 广告观看次数 |
| event_ad_watch_times_ratio | 广告观看次数转化率 |
| event_ad_watch_times_cost | 广告观看次数成本 |
| ad_show | 广告曝光 |
| click_conversion_ratio | 点击激活率 |
| conversion_cost | 激活单价 |
| download_completed_cost | 安卓下载完成单价(元) |
| download_completed_ratio | 安卓下载完成率 |
| download_conversion_ratio | 下载完成激活率 |
| download_started_cost | 安卓下载开始单价(元) |
| download_started_ratio | 安卓下载开始率 |
| conversion_num | 转化数(回传时间归因) |
| conversion_num_cost | 转化成本(回传时间归因) |
| conversion_ratio | 转化率(回传时间归因) |
- 维度字段
| 维度 | 描述 |
|---|---|
| campaign_id | 计划 ID |
| campaign_name | 计划名称 |
| unit_id | 组 ID |
| unit_name | 组名称 |
| creative_id | 创意 ID |
| photo_url | 视频链接 |
| photo_id | 视频 ID |
| image_token | 封面 ID |
| cover_url | 封面链接 |
| description | 作品广告语 |
| pic_id | 图片库图片ID |
| pic_list | 联盟图片(横版/竖版) |
| pic_url_list | 联盟图片 URL(横版/竖版) |
3.3.3 入库规则
默认情况下,我们会将拉取的数据以事件形式写入 AE 项目中:
- 由于程序化创意 2.0 数据是聚合数据,因此我们将使用一个固定值作为其用户标识,您可以认为所有数据挂载在一个虚拟用户上
- 使用数据中的 stat_date 与 stat_hour 字段,即日期与小时的拼接值,作为数据的 #event_time
- 数据事件名为 -- kuaishou_ads_program_creative_report
- 其余字段都将会入库
3.4 流量助推订单数据
接口基本信息
| 接口名 | API 类型 | 产品化 | 数据粒度 | 归因数据 | 成本数据 | 收益数据 | 展示数据 | 点击数据 | 转化数据 |
|---|---|---|---|---|---|---|---|---|---|
| 流量助推订单数据 | 拉式 | 否 | 聚合数据 | 是 | 是 | 是 | 是 |
流量助推数据将获取过去 30 天创建的流量助推订单在昨天的消耗情况
3.4.1 接口参数
- 广告主账户:
- 需要指定需要拉取数据的广告主账号 ID
3.4.2 涵盖字段
流量助推数据的指标与分析维度是固定的,以下是所有字段:
- 指标字段
| 指标 | 描述 |
|---|---|
| amount | 金额 |
| consume_amount | 消耗金额 |
| view | 封面曝光数 |
| play | 播放数 |
| action | 行为数 |
| conversion | 激活数 |
| play_percent | 封面点击率 |
| action_percent | 行为率 |
| cpm | cpm |
| cpc_of_action | 平均行为单价 |
| cpa | 激活单价 |
- 维度字段
| 维度 | 描述 |
|---|---|
| supplement_order_id | 助推订单 ID |
| task_id | 任务 ID |
| order_id | 聚星订单 ID |
| star_user_id | 达人 ID |
| account_id | account_id |
| unit_ids | unit_id |
| star_name | 达人名称 |
| status | 状态 |
| promotion_begin_time | 推广开始时间 |
| promotion_end_time | 推广结束时间 |
| target_type | 投放人群类型 |
| unit_type | 优化目标/投放目标 |
| unit_price | 出价/目标成本 |
| supplement_order_sense_id | 广告资源位 |
| android_app_name | Android 应用名称 |
| package_name | Android 应用包名 |
3.4.3 入库规则
默认情况下,我们会将拉取的数据以事件形式写入 AE 项目中:
- 由于流量助推订单的投后数据是聚合数据,因此我们将使用一个固定值作为其用户标识,您可以认为所有数据挂载在一个虚拟用户上
- 使用昨天的日期(即 'YYYY-MM-DD 00:00:00')作为数据的 #event_time
- 数据事件名为 -- kuaishou_ads_supplement_report
- 其余字段都将会入库
四、数据集成配置信息模板
在阅读完以上文档之后,建议您完成以下信息模板,并发送给您在 ThinkingAI 的客户成功经理:
数据接口:快手磁力引擎 Marketing API
---------
公司名称:XXX
AE 项目环境:(SAAS/私有化)
AE 项目名称:XXX
AE 项目 APP ID: XXX
---------
磁力引擎应用管理页 APP_ID及secret:XXX
助推接口筛选的app包名:xxx
---------
拉取数据类型:(广告主/自定义广告创意/程序化创意 2.0/流量助推订单的投后数据)
需要拉取数据的广告主(广告账号)ID 列表:XXX,XXX
需要拉取的字段:XXX,XXX
历史数据拉取时间范围:yyyy/mm/dd - yyyy/mm/dd
定时拉取:每天 X 点拉取前一天的数据
五、数据校验和使用
可在事件分析内对以下事件(数据集)进行分析:
- kuaishou_ads_account_report
- kuaishou_ads_creative_report
- kuaishou_ads_program_creative_report
- kuaishou_ads_supplement_report

