Moloco Log API
请注意,第三方数据集成产生的数据会被纳入集群的消耗数据量
Moloco Log API 已废弃,AE 后台中显示为「Log API(废弃)」。建议改用 Moloco Report API。
概要
接口简介
| 接口名 | 类型 | 粒度 | 归因 | 成本 | 收益 | 展示 | 点击 | 转化 |
|---|---|---|---|---|---|---|---|---|
| Log API | API | 用户数据 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Log API 是用户粒度原始数据,提供了非常丰富的用户数据。
集成流程
- 登录您的 Moloco 账号,获取 Workplace ID
- 登录 AE 后台,进入三方集成模块,新增 Moloco Log API 方案,并完成相关配置
- 查看 AE 系统是否成功接收数据,并完成报表搭建
一、获取授权信息
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 的授权信息后,您可以登录 AE 系统后台,在「三方集成」模块中完成 Moloco Log API 的配置,下图是 Moloco 的配置界面:
2.1 授权信息配置
点击「授权信息」下的「配置授权信息」按钮,在弹出框内填写您在授权工作中获取到的信息
请依次填入
- Workplace ID:之前获得的 Workplace ID
- Email:Moloco 账号名
- Password:Moloco 账号的密码
- Ad Account ID:需要拉取数据的广告账号的 ID,如果有多个,请使用 "," 号分割
2.2 事件表入库设置
打开「事件表入库设置」开关后,回传的数据都将写入到事件表中,我们建议您开启事件数据入库。
2.3 集成配置
您可以在集成配置模块对数据拉取的细节配置进行控制。比如入库后的事件名,数据拉取维度等。
集成配置中的内容是一个 JSON,您可以按照以下内容进行自定义配置:
| 模块 | 名称 | 含义 |
|---|---|---|
| sink_event | event_mapping | 入库后的事件名,可以自定义,不同报表可以有不同的命名,Key 的值对应 source.report_types |
| source | report_types | 拉取的报表类型 |
| transfer | double_columns | 入库的指标字段,请不要修改 |
Log API 提供了三类明细数据,分别为:
- IMP,即曝光数据(impression),其中包含了展示数据以及展示的成本数据
- CLICK,即点击数据,其中包含了点击数据,以及该用户之前的展示数据与展示成本数据
- CONVERSION,即转化数据,其中包含了从 MMP 获取的转化数据、归因数据、成本数据、收益数据以及该用户之前的曝光、点击数据
- 三类数据明细数据具体的返回字段以及含义,可查看 Moloco 官网文档
由于 Log API 的明细数据以 ADID(即 GAID)和 IDFA 标识具体的用户,且不能设置自定义用户识别字段。因此 AE 系统暂时没有提供用户识别字段与用户属性入库能力,Log API 的入库数据只会写入事件表,且数据归属于一个虚拟用户上。
默认情况下,这三类数据我们都会接入,如果需要进行调整,可以将需要的报表名写入 source.report_types 中
2.3.1 共有字段
- 以下是三类明细数据共有的字段:
| 入库字段名 | 说明 |
|---|---|
| req_exchange | 竞价的广告交易平台 |
| req_timestamp | 竞价请求时间 |
| req_app_bundle | 应用包名 |
| req_app_publisher_id | 流量主 ID |
| req_device_ifa | 设备 ID,如 ADID、IDFA |
| req_device_os | 设备平台、如 ios、android |
| 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 | 设备 IP 地址 |
| req_device_lmt | 是否开启 LAT |
| req_device_geo_country | 国家地区代号 |
| req_device_geo_utcoffset | 时区偏移分钟数 |
| req_device_geo_region | 美国的地区代号 |
| req_device_geo_metro | Google metro code |
| req_device_geo_city | 城市 |
| req_device_geo_zip | 邮编 |
| req_imp_bidfloor | 最低竞价价格 |
| req_imp_tagid | 广告 Placement 或 标签 ID |
| req_imp_banner_w | Banner 宽度 |
| req_imp_banner_h | Banner 高度 |
| 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 | 是否允许 Banner 广告 |
| req_imp_native_ext_has_video | 是否允许视频广告 |
| req_imp_instl | 是否允许插屏广告 |
| bid_mtid | Moloco 的竞价唯一 ID |
| bid_advertiser_id | 广告主 ID |
| bid_advertiser_title | 广告主名 |
| bid_campaign_id | Campaign ID |
| bid_campaign_title | Campaign 名 |
| bid_adgroup_id | 广告组 ID |
| bid_adgroup_title | 广告组名 |
| bid_creativegroup_id | 素材组 ID |
| bid_creativegroup_title | 素材组名 |
| bid_creative_id | 素材 ID |
| bid_creative_title | 素材名 |
| bid_creative_type | 素材类型 |
| bid_creative_w | 素材宽度 |
| bid_creative_h | 素材高度 |
| bid_creative_size_in_bytes | 素材大小 |
| bid_creative_video_duration | 视频持续时间,如果不是视频则为 0 |
| bid_user_bucket | 用户的流量分组 |
| bid_adslot_type | 广告槽位类型 |
| bid_adslot_w | 广告槽位宽度 |
| bid_adslot_h | 广告槽位高度 |
2.3.2 IMP 数据(Impression)
以下是 IMP 数据特有的字段:
| 入库字段名 | 说明 |
|---|---|
| imp_timestamp | 曝光时间 |
| imp_cost_moloco_micro | 曝光原始花费,美元计价,放大一百万倍 |
| imp_cost_currency | 曝光币种 |
| imp_cost_fee_percent | 曝光服务费用,美元计价,放大一百万倍 |
| imp_cost_total_micro | 曝光总花费,美元计价,放大一百万倍 |
| imp_ip | IP 地址 |
- 其中的 imp_timestamp,即曝光发生的时间,将会被设置为该条数据的 #event_time
- IMP 数据默认的事件名为 -- moloco_log_imp
2.3.3 CLICK 数据
以下是 CLICK 数据特有的字段:
| 入库字段名 | 说明 |
|---|---|
| click_timestamp | 点击时间 |
| click_type | 点击类型 |
| click_ip | IP 地址 |
- 其中的 click_timestamp,即点击发生的时间,将会被设置为该条数据的 #event_time
- CLICK 数据的事件名为 -- moloco_log_click
2.3.4 CONVERSION 数据
以下是 CONVERSION 数据特有的字段:
| 入库字段名 | 说明 |
|---|---|
| conversion_mmp | 合作伙伴 |
| conversion_event | 从合作伙伴处获得的事件回调名 |
| conversion_timestamp | 从合作伙伴处获得数据的时间 |
| conversion_attribution_timestamp | 转化数据时间 |
| conversion_attribution_is_view_through | 是否浏览转化 |
| conversion_attribution_is_engaged_view_through | 是否互动浏览转化 |
| conversion_revenue_amount | 回传的收益 |
| conversion_revenue_currency | 回传收益的币种 |
| conversion_revenue_amount_usd | 回传的美元收益 |
| conversion_postback | 原始回调数据 |
- 其中的 conversion_attribution_timestamp,即归因发生的时间,将会被设置为该条数据的 #event_time
- CONVERSION 数据的事件名为 -- moloco_log_conversion
2.4 标准化字段
以下事件属性会进行标准化处理:
| 原始字段 | 标准化字段 | 含义 |
|---|---|---|
| bid_advertiser_id | te_ads_object.ad_account_id | 广告账号 ID |
| bid_campaign_title | te_ads_object.campaign_name | 广告计划名 |
| bid_campaign_id | te_ads_object.campaign_id | 广告计划 ID |
| bid_adgroup_title | te_ads_object.ad_group_name | 广告组名,变现广告的 Unit 名 |
| bid_adgroup_id | te_ads_object.ad_group_id | 广告组 ID,变现广告的 Unit ID |
| bid_creativegroup_title | te_ads_object.ad_name | 广告名 |
| bid_creativegroup_id | te_ads_object.ad_id | 广告 ID |
| req_device_os | te_ads_object.platform | 平台,即 Android、iOS 等 |
| req_device_geo_country | te_ads_object.country | 国家地区编码 |
| 【USD】(定值) | te_ads_object.currency | 成本或收益的币种 |
| imp_cost_total_micro | te_ads_object.cost | 买量成本 |
| conversion_revenue_amount_usd | te_ads_object.revenue | 变现收益 |

