# Moloco Report API
TIP
请注意,第三方数据集成产生的数据会被纳入集群的消耗数据量
# 概要
# 接口简介
接口名 | 类型 | 粒度 | 归因 | 成本 | 收益 | 展示 | 点击 | 转化 |
---|---|---|---|---|---|---|---|---|
Report API | API | 聚合指标 | ✅ | ✅ | ✅ | ✅ | ✅ |
Report API (opens new window) 是聚合数据接口,该接口将返回一定时间范围内的指标数据,包括了成本、收益、展示、点击、转化等数据
# 集成流程
- 登录您的 Moloco 账号,获取 Workplace ID
- 登录 TE 后台,进入三方集成模块,新增 Moloco Report API 方案,并完成相关配置
- 查看 TE 系统否成功接收数据,并完成报表搭建
# 一、获取授权信息
# 1.1 获取 Workplace ID
在调用 API 之前,首先需要获取 Workplace ID。登录您的 Moloco 账号,在界面左侧栏中点击Settings 按钮进入设置页面。进入设置页后,可以在 Information 标签页获取 Workplace ID,具体可参考下图。
# 1.2 提供 Moloco 账号和密码
调用 Moloco API 需要使用 Token,而生成 Token 需要使用您的 Moloco 账号和密码。如果您不希望直接使用日常使用的账号,您还可以创建一个新的 Moloco 账号来专门用于 API 调用,创建新账号的方法可以参照下图
# 1.3 获取广告账号 ID
最后,您还需要获取所有需要拉取数据的广告账号的 ID,您可以参照下图获得广告账号 ID。您可以配置多个广告账号,因此建议您获取所有需要拉取数据的广告账号的 ID
# 1.4 总结
您需要在 Moloco 后台获取以下信息:
- Workplace ID
- Moloco 账号名,即 Email
- Moloco 账号密码
- 所有需要拉取数据的广告账号的 ID
# 二、方案配置
当您获得了 Moloco 的授权信息后,您可以登录 TE 系统后台,在「三方集成」模块中完成 Moloco Report API 的配置,下图是 Moloco 的配置界面:
# 2.1 授权信息配置
点击「授权信息」按钮,在弹出框内填写您在授权工作中获取到的信息
请依次填入
- Workplace ID:之前获得的 Workplace ID
- Email:Moloco 账号名
- Password:Moloco 账号的密码
- Ad Account ID:需要拉取数据的广告账号的 ID,如果有多个,请使用 "," 号分割
# 2.2 定时拉取
您可以在「定时拉取」模块设置 TE 系统定时拉取 Moloco Report API 数据的策略,可以选择在每天的某时或者每小时拉取一段时间的数据。由于拉取的数据也会计算再数据量中,建议您在不要定时拉取太长时间的数据
# 2.3 事件表入库设置
打开「事件表入库设置」开关后,回传的数据都将写入到事件表中,我们建议您开启事件数据入库。
# 2.4 集成配置
您可以在集成配置模块对数据拉取的细节配置进行控制。比如入库后的事件名,数据拉取维度等。
集成配置中的内容是一个 JSON,您可以按照以下内容进行自定义配置:
模块 | 名称 | 含义 |
---|---|---|
sink_event | event_name | 入库后的事件名,可以自定义 |
source | group_by | 数据中的分组维度,列表类型 |
transfer | double_columns | 入库的指标字段,请不要修改 |
以下是支持的分组维度,默认情况下我们会获取所有维度的数据。每个维度对应多个入库字段,您可以在下表中看到对应关系。如果需要调整,可以修改 source.group_by,将需要拉取的分组维度的维度名填入其中
维度 | 入库字段名 | 是否默认 | 说明 |
---|---|---|---|
默认带有 | ad_account_currency | 是 | 广告账号所用币种 |
ad_account_id | 是 | 广告账号 ID | |
ad_account_title | 是 | 广告账号名 | |
DATE | date | 是 | 日期 |
APP_OR_SITE | app_id | 是 | App 唯一 ID |
app_os | 是 | App 所在平台 | |
app_store_id | 是 | APP 应用商城 ID | |
app_title | 是 | App 名 | |
site_domain | 是 | 站点域名 | |
site_id | 是 | 站点 ID | |
site_title | 是 | 站点名 | |
CAMPAIGN | campaign_country | 是 | 广告计划对应国家地区 |
campaign_id | 是 | 广告计划 ID | |
campaign_title | 是 | 广告计划名 | |
AD_GROUP | ad_group_id | 是 | 广告组 ID |
ad_group_title | 是 | 广告组名 | |
CREATIVE_GROUP | creative_group_id | 是 | 素材组 ID |
creative_group_title | 是 | 素材组名 | |
CREATIVE | creative_id | 是 | 素材 ID |
creative_main_asset_location | 是 | 素材地址 URL | |
creative_title | 是 | 素材名 | |
creative_type | 是 | 素材类型 | |
EXCHANGE | exchange_id | 是 | 交易唯一 ID |
SUB_PUBLISHER | sub_publisher_id | 是 | Sub Publisher ID |
sub_publisher_title | 是 | Sub Publisher 名 | |
TRAFFIC | traffic_is_lat | 是 | 是否开启了 LAT,布尔值 |
traffic_mmp_effective | 是 | 是否可以被归因 | |
traffic_skan_bid | 是 | 是否包含 SKAN 的响应 |
以下是支持的指标字段:
字段 | 说明 |
---|---|
impressions | 曝光数 |
clicks | 点击数 |
installs | 安装数 |
spend | 买量成本 |
revenue | 变现收益 |
# 2.5 入库规则
- 使用数据中的 date 字段,即数据的日期,设置为聚合数据的 #event_time
- Report API 数据默认的事件名为 -- moloco_report
- 其余字段都将会入库
# 2.6 标准化字段
以下事件属性会进行标准化处理:
原始字段 | 标准化字段 | 含义 |
---|---|---|
ad_account_id | te_ads_object.ad_account_id | 广告账号 ID |
campaign_title | te_ads_object.campaign_name | 广告计划名 |
campaign_id | te_ads_object.campaign_id | 广告计划 ID |
ad_group_title | te_ads_object.ad_group_name | 广告组名,变现广告的 Unit 名 |
ad_group_id | te_ads_object.ad_group_id | 广告组 ID,变现广告的 Unit ID |
creative_group_title | te_ads_object.ad_name | 广告名 |
creative_group_id | te_ads_object.ad_id | 广告 ID |
app_store_id | te_ads_object.app_id | 应用 ID |
app_title | te_ads_object.app_name | 应用名 |
app_osapp_os | te_ads_object.platform | 平台,即 Android、iOS 等 |
campaign_country | te_ads_object.country | 国家地区编码 |
ad_account_currency | te_ads_object.currency | 成本或收益的币种 |
impressions | te_ads_object.impressions | 曝光量 |
clicks | te_ads_object.clicks | 点击量 |
installs | te_ads_object.installs | 转化量(安装) |
spend | te_ads_object.cost | 买量成本 |
revenue | te_ads_object.revenue | 变现收益 |