# Kwai 集成方案
TIP
请注意，第三方数据集成产生的数据会被纳入集群的消耗数据量
# 概要
# 接口简介
| 接口名 | 类型 | 粒度 | 归因 | 成本 | 收益 | 展示 | 点击 | 转化 |
|---|---|---|---|---|---|---|---|---|
| Marketing API | API | 聚合指标 | ✅ | ✅ | ✅ | ✅ |
目前 TE 支持接入快手海外商业平台 Kwai 的广告创意数据 (opens new window)，支持获取广告创意层级的成本、点击、展示等聚合指标数据
# 集成流程
- 登录 TE 后台，进入三方集成模块，新增 Kwai 集成方案，并完成相关配置，并复制授权回调地址
- 在Kwai 后台 (opens new window)创建新账号，使用管理员账号为该账号添加开发者角色。完成开发者申请并创建应用
- 回到 TE 后台，修改之前的 Kwai 集成方案，使用应用的 Client ID 与 secret，并打开授权链接完成授权
- 查看 TE 系统否成功接收数据，并完成报表搭建
# 一、方案配置
接入 Kwai 平台数据前，需要先在 TE 后台创建相应的集成方案，并获取授权回调地址，您可以按照本文档完成集成方案的创建
# 1.1 临时编写授权信息
首先点击授权信息栏的「配置授权信息」按钮，在弹出的授权信息弹窗中，先随意编写授权信息的三项，作为临时的授权信息。之后在完成 Kwai 平台的应用创建后，还需进行调整。
# 1.2 定时拉取
您可以在「定时拉取」模块设置 TE 系统定时拉取 Kwai Marketing API 数据的策略，可以选择在每天的某时拉取一段时间的数据。由于拉取的数据也会计算再数据量中，建议您在不要定时拉取太长时间的数据
# 1.3 拉取时区
您还可以设置拉取的数据的时区，默认为 UTC+8
# 1.4 入库设置
您可以控制数据是否以事件的形式写入，如果关闭，则数据将不会写入事件表，因此请不要关闭该配置。
# 1.5 集成配置
最后，您可以在集成配置模块对数据拉取的细节配置进行控制。包括数据的时间聚合粒度，拉取的指标字段与维度，以及入库后的事件名等。
集成配置中的内容是一个 JSON，您可以按照以下内容进行自定义配置：
| 模块 | 名称 | 含义 |
|---|---|---|
| sink_event | event_name | 入库后的事件名，可以自定义 |
| source | time_granularity | 数据的时间聚合粒度，即拉取的数据以天还是小时进行聚合 可选值: day、hour |
| transfer | double_columns | 指标字段，请不要修改 |
# 1.6 获取授权回调地址
在完成上述配置后，请点击右上角的保存并授权获取授权信息。请复制第一步中的授权回调地址，并妥善保管。之后点击「暂不授权」关闭该弹窗：
接着，点击「保存」按钮完成方案的保存，至此您暂时完成了 TE 后台的配置工作，接下来请在 Kwai 后台完成相关配置。
# 二、创建 Kwai 平台的开发者账号并创建应用
# 2.1 创建开发者角色账号
由于 Kwai 平台现阶段无法将非开发者角色（如优化师角色）的账号切换成开发者角色，开发者角色账号也无法切换成非开发者角色，因此您需要创建一个新账号并为其设置成开发者角色，具体的操作步骤如下：
首先进入Kwai 后台 (opens new window)页面，点击注册，创建新账号（建议使用公司邮箱注册，并妥善保管账号及密码）。
使用管理员账号登录Business Center (opens new window)，进入「权限管理」页面，点击「添加人员」
在「添加人员」页面，输入人员姓名，「绑定邮箱」处填入第一步中注册新账号时的邮箱；「选择团队归属」处选择与管理员所在团队一致的选项；「选择角色」处选择 Developer。完成配置后，之前创建的新账号就获得了开发者角色。
# 2.2 申请开发者权限
使用开发者角色账号登录Business Center (opens new window)，申请开发者并创建应用
- APP Name：即应用名称，可自定义
- Callback URL：授权回调地址，也就是您在 1.6 小节中获得的地址，请将其填写在此处
# 2.3 完成授权
在通过开发者审核后，可以在 APP List 中查看到之前创建的应用
点击应用后，可以查看应用的基本信息，请复制 CLIENT ID 与 Secret
# 三、回到 TE 后台，完成授权工作
完成 Kwai 后台的配置后，回到 TE 后台，进入到之前的创建的 Kwai 集成方案，点击「授权信息」：
接下来，请将您在 Kwai 后台获取到的 CLIENT ID 与 Secret 填入相应位置，Account ID List 中填入您需要拉取数据的 Kwai 广告平台账号 ID，多个 ID 之间用 "," 号分割。完成编辑后点击保存按钮：
接着点击右上角的「保存并授权」，再次进入到授权信息弹窗。此时点击「前往授权」，将打开 Kwai 平台的授权页面，请登录 Kwai 平台广告账号并完成授权
当您完成了授权之后，请在「授权信息」中点击左下角的「我已完成以上两步操作」后点击右下角的「完成授权」结束配置。至此，您完成了 Kwai 平台的数据集成。
# 四、数据入库
# 4.1 入库规则
- 由于创意报表是聚合数据，因此我们将使用一个固定值作为其用户标识，您可以认为所有数据挂载在一个虚拟用户上
- 使用数据中的 time 字段，即数据时间，作为事件的 #event_time
- 默认的事件名为：kwai_ads_creative_report
- 其他字段将全数入库
# 4.2 涵盖字段
广告创意数据支持拉取以下字段：
| 字段名 | 中文名与备注 |
|---|---|
| time | 时间戳（转成时间类型） |
| #zone_offset | 时区（从 timeZoneIana 提取） |
| accountid | 广告账户id |
| accountname | 广告账户name |
| campaignid | 广告计划id |
| campaignname | 广告计划名称 |
| unitid | 广告组id |
| unitname | 广告组名称 |
| creativeid | 广告创意id |
| creativename | 广告创意名称 |
| id | 广告创意id |
| cost | 消耗，与该账户投放平台中的币种保持一致。 数值 6 位精度，实际金额为 cost 除以 1000000 例：投放币种为美元，实际消耗 = cost / 1000000（ 美元） 注：TE 系统不会处理 cost 字段，但是标准化字段 te_ads_object.cost 会除以 1000000 |
| exposure | 展现数 |
| click | 点击数 |
| action | 转化数 |
| cpm | 千次曝光消耗，与该账户投放平台中的币种保持一致。 |
| cpc | 单次点击成本。与该账户投放平台中的币种保持一致。 |
| ctr | 点击率 |
| cvr | 转化率 |
| cpa | 平均转化成本，与该账户投放平台中的币种保持一致。 |
| play3s | 3秒播放数 |
| play5s | 5秒播放数 |
| playfinished | 完播数 |
| registration | 广告主回传的注册数，与该账户投放平台保持一致。 |
| costperregistration | 广告主回传的注册转化成本，与该账户投放平台保持一致。 |
| registrationrate | 广告主回传的注册转化率，与该账户投放平台保持一致。 |
| addtocart | 广告主回传的加入购物车数，与该账户投放平台保持一致。 |
| costperaddtocart | 广告主回传的加入购物车转化成本，与该账户投放平台保持一致。 |
| addtocartrate | 广告主回传的加入购物车转化率，与该账户投放平台保持一致。 |
| applaunch | 广告主回传唤端数，与该账户投放平台保持一致。 |
| costperapplaunch | 广告主回传的唤端转化成本，与该账户投放平台保持一致。 |
| applaunchrate | 广告主回传的唤端转化率，与该账户投放平台保持一致。 |
| activation | 广告主回传的激活数，与该账户投放平台保持一致。 |
| costperactivation | 广告主回传的激活转化成本，与该账户投放平台保持一致。 |
| activationrate | 广告主回传的激活转化率，与该账户投放平台保持一致。 |
| pageview | 广告主回传的页面浏览数，与该账户投放平台保持一致。 |
| costperpageview | 广告主回传的页面浏览转化成本，与该账户投放平台保持一致。 |
| pageviewrate | 广告主回传的页面浏览转化率，与该账户投放平台保持一致。 |
# 4.3 标准化字段
TE 系统会对以下字段进行标准化处理：
| 原始字段 | 标准化字段 | 含义 |
|---|---|---|
| accountid | te_ads_object.ad_account_id | 广告账号 ID |
| campaignid | te_ads_object.campaign_id | 广告计划id |
| campaignname | te_ads_object.campaign_name | 广告计划名称 |
| unitid | te_ads_object.ad_group_id | 广告组id |
| unitname | te_ads_object.ad_group_name | 广告组名称 |
| creativeid | te_ads_object.ad_id | 广告创意id |
| creativename | te_ads_object.ad_name | 广告创意名称 |
| exposure | te_ads_object.impressions | 曝光量 |
| click | te_ads_object.clicks | 点击量 |
| action | te_ads_object.installs | 转化数 |
| cost | te_ads_object.cost | 买量成本 |