穿山甲 Gromore 集成方案

TIP

请注意，第三方数据集成产生的数据会被纳入集群的消耗数据量

概要

接口简介

接口名	类型	粒度	归因	成本	收益	展示	点击	转化
聚合数据 API	API	聚合指标			✅	✅	✅

穿山甲 Gromore 提供了聚合数据报告 API (opens new window)，您可以通过该接口获取聚合的变现广告曝光、点击与收益数据

集成流程

1. 在穿山甲后台，获取聚合数据报告API文档的 Security key 、RoleId 以及用户的 UserId
2. 登录 TE 后台，进入三方集成模块，新增 穿山甲 Gromore 集成，创建集成方案
3. 查看 TE 系统否成功接收数据，并完成报表搭建

一、获取授权信息

接入穿山甲 Gromore 数据的第一步，您需要登录穿山甲后台，在左侧栏选择【接入】-【API 接入文档】，点击下图所示部分，获取用户的 Security key 与 RoleId

另外，您还需要获取用户的 UserId，您可以查看页面右上角，用户名之下的 ID 字段即为 UserId

二、方案配置

当您获取了穿山甲 Gromore 平台的授权信息后，您可以登录 TE 系统，在「三方集成」模块中完成新方案的配置。下图是穿山甲 Gromore 聚合数据 API 的配置界面，请您按照本章节内容完成方案的创建：

2.1 授权信息配置

点击「授权信息」按钮，在弹出框内填写您在 穿山甲 Gromore 平台中获取到的信息

2.2 定时拉取

您可以在「定时拉取」模块设置 TE 系统定时拉取穿山甲 Gromore 数据的策略，可以选择在每天的某时或者每小时拉取一段时间的数据。由于拉取的数据也会计算再数据量中，建议您在不要定时拉取太长时间的数据

2.3 拉取时区

您还可以设置拉取的数据的时区，默认为 UTC+8

2.4 事件表入库设置

打开「事件表入库设置」开关后，回传的数据都将写入到事件表中，我们建议您开启事件数据入库。

2.5 集成配置

最后，您可以在集成配置模块对数据拉取的细节配置进行控制。包括数据的时间聚合粒度，拉取的指标字段与维度，以及入库后的事件名等。

集成配置中的内容是一个 JSON，您可以按照以下内容进行自定义配置：

模块	名称	含义
sink_event	event_name	入库后的事件名，可以自定义，字符串类型。
source	report_types	数据拉取的维度，主要选择的是天级报表与小时级报表，可以选择： 天级报表：day 小时级报表：hour
	metrics	对应接口的指标字段，列表类型，可以自定义
	group_by	对应接口的维度字段，列表类型，可以自定义

由于天级别报表和小时级报表有较大区别，建议您直接使用对应报表的配置模板，或对模板进行微调

2.5.1 小时级数据报表模板

小时级数据报表也是我们默认拉取的数据报表，您可以直接使用以下模板：

{
  "sink_event": {
    "event_name": "csj_gromore_report"
  },
  "source": {
    "group_by": [
      "site_id",
      "adunittype",
      "adunit_id",
      "network",
      "code_id",
      "os",
      "sdk_version",
      "segment",
      "site_version",
      "channel"
    ],
    "report_types": [
      "hour"
    ],
    "metrics": [
      "api_ecpm",
      "api_imp_cnt",
      "api_revenue",
      "req_cnt",
      "ret_cnt",
      "fill_rate",
      "clk_cnt",
      "clk_rate",
      "imp_cnt",
      "ssr",
      "ecpm",
      "revenue"
    ]
  }
}

• 涵盖指标

以下是小时级数据报表支持的指标，如需调整，请将指标名加在 source.metrics 中：

字段	描述	备注	是否默认
api_ecpm	通过 Reporting API 获取预估Ecpm	只有使用 code_id 作为分组时才可使用	是
api_imp_cnt	通过 Reporting API 获取预估展示数		是
api_revenue	通过 Reporting API 获取预估收益		是
waterfall_req_cnt	流量请求量	在使用 network 和code_id 分组时不返回
waterfall_send_cnt	流量返回量
waterfall_sr	流量填充率
req_cnt	广告请求量		是
ret_cnt	广告返回量		是
fill_rate	广告填充率		是
clk_cnt	点击量		是
clk_rate	点击率		是
imp_cnt	展示量		是
ssr	展示率		是
ecpm	预估 eCPM		是
revenue	预估收益		是

- 分析维度

小时级数据报表提供了以下聚合维度。如需调整，请将维度名加在 source.group_by 中：

维度	字段	描述	默认
site_id	site_id	gromore聚合管理中的应用ID	是
adunittype	adunittype	聚合管理中广告位的类型	是
adunit_id	ad_unit_name	广告位名称	是
	adunit_id	广告位 ID	是
network	network	代码位所属的广告网络	是
code_id	code_name	代码位名称	是
	code_id	代码位ID	是
os	os	系统类型	是
sdk_version	sdk_version	SDK 版本
segment	segemt_id	流量分组 ID
site_version	site_version	应用版本
channel	channel	渠道信息
必有字段	user_id	媒体账号 ID	是
	role_id	子账号 ID	是
	currency	币种	是

- 入库规则

使用数据中的 start_date 与 end_date 字段，即数据聚合的小时字段，设置为聚合数据的 #event_time

默认的事件名为 -- csj_gromore_report

2.5.2 天级数据报表模板

天级数据报表与小时级数据报表存在一些差异，您可以使用以下模板，或遵循被小节内容对拉取字段进行自定义：

{
    "sink_event":
    {
        "event_name": "csj_gromore_report"
    },
    "source":
    {
        "group_by":
        [
            "site_id",
            "ad_unit_type",
            "ad_unit_id",
            "network",
            "code_id"
        ],
        "report_types":
        [
            "day"
        ],
        "metrics":
        [
            "req_cnt",
            "ret_cnt",
            "fill_rate",
            "imp_cnt",
            "ssr",
            "clk_cnt",
            "clk_rate",
            "ecpm",
            "revenue",
            "api_ecpm",
            "api_revenue",
            "api_imp_cnt",
            "api_req_cnt",
            "api_ret_cnt",
            "api_clk_cnt",
            "api_ssr",
            "api_fill_rate",
            "api_show_gap_rate",
            "api_click_gap_rate"
        ]
    }
}

• 涵盖指标

以下是天级数据报表支持的指标，如需调整，请将指标名加在 source.metrics 中：

字段	描述	备注	是否默认
waterfall_req_cnt	流量请求量	在使用 network 和code_id 分组时不返回
waterfall_send_cnt	流量返回量
waterfall_sr	流量填充率
req_cnt	广告请求量		是
ret_cnt	广告返回量		是
fill_rate	广告填充率		是
imp_cnt	展示量		是
ssr	展示率		是
clk_cnt	点击量		是
clk_rate	点击率		是
ecpm	预估 eCPM		是
revenue	预估收益		是
api_ecpm	通过 Reporting API 获取的预估 eCPM	如果想要查询这些指标，需要在Gromore平台配置广告网络后才支持返回数据。	是
api_revenue	通过 Reporting API 获取的预估收益		是
api_imp_cnt	通过 Reporting API 获取的预估展示数		是
api_req_cnt	通过 Reporting API 获取的广告请求数		是
api_ret_cnt	通过 Reporting API 获取的广告返回数		是
api_clk_cnt	通过 Reporting API 获取的广告点击数		是
api_ssr	通过 Reporting API 获取的展示率		是
api_fill_rate	通过 Reporting API 获取的填充率		是
api_show_gap_rate	通过 Reporting API 获取的展示量与广告平台统计展示量的差异，公式为 展示gap = (imp_cnt - api_imp_cnt) / api_imp_cnt		是
api_click_gap_rate	通过 Reporting API 获取的点击量与广告平台统计点击量的差异，公式为 点击gap =(点击 - 点击API) / 点击API		是

- 分析维度

天级数据报表提供了以下聚合维度，如需调整，请将维度名加在 source.group_by 中：

维度	字段	描述	默认
site_id	site_id	gromore聚合管理中的应用ID	是
ad_unit_type	ad_unit_type	聚合管理中广告位的类型	是
ad_unit_id	ad_unit_name	广告位名称	是
	ad_unit_id	广告位 ID	是
network	network	代码位所属的广告网络	是
code_id	code_name	代码位名称	是
	code_id	代码位ID	是
segment	segemt_id	流量分组
sdk_version	sdk_version	SDK 版本
site_version	site_version	应用版本
channel	channel	渠道信息
user_type	user_type	用户类型
必有字段	os	系统类型	是
	user_id	媒体账号 ID	是
	role_id	子账号 ID	是
	currency	币种	是

- 入库规则

使用数据中的 date 字段，即数据聚合的天级字段，设置为聚合数据的 #event_time

默认的事件名为 -- csj_gromore_report

2.6 标准化字段

字段	标准化字段	描述
currency	te_ads_object.currency	币种
ad_unit_name	te_ads_object.ad_group_name	广告位名称
ad_unit_id	te_ads_object.ad_group_id	广告位 ID
adunit_id	te_ads_object.ad_group_id	广告位 ID
network	te_ads_object.media_source	代码位所属的广告网络
code_name	te_ads_object.ad_name	代码位名称
code_id	te_ads_object.ad_id	代码位ID
os	te_ads_object.platform	系统类型
user_id	te_ads_object.ad_account_id	媒体账号 ID
imp_cnt	te_ads_object.impressions	展示量
clk_cnt	te_ads_object.clicks	点击量
revenue	te_ads_object.revenue	预估收益