第三方后台配置—Android版(bak20240708)

第三方后台配置—Android版(bak20240708)

wapublisher No Comments

1.Google后台应用配置

google控制台地址:https://console.developers.google.com

1.0 Google后台公共配置

Google后台首先需要做一些公共配置,大致流程如下:

图片1
上图中的所涉及到的流程在后续章节中都有详细指引。

1.1 Google API控制台公共项目配置:

简要流程:
1.API控制台创建一个公共项目用于Play 控制台关联(如果已经有关联的项目则不需要再创建,一个主开发者帐号只能关联一个项目)
2.Play控制台关联API控制台的公共项目
3.API控制台中在公共项目中创建服务者账号,下载P12证书文件
4.Play控制台中为服务者帐号开放权限,目前只需要查看财务权限
5.将P12证书文件和服务者帐号保存至WA后台

1.1.1 API 控制台创建新的公共项目

打开Google API控制台,创建一个新的控制台项目

注意:如果使用现有的公共项目(Google Play Console已关联的项目),可以不新建。

图片2
点击”新建项目”
图片3
在”新建项目页面”输入项目名称,点击“创建”新建即可完成新项目创建

图片4

项目名称需要保存记录,对应windsdk后台中,添加google支付平台的需要填写的应用名称栏目

1.1.2 控制台关联公共项目

打开Google Play开发者控制台,在设置->API权限->关联项目中,关联前面创建的公共项目。如果已关联,则下一步在已关联的项目中创建“服务者账号”即可。:

图片6


1.2.API控制台创建服务账号(Service account key)*

服务帐号是SDK后台验证支付订单时候使用,运营人员需要将服务帐号和证书保存至SDK后台。SDK后台的操作请参考《WINGSDK后台基础设置》 。不同的应用,不要使用相同的服务帐号。

打开Google API控制台,选择公共项目,进入项目“API和服务”中的“凭据”页面

图片7

在“凭据”页面,点击“创建凭据”,选择“服务账号”

图片7

进入“创建服务账号”页面,第一步填入“服务账号名称”

图片2

第二步选择服务账号“角色”,分配“Editor”角色,然后点击“继续”

图片2

第三步中直接点击“完成”即可
图片2

接下来在公共项目的“凭据”中“服务账号”列表找到刚创建的“服务账号”

图片2

点击进入该“服务账号”的编辑界面,选中“密钥”标签,点击“添加密钥”并选择“创建新密钥”

图片2

在弹出框中选择“P12”类型私钥,点击“创建”

图片2

点击“创建”后,浏览器会自动下载“P12”私钥文件

图片2

“P12″私钥文件需要妥善保管,在WingSDK后台中添加Google支付平台时会要求上传该文件。

1.1.4 Play控制台“服务账号”权限配置

创建“服务账号”完毕后,在Google Play控制台,设置->API权限的页面的“服务账号”列表中,可以找到新创建的“服务账号”查看并修改权限

图片2

选中“账号权限”标签,只勾选“查看财务”权限即可

图片2

选中“应用权限”标签,添加该“服务账号”对应的游戏,点击“应用”

图片2

在弹出框中确认已勾选“查询财务数据”权限,点击“应用”完成添加

图片2

完成“应用权限”和“账号权限”配置后,点击“邀请用户”发送邀请

图片2

之后可以在“用户和权限”中看到该“服务账号”,并且状态是“有效”

图片12

进行完上述操作之后,将“服务帐号”(即邮箱)和“P12”私钥文件保存至WA后台即可。

1.3 Google API控制台游戏项目配置

简要流程:
1.创建专用于游戏的新项目
2.在游戏项目中新建Web类型ClientID,用于WA后台Google登录配置
3.在游戏项目中新建Android类型ClientID,需要研发提供包名(PackageName)和应用签名jks文件的SHA-1信息

1.3.1 创建专用于游戏的新项目

同上面公共项目创建一样,新建一个专用于游戏的项目

图片2

图片2

1.3.2 启用Google+ API

在游戏项目中,选择进入“API和服务”中的“已启用的API和服务

图片2

在“已启用的API和服务”界面,选择“+启用API和服务”,进入“API库”界面

图片2

在“API库”中,搜索“Google+”,选择并进入“Google+ API”

图片2

图片2
在“Google+ API”产品详情页面中,点击“启用”

图片2

1.3.3 同意屏幕配置

在添加OAuth Client ID之前,必须先完成“同意屏幕”配置。“同意屏幕”会影响用户授权是看到的界面,如下:

图片2

图片2
首先在前面新建的专用于游戏的“项目”中,进入“同意屏幕”界面,操作如下

图片2

在“同意屏幕”配置界面,UserType选择“外部”,然后点击“创建”

图片2

第一步,填入“应用名称”和“用户支持电子邮件”,以及“开发者联系信息”,这几项都是必填项目。

其中“应用名称”将会是用户授权登陆时看到的应用名称,其他可选项根据实际情况决定是否填写,下面是可选项的影响及要求:

1.应用的徽标和名称:建议使用徽标,但不强制要求使用
2.用户可以用来与您联系的电子邮件地址以及范围列表:范围是您的应用对访问用户的 Google 帐号以及会共享哪些数据的具体请求。您将在下一步中添加范围。
3.指向应用隐私权政策和服务条款的链接

此部分内应包含:

一个描述用户可以如何管理对其 Google 帐号的访问权限的句子
一个指向 Google 文章的链接,其中介绍了 Google 如何帮助用户安全地共享其数据

图片2
图片2

第二步数据访问“范围”配置,这一步无需处理,直接下一步即可

图片2

第三步“测试用户”配置,这一步也无需配置,直接下一步

图片2

第四步“摘要”,到这一步已经完成“同意屏幕”配置,可以在“摘要”界面审查自己的配置,也可以直接返回。

图片2

正确配置完成OAuth同意屏幕后,“发布状态”默认是“测试版”状态。确保之前的配置无误后,还需点击“发布应用”,把“发布状态”改为“正式版”。

图片1

如果没有填写需要验证的项,可以无需验证直接发布到“正式版”,如下图“发布应用确认弹窗”点击“确认”即可完成发布。

图片2

图片3
如果是无需验证的,可以忽略以下验证过程的文章内容。
有需要验证的项的改动,则需要按照提示完成Google验证,例如添加了“应用徽标”点击“发布应用”,则是弹出下面提示框
图片4

点击“确认”后状态已是“正式版”,但是需要完成验证,点击“执行验证准备工作”
图片5

确认“OAuth同意屏幕”信息,“应用首页”和“应用隐私权政策链接”,属于必填项,填写之后还需要把这两个链接的域名加到“已获授权的网域”,点击“保存并继续”。
注意:“已获授权的网域”需要转到 Google Search Console(https://search.google.com/search-console/welcome) 来检查您的网域是否已经过授权,如何获得授权在Google Search Console也有描述和指引。

图片6

然后是确认“范围”,点击“保存并继续”
图片9

“可选信息”中,为了确保审核通过,尽量补充完善可选内容。另外按照之前提示框的提示,提供YouTube视频,展示如何使用从范围中获取的Google用户数据;还有一份书面说明,告知访问敏感数据和受限用户的原因

图片10

最后勾选声明,点击“提交以进行验证”完成提交。敏感范围验证最多需要10天才能完成,受限范围需要数周时间,其他图标,主页,隐私政策通常需要2-3天。

图片11


1.3.4 创建Web类型OAuth Client ID

进入游戏“项目”的“凭据”界面,点击“创建凭据”选择“OAuth客户端ID”

图片2

在“应用类型”中选择“Web应用”类型

图片2

填写“名称”,然后点击“创建”即可完成创建

图片2

在创建完成提示界面中,可以直接 复制刚创建的“Web客户端ID”保存,后续将需要提供给研发和WA后台Google登录配置。

图片2

1.3.5 创建Android类型OAuth Client ID

跟创建Web应用“OAuth 客户端 ID”类似,在游戏“项目”的“凭据”界面中创建“OAuth客户端ID”,但是类型选择“Android”

图片2

填写“名称”,“包名”,“SHA-1证书指纹”,其中“包名”和“SHA-1”都由研发提供,获取指引如下:
包名:Android项目的applicationId,在“应用层级”的build.gradle文件中的android->defaultConfig->applicationId找到,具体参考下图

图片2

SHA-1证书指纹:首先需要研发创建游戏的“正式应用签名jks文件”,然后使用下方命令输出“SHA-1证书指纹”信息,输出结果参考下图
命令:keytool -keystore path-to-debug-or-production-keystore -list -v

图片2

图片2

创建完成之后,一般“隔天”会生效,生效后就可以正常进行Google登录

图片2

1.4 Play控制台更改应用签名密钥

为了确保由研发生成的“正式应用签名jks文件”在GooglePlay中正常生效,需要在Play控制台更改应用签名密钥。

若Play未创建应用,可以参考章节 《GooglePlay创建应用》 进行创建。

Play控制台中选择游戏应用,在“内部测试”轨道中选择“创建新的发布版本”或“修改发布版本”

图片2

不需要上传应用,直接点击“更改应用签名密钥”,在弹出的确认框中点击“使用其他密钥”

图片2

图片2

接着在“应用签名偏好设置”界面中,选择“从Java密钥库导出并上传密钥”,在这里按照指示完成“zip文件”上传,最后点击保存。具体指示说明参考下图

PEPK工具文件:下载pepk.jar

命令:

注意 java版本最好是11版本或以上,否则执行会出错

图片2

保存完成之后,可以在游戏应用的“设置”->“应用完整性”中找到Play中已生效的“SHA-1”信息,把这个跟前面研发提供的“SHA-1”进行比对,一致则说明配置正确,否则需要重新配置,同样是从“内部测试”的“更改应用签名密钥”开始。

图片2

1.5 Google Play创建应用

进入“所有应用”界面,点击右侧“创建应用”

图片10

按照要求填写或选择“应用名称”,“默认语言”,“应用或游戏”,“免费或付费”,并且勾选同意“开发者计划政策”和“美国出口法律”。
免费或付费:免费指下载免费,付费指付费才能下载

图片11

1.6 Google Play添加应用内商品

添加应用内商品前,按要求需要先上传有BILLING 权限(接入WingSDK的Google模块默认带有该权限)的应用包,建议在“内部测试”完成上传,上传应用包即可达成条件,无需发布。

图片2

单个商品创建

在游戏应用的“应用内商品”界面,可以“创建商品”
图片2

按照提示填写完成对应项,最后点击“保存”,其中“设置价格”和“税费和法规遵从设置”界面如下图
注意:商品ID是唯一的,即使被删除后也依然占用原ID。

图片2

图片2

图片2

保存之后,商品默认是“无效”状态,需要点击“启动”改为“有效”状态

图片2

“启用”商品之后,在应用内对应商品详情界面,可以进行停用及删除

图片2

批量导入商品

GooglePlay后台目前支持批量导入,因为csv模板可能会变更,所以建议先创建一个商品,再导出,根据导出的最新csv模板样式,添加商品,再保存csv文件上传导入。

同样是在“应用内商品”界面,先根据上一步操作创建一个商品,然后点击“创建商品”旁边的选项“图标”,选择“导出”

图片2

导出的商品csv文件内容如下图,再参考已有的导出商品,按照相同方式补充完剩下的商品,保存商品csv文件

图片2

同样是“应用内商品”界面,点击选项“图标”,选择“导入”

图片2

导入最新的商品csv文件。注意:批量导入,如果csv商品文件中包含已有商品则会修改对应商品内容。

图片2

导入完成之后就可以在列表中看到所有已导入的商品

注意:如果文件内容中有中文,那么csv文件可能存在乱码问题,如果有这种情况,需要把csv的编码改为utf-8,确认中文字符正常,再保存上传。

 
 

1.7 添加Google Play测试用户

在应用未正式发布前,Google支付可以在Google Play添加测试用户才能进行沙盒测试。

详细的GooglePlay应用测试说明和方法可参考下方官方文档:
https://support.google.com/googleplay/android-developer/answer/9845334

“封闭式测试”和“内部测试”:
进入游戏应用的“内部测试”轨道(“封闭式测试”也相似),在“测试用户数量”标签中,如果勾选“已有测试列表”,如果没有则“创建电子邮件列表”再勾选(创建界面截图如下),然后保存。保存之后可以复制“测试邀请链接”,发给测试人员,注意要发布过版本才会有“测试邀请链接”

图片2

图片2

测试人员在浏览器上登录被邀请的Google账号,然后打开“测试邀请链接”,点击“接受邀请”

图片2

“接收邀请”之后,测试人员根据指示下载测试版应用安装测试

图片2

 
 

1.8.添加Google Game Service支持

在开发者管理者控制台左侧菜单打开“游戏服务”菜单,在列表中选中需要新建成就的游戏服务。

图片27

如看不到Play 游戏服务,则在顶部搜索栏中搜索”Play游戏服务设置”,然后选中
图片27

选中“是,我的游戏已经使用了Google API”,此时在下方选择要关联的项目。选择项目,下一步即可完成创建。(如没有创建Google API项目,则参考 1.3.子项目中配置应用的OAuth Client Id* 流程先创建子项目)

图片28

在游戏服务中添加新游戏之后自动生成了Google Game Service App Id,此值需提供给开发人员,如下图所示:

图片28

如提示配置OAuth同意屏幕,按照要求操作同意接口,同意完后,点击添加凭证,选择Android类型,输入名称等基本信息,选择OAuth客户端即可,然后保存。(默认情况下选择OAuth客户端只有一个,如若多个,可以选择后,查看包名和指纹是否和应用的一致进行确认)

图片6

创建完游戏服务之后就可以创建成就和排行榜了,创建完的游戏服务,必须要发布才能够使用。

在goolge应用控制台为某一个应用添加Google Game Service成就,请参考以下官方文档:
https://developers.google.com/games/services/common/concepts/achievements
 
在左侧菜单选择“成就”,点击页面“添加成就”可以添加新的成就。

图片28

1.9.Google 促销商品配置

参考地址:https://developer.android.com/google/play/billing/promo
登录Google Play后台,选择对应应用进入详情,选择获利—产品—促销代码,点击创建促销代码

图片36

输入 促销活动名称、开始时间、结束时间,促销类型选择应用内商品,然后选择需要参与促销的商品,输入促销代码数量,保存即可。

图片36

当到达输入当开始日期时间后,促销码就可以使用。在您的应用中:用户可以点击 Google Play 购买屏幕中付款方式旁边的向下箭头,然后点击兑换链接以输入代码,由此发起购买交易

图片36

选择兑换代码,输入对应兑换代码
图片36

注:创建促销商品的商品id为google_001,在应用内兑换时,需要点击相对应的商品(对应google商品id为google_001)弹出支付界面,然后输入兑换码才能正常兑换。

另外,也可在 Play商店-账号信息-付款与订阅-兑换代码,然后点击兑换代码进行兑换(预注册奖励也可使用此方式测试)

69F23255C7F76711D90C33F3613C701D

197237B259B014FAB5F19B4A37E0CF04

39C0572ED38C0E13893AA9066FB7FA19

BA4A3D184552C77DE97631C56B3BA921

AB432970EF1F97A2B4A97B05FC53F2AC

5A17CC07EE19116B87EBE81F3A3EA432

 
 

1.10.Google Play 签名密钥

如果已经成功执行《Play控制台更应用签名密钥》 章节,本章节可以忽略。若需要更详细了解Google Play密钥,或者需要升级密钥,可以查看本章内容。

Google Play控制台的签名密钥有两种,一种是应用签名密钥,一种是上传签名密钥,他们对应的实体文件是keystore/jks文件。

上传签名密钥:上传Google Play 的aab或apk包必须使用该签名秘钥进行签名,不能使用证书指纹不一致的应用签名秘钥或者其他签名秘钥,否则会提示签名错误,无法上传。该签名密钥用于Google Play验证上传的应用包的合法性。

应用签名密钥:是应用最终所使用的签名密钥。虽然上传Play的应用包使用的是上传签名秘钥签名,但是正式上架对外时,Google Play会抹去原来的签名,并使用应用签名秘钥签名。

为了方便管理,建议“应用签名密钥”和“上传签名密钥”使用相同的签名密钥jks文件
说明:使用下面步骤,不包含“上传签名密钥”的配置,因为Google不允许两个签名一致,但是“更改签名密钥”时不进行“创建新的上传密钥”即可让两个签名保持一致。

1.10.1.上传自己的签名密钥

创建应用版本会默认加入Google签名计划,该计划实际内容是:由Google自行创建签名密钥,并保存在谷歌服务器,无法访问和下载,最终向用户分发应用时再由Google进行签名。默认方式的签名密钥文件不可访问,无法控制,不利于管理签名密钥文件和调试测试,所以建议上传自己的签名密钥。

注意:这一步,是应用未正式上架时可以重复操作修改的,但是正式上架后不可用再从这里修改,需要参考下一章节执行“升级密钥”操作才可更改。

具体操作同《Play控制台更改应用签名密钥》一致,最终验证“应用签名密钥证书”和“上传密钥证书”保持一致即说明配置正确。

1.10.2.验证签名密钥配置

1.研发在命令终端通过输入keytool命令获取签名密钥jks文件的证书指纹。
命令:keytool -list -v -alias ALIAS_NAME -keystore KEYSTORE_PATH

图片_20230307160725(1)

2.在Google Play控制台的,设置->应用完整性,中找到当前生效的密钥证书信息

图片2

1.10.3.升级应用签名密钥

适用对象:已上架,并且之前执行过《Play控制台更应用签名密钥》 章节,把默认的Google生成签名改为自己签名文件的应用

不适用对象:
1.未上架的应用,无需升级也可在“内部测试”或任意轨道版本中选择“更改应用签名密钥”进行更改
2.已上架,但是之前默认由Google生成签名的应用(未执行过《Play控制台更应用签名密钥》 章节),界面参考下图

使用“Google生成的签名”的应用,会没有“请求升级密钥”按钮

图片2

升级注意:“请求升级密钥”操作,一年只有一次机会,无法撤销,请谨慎操作

同样是“应用完整性”页面,在“应用签名”标签里面找到“请求升级密钥”按钮,并点击

图片2

在弹出框中,【关键】首先展开“隐藏选项”,选择“所有Android版本的所有安装”选项 。然后升级方式选择“从Java密钥库上传新的应用签名密钥”

图片2

按照“从Java密钥库上传新的应用签名密钥”的指示,下载PEPK文件给研发使用,研发使用指示命令生成zip文件,其中命令的黑体参数需要替换为本地对应参数,具体参考如下,最后完成“上传zip文件”,选择“升级原因”,点击“升级”。

foo.keystore:新的应用签名密钥jks文件
foo:foo.keystore文件使用的别名
upload.keystore:原应用签名密钥jks文件
upload-key-alias:upload.keystore文件使用的别名

注意:若upload.keystore使用的不是原应用签名密钥jks文件,会升级失败

图片2

在弹出框中确认升级影响目标必须是“所有Android版本上的新安装”,若不是则需要修改前面“隐藏选项”的选择。
确认升级影响目标正确后,点击“确认”完成升级。

图片2

升级之后可以在“应用完整性”的“应用签名”标签中,确认最新生效的“证书指纹”信息,也可以查看“曾用密钥”的证书指纹信息。另外升级后“请求升级密钥”按钮变为不可用状态,并且旁边会有显示上一次的升级日期

图片2

更多内容可以查看Google文档了解:
https://support.google.com/googleplay/android-developer/answer/9842756

1.10.4.应用签名密钥变更后续配置

无论是“上传自己的签名密钥”或者“升级应用签名密钥”,都会影响应用的验证,比如Google登录,Facebook登录等三方功能,所以修改后确认同步修改对应平台相关内容。

  • 如果是未上架应用“上传自己的应用签名密钥”,更改原有对应配置即可。
  • 如果是已上架应用“升级应用签名密钥”,为了保证旧的“应用签名密钥”用户也可以暂时使用,保留“原应用签名密钥”证书指纹相关配置,并添加新的“新应用签名密钥”证书指纹相关配置。

下面罗列一些平台需要用到签名信息的相关配置指南:

Google:Google Cloud Platform(https://console.cloud.google.com/)控制台,API和服务 -> 凭据中,添加Android类型的OAuth 2.0 客户端 ID,输入包名和新的应用签名的SHA-1证书指纹。子项目中配置应用的OAuth Client Id

Facebook:Facebook登录的“密钥散列”与应用签名有关,需要添加新的“密钥散列”。
添加签名密钥散列

Fireabse:关联应用有用到应用签名的SHA-1和SHA-256证书指纹,需要添加
手动关联GooglePlay应用

Huawei:华为应用需要配置证书指纹。
生成签名证书指纹

1.10.3.4 签名密钥常见问题

1.打包的时候该使用哪个签名密钥?
上传签名密钥,只有在给需要上传到Google Play任意轨道(测试或正式等)的应用包打包时使用。
其他任意时候,比如想在本地运行调试,或者本地打包测试,只要不需要上传到Google Play的,都使用应用签名密钥进行打包。

2.MD5,SHA-1,SHA-256这些证书指纹该用哪个签名密钥的?
上传签名密钥只有在上传Google Play任意轨道时候打包应用包时使用,其他任何情况都以应用签名密钥为准。所以给Google,Firebase,Facebook,Huawei等平台提供的SHA-1,SHA-256证书指纹都需要使用应用签名密钥的证书指纹。

3.什么是keystore/jks文件,怎么生成的?
二者是同一个东西,都是Android签名密钥文件,用来打包Android应用的,当前常用的是jks文件。该文件用于确保应用的唯一性及合法性,非常重要,请务必保管好该文件及相关的密码,并确保不会泄漏。
虽然可以使用JDK的keytool工具生成这两种文件,但常用的方式是开发者使用Android Studio生成jks文件,而keystore文件一般使用Eclipse生成。

4.Google Play上的应用签名密钥keystore/jks文件找不到了,能否重新生成一个跟上面相同证书指纹的签名密钥文件?如果不能又该如何处理?
不能生成指定证书指纹的签名密钥文件。Google Play上也无法下载签名密钥文件。
处理方法:
1)上传应用到任意轨道(正式或测试),从Play Store的应用页面下载应用,上面下载的应用都会使用应用签名密钥打包签名过。
2)如果想自己重新掌握keystore/jks文件,并且Play控制台中该应用未升级过应用签名密钥(每个应用只有一次升级机会),可以进行密钥升级,更换为新的keystore/jks文件信息。升级的时候务必选择“上传自己的签名密钥”,不要选择默认的“由Google Play生成。。。”,升级成功后也务必对一些平台上的配置做出相依的配置改动,否则会影响这些平台的API使用,如Google登录,Facebook登录等,具体升级请参考“升级应用签名密钥”章节操作。

5.应用打包运行之后的签名密钥,和Play上的应用签名密钥不一致会有什么后果?
通常会影响所有配置了与应用签名密钥有关信息的平台API。比如Google的Android类型OAuth ClientID使用了SHA-1,会影响谷歌登录,导致谷歌登录直接返回取消。Facebook使用的散列秘钥,影响Facebook登录。其他的还有Firebase的应用关联,Huawei的应用配置。

 

1.11Google Play 发布应用

准备应用包:
使用上传签名密钥打包签名好应用包apk或aab。若使用应用签名密钥或其他签名密钥,会提示错误。关于签名密钥可以参考上一章节说明。
注意:推荐aab,2021年8份起新应用必须使用aab包发布应用。Play发布的apk大小限制为100MB,aab大小限制为150MB,若超出大小限制,apk包需要使用APK拓展文件obb功能,aab需要使用Play Asset Delivery功能,对应用或游戏资源进行配置,才能上传成功。

登录Google Play 控制台,选择并进入需要发布的应用。

1.选择发布的版本,根据需要可以选择内部测试,封闭测试,开放性测试,正式版。
2、若是测试轨道,可以选择测试人员并保存

图片36

3.若是开放性测试,或正式版,需要设置发布的国家。

图片36

4.创建新版本,上传应用包,保存。若之前已上传过该应用包,可以直接从内容库中选择。保存之后,点击检查发布版本。

图片36

图片36

5.在检查发布版本页面,查看所有错误警告消息,若是错误,必须按照指引完成修改。完成所有错误的修改后,回到该页面,点击 开始发布,即可完成操作,等谷歌审核通过后,即是正式完成发布。

图片36

其他说明:发布前错误提示,信息中心需要完成步骤,主要是设置应用部分,按照指引完成任务即可。

图片36

 

1.12.Google广告ID声明设置

选择应用》应用内容》广告 ID进入声明设置
图片36

使用广告ID项选择 “是”,使用方式选择,“分析”,“广告或营销”,点击保存。
图片36

1.13.Google Cloud后台Appsflyer卸载检测配置

1.13.1.创建 AppsFlyer uninstalls角色

进入Google Cloud后台 ,选择项目,IAM和管理,选择角色

WechatIMG603

点击创建角色

WechatIMG604

名称输入 AppsFlyer uninstalls
ID输入 af_uninstalls
角色发布阶段选择 正式版
然后点击添加权限

WechatIMG605

过滤条件输入 cloudmessaging.messages.create

WechatIMG607

WechatIMG608

选择cloudmessaging.messages.create权限,点击添加按钮。最后点击创建按钮。

WechatIMG609

1.13.2.将AppsFlyer指定为卸载角色

进入Google Cloud后台 ,选择IAM,点击授予访问权限

WechatIMG610

新的主账号输入:af-uninstalls-tracking@af-uninstalls-tracking.iam.gserviceaccount.com
角色选择   :AppsFlyer uninstalls

WechatIMG611

WechatIMG612

然后保存,完成Google Cloud后台Appsflyer卸载检测配置操作。

2.Facebook第三方后台配置


2.1 Facebook基础配置

Facebook控制台地址:https://developers.facebook.com/

2.1.1 创建Facebook应用

一共有五种可选的应用类型:公司、游戏、小游戏、消费者或无。当您选择应用类型后,系统会为应用提供仅适用于该应用类型的产品(如登录,分析等产品)、权限(访问用户生日性别照片等数据权限)和功能,精简应用创建流程。
1、公司类型适用于可帮助公司和组织管理公共主页、小组、活动、广告以及和广告相关素材的应用。
2、游戏类型适用于可以在 Facebook 开放平台上游玩的游戏应用。
3、小游戏类型适用于可以在 Facebook 开放平台上游玩的游戏应用。
4、消费者类型适用于整合 Facebook 登录等消费者相关产品以便为用户提供更多帐户关联体验的应用程式。
根据说明,上面的“游戏类型”是适用Facebook游戏平台上的游戏。我们推荐创建应用类型时,选择“消费者”类型,该类型包含Facebook登录,分析,应用事件,应用链接,Instagram基本显示API,分享,社交等常用的产品。
想了解所有应用类型对应可使用的产品、权限和功能,可以查看Facebook官方文档: https://developers.facebook.com/docs/apps/app-types/

进入应用控制台,点击“创建应用”。
图片1

点选择用途“打造关联体验”(对应消费者应用类型),点击“继续”。

图片1

填写“应用显示名”,和“应用联系邮箱”,点击“创建应用”。
图片1

“创建应用”完成以后会立即进入到该应用的控制台页面。
图片1

移除应用类型

如果选择应用类型之后,在产品添加中没有找到自己需要的产品,或者当前应用类型提供的权限或功能无法满足需求,可以移除该应用的应用类型,或者重新创建新的应用类型的应用。移除应用类型之后,就是无指定类型的应用了,可以选择添加任何产品和申请任意权限及功能。
注意:移除类型后是无法再次指定应用类型的。

下面介绍如何移除应用类型:
进入目标应用控制台页面,点击“产品 +”,往下滑,找到“想找其他产品和权限?”卡片,点击“移除应用类型”按钮。

图片1
输入该账号的密码,点击“提交”

图片1

操作完成之后,在应用控制台中可以看到,已经不再显示应用类型了,并且可添加产品中,显示了所有的产品,权限页面也可以看到显示所有权限。

图片1

2.1.2 添加产品

创建完应用编号后,需要添加产品。点击左侧菜单栏中的“产品+”按钮,找到所需的产品,点击该产品卡片的“设置”按钮进行添加。(接下来以必接的登录功能为示例,另外在这里只需要对产品进行设置,所以会忽略其他非设置步骤)。

图片1


2.1.3 设置项目信息

点击“设置”进入产品添加的向导(菜单栏“快速启动”方式设置),选择添加的产品支持的平台(此处以Android平台为例)

图片5

图:选择产品支持的平台

选择平台后,进入平台的设置页面,在这个页面可以在上面的tab中切换不同的平台进行设置,第1、2步是SDK集成,由开发人员完成,进入第三步设置项目信息。

输入应用包名,和默认活动类的完整路径(如果使用DeepLink功能,需要填入DeepLink功能响应的Activity类路径,否则可以填入首个启动的Activity,例如MainActivity即可),点击“Save”保存。

图片5

图:填写Android项目信息

点击保存,如果你的应用在Google Play没有上架,会弹出下图“Google Play包名校验遇到困难”的对话框,点击“使用此包名”即可。

图片5
图:Google Play包名验证出现困难


2.1.4 添加签名秘钥散列

签名秘钥散列需要开发技术同事协助获取,获取到的字符串是包含 28 个字符的唯一密钥散列,获取方式参考Facebook官方文档。将生成的秘钥散列添加到“秘钥散列”下面的文本框,如果测试环境和正式环境不一样的签名文件,这里可以添加多个。添加后点击“Save”保存。

具体操作过程可以参考以下任何一种方式,他们都是相同的指引,然后按指引生成“发布密钥散列”进行添加:
1.Facebook控制台 -> 产品 -> Facebook登录 -> 快速启动 -> Android平台 -> 添加开发和发布密钥散列
2.Facebook登录接入文档,第6节-为应用提供开发和发布密钥散列:
https://developers.facebook.com/docs/facebook-login/android#6

图片8

openssl-for-windows 下载路径
命令行:

图:添加签名秘钥散列

2.1.5 启用单点登录

根据需求,如果需要启用单点登录,打开单点登录,保存进入下一步。
图片9
图:启用单点登录

2.1.6 其他配置及提供参数信息给技术配置到工程项目中

在左侧菜单点开“设置->基本”,将应用编号(Facebook App id)提供给技术配置到项目中,如果需要礼物功能,需要将应用密钥(App Secret配置到SDK后台,关于礼物的配置参考后续章节。如果需要使用游戏邀请功能,必须在设置中设置应用的类别为“游戏”。
图片5

在“设置>高级>安全”中找到“客户端口令”,将该参数(ClientToken)提供给技术配置到项目中。

图片6

2.1.7 相关产品的配置修改

如果需要修改相关产品的配置,在左侧菜单中的“产品”中找到相应的产品,“设置”展示所有设置,“快速启动”是包含了向导的设置。
图片9
图:产品配置修改


2.2 Facebook添加开发者

添加步骤如下:
在Facebook控制台页面,在左侧“用户身份”菜单展开,下面有两个,“用户身份”和“测试用户”。“用户身份”是配置哪些用户拥有编辑和查看应用的权限;“测试用户”用来测试不同应用功能的临时性的 Facebook 帐户。

图片18
图:用户身份配置


图片18
图:测试用户

2.3 上线注意事项

切换到线上模式,必须提供“隐私权政策网址”和“数据删除信息”。
“隐私权政策网址”必须提供有效的地址,在Facebook登录页面和应用详情页面会显示该入口。
“数据删除信息”,Facebook为了符合通用数据保护条例 (GDPR),可获取用户数据的应用程序必须执行以下某项操作:
1.执行数据删除请求回调。
2.为用户提供含有明确说明的网址,介绍如何使用第三方网站或工具删除数据。第三方网站可能是应用程序隐私政策的相关部分。
用户在Facebook设置中移除应用时候,会有提醒用户移除数据的相关说明。
第一种方式需要按照官方文档要求提供接口给Facebook调用。我们建议选择第二种方式,提供数据删除说明地址,介绍如何删除数据。
图片18
图:切换线上模式提示框

图片18
图:选择 数据删除说明网址

图片18
图:选择 数据删除说明网址

3.VK后台应用配置

VK目前必接的功能包括登录,登出,显示用户名称以及头像,group和邀请。

3.1. VK基础配置

创建VK应用,创建地址如下(如果还没注册,需要先注册):https://new.vk.com/editapp?act=create
Android-VK基础配置

title中填入应用的名称, 点击Connect Application按钮,并按照提示创建应用。填写关键信息,主要是填写Information和Settings部分:
Android-VK基础配置

Android-VK基础配置

Android-VK基础配置

上图的SDK settings中安卓部分需要填写应用的包名和指纹,指纹的获取方式请参考1.1 配置应用程序证书指纹(去掉冒号),也可以参考:https://new.vk.com/dev/android_sdk,或者与开发人员联系获取。

获取vk app id提供给开发人员并且注意设置应用状态为可见
android-VK基础配置

3.2 应用提交审核

VK的邀请功能是对接VK渠道官方要求必须接入的,而邀请功能只能在审核通过的应用中使用,所以需要将配置好的应用提审。

这里需要注意的是:
VK的应用审核比较严格,首先必须是游戏应用,并且需要全部翻译成俄文,不能是demo,有人工审核。
如果需要测试邀请,原则需要审核过的应用,在应用审核通过之前,使用apps.sendRequest接口,type为request来测试,测试者需要双方是好友,都是管理员并且都已经安装过该应用。
对接VK邀请功能业务流程图如下:
vk上线流程图

控制台提审大致步骤如下:
Android-VK基础配置

Android-VK基础配置

4.Firebase后台配置

在Firebase后台配置后,会得到两个文件,一个是google-services.json,需要给研发配置到游戏中去;另一个是Firebase服务器秘钥,需要配置到SDK后台

4.1 添加项目

在浏览器中打开Firebase控制台点击添加已经在Google API存在的项目

图片9

点击输入项目名称输入框时,会弹出已经存在Google Api的项目列表,选择对应项目并继续

图片3

图片4

图片6

选择配置Google Analytics账号,点击添加Firebase按钮

图片7

图片8

点击继续,则项目创建完成。

4.2 新建应用

进入项目,点击对应应用类型

图片6

输入软件包名、应用名、SHA-1指纹,点击注册应用

图片6

注册应用,进入下一步,下载google-services.json。将下载的配置文件复制到项目模块文件夹,通常为 app/。

图片6

google-services.json文件可以随时重新下载,可以在设置,常规,选中项目后,下载某个项目的google-services.json文件,如果包名改变,或者其他配置更新,则需要重新下载google-services.json文件,然后更新到项目中去。

图片6

4.3 获取Firebase服务器秘钥 (消息推送使用)

在项目详情左侧菜单中点击“设置按钮”进入“项目设置”页面,选中“云消息传递标签”,目前使用的新版 Firebase Cloud Messaging API(V1),

WechatIMG595

如未开启,需要额外开启,点击“选项”图标

跳转到Google Cloud页面的 Cloud Messaging 产品详情,点击“启动”

3-云消息密钥-2

“启动”完成后,回到Firebase的云消息传递页面,刷新后就会显示,Firebase Cloud Messaging API(V1)已是“已启用”状态。

选择服务账号-Firebase Admin SDK,如未创建服务账号,展示效果如下:

WechatIMG597

点击创建服务账号按钮,成功后,展示效果如下:
WechatIMG598

点击生成新的私钥按钮,弹出提示框,点击生成密钥,然后会下载对应的密钥json文件,保存,后续android推送配置上传密钥时,会使用。

WechatIMG598

WechatIMG599

4.4 将Google Play链接到Firebase

前提条件:
所关联的应用,必须在GooglePlay中已经创建,并上传过对应包名的应用包,否则无法关联。
说明:
1.必须链接到Google Play才能查看Android应用的in_app_purchase和订阅事件。
2.需要使用主账号关联

1.在Firebase控制台项目中,点击“项目概览”的选项图标,选择“项目设置”
2.在“项目设置”页面选中“集成”选项卡,在里面找到“Google Play”,点击“关联”

4-关联Play-0

3.“关联GooglePlay”页面,在第一步中点击“下一部分”

4-关联Play-1

4、在第二步勾选“共享应用购买和订阅收入数据”,勾选后可以查看“已选择应用”,如果还没创建应用,可以先创建再关联。最后点击“关联到Google Play”

4-关联Play-2

手动关联Google Play应用

已关联Google Play账号的的项目,如若Firebase继续添加应用,则需要手动关联新的Google Play应用。

同样是在“关联Google Play”界面,在“已关联应用”中,可以勾选未被关联的应用点击“保存”进行关联,
关联的应用同样必须在Play中已创建并有上传对应包名的应用包。

4-关联Play-4

然后需要重新下载最新的google-services.json配置文件,给到研发进行更新

4.5 Firebase 分析调试

参考:https://firebase.google.com/docs/analytics/debugview?authuser=0
要在 Android 设备上启用 Analytics“调试”模式,请执行以下命令:

例如:adb shell setprop debug.firebase.analytics.app com.ghw.sdk2

“调试”模式将保持启用状态,直至您通过执行以下命令明确停用“调试”模式:

开启调试后,打开管理后台,选择项目–分析–DebugView,能够看到目前正在调试的设备,以及上传的事件。

图片36

注意:为了防止测试和开发影响测量值,在调试模式下记录的事件将从总体 Analytics 数据中排除,并且不会包含在每日 BigQuery 导出报告中。

4.6 获取 Firebase Project ID

1.进入FCM Console(FCM控制台)
2.选择一个项目。
3.进入Project Overview(项目总览)> Project settings(项目设置)。

图片12

4.复制Project ID,即为Firebase 的Project ID

5.Twitter后台配置

5.1 Twitter后台应用配置

注册一个Twitter账号,打开Twitter开发者页面,如果您的Twitter账号不是开发者账号,还需要将Twitter账号注册成为开发者账号。进入My Apps页面,可管理应用。如果还没有应用,点击“Create New App”进入创建应用界面,填写相关信息新建应用。
Twitter-后台配置
新建应用后,点击应用列表中的应用,可以查看应用的详情。
Twitter-后台配置
点开“Keys and Access Tokens”标签可以看到ConsumerKey和ConsumerSecret
Twitter-后台配置

5.2 WINGSDK后台应用配置

将Twitter中新建应用的consumeKey和ConsumeSecret配置到WINGSDK后台。选中应用→设置→登录平台→添加Twitter登录平台,在“平台应用ID”中填写consumeKey,在“公钥”中填写consumeSecret。
Twitter-后台配置

6.Instagram后台配置

打开Instagram开发者页面,注册账号并登陆。点击“Manage Clients”标签打开应用列表,点击“Register a New Client”新建一个客户端。
Instagram-后台配置
在新建客户端的页面填写相关信息提交即可完成创建。
Instagram-后台配置
回到“Manage Clients”页面,点击刚刚新建的客户端可以查看详情,在这里可以看到Client ID和Client Secret。
Instagram-后台配置
新建的客户端的状态是“Sandbox”,在这种状态下,所有参与测试的人员都需要添加到“Sandbox”才能参与测试,添加用户到“Sandbox”的方法如下:打开“Sandbox”标签页面,输入邀请的用户名,用户名不是邮箱,一般用户名是注册邮箱@符号的前部分。注意,添加后一定要保存才能生效。保存后通知被邀请人接受邀请,可在“Sandbox Invites”看到邀请记录,接受邀请后的用户可以测试登录。
Instagram-后台配置
应用如果完成了测试要准备上线,需要将应用发布为正式状态,在“permissions”标签下,点击“Start a submission”进行权限申请。
Instagram-后台配置
在下一步选择“My app allows people to login with Instagram and share their own content.”,填写相关信息,这一步需要一个视频演示链接,完成提交后等待审核即可。
Instagram-后台配置

7.智能客服 AIHelp后台配置

AiHelp官方支持地址:
https://aihelp.net/elva/FAQ/FAQList.aspx?l=zh_CN&SectionID=0&pf_app_id=5

AiHelp 官方后台配置文档地址(页面内有下载链接介绍文档pdf):
https://aihelp.net/elva/FAQ/FAQList.aspx?SectionID=3392&LanguageID=5&pf_app_id=5&kmContentId=122760

已下是常用功能配置说明,需更多更详细请到官方下载最新pdf文档

7.1.新建应用

7.1.1 左侧“设置”-> “应用”-> “+”如下图位置

WechatIMG548
弹出界面,输入应用名称,点击“Add”完成新建 如下图
WechatIMG549

7.1.2 选择新建应用,如下图操作

WechatIMG550

选择中刚刚新建应用,会切换到应用下内容。

7.2.获取参数

如果不在需要app下,需按照 7.1.2 切换app
左侧“设置”-> “应用”-> “+”如下图位置

WechatIMG551

7.3.添加语言

设置语言后app应用Aihelp部分功能支持多语言。
左侧“设置”-> “语言”-> “添加语言”如下图位置
WechatIMG552
点击设置后,弹出语言列表,可以增加需要语言
WechatIMG553

7.4.配置FAQ

此功能配置是在app 应用中FAQ相关功能

7.4.1.新建FAQ分类

左侧“机器人”->“常见问题”-> “[分类]”-> “新增分类+” 如下图位置
WechatIMG554

弹出新增页面,输入名称和顺序编号后保存

WechatIMG556

WechatIMG555

分类列表会出现新建分类,左侧栏也会出现对应分类

7.4.2编辑FAQ分类

在分类列表中,点击如下图按钮
WechatIMG558

弹出详情页面,可做对应修改。其中中文,英文对应aihelp sdk显示的语言内容。

WechatIMG557

7.4.3.新建FAQ

在左侧栏选择FAQ分类->“新增FAQ”,如下图
WechatIMG559

弹出新增页面

WechatIMG560

7.4.4.编辑FAQ

在FAQ列表中,点击如下图按钮

WechatIMG562

弹出详情页面,其中语言对应aihelp sdk显示的语言内容。

WechatIMG563

7.4.5.发布FAQ

如,在热门问题分类下,创建了一个信息,然后发布流程
左侧“机器人”-> “常见问题”-> “发布” 如下图位置

WechatIMG564

7.5.配置运营模块Tab

此功能是app应用中运营界面功能

7.5.1.新建Tab

左侧“运营支持”-> “运营模块”-> “[Tab设置]”-> “新增Tab” 如下图位置
WechatIMG566

弹出新增页面

WechatIMG567

7.5.2.编辑Tab

左侧“运营支持”-> “运营模块”-> “[Tab设置]”-> 编辑,如下图

WechatIMG568

7.5.3.新建文章

左侧“运营支持”-> “运营模块”-> “[Tab列表]”,选择刚才创建的tab1,点击新建,如下图
WechatIMG569

弹出新增页面

WechatIMG570

7.5.4.编辑文章

在文章列表中,点击如下按钮
WechatIMG571

弹出详情页面,其中语言对应aihelp sdk显示的语言内容。

WechatIMG572

7.5.5.发布Tab

Tab要在app应用中显示需要发布,每次修改都需要发布。
左部“运营支撑”-> “运营模块”-> 需要发布的Tab -> “发布” 如下图位置
选择平台、语言后发布

WechatIMG573
发布后,效果图如下
WechatIMG575

7.6 自定义SDK配置

7.6.1 展示头像配置

WechatIMG575

7.6.2 APP对外名称配置

WechatIMG575

7.6.3 设置横竖屏

WechatIMG945

7.6.4 更多其他配置

另外还包含欢迎语设置,主题设置等等功能。
详情请参考:
https://aihelp.net/FAQ/#/AIhelp%20Support/app/zh_CN/EB5AE263D8AB85A4/35E3B9E6396692FE/396CD31FF6A33A5D

8.华为HMS后台配置


8.1 基本流程

1、登录流程
WechatIMG575

参考:https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/dev-process-0000001050443773
2、支付流程
WechatIMG575
参考:https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/dev-process-0000001050033070

8.2 配置AppGallery Connect

1)注册成为开发者
2)在 AppGallery Connect创建项目、创建应用
A、 如果没有项目,则创建项目,我的项目—添加项目,输入项目名称,确认,则项目创建成功。
WechatIMG575

WechatIMG575
点击确定完成后,点击添加应用,跳转添加应用界面
WechatIMG575

WechatIMG575

注:需要集成支付能力,包名后缀必须为.HUAWEI或者.huawei

B、如果已存在项目,则可在项目下,创建具体的应用,一个项目下可创建多个应用
WechatIMG575


3)生成签名证书指纹
keytool -list -v -keystore C:\TestApp.jks
执行结果如下:

WechatIMG575

说明:C:\TestApp.jks表示应用签名文件,CP替换成自己的签名文件即可。

4)在“我的项目”中找到刚创建的项目项目,找到对应的应用,配置SHA256证书,如下图所示
WechatIMG575

5)打开相关服务
5.1)打开API权限服务,在“项目设置”->“API管理”菜单中,开启相应服务,如下图所示:
WechatIMG575
登录服务为 Auth Service,支付服务为 In-App Purchases,其他权限为创建应用默认开启的权限,可以忽略。

此操作为项目级别操作,操作完后,项目下所有应用都会有此权限。

5.2)配置支付参数
① 在我的项目中,选择具体某个应用,在左侧导航栏选择“盈利 > 应用内支付服务”,点击“设置”。

WechatIMG575
说明:如果首次配置会弹出签署协议弹框,其中订阅通知地址,可不填写

8.3.获取应用的AppGallery Connect配置文件

1)获取agconnect-services.json文件
WechatIMG575

8.4.配置商品

1)打开“ AppGallery Connect”->“我的应用”->“运营”菜单,如下:
WechatIMG575

2)点击“添加商品”,如下图所示:
WechatIMG575
填写商品相关的商品信息,点击保存即可,这里选择“消耗型”商品。

3)创建商品后,默认状态为失效状态,需要点击激活按钮:
WechatIMG575
点击后,提示此商品将被开放购买,点击确认。

8.5.配置沙盒测试账号

参考:https://developer.huawei.com/consumer/cn/doc/distribution/app/agc-tester_account_mgt

接入完支付sdk后,华为提供沙盒支付测试模式。打开华为AppGallery Connect管理后台,选择用户与访问,选择左侧沙盒测试栏目下的测试账号,点击新增,输入华为账号即可
WechatIMG575

WechatIMG575

注:测试帐号必须填写已注册、真实的华为帐号。

添加完成后,使用此沙盒测试账号,支付时,可以直接进行沙盒支付测试

8.6.配置华为分析

1)接入流程
WechatIMG575
2)后台开启分析服务

a、如果没有华为开发者联盟帐号,需要先注册帐号并通过实名认证。详细操作请参见帐号注册认证。
b、参见创建项目和在项目中添加应用完成应用的创建。
c、登录AppGallery Connect网站,点击“我的项目”图标
d、选择需要查看分析数据的应用。
e、点击“华为分析”下的任意菜单,并点击“启动分析服务”按钮可开通分析服务。(注:需拥有产品管理权限才可开通服务)

WechatIMG575

f、进入“项目接入设置”页面,设置数据存储位置、数据共享设置、支持行业分析、标识用户、时区、货币、设置用户数据留存时间、设置自然周定义后,点击“完成”,即完成Analytics Kit 服务开通。对于支持行业分析,如果您已经设置应用的分类情况,则默认开启

WechatIMG575

g、开启后,选择项目设置–我的项目–应用,下载最新的配置文件,给到研发进行更新

WechatIMG575

3)调试

1、开启/停用调试模式

调试模式打开后,所有事件将实时上报,在应用调试界面可实时查看上报的数据。
说明:请将命令行中的“package_name”字段替换为您的应用包名
数据成功上报后,“华为分析 > 应用调试”页面会展示出数据,如下图

WechatIMG575

2、您可执行如下命令行,停用调试模式

8.7.开通华为性能分析

参考:https://developer.huawei.com/consumer/cn/doc/development/AppGallery-connect-Guides/agc-apms-viewdata

进入“质量->性能管理”,如果APM服务未开通,请点击“立即开通”按钮,开通APM服务

WechatIMG575

说明:
由于开通服务时可能需要设置数据存储位置,设置数据存储位置后会刷新agconnect-services.json文件里的配置。如果您开通服务时设置了数据存储位置,在开通完成后您需要重新下载agconnect-services.json文件并集成到您的工程中。

9. appsflyer后台配置

9.1 appsflyer卸载配置

说明:
需要完成Google Cloud后台Appsflyer卸载检测配置操作,如已操作可继续执行以下步骤

进入appsflyer后台 ,选择项目-配置-卸载模块,如未开启则点击开启

WechatIMG601

输入 选择HTTPV1
输入 Project ID(获取 Firebase Project ID )
点击Test connection 按钮,测试成功会提示:Success! Your app is connected to Firebase
然后保存设置,即完成操作。

WechatIMG594

10.AdMob后台配置

AdMob后台入口地址:https://apps.admob.com/v2/home

10.1 创建应用

创建应用分为,已上架,和未上架两个步骤,最终都需要应用上架应用商店。

10.1.1 添加未上架应用

10.1.1.1 添加应用

添加应用-1

在应用页中,点击“添加应用”

添加应用-7

在上架选项中,选择“否”

添加应用-8

输入“应用名称”,点击“添加应用”

添加应用-9

点击“完成”应用添加。

注意:到这里只是完成了应用添加,要准备广告实际投放使用,还需要完成后续完成应用商店添加。

10.1.1.2 应用商店信息配置

应用上架商店后,可以继续完成商店信息添加。

添加应用-9

应用 > 选择前面添加的应用 > 应用设置 > 在“应用商店详细信息” > 点击“添加”

添加应用-9

输入“应用商店地址”或者“应用包名”,点击“搜索”,在查找结果中找到目标应用,点击“添加”

添加应用-9

点击“继续”

添加应用-9

点击“保存”

添加应用-9

点击“完成”

添加应用-9

最终看到已经完成应用商店添加的应用设置页面

10.1.2 添加已上架应用

添加应用-1

在应用页中,点击“添加应用”

添加应用-1

在上架选项中,选择“是,此应用已在受支持的应用商店中上架”

添加应用-1

输入“应用商店地址”或“应用包名”,点击“搜索”,在查询结果中找到目标应用,点击“添加”

添加应用-1

确认目标应用无误,然后点击“继续”

添加应用-1

确认应用包名等信息,点击“添加应用”

添加应用-1

点击“完成”

10.1.3 获取应用ID

成功添加应用后,在 应用 > 目标应用 > 应用设置 > 应用ID 中可以查看应用ID,点击可以进行复制

图片16

10.2 设置app-ads.txt

完成应用添加后,AdMob需要对已上架应用进行验证,确定该账号是应用的所有者,才允许进行广告投放。这需要在该应用的商店详情页中的开发者网站地址中,完成app-ads.txt的添加与设置。

官方指引文档:https://support.google.com/admob/answer/9363762

10.2.1.确认或添加开发者网站

设置ads-3

在Play后台 > 选择应用 > 商店发布 > 商店设置 > 网站,中确认当前设置的网址,如果未设置,则可以点击“修改”进行设置

设置ads-4

在弹出信息修改页中,填入网址,点击“保存并发布”,在确认弹框中点击“保存并发布”

可以在应用的商店详情页中可以查看到该网址和跳转

设置ads-5

10.2.2.创建app-ads.txt文件

如果开发者网站之前已有app-ads.txt,可以直接使用之前的文件,如果没有则新创建一个,然后在该文件中添加从AdMob后台中得到的代码段。

设置ads-1

在AdMob后台 > 应用 > 查看所有应用 > 点击“设置app-ads.txt”

设置ads-2

在弹出的设置app-ads.txt指引中,点击复制代码段

设置ads-8

粘贴复制好的代码段,如果app-ads.txt已有内容,则在新行中粘贴,如图。最后保存修改。

10.2.3 在开发者网站发布 app-ads.txt文件

AdMob 的 app-ads.txt 抓取工具会根据应用商品详情中的开发者网站查找 app-ads.txt 文件。根据 app-ads.txt 规范,抓取工具会查找采用以下网址格式的文件:
https://<<主机名>>/app-ads.txt
http://<<主机名>>/app-ads.txt
如果开发者网站是带有子域名的,抓取工具会在开发者网站中探查最多一个子域名层级,建议app-ads.txt文件发布在不带子域名的网址下,更多详细规则查看官方说明:https://support.google.com/admob/answer/9363762?sjid=5773086561328805503-AP#step3

图片1

10.2.4 等待 AdMob 验证 app-ads.txt 文件

AdMob 最长可能需要 24 小时才会抓取并验证 app-ads.txt 文件。

10.2.5 查看 app-ads.txt 文件验证结果

在应用> 查看所有应用 > app-ads.txt 中可以查看应用的验证结果

设置ads-7

10.3 添加广告单元

广告单元可以简单理解为需要在应用上播放广告的广告位。广告单元分不同类型,目前SDK支持的有,横幅广告,插页广告,开屏广告,激励广告,播放广告需要使用广告单元ID。

在AdMob后台添加广告单元

广告单元-1

应用 > 目标应用 > 广告单元 > 添加广告单元

广告单元-2

选择广告单元类型

10.3.1.横幅广告

这是一种矩形广告,会占据应用中的一部分版面;可在一段时间后自动刷新。实际效果:

横幅

广告单元-3

输入名称 > 高级设置(查看或修改) > 创建广告单元

广告单元-4

成功创建广告单元后,可以得到该广告单元的ID,以供SDK使用。

10.3.2.插页广告

这是一种全屏广告格式,在自然间歇点和过渡点(比如在打完一关时)显示,实际效果:

插页

广告单元-5

输入名称 > 高级设置(查看或修改) > 创建广告单元

广告单元-6

成功创建广告单元后,可以得到该广告单元的ID,以供SDK使用。

10.3.3.开屏广告

这种格式的广告在用户打开或切换回您的应用时显示。广告会叠加在加载屏幕上。实际效果:

开屏

广告单元-7

输入名称 > 高级设置(查看或修改) > 创建广告单元

广告单元-8

成功创建广告单元后,可以得到该广告单元的ID,以供SDK使用。

10.3.4.激励广告

这是一种会为选择观看广告的用户提供奖励的全屏广告格式。这种广告与插页式激励广告的不同点在于,必须让用户能够自主选择是否观看。实际效果:

激励

广告单元-9

输入名称 > 输入奖励数量 > 输入奖品名 > 设置回调地址(具体看下一步) > 创建广告单元

设置回调地址:

广告单元-10

输入回调地址 > 验证网址 > 使用经过验证的网址,该地址由WingSDK后台提供。

广告单元-11

成功创建广告单元后,可以得到该广告单元的ID,以供SDK使用。

10.3.5.查看广告单元ID

在 应用 > 目标应用 > 广告单元 列表中能查看所有广告单元ID,点击可以进行复制

广告单元-12

也可以点击广告单元,进入编辑页面中进行选中复制

广告单元-14

10.3.6.费用底价

有效每千次展示费用底价设置。

10.3.6.1 Google优化

默认选中的是由Google优化,并且是接受所有价格。

较高的的底价,和适中的底价目前还是属于Google的BETA测试功能,越高的底价对应广告填充率越低,也就是用户可以观看的广告越少。

广告单元-15

10.3.6.2 人工定价

选择人工定价,需要指定“全球有效前次展示费用底价”,也可以针对不同国家地区设置不同的底价。

广告单元-16

10.4 关联Firebase

官方指引文档:https://support.google.com/admob/answer/6383165

10.4.1 权限要求

操作关联对账号权限有相关的要求:
6

10.4.2 关联

1

应用 > 目标应用 > 应用设置 > 管理管理的服务

2

会自动跳转到 设置 > 已管理的服务 页面,在 管理应用管理 > 展开目标应用,点击Firebase右侧的关联开关

关联弹窗,会有三种关联方式,根据目前Firebase的项目和应用创建情况选择符合自身的选项。

10.4.2.1 与现有的 Firebase 应用和项目相关联

3

Firebase后台已经创建了项目和该应用,则选择该项 , 然后选择该应用所在项目 , 如果在该项目中找到该应用则会在下方显示该应用,最后点击“关联应用”。

10.4.2.2 在现有 Firebase 项目中创建新应用

4

Firebase后台未创建该应用,如果希望在已有项目下创建该应用,则应该选择该项,然后选择需要创建该应用的项目,最后点击“创建并关联应用”。

10.4.2.3 创建新的 Firebase 应用和项目

5

Firebase后台未创建该应用,如果希望创建新的项目并在新项目下创建应用,则应该选择该项,点击“转至Firebase”,跳转到Firebase后台进行后续操作创建项目及应用操作。

10.4.2.4 关联结果

最终关联成功后弹框提示:

7

关联之后,在应用 > 目标应用 > 应用概览 中出现Firebase用户指标模块,有相关的数据。

8

10.5 UMP隐私权与消息

“隐私权和消息”工具可帮助您与用户沟通,以根据欧盟《一般数据保护条例》(GDPR) 及美国州级隐私保护法律等法规征求用户意见或收集停用请求,或者挽回因用户屏蔽广告而造成的收入损失。

目前只需应对GDPR要求即可,该部分功能是结合UMP SDK一起使用的,主要用于控制UMP同意弹窗的显示效果。

1

1.进入 隐私权和消息 > 管理

2

2.点击“创建消息”

3

3.在消息创建编辑界面,可以完成UMP同意弹窗消息的展示控制。

必须完成的内容:
1)添加应用,可以多选
2)选择不同意按钮的开启或关闭(建议选择关闭)

其他编辑控制项:
1)消息名称
2)默认语言,建议使用英语
3)其他支持的语言
4)关闭(不同意)按钮的控制,建议关闭

预览:
1)可以选择横竖屏,和语言
2)可以选择页面进行效果查看

4

应用选择页面中,勾选适用应用,可以多选,如果未填写隐私权政策网址,则需要点击“添加网址”并完成添加。

5

可选,点击“样式”可以进行显示的样式控制

6

可选,点击“定位”,可以查看生效区域,默认为GDPR国家地区,无需修改

7

4.完成编辑后,点击“发布”即可完成最终发布。发布之后,一般是立即生效,可以在应用上立即查看到发布后的改动。

10.6 审核

官方说明文档:https://support.google.com/admob/answer/10564477

10.6.1 审核条件

必须达成下面条件,AdMob才会开始进行审核:
1.应用必须在已支持的应用商店中上架,比如Google PlayStore。
2.AdMob后台中该应用必须已经通过app-ads.txt验证。
3.AdMob后台中的该应用必须已经设置好与支持的应用商店关联。

审核通常需要几天时间,应用审核通过,或者拒绝都会有相应的电子邮件通知,也可以在AdMob后台的所有应用页面查看状态。

10.6.2 审核状态

在 应用 > 所有应用 > 应用标签 > 审批状态 中查看应用的审批状态

2

1

Android 第三方后台配置备份(20240516)

wapublisher No Comments

1.Google后台应用配置

google控制台地址:https://console.developers.google.com

1.0 Google后台公共配置

Google后台首先需要做一些公共配置,大致流程如下:

图片1
上图中的所涉及到的流程在后续章节中都有详细指引。

1.1 Google API控制台公共项目配置:

简要流程:
1.API控制台创建一个公共项目用于Play 控制台关联(如果已经有关联的项目则不需要再创建,一个主开发者帐号只能关联一个项目)
2.Play控制台关联API控制台的公共项目
3.API控制台中在公共项目中创建服务者账号,下载P12证书文件
4.Play控制台中为服务者帐号开放权限,目前只需要查看财务权限
5.将P12证书文件和服务者帐号保存至WA后台

1.1.1 API 控制台创建新的公共项目

打开Google API控制台,创建一个新的控制台项目

注意:如果使用现有的公共项目(Google Play Console已关联的项目),可以不新建。

图片2
点击”新建项目”
图片3
在”新建项目页面”输入项目名称,点击“创建”新建即可完成新项目创建

图片4

项目名称需要保存记录,对应windsdk后台中,添加google支付平台的需要填写的应用名称栏目

1.1.2 控制台关联公共项目

打开Google Play开发者控制台,在设置->API权限->关联项目中,关联前面创建的公共项目。如果已关联,则下一步在已关联的项目中创建“服务者账号”即可。:

图片6


1.2.API控制台创建服务账号(Service account key)*

服务帐号是SDK后台验证支付订单时候使用,运营人员需要将服务帐号和证书保存至SDK后台。SDK后台的操作请参考《WINGSDK后台基础设置》 。不同的应用,不要使用相同的服务帐号。

打开Google API控制台,选择公共项目,进入项目“API和服务”中的“凭据”页面

图片7

在“凭据”页面,点击“创建凭据”,选择“服务账号”

图片7

进入“创建服务账号”页面,第一步填入“服务账号名称”

图片2

第二步选择服务账号“角色”,分配“Editor”角色,然后点击“继续”

图片2

第三步中直接点击“完成”即可
图片2

接下来在公共项目的“凭据”中“服务账号”列表找到刚创建的“服务账号”

图片2

点击进入该“服务账号”的编辑界面,选中“密钥”标签,点击“添加密钥”并选择“创建新密钥”

图片2

在弹出框中选择“P12”类型私钥,点击“创建”

图片2

点击“创建”后,浏览器会自动下载“P12”私钥文件

图片2

“P12″私钥文件需要妥善保管,在WingSDK后台中添加Google支付平台时会要求上传该文件。

1.1.4 Play控制台“服务账号”权限配置

创建“服务账号”完毕后,在Google Play控制台,设置->API权限的页面的“服务账号”列表中,可以找到新创建的“服务账号”查看并修改权限

图片2

选中“账号权限”标签,只勾选“查看财务”权限即可

图片2

选中“应用权限”标签,添加该“服务账号”对应的游戏,点击“应用”

图片2

在弹出框中确认已勾选“查询财务数据”权限,点击“应用”完成添加

图片2

完成“应用权限”和“账号权限”配置后,点击“邀请用户”发送邀请

图片2

之后可以在“用户和权限”中看到该“服务账号”,并且状态是“有效”

图片12

进行完上述操作之后,将“服务帐号”(即邮箱)和“P12”私钥文件保存至WA后台即可。

1.3 Google API控制台游戏项目配置

简要流程:
1.创建专用于游戏的新项目
2.在游戏项目中新建Web类型ClientID,用于WA后台Google登录配置
3.在游戏项目中新建Android类型ClientID,需要研发提供包名(PackageName)和应用签名jks文件的SHA-1信息

1.3.1 创建专用于游戏的新项目

同上面公共项目创建一样,新建一个专用于游戏的项目

图片2

图片2

1.3.2 启用Google+ API

在游戏项目中,选择进入“API和服务”中的“已启用的API和服务

图片2

在“已启用的API和服务”界面,选择“+启用API和服务”,进入“API库”界面

图片2

在“API库”中,搜索“Google+”,选择并进入“Google+ API”

图片2

图片2
在“Google+ API”产品详情页面中,点击“启用”

图片2

1.3.3 同意屏幕配置

在添加OAuth Client ID之前,必须先完成“同意屏幕”配置。“同意屏幕”会影响用户授权是看到的界面,如下:

图片2

图片2
首先在前面新建的专用于游戏的“项目”中,进入“同意屏幕”界面,操作如下

图片2

在“同意屏幕”配置界面,UserType选择“外部”,然后点击“创建”

图片2

第一步,填入“应用名称”和“用户支持电子邮件”,以及“开发者联系信息”,这几项都是必填项目。

其中“应用名称”将会是用户授权登陆时看到的应用名称,其他可选项根据实际情况决定是否填写,下面是可选项的影响及要求:

1.应用的徽标和名称:建议使用徽标,但不强制要求使用
2.用户可以用来与您联系的电子邮件地址以及范围列表:范围是您的应用对访问用户的 Google 帐号以及会共享哪些数据的具体请求。您将在下一步中添加范围。
3.指向应用隐私权政策和服务条款的链接

此部分内应包含:

一个描述用户可以如何管理对其 Google 帐号的访问权限的句子
一个指向 Google 文章的链接,其中介绍了 Google 如何帮助用户安全地共享其数据

图片2
图片2

第二步数据访问“范围”配置,这一步无需处理,直接下一步即可

图片2

第三步“测试用户”配置,这一步也无需配置,直接下一步

图片2

第四步“摘要”,到这一步已经完成“同意屏幕”配置,可以在“摘要”界面审查自己的配置,也可以直接返回。

图片2

正确配置完成OAuth同意屏幕后,“发布状态”默认是“测试版”状态。确保之前的配置无误后,还需点击“发布应用”,把“发布状态”改为“正式版”。

图片1

如果没有填写需要验证的项,可以无需验证直接发布到“正式版”,如下图“发布应用确认弹窗”点击“确认”即可完成发布。

图片2

图片3
如果是无需验证的,可以忽略以下验证过程的文章内容。
有需要验证的项的改动,则需要按照提示完成Google验证,例如添加了“应用徽标”点击“发布应用”,则是弹出下面提示框
图片4

点击“确认”后状态已是“正式版”,但是需要完成验证,点击“执行验证准备工作”
图片5

确认“OAuth同意屏幕”信息,“应用首页”和“应用隐私权政策链接”,属于必填项,填写之后还需要把这两个链接的域名加到“已获授权的网域”,点击“保存并继续”。
注意:“已获授权的网域”需要转到 Google Search Console(https://search.google.com/search-console/welcome) 来检查您的网域是否已经过授权,如何获得授权在Google Search Console也有描述和指引。

图片6

然后是确认“范围”,点击“保存并继续”
图片9

“可选信息”中,为了确保审核通过,尽量补充完善可选内容。另外按照之前提示框的提示,提供YouTube视频,展示如何使用从范围中获取的Google用户数据;还有一份书面说明,告知访问敏感数据和受限用户的原因

图片10

最后勾选声明,点击“提交以进行验证”完成提交。敏感范围验证最多需要10天才能完成,受限范围需要数周时间,其他图标,主页,隐私政策通常需要2-3天。

图片11


1.3.4 创建Web类型OAuth Client ID

进入游戏“项目”的“凭据”界面,点击“创建凭据”选择“OAuth客户端ID”

图片2

在“应用类型”中选择“Web应用”类型

图片2

填写“名称”,然后点击“创建”即可完成创建

图片2

在创建完成提示界面中,可以直接 复制刚创建的“Web客户端ID”保存,后续将需要提供给研发和WA后台Google登录配置。

图片2

1.3.5 创建Android类型OAuth Client ID

跟创建Web应用“OAuth 客户端 ID”类似,在游戏“项目”的“凭据”界面中创建“OAuth客户端ID”,但是类型选择“Android”

图片2

填写“名称”,“包名”,“SHA-1证书指纹”,其中“包名”和“SHA-1”都由研发提供,获取指引如下:
包名:Android项目的applicationId,在“应用层级”的build.gradle文件中的android->defaultConfig->applicationId找到,具体参考下图

图片2

SHA-1证书指纹:首先需要研发创建游戏的“正式应用签名jks文件”,然后使用下方命令输出“SHA-1证书指纹”信息,输出结果参考下图
命令:keytool -keystore path-to-debug-or-production-keystore -list -v

图片2

图片2

创建完成之后,一般“隔天”会生效,生效后就可以正常进行Google登录

图片2

1.4 Play控制台更改应用签名密钥

为了确保由研发生成的“正式应用签名jks文件”在GooglePlay中正常生效,需要在Play控制台更改应用签名密钥。

若Play未创建应用,可以参考章节 《GooglePlay创建应用》 进行创建。

Play控制台中选择游戏应用,在“内部测试”轨道中选择“创建新的发布版本”或“修改发布版本”

图片2

不需要上传应用,直接点击“更改应用签名密钥”,在弹出的确认框中点击“使用其他密钥”

图片2

图片2

接着在“应用签名偏好设置”界面中,选择“从Java密钥库导出并上传密钥”,在这里按照指示完成“zip文件”上传,最后点击保存。具体指示说明参考下图

PEPK工具文件:下载pepk.jar

命令:

注意 java版本最好是11版本或以上,否则执行会出错

图片2

保存完成之后,可以在游戏应用的“设置”->“应用完整性”中找到Play中已生效的“SHA-1”信息,把这个跟前面研发提供的“SHA-1”进行比对,一致则说明配置正确,否则需要重新配置,同样是从“内部测试”的“更改应用签名密钥”开始。

图片2

1.5 Google Play创建应用

进入“所有应用”界面,点击右侧“创建应用”

图片10

按照要求填写或选择“应用名称”,“默认语言”,“应用或游戏”,“免费或付费”,并且勾选同意“开发者计划政策”和“美国出口法律”。
免费或付费:免费指下载免费,付费指付费才能下载

图片11

1.6 Google Play添加应用内商品

添加应用内商品前,按要求需要先上传有BILLING 权限(接入WingSDK的Google模块默认带有该权限)的应用包,建议在“内部测试”完成上传,上传应用包即可达成条件,无需发布。

图片2

单个商品创建

在游戏应用的“应用内商品”界面,可以“创建商品”
图片2

按照提示填写完成对应项,最后点击“保存”,其中“设置价格”和“税费和法规遵从设置”界面如下图
注意:商品ID是唯一的,即使被删除后也依然占用原ID。

图片2

图片2

图片2

保存之后,商品默认是“无效”状态,需要点击“启动”改为“有效”状态

图片2

“启用”商品之后,在应用内对应商品详情界面,可以进行停用及删除

图片2

批量导入商品

GooglePlay后台目前支持批量导入,因为csv模板可能会变更,所以建议先创建一个商品,再导出,根据导出的最新csv模板样式,添加商品,再保存csv文件上传导入。

同样是在“应用内商品”界面,先根据上一步操作创建一个商品,然后点击“创建商品”旁边的选项“图标”,选择“导出”

图片2

导出的商品csv文件内容如下图,再参考已有的导出商品,按照相同方式补充完剩下的商品,保存商品csv文件

图片2

同样是“应用内商品”界面,点击选项“图标”,选择“导入”

图片2

导入最新的商品csv文件。注意:批量导入,如果csv商品文件中包含已有商品则会修改对应商品内容。

图片2

导入完成之后就可以在列表中看到所有已导入的商品

注意:如果文件内容中有中文,那么csv文件可能存在乱码问题,如果有这种情况,需要把csv的编码改为utf-8,确认中文字符正常,再保存上传。

 
 

1.7 添加Google Play测试用户

在应用未正式发布前,Google支付可以在Google Play添加测试用户才能进行沙盒测试。

详细的GooglePlay应用测试说明和方法可参考下方官方文档:
https://support.google.com/googleplay/android-developer/answer/9845334

“封闭式测试”和“内部测试”:
进入游戏应用的“内部测试”轨道(“封闭式测试”也相似),在“测试用户数量”标签中,如果勾选“已有测试列表”,如果没有则“创建电子邮件列表”再勾选(创建界面截图如下),然后保存。保存之后可以复制“测试邀请链接”,发给测试人员,注意要发布过版本才会有“测试邀请链接”

图片2

图片2

测试人员在浏览器上登录被邀请的Google账号,然后打开“测试邀请链接”,点击“接受邀请”

图片2

“接收邀请”之后,测试人员根据指示下载测试版应用安装测试

图片2

 
 

1.8.添加Google Game Service支持

在开发者管理者控制台左侧菜单打开“游戏服务”菜单,在列表中选中需要新建成就的游戏服务。

图片27

如看不到Play 游戏服务,则在顶部搜索栏中搜索”Play游戏服务设置”,然后选中
图片27

选中“是,我的游戏已经使用了Google API”,此时在下方选择要关联的项目。选择项目,下一步即可完成创建。(如没有创建Google API项目,则参考 1.3.子项目中配置应用的OAuth Client Id* 流程先创建子项目)

图片28

在游戏服务中添加新游戏之后自动生成了Google Game Service App Id,此值需提供给开发人员,如下图所示:

图片28

如提示配置OAuth同意屏幕,按照要求操作同意接口,同意完后,点击添加凭证,选择Android类型,输入名称等基本信息,选择OAuth客户端即可,然后保存。(默认情况下选择OAuth客户端只有一个,如若多个,可以选择后,查看包名和指纹是否和应用的一致进行确认)

图片6

创建完游戏服务之后就可以创建成就和排行榜了,创建完的游戏服务,必须要发布才能够使用。

在goolge应用控制台为某一个应用添加Google Game Service成就,请参考以下官方文档:
https://developers.google.com/games/services/common/concepts/achievements
 
在左侧菜单选择“成就”,点击页面“添加成就”可以添加新的成就。

图片28

1.9.Google 促销商品配置

参考地址:https://developer.android.com/google/play/billing/promo
登录Google Play后台,选择对应应用进入详情,选择获利—产品—促销代码,点击创建促销代码

图片36

输入 促销活动名称、开始时间、结束时间,促销类型选择应用内商品,然后选择需要参与促销的商品,输入促销代码数量,保存即可。

图片36

当到达输入当开始日期时间后,促销码就可以使用。在您的应用中:用户可以点击 Google Play 购买屏幕中付款方式旁边的向下箭头,然后点击兑换链接以输入代码,由此发起购买交易

图片36

选择兑换代码,输入对应兑换代码
图片36

注:创建促销商品的商品id为google_001,在应用内兑换时,需要点击相对应的商品(对应google商品id为google_001)弹出支付界面,然后输入兑换码才能正常兑换。

另外,也可在 Play商店-账号信息-付款与订阅-兑换代码,然后点击兑换代码进行兑换(预注册奖励也可使用此方式测试)

69F23255C7F76711D90C33F3613C701D

197237B259B014FAB5F19B4A37E0CF04

39C0572ED38C0E13893AA9066FB7FA19

BA4A3D184552C77DE97631C56B3BA921

AB432970EF1F97A2B4A97B05FC53F2AC

5A17CC07EE19116B87EBE81F3A3EA432

 
 

1.10.Google Play 签名密钥

如果已经成功执行《Play控制台更应用签名密钥》 章节,本章节可以忽略。若需要更详细了解Google Play密钥,或者需要升级密钥,可以查看本章内容。

Google Play控制台的签名密钥有两种,一种是应用签名密钥,一种是上传签名密钥,他们对应的实体文件是keystore/jks文件。

上传签名密钥:上传Google Play 的aab或apk包必须使用该签名秘钥进行签名,不能使用证书指纹不一致的应用签名秘钥或者其他签名秘钥,否则会提示签名错误,无法上传。该签名密钥用于Google Play验证上传的应用包的合法性。

应用签名密钥:是应用最终所使用的签名密钥。虽然上传Play的应用包使用的是上传签名秘钥签名,但是正式上架对外时,Google Play会抹去原来的签名,并使用应用签名秘钥签名。

为了方便管理,建议“应用签名密钥”和“上传签名密钥”使用相同的签名密钥jks文件
说明:使用下面步骤,不包含“上传签名密钥”的配置,因为Google不允许两个签名一致,但是“更改签名密钥”时不进行“创建新的上传密钥”即可让两个签名保持一致。

1.10.1.上传自己的签名密钥

创建应用版本会默认加入Google签名计划,该计划实际内容是:由Google自行创建签名密钥,并保存在谷歌服务器,无法访问和下载,最终向用户分发应用时再由Google进行签名。默认方式的签名密钥文件不可访问,无法控制,不利于管理签名密钥文件和调试测试,所以建议上传自己的签名密钥。

注意:这一步,是应用未正式上架时可以重复操作修改的,但是正式上架后不可用再从这里修改,需要参考下一章节执行“升级密钥”操作才可更改。

具体操作同《Play控制台更改应用签名密钥》一致,最终验证“应用签名密钥证书”和“上传密钥证书”保持一致即说明配置正确。

1.10.2.验证签名密钥配置

1.研发在命令终端通过输入keytool命令获取签名密钥jks文件的证书指纹。
命令:keytool -list -v -alias ALIAS_NAME -keystore KEYSTORE_PATH

图片_20230307160725(1)

2.在Google Play控制台的,设置->应用完整性,中找到当前生效的密钥证书信息

图片2

1.10.3.升级应用签名密钥

适用对象:已上架,并且之前执行过《Play控制台更应用签名密钥》 章节,把默认的Google生成签名改为自己签名文件的应用

不适用对象:
1.未上架的应用,无需升级也可在“内部测试”或任意轨道版本中选择“更改应用签名密钥”进行更改
2.已上架,但是之前默认由Google生成签名的应用(未执行过《Play控制台更应用签名密钥》 章节),界面参考下图

使用“Google生成的签名”的应用,会没有“请求升级密钥”按钮

图片2

升级注意:“请求升级密钥”操作,一年只有一次机会,无法撤销,请谨慎操作

同样是“应用完整性”页面,在“应用签名”标签里面找到“请求升级密钥”按钮,并点击

图片2

在弹出框中,【关键】首先展开“隐藏选项”,选择“所有Android版本的所有安装”选项 。然后升级方式选择“从Java密钥库上传新的应用签名密钥”

图片2

按照“从Java密钥库上传新的应用签名密钥”的指示,下载PEPK文件给研发使用,研发使用指示命令生成zip文件,其中命令的黑体参数需要替换为本地对应参数,具体参考如下,最后完成“上传zip文件”,选择“升级原因”,点击“升级”。

foo.keystore:新的应用签名密钥jks文件
foo:foo.keystore文件使用的别名
upload.keystore:原应用签名密钥jks文件
upload-key-alias:upload.keystore文件使用的别名

注意:若upload.keystore使用的不是原应用签名密钥jks文件,会升级失败

图片2

在弹出框中确认升级影响目标必须是“所有Android版本上的新安装”,若不是则需要修改前面“隐藏选项”的选择。
确认升级影响目标正确后,点击“确认”完成升级。

图片2

升级之后可以在“应用完整性”的“应用签名”标签中,确认最新生效的“证书指纹”信息,也可以查看“曾用密钥”的证书指纹信息。另外升级后“请求升级密钥”按钮变为不可用状态,并且旁边会有显示上一次的升级日期

图片2

更多内容可以查看Google文档了解:
https://support.google.com/googleplay/android-developer/answer/9842756

1.10.4.应用签名密钥变更后续配置

无论是“上传自己的签名密钥”或者“升级应用签名密钥”,都会影响应用的验证,比如Google登录,Facebook登录等三方功能,所以修改后确认同步修改对应平台相关内容。

  • 如果是未上架应用“上传自己的应用签名密钥”,更改原有对应配置即可。
  • 如果是已上架应用“升级应用签名密钥”,为了保证旧的“应用签名密钥”用户也可以暂时使用,保留“原应用签名密钥”证书指纹相关配置,并添加新的“新应用签名密钥”证书指纹相关配置。

下面罗列一些平台需要用到签名信息的相关配置指南:

Google:Google Cloud Platform(https://console.cloud.google.com/)控制台,API和服务 -> 凭据中,添加Android类型的OAuth 2.0 客户端 ID,输入包名和新的应用签名的SHA-1证书指纹。子项目中配置应用的OAuth Client Id

Facebook:Facebook登录的“密钥散列”与应用签名有关,需要添加新的“密钥散列”。
添加签名密钥散列

Fireabse:关联应用有用到应用签名的SHA-1和SHA-256证书指纹,需要添加
手动关联GooglePlay应用

Huawei:华为应用需要配置证书指纹。
生成签名证书指纹

1.10.3.4 签名密钥常见问题

1.打包的时候该使用哪个签名密钥?
上传签名密钥,只有在给需要上传到Google Play任意轨道(测试或正式等)的应用包打包时使用。
其他任意时候,比如想在本地运行调试,或者本地打包测试,只要不需要上传到Google Play的,都使用应用签名密钥进行打包。

2.MD5,SHA-1,SHA-256这些证书指纹该用哪个签名密钥的?
上传签名密钥只有在上传Google Play任意轨道时候打包应用包时使用,其他任何情况都以应用签名密钥为准。所以给Google,Firebase,Facebook,Huawei等平台提供的SHA-1,SHA-256证书指纹都需要使用应用签名密钥的证书指纹。

3.什么是keystore/jks文件,怎么生成的?
二者是同一个东西,都是Android签名密钥文件,用来打包Android应用的,当前常用的是jks文件。该文件用于确保应用的唯一性及合法性,非常重要,请务必保管好该文件及相关的密码,并确保不会泄漏。
虽然可以使用JDK的keytool工具生成这两种文件,但常用的方式是开发者使用Android Studio生成jks文件,而keystore文件一般使用Eclipse生成。

4.Google Play上的应用签名密钥keystore/jks文件找不到了,能否重新生成一个跟上面相同证书指纹的签名密钥文件?如果不能又该如何处理?
不能生成指定证书指纹的签名密钥文件。Google Play上也无法下载签名密钥文件。
处理方法:
1)上传应用到任意轨道(正式或测试),从Play Store的应用页面下载应用,上面下载的应用都会使用应用签名密钥打包签名过。
2)如果想自己重新掌握keystore/jks文件,并且Play控制台中该应用未升级过应用签名密钥(每个应用只有一次升级机会),可以进行密钥升级,更换为新的keystore/jks文件信息。升级的时候务必选择“上传自己的签名密钥”,不要选择默认的“由Google Play生成。。。”,升级成功后也务必对一些平台上的配置做出相依的配置改动,否则会影响这些平台的API使用,如Google登录,Facebook登录等,具体升级请参考“升级应用签名密钥”章节操作。

5.应用打包运行之后的签名密钥,和Play上的应用签名密钥不一致会有什么后果?
通常会影响所有配置了与应用签名密钥有关信息的平台API。比如Google的Android类型OAuth ClientID使用了SHA-1,会影响谷歌登录,导致谷歌登录直接返回取消。Facebook使用的散列秘钥,影响Facebook登录。其他的还有Firebase的应用关联,Huawei的应用配置。

 

1.11Google Play 发布应用

准备应用包:
使用上传签名密钥打包签名好应用包apk或aab。若使用应用签名密钥或其他签名密钥,会提示错误。关于签名密钥可以参考上一章节说明。
注意:推荐aab,2021年8份起新应用必须使用aab包发布应用。Play发布的apk大小限制为100MB,aab大小限制为150MB,若超出大小限制,apk包需要使用APK拓展文件obb功能,aab需要使用Play Asset Delivery功能,对应用或游戏资源进行配置,才能上传成功。

登录Google Play 控制台,选择并进入需要发布的应用。

1.选择发布的版本,根据需要可以选择内部测试,封闭测试,开放性测试,正式版。
2、若是测试轨道,可以选择测试人员并保存

图片36

3.若是开放性测试,或正式版,需要设置发布的国家。

图片36

4.创建新版本,上传应用包,保存。若之前已上传过该应用包,可以直接从内容库中选择。保存之后,点击检查发布版本。

图片36

图片36

5.在检查发布版本页面,查看所有错误警告消息,若是错误,必须按照指引完成修改。完成所有错误的修改后,回到该页面,点击 开始发布,即可完成操作,等谷歌审核通过后,即是正式完成发布。

图片36

其他说明:发布前错误提示,信息中心需要完成步骤,主要是设置应用部分,按照指引完成任务即可。

图片36

 

1.12.Google广告ID声明设置

选择应用》应用内容》广告 ID进入声明设置
图片36

使用广告ID项选择 “是”,使用方式选择,“分析”,“广告或营销”,点击保存。
图片36

1.13.Google Cloud后台Appsflyer卸载检测配置

1.13.1.创建 AppsFlyer uninstalls角色

进入Google Cloud后台 ,选择项目,IAM和管理,选择角色

WechatIMG603

点击创建角色

WechatIMG604

名称输入 AppsFlyer uninstalls
ID输入 af_uninstalls
角色发布阶段选择 正式版
然后点击添加权限

WechatIMG605

过滤条件输入 cloudmessaging.messages.create

WechatIMG607

WechatIMG608

选择cloudmessaging.messages.create权限,点击添加按钮。最后点击创建按钮。

WechatIMG609

1.13.2.将AppsFlyer指定为卸载角色

进入Google Cloud后台 ,选择IAM,点击授予访问权限

WechatIMG610

新的主账号输入:af-uninstalls-tracking@af-uninstalls-tracking.iam.gserviceaccount.com
角色选择   :AppsFlyer uninstalls

WechatIMG611

WechatIMG612

然后保存,完成Google Cloud后台Appsflyer卸载检测配置操作。

2.Facebook第三方后台配置


2.1 Facebook基础配置

Facebook控制台地址:https://developers.facebook.com/

2.1.1 创建Facebook应用

一共有五种可选的应用类型:公司、游戏、小游戏、消费者或无。当您选择应用类型后,系统会为应用提供仅适用于该应用类型的产品(如登录,分析等产品)、权限(访问用户生日性别照片等数据权限)和功能,精简应用创建流程。
1、公司类型适用于可帮助公司和组织管理公共主页、小组、活动、广告以及和广告相关素材的应用。
2、游戏类型适用于可以在 Facebook 开放平台上游玩的游戏应用。
3、小游戏类型适用于可以在 Facebook 开放平台上游玩的游戏应用。
4、消费者类型适用于整合 Facebook 登录等消费者相关产品以便为用户提供更多帐户关联体验的应用程式。
根据说明,上面的“游戏类型”是适用Facebook游戏平台上的游戏。我们推荐创建应用类型时,选择“消费者”类型,该类型包含Facebook登录,分析,应用事件,应用链接,Instagram基本显示API,分享,社交等常用的产品。
想了解所有应用类型对应可使用的产品、权限和功能,可以查看Facebook官方文档: https://developers.facebook.com/docs/apps/app-types/

进入应用控制台,点击“创建应用”。
图片1

点选择用途“打造关联体验”(对应消费者应用类型),点击“继续”。

图片1

填写“应用显示名”,和“应用联系邮箱”,点击“创建应用”。
图片1

“创建应用”完成以后会立即进入到该应用的控制台页面。
图片1

移除应用类型

如果选择应用类型之后,在产品添加中没有找到自己需要的产品,或者当前应用类型提供的权限或功能无法满足需求,可以移除该应用的应用类型,或者重新创建新的应用类型的应用。移除应用类型之后,就是无指定类型的应用了,可以选择添加任何产品和申请任意权限及功能。
注意:移除类型后是无法再次指定应用类型的。

下面介绍如何移除应用类型:
进入目标应用控制台页面,点击“产品 +”,往下滑,找到“想找其他产品和权限?”卡片,点击“移除应用类型”按钮。

图片1
输入该账号的密码,点击“提交”

图片1

操作完成之后,在应用控制台中可以看到,已经不再显示应用类型了,并且可添加产品中,显示了所有的产品,权限页面也可以看到显示所有权限。

图片1

2.1.2 添加产品

创建完应用编号后,需要添加产品。点击左侧菜单栏中的“产品+”按钮,找到所需的产品,点击该产品卡片的“设置”按钮进行添加。(接下来以必接的登录功能为示例,另外在这里只需要对产品进行设置,所以会忽略其他非设置步骤)。

图片1


2.1.3 设置项目信息

点击“设置”进入产品添加的向导(菜单栏“快速启动”方式设置),选择添加的产品支持的平台(此处以Android平台为例)

图片5

图:选择产品支持的平台

选择平台后,进入平台的设置页面,在这个页面可以在上面的tab中切换不同的平台进行设置,第1、2步是SDK集成,由开发人员完成,进入第三步设置项目信息。

输入应用包名,和默认活动类的完整路径(如果使用DeepLink功能,需要填入DeepLink功能响应的Activity类路径,否则可以填入首个启动的Activity,例如MainActivity即可),点击“Save”保存。

图片5

图:填写Android项目信息

点击保存,如果你的应用在Google Play没有上架,会弹出下图“Google Play包名校验遇到困难”的对话框,点击“使用此包名”即可。

图片5
图:Google Play包名验证出现困难


2.1.4 添加签名秘钥散列

签名秘钥散列需要开发技术同事协助获取,获取到的字符串是包含 28 个字符的唯一密钥散列,获取方式参考Facebook官方文档。将生成的秘钥散列添加到“秘钥散列”下面的文本框,如果测试环境和正式环境不一样的签名文件,这里可以添加多个。添加后点击“Save”保存。

具体操作过程可以参考以下任何一种方式,他们都是相同的指引,然后按指引生成“发布密钥散列”进行添加:
1.Facebook控制台 -> 产品 -> Facebook登录 -> 快速启动 -> Android平台 -> 添加开发和发布密钥散列
2.Facebook登录接入文档,第6节-为应用提供开发和发布密钥散列:
https://developers.facebook.com/docs/facebook-login/android#6

图片8

openssl-for-windows 下载路径
命令行:

图:添加签名秘钥散列

2.1.5 启用单点登录

根据需求,如果需要启用单点登录,打开单点登录,保存进入下一步。
图片9
图:启用单点登录

2.1.6 其他配置及提供参数信息给技术配置到工程项目中

在左侧菜单点开“设置->基本”,将应用编号(Facebook App id)提供给技术配置到项目中,如果需要礼物功能,需要将应用密钥(App Secret配置到SDK后台,关于礼物的配置参考后续章节。如果需要使用游戏邀请功能,必须在设置中设置应用的类别为“游戏”。
图片5

在“设置>高级>安全”中找到“客户端口令”,将该参数(ClientToken)提供给技术配置到项目中。

图片6

2.1.7 相关产品的配置修改

如果需要修改相关产品的配置,在左侧菜单中的“产品”中找到相应的产品,“设置”展示所有设置,“快速启动”是包含了向导的设置。
图片9
图:产品配置修改


2.2 Facebook添加开发者

添加步骤如下:
在Facebook控制台页面,在左侧“用户身份”菜单展开,下面有两个,“用户身份”和“测试用户”。“用户身份”是配置哪些用户拥有编辑和查看应用的权限;“测试用户”用来测试不同应用功能的临时性的 Facebook 帐户。

图片18
图:用户身份配置


图片18
图:测试用户

2.3 上线注意事项

切换到线上模式,必须提供“隐私权政策网址”和“数据删除信息”。
“隐私权政策网址”必须提供有效的地址,在Facebook登录页面和应用详情页面会显示该入口。
“数据删除信息”,Facebook为了符合通用数据保护条例 (GDPR),可获取用户数据的应用程序必须执行以下某项操作:
1.执行数据删除请求回调。
2.为用户提供含有明确说明的网址,介绍如何使用第三方网站或工具删除数据。第三方网站可能是应用程序隐私政策的相关部分。
用户在Facebook设置中移除应用时候,会有提醒用户移除数据的相关说明。
第一种方式需要按照官方文档要求提供接口给Facebook调用。我们建议选择第二种方式,提供数据删除说明地址,介绍如何删除数据。
图片18
图:切换线上模式提示框

图片18
图:选择 数据删除说明网址

图片18
图:选择 数据删除说明网址

3.VK后台应用配置

VK目前必接的功能包括登录,登出,显示用户名称以及头像,group和邀请。

3.1. VK基础配置

创建VK应用,创建地址如下(如果还没注册,需要先注册):https://new.vk.com/editapp?act=create
Android-VK基础配置

title中填入应用的名称, 点击Connect Application按钮,并按照提示创建应用。填写关键信息,主要是填写Information和Settings部分:
Android-VK基础配置

Android-VK基础配置

Android-VK基础配置

上图的SDK settings中安卓部分需要填写应用的包名和指纹,指纹的获取方式请参考1.1 配置应用程序证书指纹(去掉冒号),也可以参考:https://new.vk.com/dev/android_sdk,或者与开发人员联系获取。

获取vk app id提供给开发人员并且注意设置应用状态为可见
android-VK基础配置

3.2 应用提交审核

VK的邀请功能是对接VK渠道官方要求必须接入的,而邀请功能只能在审核通过的应用中使用,所以需要将配置好的应用提审。

这里需要注意的是:
VK的应用审核比较严格,首先必须是游戏应用,并且需要全部翻译成俄文,不能是demo,有人工审核。
如果需要测试邀请,原则需要审核过的应用,在应用审核通过之前,使用apps.sendRequest接口,type为request来测试,测试者需要双方是好友,都是管理员并且都已经安装过该应用。
对接VK邀请功能业务流程图如下:
vk上线流程图

控制台提审大致步骤如下:
Android-VK基础配置

Android-VK基础配置

4.Firebase后台配置

在Firebase后台配置后,会得到两个文件,一个是google-services.json,需要给研发配置到游戏中去;另一个是Firebase服务器秘钥,需要配置到SDK后台

4.1 添加项目

在浏览器中打开Firebase控制台点击添加已经在Google API存在的项目

图片9

点击输入项目名称输入框时,会弹出已经存在Google Api的项目列表,选择对应项目并继续

图片3

图片4

图片6

选择配置Google Analytics账号,点击添加Firebase按钮

图片7

图片8

点击继续,则项目创建完成。

4.2 新建应用

进入项目,点击对应应用类型

图片6

输入软件包名、应用名、SHA-1指纹,点击注册应用

图片6

注册应用,进入下一步,下载google-services.json。将下载的配置文件复制到项目模块文件夹,通常为 app/。

图片6

google-services.json文件可以随时重新下载,可以在设置,常规,选中项目后,下载某个项目的google-services.json文件,如果包名改变,或者其他配置更新,则需要重新下载google-services.json文件,然后更新到项目中去。

图片6

4.3 获取Firebase服务器秘钥 (消息推送使用)

在项目详情左侧菜单中点击“设置按钮”进入“项目设置”页面,选中“云消息传递标签”,目前使用的新版 Firebase Cloud Messaging API(V1),

WechatIMG595

如未开启,需要额外开启,点击“选项”图标

跳转到Google Cloud页面的 Cloud Messaging 产品详情,点击“启动”

3-云消息密钥-2

“启动”完成后,回到Firebase的云消息传递页面,刷新后就会显示,Firebase Cloud Messaging API(V1)已是“已启用”状态。

选择服务账号-Firebase Admin SDK,如未创建服务账号,展示效果如下:

WechatIMG597

点击创建服务账号按钮,成功后,展示效果如下:
WechatIMG598

点击生成新的私钥按钮,弹出提示框,点击生成密钥,然后会下载对应的密钥json文件,保存,后续android推送配置上传密钥时,会使用。

WechatIMG598

WechatIMG599

4.4 将Google Play链接到Firebase

前提条件:
所关联的应用,必须在GooglePlay中已经创建,并上传过对应包名的应用包,否则无法关联。
说明:
1.必须链接到Google Play才能查看Android应用的in_app_purchase和订阅事件。
2.需要使用主账号关联

1.在Firebase控制台项目中,点击“项目概览”的选项图标,选择“项目设置”
2.在“项目设置”页面选中“集成”选项卡,在里面找到“Google Play”,点击“关联”

4-关联Play-0

3.“关联GooglePlay”页面,在第一步中点击“下一部分”

4-关联Play-1

4、在第二步勾选“共享应用购买和订阅收入数据”,勾选后可以查看“已选择应用”,如果还没创建应用,可以先创建再关联。最后点击“关联到Google Play”

4-关联Play-2

手动关联Google Play应用

已关联Google Play账号的的项目,如若Firebase继续添加应用,则需要手动关联新的Google Play应用。

同样是在“关联Google Play”界面,在“已关联应用”中,可以勾选未被关联的应用点击“保存”进行关联,
关联的应用同样必须在Play中已创建并有上传对应包名的应用包。

4-关联Play-4

然后需要重新下载最新的google-services.json配置文件,给到研发进行更新

4.5 Firebase 分析调试

参考:https://firebase.google.com/docs/analytics/debugview?authuser=0
要在 Android 设备上启用 Analytics“调试”模式,请执行以下命令:

例如:adb shell setprop debug.firebase.analytics.app com.ghw.sdk2

“调试”模式将保持启用状态,直至您通过执行以下命令明确停用“调试”模式:

开启调试后,打开管理后台,选择项目–分析–DebugView,能够看到目前正在调试的设备,以及上传的事件。

图片36

注意:为了防止测试和开发影响测量值,在调试模式下记录的事件将从总体 Analytics 数据中排除,并且不会包含在每日 BigQuery 导出报告中。

4.6 获取 Firebase Project ID

1.进入FCM Console(FCM控制台)
2.选择一个项目。
3.进入Project Overview(项目总览)> Project settings(项目设置)。

图片12

4.复制Project ID,即为Firebase 的Project ID

5.Twitter后台配置

5.1 Twitter后台应用配置

注册一个Twitter账号,打开Twitter开发者页面,如果您的Twitter账号不是开发者账号,还需要将Twitter账号注册成为开发者账号。进入My Apps页面,可管理应用。如果还没有应用,点击“Create New App”进入创建应用界面,填写相关信息新建应用。
Twitter-后台配置
新建应用后,点击应用列表中的应用,可以查看应用的详情。
Twitter-后台配置
点开“Keys and Access Tokens”标签可以看到ConsumerKey和ConsumerSecret
Twitter-后台配置

5.2 WINGSDK后台应用配置

将Twitter中新建应用的consumeKey和ConsumeSecret配置到WINGSDK后台。选中应用→设置→登录平台→添加Twitter登录平台,在“平台应用ID”中填写consumeKey,在“公钥”中填写consumeSecret。
Twitter-后台配置

6.Instagram后台配置

打开Instagram开发者页面,注册账号并登陆。点击“Manage Clients”标签打开应用列表,点击“Register a New Client”新建一个客户端。
Instagram-后台配置
在新建客户端的页面填写相关信息提交即可完成创建。
Instagram-后台配置
回到“Manage Clients”页面,点击刚刚新建的客户端可以查看详情,在这里可以看到Client ID和Client Secret。
Instagram-后台配置
新建的客户端的状态是“Sandbox”,在这种状态下,所有参与测试的人员都需要添加到“Sandbox”才能参与测试,添加用户到“Sandbox”的方法如下:打开“Sandbox”标签页面,输入邀请的用户名,用户名不是邮箱,一般用户名是注册邮箱@符号的前部分。注意,添加后一定要保存才能生效。保存后通知被邀请人接受邀请,可在“Sandbox Invites”看到邀请记录,接受邀请后的用户可以测试登录。
Instagram-后台配置
应用如果完成了测试要准备上线,需要将应用发布为正式状态,在“permissions”标签下,点击“Start a submission”进行权限申请。
Instagram-后台配置
在下一步选择“My app allows people to login with Instagram and share their own content.”,填写相关信息,这一步需要一个视频演示链接,完成提交后等待审核即可。
Instagram-后台配置

7.智能客服 AIHelp后台配置

AiHelp官方支持地址:
https://aihelp.net/elva/FAQ/FAQList.aspx?l=zh_CN&SectionID=0&pf_app_id=5

AiHelp 官方后台配置文档地址(页面内有下载链接介绍文档pdf):
https://aihelp.net/elva/FAQ/FAQList.aspx?SectionID=3392&LanguageID=5&pf_app_id=5&kmContentId=122760

已下是常用功能配置说明,需更多更详细请到官方下载最新pdf文档

7.1.新建应用

7.1.1 左侧“设置”-> “应用”-> “+”如下图位置

WechatIMG548
弹出界面,输入应用名称,点击“Add”完成新建 如下图
WechatIMG549

7.1.2 选择新建应用,如下图操作

WechatIMG550

选择中刚刚新建应用,会切换到应用下内容。

7.2.获取参数

如果不在需要app下,需按照 7.1.2 切换app
左侧“设置”-> “应用”-> “+”如下图位置

WechatIMG551

7.3.添加语言

设置语言后app应用Aihelp部分功能支持多语言。
左侧“设置”-> “语言”-> “添加语言”如下图位置
WechatIMG552
点击设置后,弹出语言列表,可以增加需要语言
WechatIMG553

7.4.配置FAQ

此功能配置是在app 应用中FAQ相关功能

7.4.1.新建FAQ分类

左侧“机器人”->“常见问题”-> “[分类]”-> “新增分类+” 如下图位置
WechatIMG554

弹出新增页面,输入名称和顺序编号后保存

WechatIMG556

WechatIMG555

分类列表会出现新建分类,左侧栏也会出现对应分类

7.4.2编辑FAQ分类

在分类列表中,点击如下图按钮
WechatIMG558

弹出详情页面,可做对应修改。其中中文,英文对应aihelp sdk显示的语言内容。

WechatIMG557

7.4.3.新建FAQ

在左侧栏选择FAQ分类->“新增FAQ”,如下图
WechatIMG559

弹出新增页面

WechatIMG560

7.4.4.编辑FAQ

在FAQ列表中,点击如下图按钮

WechatIMG562

弹出详情页面,其中语言对应aihelp sdk显示的语言内容。

WechatIMG563

7.4.5.发布FAQ

如,在热门问题分类下,创建了一个信息,然后发布流程
左侧“机器人”-> “常见问题”-> “发布” 如下图位置

WechatIMG564

7.5.配置运营模块Tab

此功能是app应用中运营界面功能

7.5.1.新建Tab

左侧“运营支持”-> “运营模块”-> “[Tab设置]”-> “新增Tab” 如下图位置
WechatIMG566

弹出新增页面

WechatIMG567

7.5.2.编辑Tab

左侧“运营支持”-> “运营模块”-> “[Tab设置]”-> 编辑,如下图

WechatIMG568

7.5.3.新建文章

左侧“运营支持”-> “运营模块”-> “[Tab列表]”,选择刚才创建的tab1,点击新建,如下图
WechatIMG569

弹出新增页面

WechatIMG570

7.5.4.编辑文章

在文章列表中,点击如下按钮
WechatIMG571

弹出详情页面,其中语言对应aihelp sdk显示的语言内容。

WechatIMG572

7.5.5.发布Tab

Tab要在app应用中显示需要发布,每次修改都需要发布。
左部“运营支撑”-> “运营模块”-> 需要发布的Tab -> “发布” 如下图位置
选择平台、语言后发布

WechatIMG573
发布后,效果图如下
WechatIMG575

7.6 自定义SDK配置

7.6.1 展示头像配置

WechatIMG575

7.6.2 APP对外名称配置

WechatIMG575

7.6.3 设置横竖屏

WechatIMG945

7.6.4 更多其他配置

另外还包含欢迎语设置,主题设置等等功能。
详情请参考:
https://aihelp.net/FAQ/#/AIhelp%20Support/app/zh_CN/EB5AE263D8AB85A4/35E3B9E6396692FE/396CD31FF6A33A5D

8.华为HMS后台配置


8.1 基本流程

1、登录流程
WechatIMG575

参考:https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/dev-process-0000001050443773
2、支付流程
WechatIMG575
参考:https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/dev-process-0000001050033070

8.2 配置AppGallery Connect

1)注册成为开发者
2)在 AppGallery Connect创建项目、创建应用
A、 如果没有项目,则创建项目,我的项目—添加项目,输入项目名称,确认,则项目创建成功。
WechatIMG575

WechatIMG575
点击确定完成后,点击添加应用,跳转添加应用界面
WechatIMG575

WechatIMG575

注:需要集成支付能力,包名后缀必须为.HUAWEI或者.huawei

B、如果已存在项目,则可在项目下,创建具体的应用,一个项目下可创建多个应用
WechatIMG575


3)生成签名证书指纹
keytool -list -v -keystore C:\TestApp.jks
执行结果如下:

WechatIMG575

说明:C:\TestApp.jks表示应用签名文件,CP替换成自己的签名文件即可。

4)在“我的项目”中找到刚创建的项目项目,找到对应的应用,配置SHA256证书,如下图所示
WechatIMG575

5)打开相关服务
5.1)打开API权限服务,在“项目设置”->“API管理”菜单中,开启相应服务,如下图所示:
WechatIMG575
登录服务为 Auth Service,支付服务为 In-App Purchases,其他权限为创建应用默认开启的权限,可以忽略。

此操作为项目级别操作,操作完后,项目下所有应用都会有此权限。

5.2)配置支付参数
① 在我的项目中,选择具体某个应用,在左侧导航栏选择“盈利 > 应用内支付服务”,点击“设置”。

WechatIMG575
说明:如果首次配置会弹出签署协议弹框,其中订阅通知地址,可不填写

8.3.获取应用的AppGallery Connect配置文件

1)获取agconnect-services.json文件
WechatIMG575

8.4.配置商品

1)打开“ AppGallery Connect”->“我的应用”->“运营”菜单,如下:
WechatIMG575

2)点击“添加商品”,如下图所示:
WechatIMG575
填写商品相关的商品信息,点击保存即可,这里选择“消耗型”商品。

3)创建商品后,默认状态为失效状态,需要点击激活按钮:
WechatIMG575
点击后,提示此商品将被开放购买,点击确认。

8.5.配置沙盒测试账号

参考:https://developer.huawei.com/consumer/cn/doc/distribution/app/agc-tester_account_mgt

接入完支付sdk后,华为提供沙盒支付测试模式。打开华为AppGallery Connect管理后台,选择用户与访问,选择左侧沙盒测试栏目下的测试账号,点击新增,输入华为账号即可
WechatIMG575

WechatIMG575

注:测试帐号必须填写已注册、真实的华为帐号。

添加完成后,使用此沙盒测试账号,支付时,可以直接进行沙盒支付测试

8.6.配置华为分析

1)接入流程
WechatIMG575
2)后台开启分析服务

a、如果没有华为开发者联盟帐号,需要先注册帐号并通过实名认证。详细操作请参见帐号注册认证。
b、参见创建项目和在项目中添加应用完成应用的创建。
c、登录AppGallery Connect网站,点击“我的项目”图标
d、选择需要查看分析数据的应用。
e、点击“华为分析”下的任意菜单,并点击“启动分析服务”按钮可开通分析服务。(注:需拥有产品管理权限才可开通服务)

WechatIMG575

f、进入“项目接入设置”页面,设置数据存储位置、数据共享设置、支持行业分析、标识用户、时区、货币、设置用户数据留存时间、设置自然周定义后,点击“完成”,即完成Analytics Kit 服务开通。对于支持行业分析,如果您已经设置应用的分类情况,则默认开启

WechatIMG575

g、开启后,选择项目设置–我的项目–应用,下载最新的配置文件,给到研发进行更新

WechatIMG575

3)调试

1、开启/停用调试模式

调试模式打开后,所有事件将实时上报,在应用调试界面可实时查看上报的数据。
说明:请将命令行中的“package_name”字段替换为您的应用包名
数据成功上报后,“华为分析 > 应用调试”页面会展示出数据,如下图

WechatIMG575

2、您可执行如下命令行,停用调试模式

8.7.开通华为性能分析

参考:https://developer.huawei.com/consumer/cn/doc/development/AppGallery-connect-Guides/agc-apms-viewdata

进入“质量->性能管理”,如果APM服务未开通,请点击“立即开通”按钮,开通APM服务

WechatIMG575

说明:
由于开通服务时可能需要设置数据存储位置,设置数据存储位置后会刷新agconnect-services.json文件里的配置。如果您开通服务时设置了数据存储位置,在开通完成后您需要重新下载agconnect-services.json文件并集成到您的工程中。

9. appsflyer后台配置

9.1 appsflyer卸载配置

说明:
需要完成Google Cloud后台Appsflyer卸载检测配置操作,如已操作可继续执行以下步骤

进入appsflyer后台 ,选择项目-配置-卸载模块,如未开启则点击开启

WechatIMG601

输入 选择HTTPV1
输入 Project ID(获取 Firebase Project ID )
点击Test connection 按钮,测试成功会提示:Success! Your app is connected to Firebase
然后保存设置,即完成操作。

WechatIMG594

版本变更记录(WingSteamExeSDK)

wapublisher No Comments

WingSteamExeSDK-1.0.1(2023.12.12发布)

  • WingSteamExeSDK变更如下:对接文档
    1.新增Exit退出方法,程序退出时调用

WingSteamExeSDK-1.0.0(2023.11.14发布)

  • WingSteamExeSDK变更如下:对接文档
    1、登录:集成steam登录
    2、支付:集成steam支付
    3、数据收集:WINGSDK数据收集

WingSteamExeSDK 使用指南(2.0.0)

wapublisher No Comments

WingSteamExeSDK 使用指南(2.0.0)

简介

WingSteamExeSDK主要是为满足PC端Steam平台Windows的游戏需要,为此类游戏提供基于Steam平台的登录、支付、数据收集等通用功能。以下文档中会把WingSteamExeSDK简称为SDK。

1.cp接入流程

steam exe接入流程.drawio

相关步骤指引:

1.第一步,安装和接受邀请,参考《第5.1章 成为steam应用测试者》
2.第二步,集成和接入,参考《第2章 集成》以及之后的章节进行接入
3.第三步,本地调试,参考《第5.2章 本地开发测试》《第5.3章 日志调试与沙盒支付》

2.集成

2.1.SDK库选择

SDK提供了多个版本的库文件,可以根据项目需求使用。

序号 平台 是否MT编译 lib库文件 SDK下载
1 x86 wingsdk.lib 下载
2 x64 wingsdk64.lib 下载
3 x86 wingsdk_mt.lib 下载(推荐)
4 x64 wingsdk64_mt.lib 下载

MT编译版本:已经内置VC运行库内容,不依赖于外部VC运行库。
普通(MD)编译版本:该版本会使用附带的vcruntime140.dll,msvcp140.dll,vcruntime140_1.dll这几个文件。

对应的dll版本:

版本 包含文件 备注
x86 libcrypto-3-wing.dll
libssl-3-wing.dll
sdkencryptedappticket.dll
steam_api.dll
wingsdk.dll
msvcp140.dll
vcruntime140.dll
x64 ibcrypto-3-x64-wing.dll
libssl-3-x64-wing.dll
sdkencryptedappticket64.dll
steam_api64.dll
wingsdk64.dll
msvcp140.dll
vcruntime140.dll
vcruntime140_1.dll
x86_mt libcrypto-3-wing-mt.dll
libssl-3-wing-mt.dll
sdkencryptedappticket.dll
steam_api.dll
wingsdk_mt.dll
x64_mt libcrypto-3-x64-wing-mt.dll
libssl-3-x64-wing-mt.dll
sdkencryptedappticket64.dll
steam_api64.dll
wingsdk64_mt.dll

2.2.项目集成

以VisualStudio项目工程为例

1.下载最新版本SDK压缩包,并解压
2.SDK头文件引入
1)复制include文件夹及其内容到项目中,主要包含wing目录下的wing_api.h头文件
2)右键项目->属性->C/C++->常规->附加包含目录,填入include文件夹路径,例如include文件夹是复制到项目根目录下,则路径可以填写:$(ProjectDir)include

图片1

图片2

3.SDK库文件引入
1)复制lib文件夹及其内容到项目中,并在项目属性页->链接器->常规->附加库目录,中填入lib文件夹路径,例如lib文件夹是复制到项目根目录下,则路径可以填写:$(ProjectDir)lib
2)在项目属性页->链接器->输入->附加依赖项中填入sdk的lib文件,如果是x86编译,则填入wingsdk.lib,如果是x64编译,则填入wingsdk64.lib,如果使用mt版本,则选择对应带mt后缀lib文件。
图片3

图片4

4.SDK的Api使用
1)在项目中引入。以前面步骤的配置路径作为示例,那么引入的路径为 #include “wing/wing_api.h”
2)在项目中使用。wing_api.h的接口为命名空间+方法的使用方式,例如:sdk的初始化方法使用,WingProxy::Init(“appId”,“appKey”,[](int code,wstring msg,wstring data){});

5.项目编译后,需要把sdk用到的dll文件复制到编译后的exe程序目录中,否则项目无法正常运行。具体版本对应的dll文件,参考前面dll版本文件对应表。例如x86的dll内容如下图:

图片5

6.运行程序

2.3.三方库版本

三方库 版本 包含dll(只列举x86版本) 功能
OpenSSL 3.1.3 libcrypto-3-wing.dll
libssl-3-wing.dll
网络请求
SteamSDK 1.5.8 steam_api.dll
sdkencryptedappticket.dll
Steam平台SDK

3.接口说明

3.1.使用方式

sdk的api采用命名空间+方法的形式定义的,WingProxy是所有sdk接口的命名空间,以支付是否可用方法为例,使用方式:

3.2.回调函数

sdk接口的参数中,除了一些常见类型参数,在wing_api.h中还声明了WingCallback回调函数,参数说明如下:

参数 类型 说明
code int 状态码,具体取值参考《状态码说明》章节
msg std::wstring 状态码说明
data std::wstring Json字符串,里面包含该接口会返回的字段,例如登录接口登录成功后返回的data内容:{“msg”:”token refreshed”,”code”:200,”isFirstLogin”:0,”userId”:7822920,”token”:”30_o1hejvBB22LKMu”}

4.SDK接口

4.1.初始化

调用下面接口对SDK进行初始化,建议在程序开始时首先调用,确保后续其他sdk接口可以正常使用

参数说明:

参数 类型 必填 说明
appId std::wstring Y appId,具体值从运营处获取
appKey std::wstring Y appKey,具体值从运营处获取
WingCallback WingCallback Y 回调函数

代码示例:

4.2.退出程序

调用下面接口对SDK内资源进行释放,必须在程序退出前调用。

4.3.登录

使用下面接口进行登录

参数说明:

参数 类型 必填 说明
WingCallback Y 回调函数

WingCallback的data内容字段说明:

字段名 类型 必填 说明
userId long Y 用户Id
token string Y 在线token

代码示例:

4.4.退出登录

调用下面接口退出账号

4.5.检查支付是否可用

进行支付之前,需要先判断支付是否可用

返回值为bool类型,true 表示支付可用,false表示支付不可用。

4.6.购买商品

进行支付之前,需要先判断支付是否可用

参数说明:

参数 类型 必填 说明
productId std::wstring Y WINGSDK平台的商品ID
extInfo std::wstring Y CP 扩展信息字段,限长512(JSON格式),WING服务器到CP服务器发货通知时原样返回给CP。如果CP的通知发货地址是动态变化的(比如每个服务区的地址都不一致),可以通过此字段设置:参数格式为标准JSON,参数名为 deliverUrl,参考格式{ “deliverUrl”:” http://game.com/deliver.do”, “otherInfo”:”otherInfo”,“merId”:””}merId字段(选填),收款商户ID,使用场景:同一个支付渠道下有多个不同的收款验证信息(或收款帐号)。无内容建议传入空字符串“”
WingCallback Y 回调函数

WingCallback的data内容字段说明:

字段名 类型 必填 说明
orderId std::string Y 订单ID
productId std::string Y WINGSDK平台的商品ID
currency std::string Y 基准货币
amount long long Y 基准货币价格
quantity int Y 购买数量,目前一般都是1
extInfo std::string N 扩展信息字段,内容与该方法传入的extInfo相同
status int Y 1表示支付成功,其他表示支付失败

代码示例:

4.7.游戏必要参数设置

WINGSDK包括serverId等游戏参数,这些参数主要用于数据跟踪和统计。
该部分参数必须严格按照文档进行设置,在后续的接口中会使用到这些参数,没有按照要求配置会导致部分接口调用失败。

参数设置时机除了按照说明设置,另外需要特别注意在游戏启动时的设置时机,具体参考 流程要求

4.7.1 设置服务器ID

当用户的服务器ID发生改变时,需要调用设置服务器ID接口设置新的服务器ID,例如每次进入服务

注意:设置服务器id的操作在每次选服后都需要进行,必须在调用其他事件前设置

4.7.2.设置GameUserId

当游戏角色ID发生改变时,需要调用设置接口设置新的gameUserId,例如成功登录账号后、切换账号成功后

注意:
1.必须在调用其他事件前设置。
2.游戏角色ID是游戏角色在游戏中的ID,不是WINGSDK自身的UserId。
3.若未创角前拿不到游戏角色ID,可以先设置-1,创角后再设置一次正确的角色ID

4.7.3.设置用户等级Level

当用户角色等级发生改变时,需要调用设置等级接口设置新的等级,例如开始进入游戏、等级提升等。

注意:第一次进服获取玩家等级或玩家等级变更后,需要及时调用这个接口设置玩家等级,必须在调用其他事件前设置。

4.7.4.设置玩家游戏昵称

设置游戏玩家的昵称,调用接口:

注意:
1.当玩家登录、登出游戏,或修改昵称时,需要及时调用这个接口设置玩家昵称。
2.调用该接口设置昵称后,玩家进行购买时会自动记录昵称到订单信息中。

4.8.数据收集

4.8.1.流程要求

WINGSDK数据收集使用在游戏的过程中打点的方式,如图所示:

图片6

注意:

1.以上流程图中涉及到的几个接口是有时序要求的,请参考流程图中的逻辑步骤进行设置:WingProxy::SetServerId()、WingProxy::SetGameUserId()、WingProxy::SetLevel()、WingProxy::SetNickName()、ghw_user_import事件、ghw_user_create事件。

2.其它的事件如ghw_level_achieved、ghw_self_tutorial_completed等请根据对应业务逻辑,在对应业务发生时调用接口发送。

序号 事件(接口)名称 事件描述 事件作用 建议触发点 备注
1 SetServerId 设置服务器ID 标记玩家当前所在的服务器,后台根据该字段统计每个服务器的数据 登录游戏服成功后
2 SetGameUserId 设置玩家角色ID 标记玩家当前的游戏角色ID,后台根据该字段统计玩家的数据 登录游戏服成功后
3 SetLevel 设置玩家当前等级 标记玩家当前的游戏角色等级 玩家等级发生变更后,如登录游戏服成功后、玩家完成升级后
4 SetNickName 设置玩家昵称 标记玩家当前的游戏昵称 玩家设置昵称后
5 ghw_user_import 玩家登录游戏服 记录玩家登录游戏服的动作,后台根据该事件统计导入数、登录数、导入留存等数据 玩家登录游戏服成功后 需要先调用SetServerId、SetGameUserId、SetLevel接口
6 ghw_user_create 玩家创建角色 记录玩家创建角色的动作,后台根据该事件统计创角数 玩家创建角色成功后 需要先调用SetServerId、SetGameUserId、SetLevel接口
7 ghw_user_info_update 更新用户信息 更新用户信 玩家信息更新时 需要先调用SetServerId、SetGameUserId、SetNickname接口
8 ghw_level_achieved 更新玩家等级 更新玩家等级,后台根据此字段更新玩家等级 玩家达到新的等级时 需要先调用setLevel接口更新玩家等级
9 ghw_self_lv_x 更新关键等级 更新关键等级 关键等级到达时 属于自定义事件
10 ghw_self_tutorial_completed 完成新手任务 完成新手任务 完成新手任务时 属于自定义事件

4.8.2.发送事件

使用下面接口发送事件

参数说明:

参数 类型 必填 说明
eventName const std::wstring& Y 事件名称
params const std::wstring& N 事件参数,可以不传,默认空。以json字符串的形式传递。例如需要设置isFirstEnter为1,则应该传递内容为:{“isFirstEnter”:1}。
eventValue double N 事件价值,可以不传,默认无。

代码示例:

4.8.3.预定义事件

4.8.3.1.ghw_user_import导入用户事件(进服)

说明:导入用户事件,玩家第一次进某个服时调用

参数名 类型 说明 必填 备注
isFirstEnter int 是否第一次进服 Y 0->否;1->是;默认为0

注意:发送ghw_user_import事件前需调用设置服务器ID接口更新服务器id、设置gameUserId接口更新游戏用户id
代码示例:

4.8.3.2.ghw_user_create 创建角色

说明:创建游戏角色,游戏角色创建时调用

参数名 类型 说明 必填 备注
nickname std::string 角色名(昵称) Y
registerTime long long 创建时间 Y 注册时间戳,13位数,单位为毫秒(1970以后)
gender number 角色性别 N 0 女,1 男,2 未知
roleType std::string 角色类型 N
vip number 等级 N
bindGameGold number 绑定钻石 N
gameGold number 用户钻石数 N
fighting number 战斗力 N
status number 状态 N 状态标识,-1: 锁定,1:未锁定

代码示例

4.8.3.3.ghw_user_info_update 更新用户信息

参数名 类型 说明 必填 备注
roleType std::string 角色类型 N
nickname std::string 角色名称 Y 无昵称时,可填写空字符串
vip int 等级 N
status int 状态 N 状态标识,-1:锁定,1:未锁定

代码示例

4.8.3.4.ghw_level_achieved 等级增长事件

说明:统计玩家等级增长事件,达到等级时调用。

参数名 类型 说明 必填 备注
score number 账户分数 N
fighting number 战斗力 N

注意:发送ghw_level_achieved事件前需调用设置用户等级level接口更新用户等级信息。

4.8.4.自定义事件

如果发送的事件不属于预定义事件范围,事件发送时会自动补上ghw_self_前缀,例如关键等级5的事件名称传入,lv_5,最终发送的事件名称为ghw_self_lv_5。

4.8.4.1.ghw_self_lv_x关键等级事件

代码示例:

4.6.4.2.ghw_self_tutorial_completed完成新手任务

5.本地开发调试

5.1.成为Steam应用测试者

在应用上线前,成为Steam应用测试者,可以以测试者的身份在steam客户端中拥有该游戏,并进行测试。
步骤:
1.研发提供steam账号邮箱给运营
2.运营在steam后台邀请该账号成为测试者
3.steam账号邮箱会接收到邀请邮件,需要点击接受邀请

图片1

4.运营在steam后台确认后,把该steam账号添加到对应游戏组,即可拥有该游戏权限
5.研发重新登录steam账号后查看是否已拥有目标游戏

图片2

5.2 本地开发测试

5.2.1 本地测试方式一

在应用未上线时,如果需要在本地进行开发测试,可以在本地exe的同级目录,增加一个steam_appid.txt,内容为steam应用的apppid(appid向运营获取),如steam的appid为3141480,则内容如下图:

图片3

完成steam_appid.txt添加后,运行steam客户端,此时就可以直接运行本地exe进行SDK相关api的接入测试了。

注意:开发完成后打包时,需要移除steam_appid.txt

5.2.2 本地测试方式二

cp打个exe包(此时可以不接sdk),然后让运营上传到steam后台,cp从steam上下载此游戏,然后通过游戏设置-管理-浏览本地文件,找到游戏下载路径。cp可以使用本地开发调试包进行替换,然后从steam上启动此游戏进行测试。

iShot_2024-08-21_15.04.37

iShot_2024-08-21_15.07.37

5.3 日志调试与沙盒支付

SDK的日志默认是关闭状态的,开启日志后会在程序目录下生成winglog.log日志文件,可以查看SDK的日志信息。

开启SDK调试日志:
1.SDK日志的开启需要提供设备的ClientId,在用户的隐藏目录AppData下找到SharedConf配置文件,以文本的形式查看文件可以得到ClientId值。
具体路径:C:\Users\用户名\AppData\Local\WingSteamExeSdk\SharedConf
文本内容参考:{“ClientId”:”5c56b3400000000000000e0a76c72″}
2.把ClientId的值提供给运营,运营在后台操作加入测试设备
3.重启已接入SDK的程序,进行SDK相关操作,即可在winlog.log查看SDK输出的相关日志信息。

沙盒支付:
同上面一样,加入测试设备后,重启已接入SDK的程序,即可进行沙盒支付进行支付相关测试

6.状态码说明

状态码 说明
200 操作成功
-400 一般错误
-401 SDK未初始化
-402 Steam初始化失败
-403 Steam登录授权超时
-404 Steam登录授权失败
-405 未登录
-500 服务器异常
-501 服务器异常:json解析异常
400 失败
500 服务器内部故障
501 所请求接口或页面未实现
4010 无效appId: appId不存在或未开启
4011 无效osign:osign校验失败
4012 请求已过期:ots校验失败
4013 第三方平台验证失败
4017 用户不存在(没有找到)
4019 无效orderId
4020 订单验证失败
4023 未找到渠道信息
4025 汇率转换失败
4026 支付渠道已关闭
4029 登录渠道已关闭
5005 该设备不能支付或者不允许支付
5006 支付过程中出错

iOS博客备份(3.12.0)

wapublisher No Comments

一、简介

1.1 用户模块

提供 UI界面 和 接口调用 两种方式,满足用户不同需求。

1.1.1 登录弹窗

内置登录UI弹窗,内含所有已经集成的登录方式,无需编写界面,一键集成登录功能

1.1.2 匿名登录

WINGSDK匿名登录无需账户密码,根据设备信息新建用户或登录已存在的用户,可以快速登录游戏。

1.1.3 第三方平台登录

第三方平台登录接口可以通过第三方平台账户登录,返回WINGSDK账号信息,使用没有绑定任何WINGSDK账号的第三方平台账号登录,会自动新建一个WINGSDK账号,并且与该平台账号绑定。支持Facebook登录、Google登录、VK登录。

1.1.4 内置账户管理界面

内置账户管理UI界面,无需编写界面和逻辑,即可对账户进行管理,平台账户绑定情况一目了然,绑定、解绑平台账户,新建账号,切换账号,轻松搞定。

1.1.5 账号绑定与解绑

  • 账号绑定接口,可以将WINGSDK账号跟第三方平台的账号绑定,绑定成功后可以使用绑定的平台账号登录,在同一应用中一个平台账号只能绑定一个WINGSDK账号。

  • 账号解绑接口,可以将第三方平台账号与其绑定的WINGSDK账号解绑,解绑成功后,平台账号可以与WINGSDK账号再次绑定。

  • 绑定账号查询接口,能够查询此时登录的账号(WINGSDK)已经绑定的第三方平台账号列表。

1.1.6 账号切换

一键切换账号,迅速切换WINGSDK账号或者第三方账号。

1.2 支付模块

支付模块提供支付充值接口,集成简单,无需理会复杂的支付流程,轻松完成商品的购买(充值)。

1.3 数据收集模块

数据收集模块提供了数据收集的接口,多渠道灵活调用。数据收集包含了丰富的应用内的事件类型,还支持用户自定义事件类型。

1.4 社交模块

社交模块,为游戏提供社交功能支持,一键集成,功能丰富。社交模块包含以下功能:
1、分享接口,支持分享链接、文字、图片、视频、Facebook OpenGraph;
2、游戏邀请,邀请还没有玩过该游戏的好友跟自己一起玩这款游戏,邀请好友一起玩游戏,还有丰富的邀请奖励;
3、Game Service,游戏互动更简单;
4、社区,提高玩家的积极性和互动。

1.5 应用墙模块

应用墙模块,提供应用、游戏的推广下载,引导用户安装。

注意:此模块会对苹果应用商店上架造成一定的风险,请酌情使用。

1.6消息推送

WINGSDK推送功能是基于苹果APNS,可以向客户端推送消息,通过简单几步配置即可使用。

1.7 广告

WINGSDK广告功能,可以向玩家展示视频广告,并且可以实现奖励机制。

1.8 智能客服 AIHelp

WINGSDK智能客服功能,集成机器人、人工客服,FAQ等功能。

1.9隐私政策

为了遵守欧盟以及Google等第三方的一些关于用户隐私的法律法规,WINGSDK实现了一套简单的用户隐私政策流程。分为两种类型,一种是自动的,针对的是对接了登录窗口方式的CP,这种情况CP无需接入任何新的接口;一种手动的,针对的是对接了接口登录的CP,这种情况CP需要对接新的接口,具体接口参考隐私政策接口章节。

1.10 用户中心

WINGSDK用户中心功能,可以向玩家展示充值中心账号、初始密码、信息内容。

二、快速集成

2.1 环境配置要求

1、系统:Mac OS
2、开发工具:Xcode(12.0及以上)
3、Deployment Target:iOS9.0及以上版本
4、BaseSDK iOS 10.1及以上

2.2 集成SDK到项目

集成步骤:
1、集成相应库到项目中 参考:2.2.1 库的引用
2、添加依赖库,以及配置 参考: 2.2.2 工程构建配置
3、修改配置文件 参考: 2.2.3 WINGSDK基本配置
4、编译正常,可继续sdk代码集成 参考: SDK初始化

建议:cp可先运行demo,看下配置以及需要引用的第三方库,再接入
集成参考demo: demo代码下载地址

2.2.1 库的引用

SDK的抽象层和实现层以framework的形式提供,CP可以使用cocoapods的方式或者自行下载framework拖进xcode项目的方式进行引用。

方式一:使用cocoapods进行引用

CP可以使用Cocospods进行引用更新。

这部分脚本请使用WINGSDK打包配置页面生成,CP可以将生成的脚本代码复制到自己的Podfile中。
WINGSDK打包配置页面地址:https://admin.wingsdk.com/developers/pack_config.do

目前SDK提供的库包括:
抽象层:

  • WASdkIntf——必接

实现层:

  • WASdkImpl(WingSdk)——必接

其它可选:

  • WAAdImpl(Ad)——可选

  • WAAfImpl(Appsflyer)——可选

  • WAApImpl(Apple)——可选

  • WACbImpl(Chartboost)——可选

  • WAFbImpl(Facebook) ——可选

  • WAPushImpl(Push)——可选

  • WAVkImpl(VK)——可选

  • WATwitterImpl(Twitter)——可选

  • WAInstagramImpl(Instagram)——可选

  • WAAiHelpImpl(AiHelp) ——可选

  • WAWebPayImpl(WebPay)——可选,如果需要第三方支付则需添加此模块

  • WAFirebaseImpl(Firebase)——可选

提示:使用CocoaPod引用的项目打开项目时需要点击’xcworkspace’而不是’ xcodeproj’

方式二:手动引用

如果手动引用,可以使用WINGSDK打包配置页面https://admin.wingsdk.com/developers/pack_config.do进行各个包的下载,并添加到xcode项目中。
cocoapods手动引用

下载完成后解压,把解压后的文件拖入xcode工程,其中WASdkIntf和WASdkImpl是必接库,其它可选。
注意:需要加入系统库libsqlite3.tbd(libsqlite3.dylib)、libz.tbd(libz.dylib)

2.2.2 工程构建配置

在项目Build Settings中搜索Other Linker Flags 修改值为-ObjC
如下图
iOS-工程构建配置

需要引用的库:
AppTrackingTransparency.framework
libz.1.dylib
Accelerate.framework
libc++.tbd
libresolv.tbd
WebKit.framework
sqlite3

2.2.3 WINGSDK基本配置(wa_sdk.plist)

在 WASdkIntf下,以及配置文件wa_sdk_track_config.plistwa_sdk.plist,如下图。
集成SDK到项目

wa_sdk.plist文件配置:
iOS-WINGSDK配置
参数说明:
WaSdkServerUrl:WINGSDK后台url(生产环境:https://api.wingsdk.com/sdkapi/)
appKey:WINGSDK后台appKey
appId:WINGSDK后台appId
os:手机操作系统
channel:发布渠道

关于wa_sdk_track_config.plist详见2.6.1 配置 (wa_sdk_track_config.plist)

2.3 SDK初始化

从3.12.0以及以后,需要增加如下配置:

1、在项目target,Signing&Capabilities,选择All,添加Capability,选择Keychain Sharing

图片1
2、点击+号,输入gamehollywood.wingsdk.clientid.group

图片1

导入头文件
#import <WASdkIntf/WASdkIntf.h>

1、请在AppDelegate的didFinishLaunchingWithOptions 调用下面代码:

2、在AppDelegate的applicationDidEnterBackground调用下面代码:

3、在AppDelegate的applicationWillEnterForeground调用下面代码:

4、在AppDelegate的applicationDidBecomeActive调用下面代码:

2.4 登录

登录过程中如果涉及到应用间跳转,需要在AppDelegate中实现以下方法

2.4.1 登录对话框

SDK内置了一个包含所有支持的登录方式的一个对话框,通过调用以下接口打开对话框:

注意:测试时,需要联系运营添加测试设备,才能出现登录方式。

2.4.1.1 实现协议 WALoginViewDelegate

登录结果说明 WALoginResult

字段名 类型 说明 备注
message String 登录结果消息
userId String WINGSDK用户id
token String WINGSDK用户token
pUserId NSString 用户在第三方平台的Id,GUEST登录时 值与userId一致
platform String 平台类型 当前登录的平台名称
pToken NSString 第三方平台的token
isGuestAccount int 是否游客登录 0 不是游客账号 1是游客账号

3.4.1.2 调用方法

+(void)login:(id<WALoginViewDelegate>)delegate cacheEnabled:(BOOL)cacheEnabled;
cacheEnabled是否缓存登录方式。如果缓存登录方式,第二次调用的时候直接按照上次的登录方式进行登录,不会弹出登录选择框。如果想弹出登录选择框,请调用clearLoginCache方法,清除缓存
代码示例:

2.4.1.3 清除登录方式的缓存(重新弹出登录选择框)

+(void)clearLoginCache;
代码示例:

2.4.1.4 隐藏登录选择框

+(void)hide;
代码示例:

2.4.2 用户登录接口

如果CP有自己的登录窗口,可以使用WINGSDK登录接口:

2.4.2.1登录接口

(1)选择登录方式

+(void)loginWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo delegate:(id<WALoginDelegate>)delegate;
注:extInfo目前主要用于应用内登录等高级登录设置,请参考3.3.2 应用内登录相关章节
代码示例:facebook登录

登录平台请参考5.1.2 平台取值

2.4.2.2 实现协议WALoginDelegate中定义的方法

说明:关于APPLE登录,用户每次进入APP进行登录操作,Game Center只进行一次授权。假如用户在第一次登录的时候取消了,以后每次进行登录,程序都会执行登录取消的协议方法,除非用户结束应用重新打开。同样的,第一次登录的时候,出现Game Center授权错误,之后程序都会执行登录失败的协议方法,除非用户结束应用重新打开。

2.4.3 用户登出

退出游戏的时候,必须登出操作。用户登出调用以下接口:
[WAUserProxy logout];
注意:调用logout接口后,serverId、gameUseId、level字段值会被重置,如果需要保持相应字段的值不重置,需要重新设置相应字段的值,参考3.1 公共参数设置

2.5 支付

WINGSDK支付流程如下:
支付流程

2.5.1 初始化

使用对应平台的支付服务前必须对其进行初始化,请在AppDelegate的didFinishLaunchingWithOptions方法调用以下方法。
+(void)init4Iap;
代码示例:

2.5.2 查询商品

2.5.2.1 实现协议 WAInventoryDelegate

2.5.2.2 调用方法

查寻库存商品,调用以下接口:
+(void)queryInventoryWithDelegate:(id<WAInventoryDelegate>)delegate;
代码示例:

注意:这里返回的库存商品信息是WINGSDK平台的商品信息,并非第三方平台的商品信息。
建议在商品页出来之前调用,最好是sdk初始化完后就开始调用,如下

2.5.3 购买商品

2.5.3.1 实现协议 WAPaymentDelegate

支付结果说明 WAIapResult

字段名 类型 说明 备注
productIdentifier NSString 商品id
resultCode long 支付结果代码 1.支付成功
2.支付失败
3.用户取消
4.支付成功,上报失败
5.商品消耗中
6.创建订单失败

注意:如果需要在订单信息中记录当前玩家昵称,需要按3.1.4 设置玩家昵称设置玩家昵称。

2.5.3.2 调用方法

购买指定平台的商品,调用以下接口:
+(void)payWithProductId:(NSString*)productId extInfo:(NSString*)extInfo delegate:(id<WAPaymentDelegate>)delegate;
代码示例:

参数说明:

参数名 类型 必填 说明 备注
productId String Y 库存商品的id wingsdk平台的商品id
extInfo String N 额外信息,该信息会在支付成功后原样通知到CP服务器,CP用于检验 CP 扩展信息字段,限长512(JSON格式),WING服务器到CP服务器发货通知时原样返回给CP。如果CP的通知发货地址是动态变化的(比如每个服务区的地址都不一致),可以通过此字段设置:参数格式为JSON,参数名为 deliverUrl,参考格式
{
“deliverUrl”:” http://game.com/deliver.do”,
“otherInfo”:”otherInfo”,
“merId”:””
}
merId字段(选填),收款商户ID,使用场景:同一个支付渠道下有多个不同的收款验证信息(或收款帐号)。如果是 APPLE支付渠道,merId使用客户端bundleId

2.5.3.3 查询商品本地价格

通过查询商品信息,可以获取库存商品的本地价格,查询商品本地价格调用接口:
+ (void)queryChannelProduct:(NSString )channel
callBackBlock:(void(^)(NSArray
channelProductsArray,NSError *error))callBackBlock

代码示例

注意:这个接口需要在查询库存商品( queryInventoryWithDelegate)成功回调后使用。
参数说明:

参数名 类型 必填 说明 备注
chanel NSString Y 渠道名称 如苹果渠道 APPLE

实体结果说明 WAChannelProduct:

字段名 类型 说明 备注
channel NSString 渠道名称 传递的channel
productIdentifiere NSString 平台商品id
localeCurrencyCode NSString 本地货币code USD 、CNY
localFormattedPrice NSString 格式化价格 $999.99 、 ¥6,498.00
price NSDecimalNumber 价格 999.99、 6498

2.5.4支付服务是否可用

通过以下接口可以获取支付服务是否可用,返回boolean类型结果,true为可用,false为不可用,只要有一个支付渠道可用即为true:
+(BOOL)isPayServiceAvailableWithPlatform;
代码示例:

2.6 数据收集

使用WINGSDK数据收集接口配合大数据平台,可以轻松统计玩家习惯以及充值等行为,为游戏的市场营销提供数据依据。WINGSDK数据收集使用在游戏的过程中打点的方式,如图所示:
iOS-数据收集流程图

  1. 以上流程图中涉及到的几个接口是有时序要求的,请参考流程图中的逻辑步骤进行设置:setServerId、setGameUserId、setLevel、setNickname、ghw_user_import事件、ghw_user_create事件
    2.其它的事件如ghw_level_achieved、ghw_self_tutorial_completed、ghw_self_lv_x等请根据对应业务逻辑,在对应业务发生时调用接口发送。
序号 事件(接口)名称 事件描述 事件作用 建议触发点 备注
1 setServerId 设置服务器ID 标记玩家当前所在的服务器,后台根据该字段统计每个服务器的数据 登录游戏服成功后
2 setGameUserId 设置玩家角色ID 标记玩家当前的游戏角色ID,后台根据该字段统计玩家的数据 登录游戏服成功后
3 setNickname 设置玩家角色昵称 标记玩家当前的游戏角色昵称,后台订单记录中会记录该昵称 登录游戏服成功后
4 setLevel 设置玩家当前等级 标记玩家当前的游戏角色等级 玩家等级发生变更后,如登录游戏服成功后、玩家完成升级后
5 ghw_user_import 玩家登录游戏服 记录玩家登录游戏服的动作,后台根据该事件统计导入数、登录数、导入留存等数据 玩家登录游戏服成功后 需要先调用setServerId、setGameUserId接口
6 ghw_user_create 玩家创建角色 记录玩家创建角色的动作,后台根据该事件统计创角数 玩家创建角色成功后 需要先调用setServerId、setGameUserId、setLevel接口
7 ghw_self_tutorial_completed 完成新手任务 完成新手任务 玩家完成新手任务后
8 ghw_level_achieved 更新玩家等级 更新玩家等级,后台根据此字段更新玩家等级 玩家达到新的等级时 需要先调用setLevel接口更新玩家等级
9 ghw_self_lv_x 更新玩家等级 更新玩家等级,后台根据此字段更新玩家等级 需要先调用setLevel接口更新玩家等级
10 ghw_user_info_update 更新用户信息 更新用户信 玩家信息更新时 需要先调用setServerId、setGameUserId、setNickname接口

2.6.1 配置 (wa_sdk_track_config.plist)

对各个平台进行相应的配置(修改wa_sdk_track_config.plist)。注:文件名以及key值不可修改。
iOS-数据收集功能模块
其中,AppleAppID可以在iTunes Connect(https://itunesconnect.apple.com)中新建应用之后获取,具体可以参考iOS-第三方后台配置文档“Apple基础配置”章节
iOS-配置-wa_sdk_track_config.plist
每个数据收集平台都有相应的开关,可以进行配置。下图的Enable就是开关,Enable: YES-开,NO-关。
iOS-数据收集功能模块
WINGSDK URL正式环境的地址: https://api.wingsdk.com/data/

2.6.2 调用

2.6.2.1 导入头文件

#import <WASdkIntf/WASdkIntf.h>

2.6.2.2 工程启动时初始化

您需要在第一次启动在应用程序上进行SDK初始化。请保证在发送下面的跟踪事件之前进行SDK初始化。请在AppDelegate中的didFinishLaunchingWithOptions方法中添加以下代码:
[WACoreProxy initAppEventTracker];

2.6.2.3 调用事件进行追踪

安装和打开游戏事件是内部触发的,另外关于充值事件(WAEventPayment)和点击充值(WAEventInitiatedPayment)的跟踪已经在WINGSDK中自动调用,用户不用自己调用。若不想启用这两个事件的自动跟踪,可在didFinishLaunchingWithOptions进行如下操作:
[WATrackProxy autoTriggerAfterPayment:NO];
调用方法有两种。方法一调用方法简单,但是发送到各个渠道的事件名称(eventName)、参数(params)、累加值(value)是一样的。如果需要自己设置事件名称、参数、累加值,请使用方法二。

2.6.2.3.1 方法一

注:当使用带有小数点的数值时,使用NSDecimalNumber类型,如[NSDecimalNumber decimalNumberWithString:@"8.88"];
调用事件的用法如下:
+(void)trackWithEventName:(NSString *)eventName valueToSum: (double)value params:(NSDictionary *)params;
-eventName:事件名称可在附表中查询
-valueToSum:传入一个double值作为累加值,没有累加值可以传0。
-params:参数字典参数可在附表中查询
例如:

调用购买事件WAEventPayment,
参数:WAEventParameterNameContentType道具类型,
WAEventParameterNameContentID内容ID,
WAEventParameterNameItemAmount购买数量,
WAEventParameterNameCurrencyType货币类型,
WAEventParameterNameCurrencyAmount现金额

2.6.2.3.2 方法二

注:当使用带有小数点的数值时,使用NSDecimalNumber类型,如[NSDecimalNumber decimalNumberWithString:@"8.88"];

2.6.2.3.2.1 调用示例

步骤一 构建WAEvent实例

步骤二 发送数据:

2.6.2.3.2.2 关于WAEvent 实例的构建

(1)设置默认的事件名称

设置该事件的事件名称,请参考5.2.1 SDK 预定义事件名
event.defaultEventName = WAEventLevelAchieved;

(2)设置渠道自定义事件名称

注:
1)eventNameDict的key参考附表 2.6.2 渠道名称表
2)AppsFlyer和facebook的应用内事件和WINGSDK的应用内事件已经做了映射(例如: ghw_login <-> af_login,ghw_login<->fb_login,参考下图),用户无需再手动自定义。
3)如果不进行设置,所有的渠道将采用设置的默认值(defaultEventName)。

iOS-各渠道事件映射对应表

各渠道事件映射对应表

(3)设置默认累加值

设置累加值用于统计数字,比如购买的金额等
event.defaultValue = 1;

(4)设置渠道自定义累加值

1)valueDict的key值参考 附表2.6.2 渠道名称表
2)如果不进行设置,所有的渠道将采用设置的默认值(defaultValue)。

(5)设置事件默认的参数/值

注:
1)参数名称参考5.2.2 SDK 预定义参数名

(6)设置事件渠道自定义的参数/值

注:
1)渠道名称参考:附表 2.6.2 渠道名称表
2)参数名称参考:5.2.2 SDK 预定义参数名
3)如果不进行设置,所有的渠道将采用设置的默认值(defaultParamValues)

(7)渠道开关设置

注:以上代码会关闭Appsflyer对该事件的收集,而Facebook、WINGSDK、Chartboost、firebase是打开的。默认情况下,WINGSDK和Appsflyer、firebase是打开的,而Facebook和Chartboost是关闭的。

2.6.3 预定义事件

建议参数属性:(参数对应的静态变量名请看5.2.2 SDK 预定义参数名

2.6.3.1 ghw_user_import

说明:导入用户事件,用户每次进服事件–通过用户id在后台查找

参数名 类型 说明 必填 备注
isFirstEnter int 是否为第一次导入 Y 否为0,
是为:1。
默认为0。

注意:发送ghw_user_import事件前需要调用 设置服务器ID设置角色ID

代码示例:

2.6.3.2 ghw_initiated_purchase 点击购买

说明:点击购买的时候调用(用于游戏内部虚拟交易统计)
无参数
代码示例:

2.6.3.3 ghw_purchase 购买完成

说明:点击购买的时候调用(用于游戏内部虚拟交易统计)。
注:valueToSum(或者defaultValue)的值要传,而且值要和price一样。

参数名 类型 说明 必填 备注
itemName String 游戏内虚拟物品的名称/ID Y
itemAmount int 交易的数量 Y
price float 交易的总价 Y

代码示例:

2.6.3.4 ghw_level_achieved

说明:统计玩家等级增长事件,达到等级时调用。

参数名 类型 说明 必填 备注
score int 账户分数 N
fighting int 战斗力 N

注意:发送事件前WAEventLevelAchieved需调用3.1.3 设置用户等级level 接口更新用户等级信息。

代码示例:

2.6.3.5 WAEventUserCreate

说明:创建游戏角色

参数名 类型 说明 必填 备注
roleType string 角色类型 N
nickname String 角色名(昵称) Y
gender int 角色性别 N 性别: 0表示女,
1表示男,
2表示未知
registerTime long 创建时间 Y 注册时间戳,单位为毫秒(1970以后)
vip int 等级 N
status int 状态 N 状态标识:
-1: 锁定,
1:未锁定
bindGameGold int 绑定钻石 N
gameGold int 用户钻石数 N
fighting int 战斗力 N

代码示例:

2.6.3.6 ghw_self_tutorial_completed 完成新手任务

说明:新手完成新手任务时调用
无参数
代码示例:

2.6.3.7 ghw_self_lv_x 关键等级

说明:完成关键等级时调用,如ghw_self_lv_1、ghw_self_lv_3

无参数

代码示例:

2.6.3.8. ghw_user_info_update 更新用户信息

参数名 类型 说明 必填 备注
roleType String 角色类型 N
nickname String 昵称 Y 无昵称时,可填写空字符串
vip int 等级 N
status int 状态 N 状态标识,-1:锁定,1:未锁定

代码示例:

2.6.4 自定义事件

事件描述:自定义事件
事件名称:自定义
参数:自定义
有无累计值:自定义

说明:支持自定义事件的统计
自定义

自定义事件目前只支持事件名和累加值,见示例。
例如:

附表 2.6.1 货币标识

名称 标识
人民币 CNY
美元 USD
港币 HKD
欧元 EUR
英镑 GBP
日元 JPY
加元 CAD

详见:https://en.wikipedia.org/wiki/ISO_4217

附表 2.6.2 渠道名称表

常量 代表渠道
WA_PLATFORM_APPSFLYER Appsflyer
WA_PLATFORM_FACEBOOK Facebook
WA_PLATFORM_WINGA WINGSDK
WA_PLATFORM_CHARTBOOST ChartBoost
WA_PLATFORM_FIREBASE Firebase

2.6.5 获取 IDFA 弹出“询问用户是否授权”适配

应苹果要求,iOS14后,获取IDFA需要授权弹框。目前sdk默认为不弹框获取用户授权。如需弹框授权,需要以下步骤
1、xcode升级到12或者以后版本
2、接入sdk3.9.1或以后版本
3、Info.plist 中新增 key Privacy – Tracking Usage Description ,value 填写使用 IDFA 原因。其中原因将展示给用户

效果如图:
图片1

2.7. 隐私政策

如果CP对接的登录方式是接口登录方式,则可以使用以下几个接口来实现隐私政策流程,具体流程可参考下图。
图片1

2.7.1 获取隐私政策url

WINGSDK有自己的隐私政策,调用以下接口获取到隐私政策url(隐私政策内容为html页面)

示例:

2.7.2 获取隐私政策更新时间

隐私政策更新需要重新显示时可以调用以下接口获取最新隐私政策更新时间,和上一次保存的时间戳作对比,从而确定是否需要展示

示例:

2.7.3 显示隐私政策详情UI

当需要显示隐私政策详情时,可以调用以下接口显示出隐私政策详情界面

示例:

三、高级功能

3.1 公共参数设置

WINGSDK包括serverId等公共参数,这些参数主要用于数据跟踪和统计。公共参数必须严格按照文档进行配置,在后续的接口中会使用到这些公共的参数,没有按照要求配置会导致部分接口调用失败。

3.1.1 设置服务器ID

当用户的服务器ID发生改变时,需要调用设置服务器ID接口设置新的服务器ID,例如每次进入服务器:
[WACoreProxy setServerId: @"127.0.0.1"];
注意:设置服务器ID的操作在每次选服后都需要进行,必须在调用其他接口前设置。

3.1.2 设置用户gameUserId

用户在选择服务器并且登录之后将用户gameUserId设置到SDK中以便于跟踪。
[WACoreProxy setGameUserId:@"12345"];

3.1.3 设置用户等级level

设置游戏玩家的角色等级,调用接口:
[WACoreProxy setLevel:10];
注意:第一次进服获取玩家等级或玩家等级变更后,需要及时调用这个接口设置玩家等级,必须在调用其他接口前设置。

3.1.4 设置玩家昵称

设置游戏玩家的昵称,调用接口:
[WACoreProxy setNickName:@"测试角色名称"];
注意:
1.当玩家登录、登出游戏,或修改昵称时,需要及时调用这个接口设置玩家昵称。
2.调用该接口设置昵称后,玩家进行购买时会自动记录昵称到订单信息中。

3.2 调试模式

3.2.1 开启、关闭调试模式

WINGSDK具备调试模式并提供了Log悬浮按钮调试工具,打开调试模式就会显示Log悬浮按钮,使用这个工具测试人员不需要IDE环境就可以在工具窗口中查看调试信息。开启/关闭调试模式调用以下接口(WINGSDK默认是关闭调试模式的)。
[WACoreProxy setDebugMode:YES];
关闭调试模式:
[WACoreProxy setDebugMode:NO];

3.2.2 如何获取 client_id

打开调试模式后,显示Logcat工具,点击-设备信息-clientid,点击获取

F757A84C441ED6EC3E50CE12F7A8F87F

3.3 登录高级设置

3.3.1 设置登录流程接口

使用该接口需注意以下两点:
1)一般来说,如果应用登录的时候有登录方式选择界面,就不需要使用此接口,此接口默认是这种方式(取值为1)。

2)这个接口主要是用来满足以下需求:用户第一次登录是以游客方式进行登录,进到应用里面可以切换其它登录方式,下次登录会直接以切换后的账户进行登录(取值为2)。

+(void)setLoginFlowType:(int)flowType;
代码示例:
[WAUserProxy setLoginFlowType:WA_LOGIN_FLOW_TYPE_DEFAULT];
登录流程有两种模式,在WAConstants类中定义,取值如下表:

名称 取值 备注
WA_LOGIN_FLOW_TYPE_DEFAULT 1 适用于有登录界面的场景,登录的时候不会重新绑定设备
WA_LOGIN_FLOW_TYPE_REBIND 2 适用于无登录界面的场景,登录时重新将新账号与当前设备绑定,如在游戏中切换账户,切换以后的匿名登录是以切换后的账户进行登录。

3.3.2 应用内登录

SDK平台应用内登录,是指CP本身有自己登录系统,先登录CP后台拿到用户信息后登录SDK后台,应用内登录调用接口2.4.2 用户登录接口 ,登录平台取值WINGA(CHANNEL_WA),将CP后台返回的用户信息按照规定格式(JSON字符串)通过extInfo字段传入。

应用内登录extInfo格式(标准JSON格式字符串)

实例:

字段说明:

字段名 类型 说明 必填 备注
appSelfLogin boolean 应用内登录固定值true Y
puserId String CP用户id Y
accessToken String CP用户Token Y
extInfo String 额外信息 N CP 扩展信息字段,限长512,WING服务器到CP服务器验证登录时原样返回给CP。CP可以添加任意自定义的字段(JSON格式),用于检验登录或扩展其它功能,不超过长度限制即可。

3.4 账户管理

3.4.1 使用账户管理页面

SDK内置了账户管理页面,打开这个内置的页面之前必须先登录,通过这个页面可以对账户进行管理操作,包括账号绑定、解绑、切换账户、新建账户。

3.4.1.1 实现协议 WAAcctManagerDelegate

3.4.1.2 调用方法

+(void)openAccountManager:(id<WAAcctManagerDelegate>)delegate;

代码示例:

3.4.1.3 关于绑定解绑的通知

账户管理界面没有返回绑定和解绑结果,但是会以通知的方式将结果回调给CP。当绑定有结果之后(无论成功失败),将回传一个WABindingResult实例。当解绑有结果(无论成功失败),将回传一个WAAccount实例。有四个通知,分别是绑定成功、绑定失败、解绑成功、解绑失败,通知的名称分别是以下常量:
WABindDidSucceedNotification;//绑定成功
WABindDidFailNotification;//绑定失败
WAUnbindDidSucceedNotification;//解绑成功
WAUnbindDidFailNotification;//解绑失败

注:关于绑定facebook成功之后,请注意触发邀请奖励。代码如下:

3.4.2 绑定第三方平台账户

3.4.2.1 实现协议WAAccountBindingDelegate

说明:关于APPLE账号的绑定,请参考2.4.2.2 实现协议WALoginDelegate中定义的方法的说明。

3.4.2.2 调用方法

+(void)bindingAccountWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo delegate:(id<WAAccountBindingDelegate>)delegate;
绑定平台取值:

名称 取值 备注
WA_PLATFORM_FACEBOOK FACEBOOK FACEBOOK平台
WA_PLATFORM_APPLE APPLE APPLE平台
WA_PLATFORM_VK VK VK平台

示例代码:

3.4.3 查询已经绑定的第三方平台账户

通过以下接口,可以查询当前的账户已经绑定的第三方平台账户:
+(void)queryBoundAccountWithCompleteBlock:(void(^)(NSError* error,NSArray<WAAccount *>* accounts))block;

示例代码:

3.4.4 解绑第三方平台账户

通过以下接口,可以解绑已经绑定的第三方平台账户:
+(void)unBindAccountWithPlatform:(NSString *const)platform platformUserId:(NSString*)pUserId completeBlock:(void(^)(NSError* error))completeBlock;
有以下情况之一者,不可解绑:
1.解绑的账户为WINGSDK平台的;
2.用户没有绑定第三方平台账户的;
3.用户只绑定一个第三方平台账户,且用户没有与当前设备绑定的。
示例代码:

3.4.5 切换账户

使用以下接口可以快速切换登录的账户
+(void)switchAccountWithPlatform:(NSString *const)platform completeBlock:(void(^)(NSError* error,WALoginResult* result))completeBlock;

3.4.6 新建账户

+(void)createNewAccountWithCompleteBlock:(void(^)(NSError* error,WALoginResult* result))completeBlock;

新建账户后,新的账户会跟当前设备绑定,如果之前的账户没有绑定第三方平台账户,数据将会丢失。
代码示例:

3.4.7获取账户信息

SDK提供了获取指定平台的账户信息,可以通过以下接口获取:

+(WAAppUser*)getAccountInfoWithPlatform:(NSString *const)platform;

示例代码:

3.5 应用墙模块功能

注意:此模块会对苹果应用商店上架造成一定的风险,请酌情使用。

3.5.1 应用墙使用

WINGSDK应用墙包含了应用推荐等功能。

3.5.2显示应用墙入口悬浮按钮

[WAApwProxy showEntryFlowIcon];

3.5.3隐藏应用墙入口悬浮按钮

[WAApwProxy hideEntryFlowIcon];

3.6 社交

3.6.1 分享

3.6.1.1 实现协议 WASharingDelegate

3.6.1.2 调用方法

分享调用以下接口,支持分享链接、图片、视频、Facebook OpenGraph:
+(void)shareWithPlatform:( NSString *const)platform shareContent:(NSObject<WASharingContent>*)shareContent shareWithUI:(BOOL)shareWithUI delegate:(NSObject<WASharingDelegate>*)delegate;
示例代码:

参数说明:

参数名 类型 必填 说明 备注
shareContent NSObject* Y 分享内容
shareWithUI BOOL Y 是否通过UI分享 设置为YES时直接通过UI分享,有界面。设置为NO时通过API分享,没有界面。注意:目前不支持这种方式,相关权限已被facebook收回,此值只能为false
delegate NSObject* N 委托

3.6.1.3 实体说明

3.6.1.3.1 分享链接内容实体WAShareLinkContent

WAShareLinkContent字段说明

字段名 类型 必填 说明 备注
contentURL NSURL Y 链接
peopleIDs NSArray N 分享好友ID
placeID NSString N 地址id
ref NSString N 添加到引用链接中的参数值
contentTitle NSString N 连接标题 Facebook无效
contentDescription NSString N 链接描述
imageURL NSURL N 配图 Facebook无效

3.6.1.3.2 分享图片内容实体WASharePhotoContent

WASharePhotoContent字段说明

字段名 类型 必填 说明 备注
contentURL NSURL N 内容URL
peopleIDs NSArray N 分享好友ID
placeID NSString N 地址id
ref NSString N 添加到引用链接中的参数值
photos NSArray Y 图片列表 不能超过12MB,而且列表不能为空,至少一张图片

WASharePhoto字段说明

字段名 类型 必填 说明 备注
image UIImage Y 图片对象 和imageURL两个必选一个
imageURL NSURL Y 图片Uri 和image两个必选一个
userGenerated BOOL N 未使用
caption NSString N 图片描述

3.6.1.3.3 分享视频内容实体WAShareVideoContent

WAShareVideoContent字段说明

字段名 类型 必填 说明 备注
contentURL NSURL N 内容URL
peopleIDs NSArray N 分享好友ID
placeID NSString N 地址id
ref NSString N 添加到引用链接中的参数值
previewPhoto WASharePhoto N 视频缩略图
video WAShareVideo Y 视频 不能超过12MB

WAShareVideo字段说明

字段名 类型 必填 说明 备注
videoURL NSURL Y 视频URL

3.6.2 发送请求接口

发送请求接口向平台好友发送请求,请求包括普通请求、游戏邀请(详见3.6.3 游戏邀请)等,发送请求调用以下接口:

参数说明:

参数名 类型 必填 说明 备注
platform NSString Y 平台类型 平台类型在WAConstants类中定义,目前支持VK以及FACEBOOK
requestType NSString Y 请求类型 请求类型默认的在WAConstants下有定义,请参考5.1.3 请求类型说明
title NSString Y 标题 部分平台需要显示
message NSString Y 说明文字 部分平台需要显示
objectId NSString N 对象id 部分请求类型必填
receiptIds NSArray Y 接收者id 根据平台而定,有些平台支持一次发送请求给多个用户,有些平台一次只能发送给一个用户。VK平台一次只能发送一个用户,Facebook时传入为nil
delegate NSObject N 代理

示例代码:

3.6.3 游戏邀请

3.6.3.1 查询可邀请好友列表

游戏邀请只能邀请没有玩过当前游戏的好友,称为可邀请好友,查询可邀请的好友调用以下接口:
+(void)queryInvitableFriendsWithDuration:(float)duration platform:(NSString *const)platform completeBlock:(void(^)(NSArray* friends,NSError *error))block;

代码示例:

参数说明:

参数名 类型 必填 说明 备注
block String Y 回调
platform NSString Y 平台类型 平台类型在WAConstants类中定义,目前支持VK
duration long Y 过滤时间间隔 单位为分钟,当过滤时间间隔大于0时,在这个时间间隔内不会出现已经发出邀请的好友

3.6.3.2 游戏邀请(@since v3.5.2 使用发送请求接口代替)

3.6.3.2.1 实现协议 WAGameRequestDialogDelegate

3.6.3.2.2 调用方法

发送游戏邀请请求调用以下接口(注:VK平台一次只能发一次邀请给一个好友):
+(void)gameInviteWithPlatform:(NSString *const)platform Content:(WAGameRequestContent*)content delegate:(NSObject<WAGameRequestDialogDelegate>*)delegate;
代码示例:

注:如果是VK平台 actionType必须赋值(gameRequestContent.actionType = WAGameRequestActionRequest) VK平台有两个actionType: WAGameRequestActionInvite, WAGameRequestActionRequest。在游戏的测试阶段,请用WAGameRequestActionRequest进行测试。正式上线的时候修改为WAGameRequestActionInvite,参照下图。
vk上线流程图

3.6.3.3 邀请成功记录

成功邀请好友后,在协议方法-gameRequestDialog:platform:didCompleteWithResults:中调用以下接口向服务器记录邀请信息:
+(void)createInviteInfoWithPlatform:(NSString *const)platform results:(NSDictionary*)results handler:(void (^)(NSUInteger code,NSString* msg, NSError* error)) handler;
示例代码:

3.6.3.4 邀请安装奖励

通过邀请安装使用的用户,安装后需要通知服务器对邀请人进行奖励,必须在玩家进行登录成功或者绑定成功之后时候调用
+(void)inviteInstallRewardPlatform:(NSString *const)platform TokenString:(NSString*)tokenString handler:(void (^)(NSUInteger code,NSString* msg, NSError* error)) handler;
示例代码:

3.6.3.5 邀请事件奖励

通过邀请安装使用的用户,在触发定义的特定事件,需要通知服务器奖励邀请人,比如等级达成、充值等,调用以下接口:
+(void)inviteEventRewardWithPlatform:(NSString *const)platform eventName:(NSString*)eventName handler:(void (^)(NSUInteger code,NSString* msg, NSError* error)) handler;

代码示例:

3.6.4 社区

3.6.4.1 通过Group id查询Group详情

通过Group id查询Group详情,调用以下接口:
+(void)getGroupWithPlatform:(NSString *const)platform groupIds:(NSArray*)groupIds extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码:

WAGroup实体说明

参数名 类型 说明 备注
gid NSString group id
name NSString group名称
screen_name NSString group screen_name
is_closed int 是否封闭 0 – 开放
1 – 封闭
2 – 私有
is_member BOOL 当前用户是否该group成员 0 – 不是group的成员
1 – 是group的成员
type NSString 类型 group — group,
page — public page,
event — event
photo NSString group图片
photo_medium NSString group图片,中尺寸
photo_big NSString group图片,大尺寸
desc NSString group描述
members_count int 成员数
status NSString 状态
schemeUrl NSString 跳转到应用对应的页面
pageUrl NSString 跳转到浏览器对应的页面

3.6.4.2 查询当前应用关联的Group

一个应用只能关联一个Group,通过以下接口可以查询当前应用关联的Group详细信息:
+(void)getCurrentAppLinkedGroupWithPlatfrom:(NSString *const)platform extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码:

3.6.4.3 查询当前用户已加入的Group

查询当前用户加入的Group详细信息调用以下接口:
+(void)getCurrentUserGroupWithPlatfrom:(NSString *const)platform extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码:

3.6.4.4 查询当前应用推荐的所有Group

这是3.6.5.2 查询当前应用关联的Group3.6.5.3 查询当前用户已加入的Group查询到的Group的汇总,调用以下接口:

+(void)getGroupsWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码:

3.6.4.5 加入Group

加入指定的某个Group,调用以下接口:

+(void)joinGroupWithPlatform:(NSString *const)platform groupId:(NSString*)groupId extInfo:(NSString *const)extInfo completeBlock:(void(^)(NSError* error))block;

示例代码:

3.6.4.6 进入Group详情页

进入Group的详情页面,调用以下接口:

+(void)openGroupPageWithPlatform:(NSString *const)platform groupUri:(NSString *const)groupUri extInfo:(NSString*)extInfo

如果客户端已经安装platform指定平台的app客户端,将会进入到app客户端详情页面,如果没有安装,则打开网页详情页。
参数说明:

参数名 类型 必填 说明 备注
platform String Y 平台类型
groupUri String Y 打开Group的uri VK平台为screen_name字段值
extInfo String N 额外数据信息 扩展字段,根据各个平台需要定义

示例代码:

3.7消息推送



WINGSDK推送功能是基于苹果APNS,可以给客户端发送推送通知,通过简单几步配置即可使用。

3.7.1苹果相关配置

导出App推送证书为p12,并上传到WINGSDK后台。
注意:
1、苹果消息推送证书配置请参考Apple官方文档
http://help.apple.com/xcode/mac/current/#/dev11b059073

3.7.2推送集成配置

添加推送模块依赖方法参考2.2 集成SDK到项目
注:Appsflyer卸载检测某些配置与消息推送一样,但如果是用于Appsflyer,此步骤可忽略

3.7.3 Xcode配置

1)开启推送功能

在 Xcode 8.x 以上,必须开启Push Notification能力。找到应用Target设置中的Capabilities -> Push Notifications,确认开关已经设为ON状态。如果没有开启该开关,在 Xcode 8.x 上编译后的应用将获取不到DeviceToken。
iOS——推送配置

2)APNs静默推送权限设置

为了更好支持消息推送,提高消息到达率,需要配置APNs静默推送权限
iOS——推送配置

3.7.4 编写集成代码

1、导入文件头,在AppDelegate中导入:
#import <UserNotifications/UserNotifications.h>

2、初始化消息推送,在AppDelegate的application:initPushWithDelegate:调用下面代码:

注:Appsflyer卸载检测某些配置与消息推送一样,但如果是用于Appsflyer,此步骤可忽略

3、监控用户对推送消息的设置
在AppDelegate的application:didRegisterUserNotificationSettings:调用下面代码:

4、注册DeviceToken
在AppDelegate的application:didRegisterForRemoteNotificationsWithDeviceToken:调用下面代码:

5、监控APNs推送错误
在AppDelegate的application:didFailToRegisterForRemoteNotificationsWithError:调用下面代码:

6、为更好统计用户在不同场景下和不同iOS系统中收到的消息,需在AppDelegate的application:didReceiveLocalNotification:调用下面代码:

7、在iOS 10 以前,为统计 APNs 消息接收事件,需在AppDelegate里的application:didReceiveRemoteNotification:fetchCompletionHandler:回调方法中调用以下接口

对于iOS 10 及以后版本,为统计 APNs 消息接收事件,需要AppDelegate实现协议 UNUserNotificationCenterDelegate,然后在AppDelegate的 userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:回调方法中调用以下接口:

8、iOS10中,App可以在前台获取通知,为统计这种消息的接收情况,需在AppDelegate的userNotificationCenter:willPresentNotification:withCompletionHandler:调用下面代码:

3.8 越狱检测

WINGSDK具备调试模式并提供了检测设备是否越狱接口

3.9 广告

3.9.1 检测可播放广告数量

+ (NSInteger) checkRewardedVideo;
大于0为可用

示例代码:

3.9.2 显示广告

+ (void) displayRewardedVideoWithExtInfo:(NSString *)extInfo delegate:(id<WAAdRewardedVideoDelegate>)delegate;

示例代码:

参数名 类型 必填 说明 备注
extInfo NSString N 额外数据(CP调用展示广告接口传递的自定义数据)
delegate WAAdRewardedVideoDelegate Y WAAdRewardedVideoDelegate代理

3.9.3 广告视频代理

在调用3.9.2显示广告代码,需要实现WAAdRewardedVideoDelegate代理

3.9.3.1 显示视频前页面成功时回调

- (void) adPreDisplayRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId rewarded:(NSString *)rewarded rewardedCount:(NSInteger)rewardedCount extInfo:(NSString *)extInfo;

参数名 类型 说明 备注
campaignId NSString 活动Id
adSetId NSString 广告Id
rewarded NSString 奖励物品
rewardedCount NSInteger 奖励物品数量
extInfo NSString 额外数据(CP调用展示广告接口传入的自定义数据)

3.9.3.2 点击叉按钮后回调

- (void) adDidCancelRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId process:(WAAdCancelType)process extInfo:(NSString *)extInfo;

参数名 类型 说明 备注
campaignId NSString 活动Id
adSetId NSString 广告Id
process WAAdCancelType WAAdCancelTypePlayBefore 播放前取消
WAAdCancelTypePlaying 播放过程中取消
WAAdCancelTypeAfter 播放后取消
extInfo NSString 额外数据(CP调用展示广告接口传入的自定义数据)

3.9.3.3 加载视频失败回调

- (void) adDidFailToLoadRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId extInfo:(NSString *)extInfo;

参数名 类型 说明 备注
campaignId NSString 活动Id
adSetId NSString 广告Id
extInfo NSString 额外数据(CP调用展示广告接口传入的自定义数据)

3.9.3.4 播放视频结束回调

- (void) adDidDisplayRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId rewarded:(NSString *)rewarded rewardedCount:(NSInteger)rewardedCount extInfo:(NSString *)extInfo;

参数名 类型 说明 备注
campaignId NSString 活动Id
adSetId NSString 广告Id
rewarded NSString 奖励物品
rewardedCount NSInteger 奖励物品数量
extInfo NSString 额外数据(CP调用展示广告接口传入的自定义数据)

3.9.3.5 播放完视频点击回调

- (void) adDidClickRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId rewarded:(NSString *)rewarded rewardedCount:(NSInteger)rewardedCount extInfo:(NSString *)extInfo;

参数名 类型 说明 备注
campaignId NSString 活动Id
adSetId NSString 广告Id
rewarded NSString 奖励物品
rewardedCount NSInteger 奖励物品数量
extInfo NSString 额外数据(CP调用展示广告接口传入的自定义数据)

3.9.4 设置视频广告缓存完代理

+ (void)setWAAdRewardedVideoCachedDelegate:(id<WAAdRewardedVideoCachedDelegate>)delegate;

示例代码:

参数名 类型 必填 说明 备注
delegate WAAdRewardedVideoCachedDelegate Y WAAdRewardedVideoCachedDelegate代理

3.9.5 视频广告缓存完代理

在调用3.9.4设置视频广告缓存回调代码,需要实现WAAdRewardedVideoCachedDelegate代理

视频广告缓存完成回调
- (void)adDidRewardedVideoCachedWithCacheCount:(NSInteger)cacheCount;

参数名 类型 说明 备注
cacheCount NSInteger 可用广告数量,大于0为可用

3.10 智能客服 AIHelp

3.10.1. 判断是否开启AiHelp

说明:该接口返回布尔值,true表示已开启,false表示未开启。在使用其他AIHELP接口前请先判断这个接口,在返回true的情况下使用。示例如下:

3.10.2. 展示WING后台配置界面

参数说明:

参数名 类型 必填 说明 备注
language String Y 语言设置 如果使用默认配置传null,比如简体中文传zh_CN。
isVip boolean Y 是否vip用户 true表示vip用户,false是非vip用户。

说明:这个接口展示的界面由WING后台中SDK客服开关配置决定。如果后台未开启客服开关,此接口不生效。同时提供了无参数的重载方法WACscProxy.openAiHelp(),表示使用默认语言设置和设置非Vip用户。

3.10.3.设置客服系统语言

示例代码:

参数说明:

参数名 类型 必填 说明 备注
language NSString Y 语言名称 语言支持如下图

语言支持列表图:
图片1

3.11 用户中心(充值中心账号信息)

3.11.1 获取用户中心数据接口

3.11.1.1实现协议WAUserCenterNoticeDelegate

WAUserCenterResult说明

字段名 类型 说明 备注
code int 状态码 参照5.1.1 状态码说明
msg string 错误信息
userCenterInfo string 用户中心文字内容
uid string 用户ID
characterId string 充值中心Character ID

3.11.1.2 调用方法

3.11.2 显示用户中心弹窗

3.11.2.1实现协议WAUserCenterNoticeUIDelegate

1)用户中心界面关闭回调接口

2)用户中心界面错误回调接口

3.11.2.2调用方法

3.12 调用评分界面

cp可根据需求,调用appStore评分界面,调用方法

系统要求:iOS10.3及以上系统才可以调起评分界面。


3.13 账号删除

3.13.1 UI 版本

sdk内部已经完成了UI展示,以及请求接口操作,CP只需要调用即可。

类名:WAUserProxy
方法名:requestDeleteAccoutUI
返回值:callback
调用方法:WAUserProxy.requestDeleteAccoutUI

调用示例:

3.13.2 接口 版本

接口版本为,cp需要自己做UI,然后调用sdk接口进行删除操作。

3.13.2.1 第三方账号删除授权接口

描述:如果是SIGGINWITHAPPLE登录(可通过接口[WAUserProxy getCurrentLoginPlatform]获取登录方式),需要单独授权一次拿到授权信息,然后再调用请求删除账号接口,目前只支持SIGGINWITHAPPLE
类名:WAUserProxy
方法名:deleteAccounAuthorizationWithPlatform
请求参数:paltform,登录平台
调用方法:WAUserProxy.deleteAccounAuthorizationWithPlatform
调用示例:

WADeleteRequestModel说明

字段名 类型 说明 备注
deletePlatform string 删除平台(Facebook,Apple)
deleteToken string 删除平台accessToken

3.13.2.2 请求删除账号接口

类名:WAUserProxy
方法名:requestDeleteAccout
请求参数:(WADeleteRequestModel*)deleteResult,如无则传递nil。此参数通过调用第三方账号删除授权接口回掉获取。如signinwithappie需要传递此参数
返回值:callback
调用方法:WAUserProxy.requestDeleteAccout
调用示例:

3.13.2.2 取消删除账号接口

类名:WAUserProxy
方法名:cancelRequestDeleteAccoutWithUserid
返回值:callback
调用方法:WAUserProxy.cancelRequestDeleteAccoutWithUserid
调用示例:

四、第三方配置

4.1 Facebook相关配置

4.1.1 Facebook基本配置

游戏如需使用Facebook相关登录、社交、数据收集功能,需要进行以下配置。如果不需要相关功能,请忽略此章节
具体配置请参考第三方后台配置—iOS版 二、Facebook第三方登录后台配置
1、在facebook开发者平台创建一个Facebook应用,创建完之后会生成App ID和App Secret
这里的App ID要配置在项目当中,作为客户端与后台服务器连接的标识
iOS-Facebook基本配置
iOS-Facebook基本配置

注:从3.9.7版本开始,需要配置FacebookClientToken,获取方式:设置-高级-客户端口令

2、在Xcode中配置相应的信息,主要是在info.plist文件中配置URL Schemes、FacebookAppID、FacebookDisplayName、FacebookClientToken。注意一定要对应到facebook后台该App的App ID和Display Name、FacebookClientToken。参考步骤1的截图。

3、针对iOS9做的一些配置
(1)Whitelist Facebook Servers for Network Requests
在info.plist增加下面配置

(2)Whitelist Facebook Apps

4.1.2 Facebook登录权限对照表

权限 类型 权限取值 说明
读取用户配置 string public_profile
读取好友列表 string user_friends

4.2 APPLE相关配置

游戏如需使用APPLE账号进行登录、APPLE商店进行支付,需要进行以下配置。 如果不需要使用APPLE相关功能,请忽略此章节
具体配置请参考第三方后台配置—iOS版 一、Apple后台应用配置

4.3 Appsflyers 相关配置

游戏如需使用Appsflyer相关数据收集功能,需要进行以下配置。如果不需要相关功能,请忽略此章节

4.3.1 数据收集配置

详见2.6.1 配置 (wa_sdk_track_config.plist)

4.3.2卸载检测

a)官方说明:https://support.appsflyer.com/hc/en-us/articles/211211963-iOS-Uninstall-Tracking



b)对接WINGSDK代码同3.7消息推送

c) 导出App推送证书p12文件,进入appsflyer后台–配置-应用配置-卸载模块
上传p12证书与密码,点击验证。开启卸载衡量开关
图片1

4.4 Chartboost 相关配置

游戏如需使用Chartboost相关数据收集功能,需要进行以下配置。如果不需要相关功能,请忽略此章节
1.数据收集配置:详见2.6.1 配置 (wa_sdk_track_config.plist)

4.5 VK相关配置

游戏如需使用VK相关登录、社交功能,需要进行以下配置。如果不需要相关功能,请忽略此章节
在xcode配置URL Schemes:
在VKapp管理后台https://vk.com/apps?act=manage找到对应App的配置信息。将下图中Application ID(标注1)填到Xcode中的URL Schemes(标注2)。注意加上前缀vk。
iOS-VK配置1
iOS-VK配置2

4.6 Twitter相关配置

游戏如需使用Twitter账号登录游戏,需要进行以下配置。如果不需要相关功能,请忽略此章节
Twitter需要iOS 9.0以上编译,如果使用9.0以下版本编译,会导致应用闪退。具体配置请参考第三方后台配置—iOS 四、Twitter后台应用配置
1、在twitter开发者平台创建一个twitter应用,创建完之后会生成Consumer Key和Consumer Secret
iOS-Twitter配置
这里的Consumer Key和Consumer Secret要配置在项目info.plist中,作为客户端与后台服务器连接的标识。
iOS-Twitter配置
可复制下面代码到info.plist中在修改为对应Consumer Key和Consumer Secret。

2、配置URL Scheme
iOS-Twitter配置
URL Scheme格式:twitterkit-
例如: twitterkit-SPRwO9pH5p9bJCAbUHaiV8oQY

4.7 Instagram相关配置

游戏如需使用Instagram账号登录游戏,需要进行以下配置。如果不需要相关功能,请忽略此章节
具体配置请参考第三方后台配置—iOS 五、Instagram后台应用配置
在instagram开发者平台创建一个instagram应用,创建完之后会生成Client ID、Client Secret和Website URL
这里的Client ID、Client Secret和Website URL要配置在项目info.plist中clientId、clientSecret和redirectUri,作为客户端与后台服务器连接的标识。
iOS-Instagram配置
可复制下面代码到info.plist中在修改为对应clientId、clientSecret和redirectUri

4.8 智能客服 AIHelp 相关配置

如果不需要AiHelp 功能,请忽略此章节
具体配置请参考WINGSDK第三方后台配置-智能客服 AIHelp 相关章节

4.8.1 在AiHelp开发者平台创建一个AiHelp应用,创建完之后会生成appId、domain和appSecret(appKey)

图片27
可复制下面代码到info.plist中在修改为对应appId、domain和appSecret(appKey)

注:从3.9.7版本开始,项目中的domain如果为gamehollywoodhk@aihelp.net,接入新版本后,可能后闪退,需要把domain的@改成.
如 gamehollywoodhk.aihelp.net

4.8.2 配置权限

Privacy – Photo Library Additions Usage Description

4.9 Firebase相关配置

如果不需要Firebase 功能,请忽略此章节
具体配置请参考WINGSDK第三方后台配置-Firebase相关章节

4.9.1 接入

1、引入WAFirebaseImpl库到项目
2、引用GoogleService-Info.plist配置文件到项目中
图片27

Firebase SDK会自动收集事件,详情请参考:Firebase自动收集事件
完成以上两个步骤,即完成Firebase 模块的接入工作

4.9.2 调试

firebase analytics调试方法
1、在xcode中,选择Product > Scheme > Edit scheme…
2、在左侧菜单选择Run
3、选择Arguments 项
4、在Arguments Passed On Launch区域,添加-FIRAnalyticsDebugEnabled
图片27
5、运行项目后,登录firebase 管理后台,项目—分析—DebugView模块,可查看到调试设备上传事件
图片27

五、附录

5.1 代码说明

5.1.1 状态码说明

SDK所有的状态码都定义在枚举WACode中,详见下表:

枚举名称 取值 说明
WACodeSuccess 200 成功
WACodeError 400 错误
WACodeUnautherized 401 请求未认证:访问受限资源是缺少认证信息,或者认证未通过
WACodeForbiden 403 禁止访问:由于应用上下文原因或请求端上下文的原因被禁止访问资源,例如IP限制等
WACodeNotFound 404 找不到被访问资源:接口不存在、页面不存在或对应的业务实体找不到
WACodeServerError 500 服务器内部故障
WACodeApiInvalid 501 所请求接口或页面未实现
WACodeSdkAppIdInvalid 4010 无效appId: appId不存在或未开启
WACodeSignError 4011 无效osign:osign校验失败
WACodeRequestTimeOut 4012 请求已过期:ots校验失败
WACodeAccountVerifyError 4013 第三方平台验证失败
WACodeAccountVerifyError 4014 访客登录验证失败,登录验证失败
WACodePlatformBoundAlready 4015 用户已经绑定了这个平台的其他账户
WACodePrePlatformVerifyError 4016 prePlatform验证失败
WACodeUserNotFound 4017 用户不存在(没有找到)
WACodeAccountBoundByOthers 4018 账户已经被其他用户绑定
WACodeOrderIdInvalid 4019 无效orderId
WACodeOrderVerifyError 4020 订单验证失败
WACodeRewardNotFound 4021 FB邀请奖励事件未找到奖励政策
WACodeRepeatCrashReport 4022 闪退发送报告重复
WACodeChannelNotFound 4023 未找到渠道信息
WACodeCanNotUnbind 4024 不可以执行解绑操作
WACodeExchangeRateConversionFailure 4025 汇率转换失败
WACodePayPlatformClosed 4026 支付渠道已关闭
WACodeLoginPlatformClosed 4029 登录渠道已关闭
WACodeBindAccountClosed 4048 账号绑定关闭
WACodeUnBindAccountClosed 4049 账号解绑关闭
WACodeUserCenterClosed 4059 用户中心未开启
WACodeCanNotSwitchToAnonymous 5001 切换到匿名
WACodeFbObjectType 5002 facebook的objectType不能为空
WACodeFbGiftListRequestPrameterLack 5003 请求gift列表缺少appid,appSecret,objectType参数
WACodeFbTokenNull 5004 facebook token为空
WACodeCanNotMakePayment 5005 该设备不能支付或者不允许支付
WACodePaymentError 5006 支付过程中出错
WACodeCancelled -100 取消操作
WACodeSdkUninitialized -200 SDK没有初始化
WACodeContentCanNotBeShared -201 内容不可分享,一般是传入的内容为空,或者其他
WACodeNotLogin -202 没有登录
WACodeLoginFailure -203 登录失败
WACodeNoPermission -204 登录没有获取到相应的权限
WACodeFileSizeLimit -206 文件大小超出限制
WACodeCurrentIDNotMatch -211 登录的平台账户和当前用户不匹配
WACodeDeviceNotSupported -401 设备不支持
WACodeNetworkUnavailable -402 网络不可用
WACodePayReOrderTimeLimit -509 支付:订单时间间隔限制(在特定的时间内重复下订单)

5.1.2 平台取值

常量 取值 备注
WA_PLATFORM_WINGA WINGA WA平台,分匿名登录和应用内登录
WA_PLATFORM_APPLE APPLE APPLE平台
WA_PLATFORM_FACEBOOK FACEBOOK Facebook平台
WA_PLATFORM_VK VK VK平台

5.1.3 请求类型说明

取值值 说明 备注
INVITE 邀请
REQUEST 普通请求

注:vk平台测试游戏邀请功能需要申请权限,可以把请求类型设置成WA_REQUEST_TYPE_REQUEST来测试普通邀请,带申请权限通过后改成WA_REQUEST_TYPE_INVITE来测试。关于vk邀请功能的业务流程图如下:
vk上线流程图

5.2 事件说明

5.2.1 SDK 预定义事件名

静态变量名称 事件名称 说明
WAEventInitiatedPurchase ghw_initiated_purchase 点击购买
WAEventPurchase ghw_purchase 购买完成
WAEventUserCreate ghw_user_create 创建角色
WAEventUserInfoUpdate ghw_user_info_update 更新用户信息
WAEventUserImport ghw_user_import 导入用户
WAEventTaskUpdate ghw_task_update 玩家任务统计
WAEventLevelAchieved ghw_level_achieved 等级或分数

5.2.2 SDK 预定义参数名

参数意义 类型 备注
货币类型 currencyType Stirng 货币类型:如美元USD,人民币CNY详见货币表
现金额 currencyAmount Int
价钱 price Double
道具类型 ContentType String
道具ID contentId Stirng
搜索内容 searchString Stirng
成功失败 success Bool 0表示失败
1表示成功
是否可获得 ghw_payment_info_available Bool 1表示可获得,
0表示不可获得
物品数量 itemAmount Int
物品id itemId Stirng 道具id
物品名称 itemName Stirng 道具名称
是否为第一次导入 isFirstEnter Int
得分 score Int
描述 description Stirng
性别 gender int 性别(int):
0表示女,
1表示男,
2表示未知
年龄 age Int
账户类型 accountType Stirng
设备id deviceId Stirng
渠道id channelId Stirng
广告标识 idfa Stirng
交易流水号 transactionId Stirng
支付类型 paymentType Int 0表示google支付,
1表示apple支付,
2表示赠送
虚拟游戏币 virtualCoinAmount Int
道具名称 iapName Stirng
道具数量 iapAmount Stirng
道具id iapId Stirng
注册时间 registerTime String 时间戳(从1970年开始)
任务id taskId String
任务名称 taskName String
任务类型 taskType String
任务状态 taskStatus String 状态标识:
1->领取任务,
2->开始任务,
3->待领奖(任务完成),
4->已领奖
角色名称 nickName String
vip等级 vip Int
状态 status Int 状态标识,-1: 锁定,1:未锁定
游戏角色Id gameUserId String
角色类型 roleType String
绑定钻石 bindGameGold Int
用户钻石数 gameGold Int
战斗力 fighting Int
货币类型 goldType String 货币类型(string) 钻石,绑定钻石,金币,军魂等。预定义有1和2:
1:游戏货币;
2:游戏绑定货币
变更途径 approach String
当前货币数量 currentAmount Int 用户变更以后该种货币的数量
变更货币数 amount Int