详细说明


  1. 注册登录
  2. 个人信息编辑
  3. 创建游戏、发布计划
  4. 接入西瓜SDK
  5. 配置
  6. 充值补单
  7. 协作日志
  8. 社交分享配置
  9. 运营统计
  10. 接入交流

1.注册登录

  • 登录西瓜web控制台进行账号注册,注册时请填写真实信息,以便找回密码和后续反馈交流。

  • 注册成功后进行登录,如果此时您忘记了密码,请点击“忘记密码”开启密码重置技能。

  • 点击 “渠道接入” ,开始西瓜SDK的接入之旅!

2.个人信息编辑

  • 登录成功后,点击用户头像,即有弹出框,选择“账户设置”。

  • 修改自己需要修改的信息,完成修改后点击保存即可。

2.1 修改密码

  • 点击右方用户头像,然后点击“账户设置”

  • 点击“修改密码”,然后保存

2.2 邀请成员

  • 点击右方用户头像,然后点击“应用中心”

  • 选择你需要添加成员的游戏,然后点击“邀请成员”

  • 输入邀请人的邮箱,选择被邀请人的管理权限。可批量邀请成员。

2.3 权限说明

普通用户: 管理员无锁定的情况下 ,可以配置渠道参数,上传签名文件,上传、下载角标资源,上传自定义资源,高级配置填写,充值补单查询;管理员锁定后,只能查看信息,下载角标资源以及查询充值补单,不能进行修改参数

管理员: 普通用户权限+编辑/删除发布计划、锁定/解锁发布计划、锁定/解锁充值回调地址、邀请成员

  • 锁定单个发布计划,普通成员无法修改该发布计划,如需修改参数配置需要联系管理员解锁

  • 锁定发布计划,包括角标资源

  • 锁定正式环境充值回调地址

  • 锁定正式环境充值回调地址以及各个渠道的 充值回调地址

  • 锁定高级配置

3.创建游戏、发布计划

在所有的工作开始前,请先创建游戏。

3.1 创建游戏项目

进入“渠道接入”页面,点击"新建游戏项目",创建游戏。

  • 游戏名称:同一个用户不能创建2个相同名称的游戏;
  • 游戏类型:选择游戏所属类型(必选项);
  • 上传游戏图标(可选项)。 输入以上信息点击确认即可。

3.2 选择游戏平台

当新建一个游戏后,会生成Android和ios两种游戏平台,操作前请先选定所要操作的平台(Android和ios的操作互不影响)。

3.3 创建发布计划:选择游戏版本的上线时间和渠道

每个游戏可以有多个发布计划,发布计划可以根据游戏的上线计划不同而进行区分,使打包更加便捷。在一个发布计划中可以清晰掌控每个渠道的接入进度,可以更好的进行时间上的把控。
点击“发布计划”中“新建计划”,输入完整信息,如图:

  • 上线日期:游戏上架时间;
  • 计划名称:如删档内测版、不删档公测版等;
  • 发布渠道:选择游戏上线渠道,至少要选择一个渠道;在选择渠道时可以选择所需的渠道SDK版本(默认版本是当前所支持的最新版本,如图中红框所示),点击创建完成创建发布计划。

如果在创建发布计划没有您所需要的渠道或者渠道版本,点击“没有您要的渠道或版本?”输入相应的信息点击“确定”,即可反馈给我们。

3.4 查看发布计划

点击发布计划,可以查看到发布计划中每个渠道的状态,如图:

发布计划中的5步代表含义:

  • 第1步——配置渠道参数:需要将申请到的渠道参数配置到西瓜web控制台(配置渠道参数详细过程请参考5.1渠道参数

  • 第2步——验证渠道参数:接入西瓜SDK并用西瓜的打包工具生成“制作参数测试包”后,进行参数的验证

  • 第3步——上传图标资源:如果渠道要求有角标,则需要上传指定格式的角标资源;若无角标要求,进度条会自动亮起;图标资源也可以利用“西瓜打包工具”进行制作,在打包工具指南中将详细介绍

  • 第4步——渠道包就绪:利用打包工具打出渠道包,打包完成后在打包工具中点击“就绪”即会亮起(仅代表一个打包完成状态)

  • 第5步——成功上架确认:渠道包通过渠道审核后手动点亮发布计划中的“提交渠道审核”并点击确认即可点亮进度条(此步只是一个状态表示,亮灭均不会影响游戏上架)
    温馨提示:虽然完成渠道参数配置后,就可以进行打包,但是西瓜强烈建议您进行渠道参数验证和根据渠道要求上传图标资源。

3.5 编辑发布计划

在“发布计划”中点击编辑发布计划按钮,您可以修改该计划的上线时间,计划名称以及上线渠道

点击“修改”进行保存

3.6 克隆发布计划

克隆发布计划可以选定当前已有的发布计划,克隆此发布计划的渠道个数、渠道版本(默认更新至最新版本)、渠道参数、充值回调、角标资源和高级配置;如果需要增减渠道,可点击本发布计划的“修改按钮”进行修改。
克隆功能避免了对同一渠道的参数的二次填写,降低填写过程中出错的几率。

注意:克隆后的发布计划只会继承父发布计划的3个进度条状态:

  • “配置渠道参数”:参数个数、名称不变则点亮,若发生变化则置灰;
  • “验证渠道参数”:参数个数、名称不变则点亮,若发生变化则置灰;
  • “上传图标资源”

3.7 锁定发布计划(只有管理员才有该功能的操作权限)

如果您是管理员,就有权限对发布计划进行锁定和解锁操作;锁定后渠道参数、充值回调地址、图标资源、签名文件都不可修改,需解锁后才能修改。

锁定按钮被点亮表示当前计划被锁定,如图:

温馨提示:游戏上线后锁定对应的发布计划,可有效避免一些失误操作。

3.8 渠道新版本提示功能

当渠道的新版本发布后,将会在渠道版本号下方显示红圈,若需要更新版本号,可以点击“编辑发布计划”

点击”修改发布计划“,可查看本发布计划中共有多少渠道有新版本,如下图:

将渠道SDK版本号更新了之后,升级提示消失

4.接入西瓜SDK

4.1游戏基本信息

4.1.1 选择游戏基本信息

点击左侧菜单栏的“游戏基本信息”,选择游戏引擎和横竖屏(这两个选项为必选项)
基础包名是不带渠道后缀名称的游戏包名,西瓜会自动生成相应渠道的渠道包名。

4.1.2 下载西瓜sdk接口包、渠道包制作工具

在西瓜SDK接入准备工作的下载中心点击“西瓜sdk接口包、渠道包制作工具下载 ”或者点击窗口右上方的“下载”按钮,根据游戏具体情况下载相应的XGSDK接口包和XGSDK打包工具。


4.1.3 将西瓜接入参数配置到游戏中
  • 新游戏如何获取接入参数:创建一个新游戏就可以获得西瓜分给游戏的接入参数:XgAppId、XgAppKey、XgServerKey
  • 已创建的游戏如何获取接入参数:如果游戏已创建完成,则可以点击"游戏基本信息"查看分配给游戏的接入参数,具体如下:


4.1.4 进行SDK接入
  • 点击下载"客户端接入指南"和" 服务端接入指南 "
  • 参考 客户端接入指南服务端接入指南 进行接入(客户端接入指南包括: cocos2d-x 引擎接入指南、unity3d 引擎接入指南、原生接口接入指南;服务端指南包括:session 验证、支付通知)

4.1.5 正式环境充值回调地址

充值回调是游戏服务器接收订单支付信息的接口地址,该地址的配置有三种方式,优先级为:客户端传>渠道局部充值回调>全局充值回调(即正式环境充值回调地址)

  • 游戏通过客户端代码传此地址(最高优先级,也可不选择此方式进行传递)
  • 配置充值回调地址 中对不同的渠道配置不同的充值回调地址,如图所示(次优先级)

  • 在如下图所示的 正式环境充值回调地址 输入框中填写(此处只能填一个地址,最低优先级)

注意:

如果充值回调地址已经在客户端进行传递,填在西瓜后台的充值回调地址即会失效;
如果客户端未传递,填写了全局充值回调地址,部分渠道也填写了局部充值回调地址,对于这些渠道而言是取局部充值回调地址,其余渠道则取全局充值回调地址。

4.1.6 商品参数配置
4.1.6.1 商品参数配置说明

联想联通应用汇酷派朋友玩 渠道在填写参数时需要填写渠道分配给游戏商品的商品 ID,当游戏有多种商品时就需要一个商品映射机制。

4.1.6.2 商品参数配置步骤
  • 确定游戏商品ID
  • 在渠道后台进行商品配置,渠道会为不同的商品分配不同的商品ID,如图

  • 在“游戏基本信息”中找到商品参数配置

  • 点击“修改”进行商品参数的填写,如图

  • 在“渠道参数”中选择联想渠道,点击“商品ID映射”的“配置”按钮进行配置

  • 点击“编辑”按钮,进行商品ID映射配置

  • 将在渠道后台配置获得的商品ID,填写在对应商品的“渠道商品ID”位置,如图

  • 点击“确认”即完成了商品参数配置

4.1.7 XG闪屏

西瓜闪屏机制说明

西瓜提供了一套闪屏机制,支持渠道闪屏闪在第一屏,无需CP对不同渠道的闪屏做特殊处理。

4.2 接入调测

4.2.1 调测功能说明

提供接口管理功能,用来检查客户端接口是否全部实现; 提供接口调用日志查询功能,在调侧过程中,根据用户名查询所有接口调用。

4.2.2 调测功能使用

4.2.2.1 西瓜 SDK 接入验证
  • 接口调用管理,在“接入调测”页面,可以查询哪些接口未调用,如图

4.2.2.2 接口调用日志
  • 查询调测日志详情,输入调测时使用的用户名关键字和调测时间,搜索符合条件的调测日志

  • 点击“查看详情”,查看交互流程及结果,如图

  • 选择流程节点,查看具体交互参数

5. 配置

5.1 渠道参数

5.1.1 申请参数

此处配置的渠道参数为开发者在渠道申请得到的应用参数,渠道参数的具体申请步骤请参考参数申请指南获取相应渠道的渠道参数

5.1.2 配置参数

将获取到的渠道参数填入对应渠道的参数表中

5.1.3 配置渠道充值回调地址

渠道的回调地方配置方式有3类:

  • 将西瓜回调地址配置到相应渠道后台
  • 将西瓜回调地址在渠道讨论组交给渠道人员进行配置
  • 西瓜在渠道客户端代码传递,无需配置

CP需要根据以上3种不同方式进行回调地址的配置,配置完成后,需要在“渠道参数”的“配置回调地址”中点击“我已完成配置”,未配置回调地址的渠道会导致充值不到账(不包括第三种无需配置回调地址的渠道)。
注意:如果未点击“我已完成配置”则无法对该渠道进行打包。

回调地址配置步骤说明:

1.渠道后台配置:

2.渠道讨论组人工配置:

3.西瓜渠道客户端代码传递,无需CP配置,如图:

5.1.4 商品ID映射

西瓜所提供的渠道中,目前需要配置商品ID 的有以下渠道:联想、联通、应用汇、酷派、朋友玩、快发、易信、布卡、G站、萌即正义、移动、有量、迅乐、三星、快看漫画

具体操作参见商品参数配置

5.1.5 签名文件

签名文件分为3种:

  • 渠道有要求必须使用渠道所提供的签名文件(目前只有新浪、当乐对签名文件有要求),按照规定的签名文件格式生成签名文件并进行上传;
  • 在渠道对签名文件无要求时,游戏可使用自己提供的签名文件,按照规定的签名文件格式生成签名文件并进行上传;
  • 渠道、游戏对签名文件均无要求时,即可使用西瓜为游戏生成的

替换功能:游戏可以上传自己的签名文件,步骤如下:

还原功能:可以将当前的签名文件替换为西瓜为游戏生成的原始签名文件。
如果替换错签名文件,可点击“还原”—“确认”,即还原为西瓜为游戏生成的原始签名文件。

若有些渠道对签名文件有特殊要求,需要单独使用不一样的签名文件,即可在“渠道参数”中选择对应渠道上传所需的签名文件。
渠道签名文件上传步骤:

  • 点击签名文件的“配置”按钮
  • 上传“keystore文件”
  • 配置该keystore文件的三个属性值:alias、storepass和keypass
  • 点击确认进行保存

5.1.6 全部参数配置完毕,即可进行保存。

5.1.7 渠道参数验证(详细验证步骤参考:参数验证指南

渠道参数配置好后,进行参数验证(此步骤并不是必须的,但是建议对参数进行验证):利用西瓜提供的打包工具生成的“制作参数测试包 ” 进行渠道参数的验证

即实现如下三点:

  • 能够正常登录;
  • 所有渠道所支持的充值方式均能成功调起即弹出充值页面;
  • 选择一种充值方式充值到账。

5.2 充值回调

具体内容参见正式环境充值回调地址

5.3 角标资源

为了满足渠道对角标的要求,西瓜提供了2种生成角标机制:

  • 使用西瓜打包工具进行带角标的icon制作;
  • 游戏自行制作好角标资源并上传到西瓜web控制台。

2种方式的操作步骤如下:

1.使用西瓜打包工具进行带角标的icon制作

  • 打开西瓜打包工具

  • 选择游戏以及需要上传图标资源的渠道,在渠道名称左侧打勾,然后点击“制作图标资源”

  • 点击“浏览”载入图标,名字必须以png结尾,在游戏的manifest文件中找到application中icon名字:如 <application android:icon="@drawable/app_icon" android:label="@string/app_name" android:theme="@android:style/Theme.NoTitleBar"> app_icon部分是png图片的名称,然后点击“制作并上传”

  • 图标下方显示“上传该渠道资源包”,即为上传成功,如有需要可以在此上传渠道资源包。滚动其他渠道,将会看见其他渠道也制作好角标

2.游戏自行制作好角标资源并上传到西瓜web控制台

对于有角标要求的渠道,首先下载渠道相对应的角标、闪屏素材和制作要求,制作符合渠道要求的游戏图标资源进行上传。

上传的角标资源压缩包结构如下所示,里面的文件夹一个都不能少喔,每个文件夹下都有一张不同分辨率的图标。

5.4 高级配置

5.4.1 配置渠道参数(使用自定义AndroidManifest参数)
5.4.1.1 使用自定义AndroidManifest参数
5.4.1.2 使用场景

在AndroidManifest.xml文件中,可能我们针对每个渠道会有一些不同的配置项,例如JPUSH插件,每个渠道都有不同的APPKEY值。这时候为了使用同一个游戏母包进行打包操作,游戏开发者需要在母包的AndroidManifest.xml中使用一个通配符来标识这个配置项,然后通过西瓜web控制台后台配置这个通配符在各个渠道的值,西瓜SDK就可以在打包阶段正确地打出每一个渠道包。

目前西瓜SDK支持10个AndroidManifest自定义参数。分别是:

  • xg_param1
  • xg_param2
  • xg_param3
  • xg_param4
  • xg_param5
  • xg_param6
  • xg_param7
  • xg_param8
  • xg_param9
  • xg_param10

这些KEY值目前是固定的。value值可以在西瓜web控制台-“高级配置”中进行指定。

5.4.1.3 操作

以配置JPUSH_APPKEY为例,JPUSH_APPKEY的值在每个渠道都是不一样的,我们这里使用xg_param1这个自定义参数值(当然你也可以选择其他的):

  • 在母包的AndroidMinifest.xml文件内容:
        <meta-data android:name="JPUSH_APPKEY" android:value="$xg_param1$" />
  • 依次在【高级配置】 -> 【发布计划】 -> 【渠道】,进行参数值的配置。如下图所示,我们配置一个UC渠道的JPUSH_APPKEY的值。如有多个渠道请每个渠道分别配置对应的JPUSH_APPKEY的值。

  • 使用西瓜提供的打包工具(含命令行工具)进行打包之后,最终生成的渠道包apk中的AndroidManifest.xml对应的配置将被替换成:

                 <meta-data android:name="JPUSH_APPKEY" android:value="23ocd36n2dx345dsxx73d" />
    
5.4.1.4 注意
  • 目前的KEY是固定的,支持10个自定义参数,可以自由选择使用哪一个。

  • 母包中如果使用了自定义参数,则必须在西瓜web控制台中对应的发布计划和渠道必须配置对应的参数值,否则无法打包成功。

  • 如果同一个发布计划中有一部分渠道不需要自定义参数,比如计划【游戏内测发布计划】中有三个渠道,分别是:【360】、【UC】、【爱游戏】,其中【360】和【UC】两个渠道有自定义参数,【爱游戏】没有自定义参数,那么请使用带自定义参数和不带自定义参数的两个母包,并且在实际打渠道包的时候针对【360】和【UC】使用带参数母包,针对【爱游戏】使用不带参数的母包。

  • 自定义渠道参数的值不支持为空的替换。例如【爱游戏】渠道不需要配置JPUSH_KEY,则需要提供一个AndroidManifest.xml中不含有JPUSH_KEY的母包,而不能将【爱游戏】中的JPUSH_KEY的自定义参数值设置为""(空字符串)。

5.4.2 自定义资源

某些渠道需要在apk包中放置一些必要的资源文件,例如【爱游戏】需要将feeInfo.dat文件放置在assets目录下。 我们在西瓜web控制台中的高级配置下可以指定渠道上传自定义游戏资源,该资源将在打渠道包的过程中,被拷贝到apk根目录下。

具体操作
以【爱游戏】配置feeInfo.dat资源为例,该文件需要放置在assets目录下。

  • 在本地创建assets目录,将feeInfo.dat放置于assets目录中。

  • 将assets目录压缩成zip包,文件名可自由定义,例如叫custom_res.zip。此zip包的结果如下:

             custom_res.zip
          |_ assets
              |_ feeInfo.dat
    
  • 导航到【高级配置】 -> 【发布计划】 -> 【渠道】,点击上传按钮,选择刚刚生成的custom_res.zip包上传,如下图所示:

6. 充值补单

进入充值补单界面,如果游戏在24小时之内有出现“游戏拒绝”状态的订单,页面上会出现提示,可以点击立即处理来对游戏拒绝订单进行处理。
点击补单按钮,会对“游戏拒绝”的订单进行补单,补单成功后,订单状态从“游戏拒绝”变成“订单初始化”。

充值补单可以对所有订单进行查询,可以设定特定渠道、订单状态、订单时间等搜索条件。当订单状态为“游戏拒绝”时,该订单会显示补单按钮,点击补单按钮,会对“游戏拒绝”的订单进行补单,补单成功后,订单状态从“游戏拒绝”变成“游戏通知成功”,补单按钮将会消失。

系统提供了按条件搜索、订单号搜索和按角色ID搜索功能,用于查找一个或多个订单和某个角色相关的所有订单。

6.1 条件搜索

6.2 按订单号搜索

6.3 按角色ID搜索

7.协作日志

协作日志可以查看所有用户对游戏进行过的操作。

筛选查找:可以对某一特定事件、发布计划、渠道来进行查询,使得查询过程更快捷简便。

8.社交分享配置

社交分享配置提供了对现行主流分享平台的支持。目前已支持的平台包括:

  • 腾讯QQ
  • 微信
  • 新浪微博

要使用分享平台,我们应该首先打开分享开关,然后进行分享平台参数配置,接着打包工具将能够识别并为相应的渠道包添加分享功能模块。

  • 分享开关分为两级:游戏级和平台级。请参考 8.1 打开/关闭分享

  • 分享配置分为两种维度:产品维度和包维度。
    -- 产品维度 是一个游戏使用一套分享参数。目前腾讯QQ使用产品维度的配置方式;
    -- 包维度 是一个游戏内的不同包名单独使用一套参数,目前微信和新浪微博使用此类型的配置方式;
    具体配置信息请参考 8.2 配置分享平台参数

注意:应用宝渠道暂不支持分享功能。

8.1 进入分享页面

需要在XG后台进入分享功能页面,具体如下图:

8.1.1 打开/关闭平台级别分享开关

需要打开分享平台级的开关,分享功能才能最终起作用。
操作步骤:

  1. 进入分享功能页面;
  2. 右边将出现【腾讯QQ】、【新浪微博】、【微信】三个标签页,每个标签页的标题最右侧有一个按钮,亮起(蓝色)表示该平台分享处于开启状态,灰色表示该平台分享处于关闭状态。您可以通过点击改变其状态。

    具体示意图如下:

8.2 配置分享平台参数

如前所述,分享平台的配置方式分为两种维度。

  • 产品维度
  • 包维度

下面针对每个平台和维度分别说明:

8.2.1 产品维度平台配置(腾讯QQ)

一个游戏要接入腾讯QQ的分享,只需要申请一套参数。并且这个参数只有一个即 AppID

8.2.2 包维度平台配置(新浪微博和微信)

以新浪微博为例(微信也是一样的)。

新浪微博属于包维度,因为新浪平台的每一套参数配置都跟游戏包本身的包名有关(申请时需要提供包名),所以同一个游戏如果在不同的渠道使用不同的包名进行推广,就需要在新浪微博分享平台中,为每一个包名的游戏渠道包申请一套独立的参数。
注意:包维度配置需要输入包名,此包名请务必和游戏申请分享平台参数时候的包名完全一致!!

新浪微博需要提供 AppIDAppSecret 两个参数.

具体操作步骤:

  1. 点击添加包名;
  2. 输入包名,点确认;
  3. 在右侧填写微博的参数值。
  4. 点击“保存”

8.2.3 删除配置信息(仅限包维度)

同样以新浪微博为例(微信也是一样的)。

1.点击【编辑包名】可以打开编辑模式,如图:

2.点击包名右边的【删除】按钮,会弹出删除确认框,点【确认】即可删除对应包名及其参数配置。

9. 运营统计

运营人员要去数据平台,以下三种方式可以进入,如下图所示。具体内容请点击这里查看“统计分析”说明。

方式一:进入西瓜官网(网址),“服务”中选择“运营统计”;

方式二:在用户中心点击“运营统计”下的“立即进入”

方式三:在游戏渠道上方点击“渠道接入”下的“运营统计”

10. 接入交流

西瓜提供了QQ群以方便用户的交流反馈,感谢您对西瓜SDK的支持。