# 奇遇开发者平台工具--使用说明

# 目录

使用前必读！！！
奇遇开发者平台工具介绍
使用方式
查看平台工具版本
获取帮助
自升级平台工具
获取使用该实用程序的凭据
上传任务构建
下载任务构建
日志保存目录

# 使用前必读！！！

阅读使用说明前请注意：如果您使用了奇遇开发者平台工具上传您的apk，请在上传apk后，到奇遇开发者平台进行提交审核操作。如果您只在平台工具上传了apk但没有在奇遇开发者平台提交审核，平台将不会对您上传的apk进行审核以及发布操作

# 奇遇开发者平台工具介绍

奇遇开发者平台工具是一个命令行工具，您可以通过该工具来上传软件安装包（支持APK及其OBB格式），且通过该工具上传比网页上传更加稳定，支持上传更大的软件安装包。

APK：可上传不大于3.5G的文件
OBB：可上传不大于3.5G的文件

# 使用方式

1、请确保您的奇遇开发者平台工具已经下载且安装完成，详细请参考奇遇开发者平台工具-下载安装说明

2、部分Mac用户在初次使用时，需要点击系统偏好设置，在安全性与隐私中，点击”仍然允许“

3、使用方式为，先将工具拖拽到命令行终端中，再输入相关命令行（每个功能对应的命令行不同，具体见下）以下示意图为拖拽后效果，没有输入任何对应的相关命令行

Mac截图

Windows截图

# 查看平台工具版本

在拖拽工具进入终端后，输入空格，然后输入version可查看当前平台工具版本，版本更新记录详见奇遇开发者平台工具-下载安装说明 Mac截图

Windows截图

# 获取帮助

获取菜单在拖拽工具进入终端后，输入空格，然后输入--help ，可以获得平台工具的功能菜单。

Mac截图

Windows截图

此时Commands下方的命令，为各个功能的命令行及功能的介绍

功能帮助例：如您希望获得有关上传命令upload-qiyu-build的帮助，在拖拽工具进入终端后，输入空格，输入upload-qiyu-build，再次输入空格，之后输入--help，回车即可查看该功能的详细说明

在Options下方，可以看到该功能需要传入的参数，以及对应的说明

# 自升级平台工具

在拖拽工具进入终端后，输入空格，然后输入self-update , 可将平台工具进行更新。截图展示

下载成功后，会提示您下载成功

如果您已经是最新版了，会给出提示信息

截图展示

# 获取使用该实用程序的凭据

使用命令行来获取应用的用户令牌

在拖拽工具进入终端后，输入空格，然后输入get-access-Token命令获取令牌

然后请逐步输入email、密码、应用ID、应用密钥

以上操作完成后，即可获得该应用的用户令牌

在网页中获取应用ID/应用密钥/应用令牌

在我的应用列表中查找应用程序，点击列表操作栏的API按钮

找到列表中 API页面以查找应用程序ID并可以点击生成用户令牌。

下图显示了API页面的示例：

# 上传任务构建

将工具拖拽进入终端后，输入空格，然后输入upload-qiyu-build

以下是所需要的参数

# 参数

参数	描述
APP ID -a	必填项。可在应用列表中查看应用ID。
APP Secret -s	与用户令牌至少填一个。可在应用列表中查看应用密钥
User Token -t	与应用密钥至少填一个。可在应用列表中查看用户令牌或通过 get-access-token命令获取。
apk filePath --apk TEXT	必填项。APK 的文件路径。
obb filePath --obb TEXT	选填项。OBB 的文件路径。
releaseChannel --channel TEXT	选填项。如果需要填写，为固定值，Production。
release note -n	选填项。应用更新信息也可以在网页端填写。

注：每个参数后需要加空格（例子：-a 11111），同时新输入参数也要加空格（例子：-a 11111 -s abcdef)。

# 上传示例

此上传示例使用了虚构的应用程序「Test」，示例是在 Mac 上使用的语法。

应用 ID：123

应用密钥：123abc

APK路径：/Users/Shared/test123.apk

输入：$ /Users/Shared/qyvr-platform-util upload-qiyu-build -a 123 -s 123abc --apk /Users/Shared/test123.apk 回车后会进行上传，会以进度条的形式展示上传百分比以及剩余时间

上传成功后，会对您进行提示，在此之后请您到奇遇开发者网站上，在下图所示位置（我的应用-编辑-APK&更新）选择最新上传的版本，进行相关提交

# 错误原因及提示

序号	中文	出错原因	备注
1	未知错误	未知出错原因	其余未覆盖到的其他异常
2	读取文件失败	当前上传APK文件读取或解析失败	该文件可能无法读取或者按照APK文件解析
3	非VR应用	当前上传APK文件未检测到高通XR接口文件	参看lib/arm64-v8a/libsxrapi.so
4	包名不一致	当前上传APK文件包名与历史上传并审核通过的版本包名不一致
5	未检测到版本号	当前上传APK文件未获取到版本号	参看AndroidManifest.xml文件中versionCode值
6	版本号过低	当前上传APK版本号小于或等于历史就近上传的版本	参看AndroidManifest.xml文件中versionCode值
7	非正式版本	当前上传的APK文件是一个DEBUG版本	参看AndroidManifest.xml文件中debugable属性，若为true，则为debug版本
8	APK未签名	当前上传的APK文件签名与历史上传并审核通过的APK签名不一致
9	签名不一致	当前上传的APK文件签名证书与历史上传并审核通过的APK签名证书不一致
10	证书不一致	当前上传的APK文件签名证书与首次上传并审核通过的APK签名证书不一致
11	证书解析失败	APK文件签名证书解析异常
12	未集成奇遇SDK	游戏APK文件未检测到奇遇SDK的相关so文件
13	奇遇SDK版本过低，请升级到X以上版本	奇遇SDK版本低于后台配置的最低版本要求	X为当前后台配置的最低版本值为1.0.0
14	安卓SDK版本过低，请升级到X以上版本	安卓SDK版本低于后台配置的最低版本要求	X为当前后台配置的最低版本值为26，详情及其他历史版本请参看：https://en.wikipedia.org/wiki/Android_version_history (opens new window)
15	签名证书无效	使用了Android的DEBUG证书签名了APK	使用自有证书重新签名APK
16	未集成平台SDK	应用未集成奇遇平台SDK	对于要在奇遇商店上线的应用，必须集成奇遇平台SDK，Unity开发者请参考：https://dev-qiyu.iqiyi.com/doc/zh/develop/unity/platform/platformsdk.html (opens new window) Unreal开发者请参考：https://dev-qiyu.iqiyi.com/doc/zh/develop/unreal/platformsolution.html (opens new window)