在上一次的闭门会上，应用试客负责人杨冲提到，苹果获取的应用信息越来越多，开发者在后台能够看到的统计数据已经很完善，比如在做推广时非常重要的一个问题——如何区分是否被掺量【是否真实用户】，在App Store Connect中查看独立设备数就可以。
对于运营者来说，数据非常重要，那么还有更多数据如何获取？这篇文章就是讲的如何自动化地从苹果后台获取App的每日销售记录(下载量)，方便分析和统计。
App Store Connect里的销售记录
我们先看看如何通过App Store Connect网页查看和下载App的销售记录。 「App分析」和「销售和趋势」里都能看到每日销售明细，且可以下载对应的数据(图中红圈处)。
App分析
销售与趋势
可惜的是，苹果并没有开放这些明细API，仅仅开放了下载”销售和趋势报告“的API，这是一个销售总报告，没有每日明细，而且报告内容的格式有些”糟糕“。
”销售和趋势报告“长什么样？
非官方API下，Fastlane - Spaceship 通过抓取App Store Connect - 【App分析】模块的网页数据，提供了获取到每日销量明细的API，后文详细介绍。
获取”销售和趋势报告“的三种方式
本文将介绍三种方式获取销售和趋势报告：【苹果官方】App Store Connect API：REST API，下载销售和趋势报告(.txt文件) 【苹果官方】Reporter 命令行工具：.jar包，跨平台，下载销售和趋势报告(.txt文件) 【第三方开源】Fastlane - Spaceship：需要Ruby环境，获取每日销售明细(json数据)
App Store Connect API
App Store Connect API 是苹果官方提供的REST API，其中的下载销售和趋势报告API，可以下载每日、每周、每月、每年的销售和趋势汇总报告，这个和手动在网页上下载报告是一样的效果。请求头需要带上token，如何生成token请参考 《App Store Connect API》。 下载销售和趋势报告
GET https://api.appstoreconnect.apple.com/v1/salesReports
请求参数
filter[reportType]：报告类型，SALES, PRE_ORDER, NEWSSTAND, SUBSCRIPTION, SUBSCRIPTION_EVENT, SUBSCRIBER
filter[reportSubType]：报告子类型，SUMMARY, DETAILED, OPT_IN
filter[frequency]：报告周期，DAILY, WEEKLY, MONTHLY, YEARLY
filter[reportDate]：报告时间，传你想获取的报告时间，格式：YYYY-MM-DD(日报；周报，周一到周天，只能传周天的时间，否则报错)，YYYY-MM(月报)，YYYY(年报)，例如 2019-10
filter[vendorNumber]：供应商号，App Store Connect - 付款和财务报告，左上角那串数字。
filter[version]：接口版本号，可不传。
成功返回200，返回数据为文件流，.gz(压缩文件)类型的文件，解压后为 .txt。
失败返回json，会有很详细的错误提示，根据错误提示修改即可。
月报 请求示例
curl 'https://api.appstoreconnect.apple.com/v1/salesReports?filter[reportSubType]=SUMMARY&filter[reportType]=SALES&filter[vendorNumber]=88xxxxx&filter[frequency]=MONTHLY&filter[reportDate]=2019-10' -H 'Authorization: Bearer eyJhbGci...h5T-JUcdCP_CVuKMWgm3g' -g > /Users/Cocoakier/Movies/a.gzip
(-g 是因为token中包含特殊字符)
周报 请求参数示例：
curl 'https://api.appstoreconnect.apple.com/v1/salesReports?filter[reportSubType]=SUMMARY&filter[reportType]=SALES&filter[vendorNumber]=88xxxxx&filter[frequency]=WEEKLY&filter[reportDate]=2019-11-17' -H 'Authorization: Bearer eyJhbGci...h5T-JUcdCP_CVuKMWgm3g' -g > /Users/Cocoakier/Movies/a.gzip
注意事项(必看)
参数关联组合
reportType、reportSubType、frequency、reportDate这四个参数的组合必须遵循下面这张表，否则会报错。
注意：周报，filter[frequency]=WEEKLY，是从周一到周天，reportDate只能传周天的日期，传其它日期会报错。
参数关联组合
报告可用性
销售报告可用性是有严格时间限制的，传入还未可用的报告reportDate，会报错。下面是苹果文档上的描述：
“销售和趋势”报告在以下时间可供下载：但是，由于北京时间比太平洋时间快了16小时，今天我们这边11月21日了，美国那边才11月20日，根据报告次日可用，所以报告只能看到11月19日的。 这就导致了报告实际延迟了两天！ 即，今天只能看到前天的报告。这对运营来说恐怕是灾难的。
- 每日报告可于次日获取
- 每周报告可在每周一获取
- 每月报告可在该月月末的五天后获取
- 年度报告可以在该年年末的六天后获取
报告通常在太平洋标准时间(PST)早上 8 点(楼主注：北京时间00:00)提供。
【注】每日报告、每周报告和每月报告在提供后保留一年。年度报告无限期保留。到期后，我们不再存储或重新生成报告以供下载。
报告实际上延迟了2天
token无效或没有授权。我测试的时候发现，有时候会报token无效或没有授权，重新生成一个token仍然报错，实际上token没有问题，其它GET接口可以成功，是请求参数传的有问题，比如报告不可用，或者参数组合有问题，自己注意检查！
Reporter 命令行工具
下载销售和趋势报告，苹果还专门提供了一个.jar的命令行工具——Reporter，这个东西只干能一件事，就是下载报告——Reporter官方文档。 别看文档是java的就望而却步了，楼主最开始也有这种感觉，后来静下心来把官方文档看完了，发现这个工具虽然是java开发的，但是使用起来很简单，用来下载报告比App Store Connect API“更专业”。下载Reporter
在苹果页面下载后▽ 【https://help.apple.com/itc/appsreporterguide/#/apda86f89da5】 解压后有两个文件：(请确保两个文件在同一目录下)- Reporter.jar，命令行工具
- Reporter.properties，属性文件，用于存放配置参数(访问令牌等)
访问令牌
Reporter需要在属性文件中配置访问令牌才能使用。访问令牌是App Store Connect 后台生成的一串字符串。生成访问令牌
访问令牌有两种生成方式：- 去网页手动生成。App Store Connect后台 - 销售和趋势 - (左边)销售和趋势报告 - (右上角)关于报告 - 生成Reporter令牌。
- 通过命令生成，需要输入苹果账号和密码。(详见下文API部分)。注意：开通双重认证的账号无法使用命令生成访问令牌，只能通过网页手动生成。
手动生成访问令牌
注意事项
- 访问令牌有效期180天。每个 Apple ID 每次仅可生成一个访问令牌。如果您生成了新的访问令牌，先前的访问令牌将立即过期。
- 您只需生成一个访问令牌即可访问销售和财务应用程序。无需生成单独的访问令牌。
属性文件
下载的文件中有个Reporter.properties文件，这是属性文件，用于存放Reporter的默认配置参数。- 每个属性单独成行，包括一个 Key 和其对应的值，值不需要加引号
- 如果命令行中传入的属性参数，则会覆盖属性文件中的属性
- 属性文件中的Account，并不是苹果开发者账号的值，这个值是苹果账号的隐式id，需要通过命令(见下文)获取。
属性文件
下面是属性文件的全部key-value
常用命令
打开终端，cd 到.jar包的目录，执行下列命名。 命令通用格式java -jar Reporter.jar p=[properties file name] a=[account number] m=[mode] Sales.[command]
java -jar Reporter.jar p=[properties file name] a=[account number] m=[mode] Finance.[command]
生成访问令牌(根据提示输入苹果账号和密码。注意，开通了双重认证的账号无法使用该命令)
java -jar Reporter.jar p=Reporter.properties Sales.generateToken
返回结果
Please type in your username: ********
Please type in your password: ********
Your access token has been generated.
AccessToken:d21xxx-xxxx-xxxx-xx0a
Expiration Date:2020-06-07
查看访问令牌(根据提示输入苹果账号和密码)
java -jar Reporter.jar p=Reporter.properties Sales.viewToken
删除访问令牌
java -jar Reporter.jar p=Reporter.properties Sales.deleteToken
检查可用状态(校验token，返回0表示有效)
java -jar Reporter.jar p=Reporter.properties m=Robot.XML Sales.getStatus
返回结果
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Status>
<Message>Sales and Trends Reporter is currently available.Message>
<Code>0Code>
Status>
获取Reporter版本(始终返回纯文本)
java -jar Reporter.jar getVersion
返回结果
1.0
获取账号列表(account num)
一般模式(每个账号一行，用户名和ID用逗号分开)
java -jar Reporter.jar p=Reporter.properties Sales.getAccounts
返回结果
Jane Appleseed Inc, 12345
John Appleseed Inc, 67890
java -jar Reporter.jar p=Reporter.properties m=Robot.XML Sales.getAccounts
返回结果
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Accounts>
<Account>
<Name>Jane Appleseed IncName>
<Number>12345Number>
Account>
<Account>
<Name>John Appleseed IncName>
<Number>67890Number>
Account>
Accounts>
获取Vendor 编号(供应商号，下载报告需要传)
一般模式(每个 Vendor 编号都单独成行)java -jar Reporter.jar p=Reporter.properties Sales.getVendors
返回结果
800xxxxx
801xxxxx
机器人模式java -jar Reporter.jar p=Reporter.properties m=Robot.XML Sales.getVendors
返回结果
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Vendors>
<Vendor>800xxxxxVendor>
<Vendor>801xxxxxVendor>
Vendors>
下载销售和趋势报告
命令格式java -jar Reporter.jar p=[properties file] Sales.getReport [vendor number], [report type], [report subtype], [date type], [date], [version]* (if applicable)
参数：
[vendor number]：供应商号，App Store Connect后台-付款和财务报告，左上角那串数字；或者使用上面介绍的getVendors命令获取。
[report Type]：报告类型，SALES, PRE_ORDER, NEWSSTAND, SUBSCRIPTION, SUBSCRIPTION_EVENT, SUBSCRIBER
[report SubType]：SUMMARY, DETAILED, OPT_IN
[date type]：日期类型，DAILY, WEEKLY, MONTHLY, YEARLY
[date]：日期，YYYYMMDD，YYYYMM，YYYY
使用示例(更多示例见官方文档)
java -jar Reporter.jar p=Reporter.properties m=Robot.XML Sales.getReport 800xxxxx, SALES, SUMMARY, DAILY, 20191005
返回结果
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Output>
<Message>Successfully downloaded S_D_800xxxxx_20150201.txt.gz.Message>
Output>
Fastlane - Spaceship
Fastlane是一套用Ruby开发的，开源的，用于解决iOS和Android自动化编译打包、上传、发布等工作的命令行工具集。 其中，Spaceship提供了一套Apple Developer Center 和 App Store Connect 的API。下面来介绍，如何通过Spaceship获取App的每日销售量。 与上面两个方案不同的是，Spaceship可以直接获取到每日销售量明细，而不是下载销售报告。我们可以通过Spaceship - App Analytics模块的API来实现。下面是一个返回示例。{
"size": 1,
"results": [{
"adamId": "147xxxxxx",
"meetsThreshold": true,
"group": null,
"data": [{
"date": "2019-10-01T00:00:00Z",
"units": 1.0
}, {
"date": "2019-10-02T00:00:00Z",
"units": 1.0
}, {
"date": "2019-10-03T00:00:00Z",
"units": 0.0
},
...
],
"totals": {
"value": 2.0,
"type": "COUNT",
"key": "units"
}
}]
}sudo gem install fastlane
你可以参考Spaceship文档一步一步操作，体验一下Spaceship的功能。
Spaceship文档上提到的获取销售量的的方法，只能获取到最近7天的销量，不够灵活。
sales = analytics.app_sales
我阅读了app_analytics.rb源码，写了一段Ruby代码，执行下面代码即可获取到指定时间范围内某个App的销售量了。(如果你开启了双重认证，请先把下列代码保存到文件a.rb后，打开终端执行ruby a.rb，双重认证需要根据提示输入验证码)
require "spaceship"
require "JSON"
APPLE_ACCOUNT = "xxxxxx@xxxx.com" #苹果开发者账号
APPLE_ACCOUNT_PWD = "xxxxxxxxxxxxxxxx" #苹果开发者密码
APP_ITUNES_ID = 148xxxxxxxx #APP ID
start_t = "2019-11-01T00:00:00Z" #查询开始时间
end_t = "2019-11-015T00:00:00Z" #查询结束时间
# end_t = Time.now.strftime("%Y-%m-%dT00:00:00Z") #查询结束时间取当天
Spaceship::Tunes.login(APPLE_ACCOUNT, APPLE_ACCOUNT_PWD) #登录App Store Connect后台
# puts all_apps = Spaceship::Tunes::Application.all #获取所有app信息，可以帮助你获取APP ID
app = Spaceship::Tunes::Application.find(APP_ITUNES_ID) #获取App对象
sales = app.analytics.app_units_interval(start_t,end_t) #获取 App分析-销售 信息
puts JSON.generate(sales) #ruby对象转JSON，并打印- 数据同样有两天延迟。Spaceship的原理是模拟网页请求，抓取网页数据。App Store Connect后台 - App 分析，显示的数据也遵循我上文说的延迟两天的规则。因此，Spaceship返回的销售数据最多只能返回前天的数据，如果查询不可用时间内销售数据，Spaceship并不会报错，只是返回的销售量为0，这点注意一下！
- 双重认证。因为Spaceship需要登录苹果开发者账号，如果开启了双重认证，需要输入验证码，session有效期1个月。双重认证暂时没有好的对策，只能尽量用没有开启双重认证的苹果账号。(Tips：如果你是公司账号，你可以邀请一个没开通双重认证的账号加入你们团队，用这个没开启双重认证的账号进行Spaceship操作。)
- 苹果的销售报告有2天的延迟，实时性太差，这也是苹果官方统计在国内不太被重视的一个重要原因吧。
- 对于公司开发者，推荐使用Reporter命令行工具，.jar包，跨平台，生成访问令牌简单，访问令牌有效期180天，适合服务器后台定期拉取销售和趋势报告，解析后存入数据库。虽然销售和趋势报告可读性不友好，但是文件里包含了丰富的字段，后台可以按需解析，灵活度更高，可定制化更强。
- 对于个人开发者，自动化获取AppStore销售报告的需求恐怕很弱了。苹果官方的Connect App或者直接网页浏览，完全可以满足需求。如果非要选一个的话，推荐使用Spaceship，返回JSON格式数据，可读性好，直接返回明细，不需要解析报告文件。
- 下载好销售和趋势报告，如何解析也是一个问题。如果后续有时间，我在研究一下这一块。
参考链接：
App Store Connect API 苹果官方文档：
https://developer.apple.com/documentation/appstoreconnectapi
App Store Connect 帮助 - 下载和查看报告：
https://help.apple.com/app-store-connect/#/dev061699fdb
Reporter 苹果官方文档：
https://help.apple.com/itc/appsreporterguide/#/itcbe21ac7db
Spaceship Github：
https://github.com/fastlane/fastlane/blob/master/spaceship/docs/AppStoreConnect.md#app-analytics
app_analytics.rb源码：
https://github.com/fastlane/fastlane/blob/08b539854c575e891c18af173ea2bae229a720ad/spaceship/lib/spaceship/tunes/app_analytics.rb
你可能错过的
应用试客五周年，感恩回馈
公众号回复关键字“试客”，注册会员获取优惠
扫一扫
912
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
