Moloco 数据集成解决方案
最近更新日期:2022-05-18
一、集成方案介绍
请注意,第三方数据集成产生的数据会被纳入集群的消耗数据量
概要
本文将介绍如何将 Moloco 的数据回传到 Agentic Engine(后文简称 AE 系统) ,本方案支持:
- 通过 Moloco Report API 回传聚合指标数据,数据中包含曝光、点击、安装、收入、成本指标
- 通过 Moloco Log API 回传用户粒度原始数据,涵盖曝光、点击、转化数据
在开始接入 Moloco 数据前,请确保您已经阅读 AE 系统数据规则,理解 AE 的数据结构。另外,建议您将拉取数据所需的信息交给我们的客户成功经理,格式可参考数据集成配置信息模板。
流程
Moloco 数据的接入流程如下:
-
登录您的 Moloco 账号,获取 Workplace ID
-
向 AE 工作人员提供用于 API 调用的 Moloco 账号、密码以及 Workplace ID
-
确定数据拉取的方式:
- 通过 Moloco Report API 回传聚合指标数据
- 通过 Moloco Log API 回传用户粒度原始数据
-
确定数据拉取的数据维度、指标类型、拉取频率以及拉取时间范围
-
由 AE 工作人员完成数据拉取开发工作
-
在 AE 后台搭建看板、报表,并完成数据验收
二、集成前准备工作
2.1 获取 Workplace ID
在调用 API 之前,首先需要获取 Workplace ID。登录您的 Moloco 账号,在界面左侧栏中点击Settings 按钮进入设置页面。进入设置页后,可以在 Information 标签页获取 Workplace ID,具体可参考下图。
图1、Workplace ID 获取方式
2.2 提供 Moloco 账号和密码,以及 Workplace ID
调用 Moloco API 需要使用 Token,而生成 Token 需要使用您的 Moloco 账号和密码,以及上一步中获取的 Workplace ID。
由于 Token 的有效期只有一个小时,因此需要您向 AE 工作人员提供您的 Moloco 账号、密码以及 Workplace ID,系统在拉取数据时同时生成新的 Token。我们将严格遵守保密原则,杜绝这些信息的泄露。Token 生成的详细机制,可以查看 Moloco 官网文档。
您还可以创建一个新的 Moloco 账号来专门用于 API 调用,创建新账号的方法可以参照下图。另外,您还可以查看本文档了解更多创建新账号的信息。
图2、创建新用户示意图
三、数据拉取
Moloco 提供了两种数据拉取方式,分别是回传聚合指标数据的 Report API,以及回传用户粒度原始数据的 Log API。
3.1 Report API
接口基本信息
| 接口名 | API 类型 | 产品化 | 数据粒度 | 归因数据 | 成本数据 | 收益数据 | 展示数据 | 点击数据 | 转化数据 |
|---|---|---|---|---|---|---|---|---|---|
| Report API | 拉式 | 否 | 聚合数据 | 是 | 是 | 是 | 是 | 是 |
Report API 是聚合数据接口,该接口将返回一定时间范围内的指标数据。具体信息可以查看 Report API 官网文档
3.1.1 涵盖指标
Report API 的数据中包含五个指标字段分别为:
- impressions:曝光数
- clicks:点击数
- installs:安装数
- spend:买量成本
- revenue:变现收益
3.1.2 接口参数
-
广告账户:
- Report API 拉取数据时,需要指定待拉取数据的广告账户。我们将尝试拉取所有广告账户的数据,如果您需要指定拉取的广告账户列表,请在数据集成配置信息模板中注明
-
时间:
- 可以拉取以天为单位、 UTC 时间的数据
-
可选维度:
-
Moloco Report API 提供了以下分析维度,在默认情况下,我们将选用所有维度,以获取维度最细致的数据:
- DATE
- APP_OR_SITE
- CAMPAIGN
- CREATIVE_GROUP
- CREATIVE
- EXCHANGE
- SUB_PUBLISHER
- TRAFFIC
-
3.1.3 入库数据结构
- 由于 Report API 是聚合数据,因此我们将使用一个固定值作为其用户标识,您可以认为所有数据挂载在一个虚拟用户上
- 使用数据中的 date 字段,即数据的日期,设置为聚合数据的 #event_time
- Report API 的数据事件名为 -- moloco_report
- 以下是 Report API 的入库字段:
------------------------维度字段------------------------
ad_account_currency
ad_account_id
ad_account_title
ad_group_id
ad_group_title
app_id
app_os
app_store_id
app_title
campaign_country
campaign_id
campaign_title
creative_id
creative_main_asset_location
creative_title
creative_type
creative_group_id
creative_group_title
exchange_id
site_domain
site_id
site_title
skan_conversion_value
skan_metric_conversion_count
sub_publisher_id
sub_publisher_title
traffic_is_lat
traffic_mmp_effective
traffic_skan_bid
------------------------指标字段(数值类型)------------------------
clicks
impressions
installs
revenue
spend
3.2 Log API
| 接口名 | API 类型 | 产品化 | 数据粒度 | 归因数据 | 成本数据 | 收益数据 | 展示数据 | 点击数据 | 转化数据 |
|---|---|---|---|---|---|---|---|---|---|
| Log API | 拉式 | 否 | 用户级别 | 是 | 是 | 是 | 是 | 是 | 是 |
Log API 是用户粒度原始数据,提供了非常丰富的用户数据。其主要提供三类明细数据,分别为:
- IMP,即曝光数据(impression),其中包含了展示数据以及展示的成本数据
- CLICK,即点击数据,其中包含了点击数据,以及该用户之前的展示数据与展示成本数据
- CONVERSION,即转化数据,其中包含了从 MMP 获取的转化数据、归因数据、成本数据、收益数据以及该用户之前的曝光、点击数据
由于 Log API 的明细数据以 ADID(即 GAID)和 IDFA 标识具体的用户,因此如果需要将 Moloco 的明细数据关联到 AE 用户上,则您需要将 ADID 和 IDFA 记录在 AE 的用户属性中,或者将 ADID 和 IDFA 设置为 AE 用户的 #distinct_id。否则明细数据将无法和其他 AE 用户数据进行关联。
3.2.1 接口参数
- 广告账户:
- Log API 拉取数据时,需要指定待拉取数据的广告账户。我们将尝试拉取所有广告账户的数据,如果您需要指定拉取的广告账户列表,请在数据集成配置信息模板中注明
- 时间:
- 每天 3AM - 4AM (UTC) 可以拉取前一天(UTC)的数据
3.2.2 入库数据结构
- 三类数据明细数据具体的返回字段以及含义,可查看 Moloco 官网文档:https://help.moloco.com/hc/en-us/articles/360047856254-Log-data-field-specification
- 我们会将返回数据中的 req_device_ifa 作为标识用户的 ID。请注意将 ADID 和 IDFA 设置为 AE 用户的 #distinct_id 或设置在 AE 的用户属性中
- 以下是三类明细数据共有的字段:
req_exchange
req_timestamp
req_app_bundle
req_app_publisher_id
req_device_ifa
req_device_os
req_device_osv
req_device_carrier
req_device_connectiontype
req_device_hwv
req_device_make
req_device_model
req_device_devicetype
req_device_language
req_device_ip
req_device_lmt
req_device_geo_country
req_device_geo_utcoffset
req_device_geo_region
req_device_geo_metro
req_device_geo_city
req_device_geo_zip
req_imp_bidfloor
req_imp_tagid
req_imp_banner_w
req_imp_banner_h
req_imp_video_maxduration
req_imp_video_minduration
req_imp_video_w
req_imp_video_h
req_imp_video_skip
req_imp_video_ext_is_rewarded
req_imp_native_ext_has_image
req_imp_native_ext_has_video
req_imp_instl
bid_mtid
bid_adaccount_id
bid_adaccount_title
bid_app_id
bid_app_title
bid_app_store_id
bid_campaign_id
bid_campaign_title
bid_adgroup_id
bid_adgroup_title
bid_creativegroup_id
bid_creativegroup_title
bid_creative_id
bid_creative_title
bid_creative_type
bid_creative_w
bid_creative_h
bid_creative_size_in_bytes
bid_creative_video_duration
bid_user_bucket
bid_adslot_type
bid_adslot_w
bid_adslot_h
bid_traffic_skan
IMP 数据(Impression)
以下是 IMP 数据特有的字段:
- 其中的 imp_timestamp,即曝光发生的时间,将会被设置为该条数据的 #event_time
- IMP数据的事件名为 -- moloco_log_imp
- 特有字段如下:
imp_timestamp
imp_cost_moloco_micro
imp_cost_currency
imp_cost_fee_percent
imp_cost_total_micro
imp_ip
CLICK 数据
以下是 CLICK 数据特有的字段:
- 其中的 click_timestamp,即点击发生的时间,将会被设置为该条数据的 #event_time
- CLICK 数据的事件名为 -- moloco_log_click
- 特有字段如下:
click_timestamp
click_type
click_ip
CONVERSION 数据
以下是 CONVERSION 数据特有的字段:
- 其中的 cv_attribution_timestamp,即归因发生的时间,将会被设置为该条数据的 #event_time
- CONVERSION 数据的事件名为 -- moloco_log_conversion
- 特有字段如下:
cv_mmp
cv_event
cv_timestamp
cv_attribution_timestamp
cv_attribution_is_view_through
cv_revenue_amount
cv_revenue_currency
cv_revenue_amount_usd
cv_postback
3.2.3 用户属性的处理
目前,我们暂未将 Moloco Log API 明细数据中的字段设置为用户属性,如果您需要将部分字段写入用户属性,请在数据集成配置信息模板中进行写明。
四、数据集成配置信息模板
在阅读完以上文档之后,建议您完成以下信息模板,并发送给您在 ThinkingAI 的客户成功经理,我们将根据该信息模板完成 Moloco 的数据拉取:
数据接口:Moloco API
---------
公司名称:XXX
AE 项目环境:(SAAS/私有化)
AE 项目名称:XXX
AE 项目 APP ID: XXX
数据接收地址 push_url: XXX
---------
Moloco 账号名:XXX
Moloco 账号密码:XXX
Moloco Workplace ID:XXX
广告主 ID (ad_account_id)列表:XXX, XXX
---------
Report API 配置
时间范围:yyyy/mm/dd - yyyy/mm/dd
分组维度:DATE, APP_OR_SITE, CAMPAIGN, CREATIVE_GROUP, CREATIVE, EXCHANGE, SUB_PUBLISHER, TRAFFIC
---------
Log API 配置
历史数据拉取时间范围:yyyy/mm/dd - yyyy/mm/dd
事件类型:IMP, CLICK, CONVERSION
需要设置为用户属性的字段:XXX
五、联调测试和数据使用
联调测试
可以在 AE 系统后台的「数据管理」—「事件管理」页面 或「SQL IDE」页面搜索以下事件是否入库:
-
Report API 对应的事件:
- moloco_report
-
Log API 对应的事件:
- moloco_log_imp
- moloco_log_click
- moloco_log_conversion

