adjust-icon

Parquet 终端

该报告终端可以在同一报告中结合多种服务数据。可请求按天、应用及广告渠道等查看安装、收入、广告支出以及 SKAdNetwork 数据。

调取 Parquet 格式报告

终端
GET https://automate.adjust.com/reports-service/parquet_report

以二进制 Parquet 格式返回来自报告服务的过滤数据。

过滤

过滤类型描述示例
dimensions*String用于参数分类的值，用逗号隔开。详细信息请参考下面的表格。dimensions=app,os_name,week,campaign_id_network
metrics*String用逗号隔开的 KPI。详细信息请参考下面的表格。metrics=cost,installs,ecpi_network
date_period*String报告起始和截止日期，支持 3 种格式：
  • 逻辑日期
  • 绝对日期
  • 相对日期
  • 逻辑日期：
    • this_month_until_yesterday
    • today
    • yesterday
    • this_week
    • last_week
    • this_month
    • last_month
  • 绝对日期：
    • 2020-12-31:2021-01-01
  • 相对日期：
    • -10d:-3d (from 10 days ago to 3 days ago)
cohort_maturityString
  • immature: 展示所有同期群累积性指标的当前值，包括未成熟同期群。
  • mature: 只展示成熟同期群的累积性指标数据，未成熟同期群指标显示为零。
cohort_maturity=immature
utc_offsetString报告中使用的时区。utc_offset=+01:00
attribution_typesString归因交互类型。
  • click
  • impression
  • engaged_ad
E		attribution_types=click,engaged_ad
attribution_sourceString应用内活动是分配给用户的安装来源first，还是分配给安装来源和后续再归因来源dynamic。默认为dynamic 。attribution_source=first
reattributedString已被再归因用户的专属过滤器。当一名用户已经安装您的应用，但是又通过由 Adjust 跟踪的来源返回到应用，就会被再归因。
  • all (默认)
  • false
  • true
reattributed=false
iap_revenue_modeString终端返回的广告总收入百分比。可选项包括：
  • GROSS_100
  • GROSS_85
  • GROSS_70
  • GROSS_60
iap_revenue_mode=GROSS_70
ad_revenue_sourcesString用逗号隔开的广告收入来源列表。ad_revenue_sources=unknown
os_namesString用逗号隔开的操作系统名称列表。os_names=ios,android
ad_spend_modeString指定计算中应用的广告支出。请阅读广告支出来源如何影响数据，了解更多信息。
  • adjust
  • network
  • mixed
ad_spend_mode=network
sandboxBoolean使用 sandbox 还是真实流量数据。默认为 false。sandbox=true
sortString报告排序所用的指标/维度列表 (用逗号隔开)。使用 - 以降序排列。sort=-clicks,installs
indexString报告索引所用的维度列表 (用逗号隔开)。index=network,campaign,adgroup
format_datesBoolean如果设置为 false，则所有日期维度都将采用 ISO 格式。format_dates=false
period_over_periodString报告数据比较周期。period_over_period=previous_week
currencyString金额相关指标换算时所用的币种。currency=USD
[dimension]__inString逗号隔开的值列表，用于任意维度的维度值过滤 (精准匹配)。campaign__in=abc,def
[dimension]__not_inString逗号隔开的值列表，用于任意维度的维度值过滤 (排除精准匹配)。campaign__not_in=abc,def
[dimension]__containsString任意维度的维度值子字符串搜索 (不区分大小写)。campaign__contains=ios
[dimension]__excludeString任意维度的维度值子字符串排除搜索 (不区分大小写)。campaign__exclude=ios
[dimension]__starts_withString带有指定前缀的维度值子字符串匹配搜索 (不区分大小写)。campaign__starts_with=ios
[dimension]__not_starts_withString不带指定前缀的维度值子字符串匹配搜索 (不区分大小写)。campaign__not_starts_with=ios
[dimension]__ends_withString带有指定后缀的维度值子字符串匹配搜索 (不区分大小写)。campaign__ends_with=ios
[dimension]__not_ends_withString不带指定后缀的维度值子字符串匹配搜索 (不区分大小写)。campaign__not_ends_with=ios
[metric]__ltString适用于任意指标的 “小于” 指标值过滤器。skad_installs__lt=100
[metric]__lteString适用于任意指标的 “小于或等于” 指标值过滤器。skad_installs__lte=100
[metric]__gtString适用于任意指标的 “大于” 指标值过滤器。skad_installs__gt=100
[metric]__gteString指标的 “大于或等于” 指标值过滤器。skad_installs__gte=100
[metric]__eqString适用于任意指标的 “等于” 指标值过滤器。skad_installs__eq=100
[metric]__neString适用于任意指标的 “不等于” 指标值过滤器。skad_installs__ne=100

dimensions

通过维度，用户可以用一个或多个参数将指标细分为多个组。例如，您可以按照日期、国家/地区和渠道分别查看安装量。

维度数据类型描述示例
hourDate使用 format_dates=false 返回 ISO 格式值。 YYYY-MM-DDTHH:MM:SS2021-05-11T17:00:45
dayDate使用 format_dates=false 返回 ISO 格式值。 YYYY-MM-DD2021-05-11
weekDate使用 format_dates=false 返回 ISO 格式值。 YYYY-MM-DD - YYYY-MM-DD2021-05-09 - 2021-05-15
monthDate使用 format_dates=false 返回 ISO 格式值。 YYYY-MM2021-05
yearDate使用 format_dates=false 返回 ISO 格式值。 YYYY2021
quarterString使用 format_dates=false 返回 ISO 格式值。 Q<quarter_number> YYYYQ2 2021
os_nameString可能值：
  • android
  • bada
  • blackberry
  • ios
  • linux
  • macos
  • server
  • symbian
  • unknown
  • webos
  • windows
  • windows-phone
device_typeString可能值：
  • bot
  • console
  • ipod
  • mac
  • pc
  • phone
  • server
  • simulator
  • tablet
  • tv
  • unknown
appString应用名称。
app_tokenStringAdjust 中的应用 ID。
ad_account_idString广告账户的 ID。
store_idString商店应用 ID。com.random.app
store_typeString应用安装来源商店。google_play
currencyString币种名称。Euro
currency_codeString3 字符 ISO 4217 值。EUR
networkString广告渠道的名称。Organic, AppLovin, Facebook Installs, Instagram Installs.
campaignString跟踪链接子层级 1。 字符串值中一般包含推广活动名称和 ID。
campaign_networkString渠道的推广活动名称。
campaign_id_networkString渠道的推广活动 ID。
adgroupString跟踪链接子层级 2。 字符串值中一般包含广告组名称和 ID。
adgroup_networkString渠道的广告组名称。
adgroup_id_networkString渠道的广告组 ID。
source_networkString来源渠道名称。基于渠道的可选值。
source_id_networkString来源渠道 ID
creativeString跟踪链接子层级 3。 字符串值中一般包含素材名称和 ID。
creative_networkString渠道素材名称。
creative_id_networkString渠道素材 ID。
countryString国家/地区名称。United States of America
country_codeString2 字符 ISO 3166 值。US
regionString业务地区。APAC
partner_nameStringAdjust 系统中的合作伙伴名称。AppLovin
partner_idStringAdjust 系统中的合作伙伴 ID。34
partnerString合作伙伴唯一 slug。applovin
channelStringpartner_name和network的组合。
platformString设备平台类型，例如mobile_app、web或undefined。mobile_app

metrics

指标用于评估和比较您通过 Adjust 开展和监测的推广活动表现。

每个请求须带有至少 1 个指标。最常用的指标包括：

  • installs
  • clicks
  • impressions

您可以在我们的Datascape 指标术语表中查看完整指标列表。您还可以使用过滤器数据终端来搜索指标。

响应格式

该终端会返回一个 Parquet 格式文件。报告服务使用 pyarrow 引擎和 brotli 压缩来创建输出。

响应代码

终端返回以下响应：

响应描述注意事项
200成功返回报告信息
204无内容 (No content)响应对象为空时
400错误请求 (Bad request)请求格式错误或包含不受支持的参数
401未授权 (Unauthorized)您的凭证不正确或缺失
403禁止 (Forbidden)您没有访问此信息的权限
429请求过多 (Too many requests)同时发送超过 50 个请求
503服务不可用 (Service unavailable)无法连接服务器
504网关超时 (Gateway timeout)查询返回响应时间过长

示例

cURL
$ curl \
--header 'Authorization: Bearer <adjust_api_token>' \
--location --request GET 'https://automate.adjust.com/reports-service/parquet_report?ad_spend_mode=network&app_token__in={app_token1},{app_token2}&date_period=2021-05-01:2021-05-02&dimensions=app,partner_name,campaign,campaign_id_network,campaign_network&metrics=installs,network_installs,network_cost,network_ecpi'