概要:您可以使用该API拉取CSV格式的原始数据报告。本文为您介绍了具体的使用方法。
Pull API原始数据报告
- Pull API能够帮助您拉取到CSV格式的原始数据报告。详情请见原始数据报告说明。
- 可用的筛选条件包括:媒体渠道、日期范围、应用内事件名称以及地理位置。
- Pull API的其他功能包括:
- 选择货币
- 选择时区
Pull API能够拉取到的原始数据报告
报告 | 说明 | 更新频率 |
---|---|---|
原始数据报告(非自然) | ||
激活 | 用于记录非自然激活。每当有用户首次启动应用时就会生成一条记录。 |
实时 |
应用内事件 | 于记录用户完成的事件。 |
实时 |
卸载 | 用于记录用户的应用卸载情况。 |
每日更新 |
重装激活 |
用于记录用户卸载应用后与拉新渠道互动并在再归因窗口期内重新安装并激活应用的情况。 | 实时 |
原始数据报告(自然量) |
||
自然激活 |
用于记录用户首次打开应用的情况。 |
持续滚动 |
自然应用内事件 |
用于记录用户所完成的事件的详细信息。 |
持续滚动 |
自然卸载 |
用于记录用户的应用卸载情况。 |
每日更新 |
自然重装激活 |
用于记录带量的再营销渠道在再互动窗口期内带来的广告收入。 |
每天更新一次 |
再营销 | ||
转化 | 用于记录用户与再营销广告交互后打开相关应用的行为。 | 实时 |
应用内事件 | 用于记录用户在再互动窗口期内完成的应用内事件。 | 实时 |
广告收入原始数据 |
||
已归因的广告收入 |
用于记录非自然(由媒体渠道带来的)用户产生的广告收入。 | 每日更新 |
自然广告收入 | 用于记录自然(未归因到任何渠道的)用户产生的广告收入。 | 每日更新 |
Protect360防作弊 | ||
激活 | 用于记录系统识别的激活假量,AF不会将这些激活归因到任何媒体渠道。 | 实时 |
归因后判定为假量的激活 | 用于记录来自虚假激活的应用内事件,AF不会对这些事件进行归因。 | 实时 |
应用内事件 | 用于记录Protect360识别到的应用内事件假量。 | 每日更新 |
归因后识别为假量的应用内事件 | 用于记录归因到某渠道后被识别为假量的激活所产生的应用内事件,或直接被识别为假量的应用内事件。 | 每日更新 |
Clicks | 用于记录被Protect360拦截的用户所完成的点击。 | 每日更新 |
已拦截的激活回传 | 若某渠道带来的激活被拦截,该报告会记录发送到这些渠道的回传。 | 实时 |
数据回传 | ||
激活回传 | 用于记录用户首次打开应用所形成的激活。 | 每日更新 |
应用内事件回传 | 用于记录发送到渠道的应用内事件回传。 | 每日更新 |
再营销应用内事件回传 | 用于记录用户在再互动窗口期内完成的应用内事件。 | 实时 |
再营销转化回传 | 用于记录用户在再互动窗口期内完成的应用内事件。 | 实时 |
使用Pull API拉取原始数据
Pull API原始数据的拉取方式:
获取API token。只有相关账户的管理员才能获取该token。
- 将该API token发送给您的开发人员,用于认证头(Authentication Header)中。
- 将下表所列的相关参数发送给您的开发人员,让其在调用API时输入这些参数。这些参数用于界定报告的重点内容、信息梳理方式以及报告覆盖的时间范围。
- 让您的开发人员按照开发者资源中心的Pull API原始数据指南进行操作。
参数
参数 | 说明 |
---|---|
from |
|
to |
表示截至日期,与from 相对
|
media_source |
请按以下方式设置
|
maximum_rows |
单次API调用最多可以拉取到的数据行数。
|
event_name |
按指定事件来筛选应用内事件数据。可以选择多个事件,事件之间用逗号分隔。 示例: |
reattr |
设置再营销归因数据
|
additional_fields |
用于拉取默认字段之外的数据。 示例: |
currency |
收入和成本的货币币种
示例:如果应用层级的指定货币是EUR(欧元),发送 |
timezone |
【默认】数据以UTC时间显示。
|
geo |
按国家代码筛选数据 局限性:每次调用API时只能设置一个国家代码。 示例: |
from_install time |
|
to_install_time |
表示截至日期,与 |
agency |
用于筛选出某个具体代理的数据。 |
Protect360字段
时间范围字段
如果API返回的结果超过行数上限,请通过小时数和分钟数来拆分报告。具体方法如下:
- from/to参数的格式为:yyyy-mm-dd hh:mm
-
from:
- 如果参数仅包含日期 = 从选定日期的零时(00:00)开始
- 如果同时包含日期和时间 = 从选定时间(含)开始
-
参数to:
- 如果参数仅包含日期 = 到选定日期结束(24:00)为止
- 如果同时包含日期和时间 = 到选定时间(不含)为止
示例: 各渠道每天共为某广告主带来130万个新增激活。为克服100万行的限制,该广告主分两次调用API,每次拉取12小时的数据。具体方案请见下表:
API调用 | From | To |
---|---|---|
首次API调用 |
from=yyyy-mm-dd 示例:
|
to=yyyy-mm-dd 12:00 示例:
|
方案A: 第二次API调用
示例:
|
from=yyyy-mm-dd 12:00 示例:
|
to=yyyy-mm-dd 示例:
|
方案B:第二次API调用 |
from=yyyy-mm-dd 12:00 示例:
|
to=yyyy-mm-dd+1 00:00 +1 = 第二天的00:00 示例:
|
请注意:方案A和方案B拉取到的结果是一样的。 |
可选的非默认字段
额外添加的非默认字段不会影响您的数据入库和上传流程。您可以使用additional_fields
这个参数来拉取非默认字段的值。
- 这个参数在每个URI中只能出现一次。
- 可用字段请见此列表。
-
示例:
additional_fields=device_download_time,deeplink_url
默认字段
Pull API默认字段 |
---|
Attributed Touch Type(归因到的广告触达类型) |
Attributed Touch Time(归因到的广告触达时间) |
Install Time(激活时间) |
Event Time(事件时间) |
Event Name(事件名称) |
Event Value(事件值) |
Event Revenue(事件收入) |
Event Revenue Currency(事件收入货币) |
Event Revenue USD(以美元为单位的事件收入) |
Event Source(事件来源) |
Is Receipt Validated(收入验证) |
Partner(合作代理) |
Media Source(媒体渠道) |
Channel(流量入口) |
Keywords(关键词) |
Campaign(广告系列) |
Campaign ID(广告系列ID) |
Adset(广告组) |
Adset ID(广告组ID) |
Ad(广告) |
Ad ID(广告ID) |
Ad Type(广告类型) |
Site ID(子渠道ID) |
Sub Site ID(次级子渠道ID) |
Sub Param 1(可配置参数1) |
Sub Param 2(可配置参数2) |
Sub Param 3(可配置参数3) |
Sub Param 4(可配置参数4) |
Sub Param 5(可配置参数5) |
Cost Model(计费模式) |
Cost Value(成本值) |
Cost Currency(成本货币) |
Contributor 1 Partner(助攻1合作代理) |
Contributor 1 Media Source(助攻1媒体渠道) |
Contributor 1 Campaign(助攻1广告系列) |
Contributor 1 Touch Type(助攻1触达类型) |
Contributor 1 Touch Time(助攻1触达时间) |
Contributor 2 Partner(助攻2合作代理) |
Contributor 2 Media Source(助攻2媒体渠道) |
Contributor 2 Campaign(助攻2广告系列) |
Contributor 2 Touch Type(助攻2触达类型) |
Contributor 2 Touch Time(助攻2触达时间) |
Contributor 3 Partner(助攻3合作代理) |
Contributor 3 Media Source(助攻3媒体渠道) |
Contributor 3 Campaign(助攻3广告系列) |
Contributor 3 Touch Type(助攻3触达类型) |
Contributor 3 Touch Time(助攻3触达时间) |
Region(地区) |
Country Code(国家代码) |
State(州) |
City(城市) |
Postal Code(邮政编码) |
DMA(指定市场区域) |
IP |
WIFI |
Operator(移动服务商) |
Carrier(网络运营商) |
Language(语言) |
AppsFlyer ID |
Advertising ID |
IDFA |
Android ID |
Customer User ID(客户用户ID) |
IMEI |
IDFV |
Platform(系统平台) |
Device Type(设备类型) |
OS Version(操作系统版本) |
App Version(应用版本) |
SDK Version(SDK版本) |
App ID(应用ID) |
App Name(应用名称) |
Bundle ID |
Is Retargeting(是否为再营销广告) |
Retargeting Conversion Type(再营销转化类型) |
Attribution Lookback(归因回溯窗口期) |
Reengagement Window(再互动窗口期) |
Is Primary Attribution(是否为主要带量渠道) |
User Agent(用户代理) |
HTTP Referrer |
Original URL |
其他相关信息
特点与局限性
特点 | 注意事项 |
---|---|
规定的API密钥类型 |
|
渠道权限 | 否 |
代理访问权限 | 是 |
代理数据透明化 | 区分。但如果您同时使用“代理”和“媒体渠道”这两个筛选条件,“媒体渠道”这个筛选条件不会对数据不透明的代理生效。也就是说报告中会包含所有不透明代理的数据,而不仅仅是按媒体渠道筛选出来的数据。 |
应用配置中的指定货币 | 是 |
应用层级指定时区 | 是 |
数据时效性 |
|
历史数据 | 区分。 须遵循数据保存期限和频次限制规定。 |
非自然量数据 | 是 |
自然量数据 | 是 |
拉取频次限制 |
原始数据的API调用限制 |
大小限制 |
|
Install_date_from和install_date_to | 激活日期范围必须早于用户行为日期范围。 |
问题排查
问题表现/报错消息 | 解决方法 |
---|---|
所选时间段中有数据缺失,或原始数据和汇总数据报告之间有数据差异。 |
请检查 |