聚合数据导出

概述

仅适用于前TUNE客户

该功能当前仅适用于前TUNE客户端,并复制通过https://api.mobileapptracking.com/v2/advertiser/stats/actuals/export可用的TUNE端点。

Branch Aggregate Exports查找并排列符合您要搜索的搜索条件的聚合数据。与“自定义导出”不同的是,“自定义导出”包含与您的移动应用相关的每个属性的单独日志,而“总导出”则包括您感兴趣数据的可自定义可视化。

最多只能在同步端口上导出不超过5k行,在异步端点上最多10k行,并且仅能查询在导出日期之前的180天内的数据。如果需要更多记录,请以较小的时间间隔进行多次请求,分批提取必要的数据。

认证方式

调用Aggregate Export API时,每个请求都必须传递一个_api 查询字符串参数。 API密钥是基于每个用户生成的,并且是永久的。

了解如何检索您的API密钥(又名Access Token

需要组织级别的访问权限

为了检索或重置您的API密钥/访问令牌,您必须有权访问帐户的组织级别。此功能在应用程序级别不存在。

速率限制

速率限制取决于您请求的端点。

为了创建和检查出口状态,速率限制为每秒2个请求,每分钟10个请求和每小时1000个。

导出权限设置

为了访问Aggregate Exports,用户将需要同时具有Aggregate DataExport 访问权限。

图像

有关如何授予用户所需访问权限的更多详细信息,请遵循授予用户导出访问权限

第三方访问

任何有权访问帐户的API密钥的用户都将能够访问Branch的Custom Export API(从而可以访问未经过滤的日志级数据)。因此,我们建议您不要在邀请过程中向第三方提供查看API密钥所需的权限。

提供代理商/合作伙伴API访问权限

如果您与运行广告活动的代理商合作,并希望授予他们导出后续数据的权限,则可以向他们提供对Custom Export API的访问权限。

为代理商团队成员提供对Custom Export API的访问权限:

  1. 在左侧导航栏中的Setup & Testing下,点击Account Settings
  2. Account Settings 页面上,点击Agencies 选项卡。
  3. 展开有问题的代理商,找到您要授予访问权限的代理商团队成员,将鼠标悬停在Actions 列中的按钮上,然后点击Edit
  4. Edit Agency Team Member 中:
    1. Access Level ,选中Export 框。
    2. Permissions ,选中Aggregate Data 框。
  5. 可选:添加数据过滤器
    1. Data Filters ,将所有必要的数据过滤器切换为蓝色。导出的数据将被相应地过滤。
  6. 点击Save

图像

代理商标签的数据

如果您未启用“仅显示带有代理商标签的数据”数据过滤器,则代理商团队成员将能够导出与您所有广告系列相关联的汇总数据,无论它们是否与它们关联。

可用的导出主题

可通过Aggregate Export API获得以下日志主题:

  • Clicks
  • Events
  • Impressions
  • Installs
  • Opens
  • Revenue USD

信息

Branch不支持导出不常用的更新和回发TUNE主题。

IP 地址差异

对于无法将IP解析到某个位置的事件,只有很少一部分事件无法使用国家和城市等地理数据。

可用字段

TUNE 字段 TUNE 字段的可读形式
ad_network_id Ad Network ID
ad_network.name Ad Network Name
advertiser_id Advertiser ID
advertiser.name Advertiser Name
advertiser_sub_ad.name My Ad Name
advertiser_sub_ad.ref My Ad Ref
advertiser_sub_adgroup.name My AdGroup Name
advertiser_sub_adgroup.ref My AdGroup Ref
advertiser_sub_campaign.name My Campaign Name
advertiser_sub_campaign.ref My Campaign Ref
advertiser_sub_keyword.name My Keyword Name
advertiser_sub_keyword.ref My Keyword Ref
advertiser_sub_placement.name My Placement Name
advertiser_sub_placement.ref My Placement Ref
advertiser_sub_publisher.name My Publisher Name
advertiser_sub_publisher.ref My Publisher Ref
advertiser_sub_site.name My Site Name
advertiser_sub_site.ref My Site Ref
country.code Country Code
device_type Device Type
publisher_sub_ad.name Publisher Sub Ad Name
publisher_sub_ad.ref Publisher Sub Ad Ref
publisher_sub_adgroup.name Publisher Sub AdGroup Name
publisher_sub_adgroup.ref Publisher Sub AdGroup Ref
publisher_sub_campaign.name Publisher Sub Campaign Name
publisher_sub_campaign.ref Publisher Sub Campaign Ref
publisher_sub_keyword.name Publisher Sub Keyword Name
publisher_sub_placement.name Publisher Sub Placement Name
publisher_sub_publisher.name Publisher Sub Publisher Name
publisher_sub_site.name Publisher Sub Site Name
site_id Site ID
timestamp Timestamp
wurfl_device_os Device OS
wurfl_model_name Model Name

已停用的字段

有些字段对我们的客户来说价值非常有限,因此已经停用。通过“自定义导出” API将无法使用停用的字段。如果您有任何疑问或疑虑,请与您的CSM或我们的支持团队合作。

包括相关数据对象中的字段

相关对象不再使用句点(.)访问该对象上的属性。而是,字段名称仅使用下划线(_)。

例如, site_event.id 现在将导出为site_event_id

创建导出请求

查找并对符合搜索条件的所有记录进行排队;将返回用于下载的“句柄(handle)”。

参数名称
类型
描述

api_key

您的API密钥; 必填

start_date

日期

以ISO-8601格式提供的请求结果的开始日期时间。 必填


不带偏移的日期(即时区)默认为为时区参数提供的值。如果未指定timezone参数,则日期时区默认为UTC。日期必须在最近的120天内。范例:2016-01-01T00:00:00Z

end_date

日期

以ISO-8601格式提供的请求结果的结束日期时间。 必填


不带偏移的日期(即时区)默认为为时区参数提供的值。如果未指定timezone参数,则日期时区默认为UTC。范例:2016-01-01T23:59:59Z

filter

过滤

根据字段和布尔值运算符过滤实际端点的字段;必须经过URI编码和JSON解析。例: &filter=%5B%22and%22%2C%5B%22eq%22%2C%22mat_id%22%2C%223bc15517-92d5-4b7f-9837-e9a30d6fb9b8%22%5D%2C%5B%22eq%22%2C%22site_event_id%22%2C1844998705%5D%5D

fields

逗号分隔列表

结果所需的LogInstalls模型中逗号分隔的字段的列表。默认显示所有字段; 必填

limit

整数

限制每个请求返回的项目数。最大允许值为200万。如果需要超过200万条记录,请以较小的时间间隔进行多次请求,以提取“批次”中所需的数据; 必填

sort

分类

字段后跟方向(asc或desc)。结果可以按多个字段和方向排序。


可选参数。

group

数组

对所选字段返回的项目进行分组。

timestamp

设置按时间戳分类的统计信息。选项包括:小时,日期,日期,星期,月份。


可选参数。

format

可空字符串

回应格式;可以是JSON或CSV。如果未选择,则默认为CSV。

response_timezone

时区

传达结果日期的时区;默认为您帐户中设置的时区。

导出请求示例

https://api.mobileapptracking.com/v2/advertiser/stats/actuals/export.json?api_key=4c5b6461026cb0caff3c66bef881b4af&start_date=2018-08-01+00%3A00%3A00&end_date=2018-08-18+00%3A00%3A00&fields[]=opens&fields[]=installs&fields[]=events&fields[]=publisher_sub_adgroup_id&fields[]=publisher_sub_campaign_id&timestamp=date&format=json

导出请求返回示例

{
  "status_code": 200,
  "response_size": "334",
  "throttle": {
    "decision": "Permit",
    "decision_authority": "Endpoint",
    "decision_state": "Always Permit",
    "object_key": "/advertiser/stats/actuals/export",
    "virtual_record": false,
    "next_reset": "N/A",
    "count_remaining": 0,
    "limit": 0,
    "interval": 0
  },
  "data": {
    "job_id": "5a494d8b-e5f9-4561-b71d-5c5ee4ed087d"
  }
}

构建下载导出请求

查找并导出请求的队列(按句柄),并提供URL地址以供下载。

参数名称
类型
描述

advertiser_id

您的TUNE广告客户ID; 必填

api_key

您的API密钥; 必填

handle

日志导出队列返回的ID。 必填

报告状态请求示例

https://api.mobileapptracking.com/v2/export/download.json?api_key=REMOVED&job_id=5a494d8b-e5f9-4561-b71d-5c5ee4ed087d

报告状态返回体示例

{"status_code":200,"response_size":"437","data":{"status":"complete","percent_complete":100,"data":{"format":"json","url":"https:\/\/s3.amazonaws.com\/hasdevfiles\/9da89700-ee8e-42f1-932f-7b9459a614dd.json?response-content-disposition=attachment%3B%20filename%3D%229da89700-ee8e-42f1-932f-7b9459a614dd.json%22&AWSAccessKeyId=AKIAIHT2RGXNQAIUT7ZA&Expires=1547654522&Signature=mfXJ7fGZeZZ%2FYPnEHssGopvdpxk%3D"},"report_schedule_id":null}}

报告下载请求示例

curl 'https://s3.amazonaws.com/hasdevfiles/3bce2890-97c8-44e0-985b-9c5505b7ec4a.json?response-content-disposition=attachment%3B%20filename%3D%223bce2890-97c8-44e0-985b-9c5505b7ec4a.json%22&AWSAccessKeyId=AKIAIHT2RGXNQAIUT7ZA&Expires=1535997897&Signature=v9WhAulFDVmfaR%2FzAg3uvh8DVAc%3D'

报告示例

[
  {
    "publisher_sub_campaign_id": "975222707",
    "publisher_sub_adgroup_id": "666119300",
    "installs": 0,
    "opens": 0,
    "events": 0
  },
  ...
  {
    "publisher_sub_campaign_id": "0",
    "publisher_sub_adgroup_id": "0",
    "installs": 12,
    "opens": 13,
    "events": 31
  }
]

4个月前更新

聚合数据导出


建议的编辑仅限于API参考页

您只能建议对Markdown正文内容进行修改,而不能建议对API规范进行修改。