跳转到主要内容
PRODUCT DOCUMENTS

快速找到所需文档,高效完成接入与排障

浏览产品文档与友盟 Skill,展开目录并阅读正文。

小游戏云配

您可通过远程配置功能在不重新发版的情况下,完成给不同用户展示不同功能、页面或页面内容的能力。

说明

目前该功能正在公测中,仅对部分小游戏客户提供;如果您希望加入公测中,请加入小程序开发者钉钉群联系我们。

功能介绍

使用场景举例:

  • 根据用户设定系统语言,显示不同语言的欢迎语;

  • 小游戏更新新关卡,先对少量用户可见,验证后再全量发布上线;

  • 活动、节日大促道具限期领取;

  • 游戏新玩家免费试用纪念款皮肤;

  • 广告的开启与关闭;

  • 针对特定用户群体,呈现不同的召回语;

  • 在不同的属性人群中进行AB测试,利用数据化运营,科学改进应用。

    说明

    名词注释参数 : 包括参数名和参数值。参数名是代码中的一个字符串类型变量,需满足命名规则,参数名不可修改,不能重复。参数值分为默认值和条件值,创建时必须指定默认值,不指定则为空字符串。一个参数可以对应多个条件值和一个默认值,条件值有优先级,可在编辑时拖动顺序,改变优先级。应用的一个用户若满足多个条件值,优先命中优先级最高的条件值。如果所有的条件都不满足,则使用默认值。

    条件 : 条件用于定位一组特定的用户,条件有一组规则组成。对于某个特定的用户,条件对于的所有规则都满足才是true,才会下发此条件值。如果规则的值未指定,比如没有值可用,该规则将求值为false。例如根据系统显示开屏url,创建一个条件os=’Android’,再创建一个参数,关联此条件。再例如,可根据拉取时间来控制应用何时显示打折商品,控制游戏双倍经验活动时间范围。

    历史配置 : 您可以在历史配置中看到已发布版本的详情,可通过「对比参数」diff不同历史版本差异,可选中历史版本回滚到历史版本。版本 : 用户每次发布即为一个版本,初始版本为1,每次新版本+1,每次发布可以添加、修改多个参数和条件。

操作说明

1. 集成SDK

在使用「远程配置」功能前,1. 请先完成升级微信小游戏2.4.0 版本 sdk;2. 根据下文「远程配置」功能的配置,完成「参数」相关的SDK配置。适用范围**集成了统计 SDK 2.4.0及以上版本的小游戏; sdk下载地址:https://developer.umeng.com/docs/147615/detail/184228

基础功能

设置默认参数 setDefaultValues调用时机:针对小程序,在小程序生命周期onLaunch之后。针对小游戏,因为小游戏没有统计的页面生命周期,因此在集成统计sdk初始化完成之后的任意时机都可以调用方式:

uma.rc.setDefaultValues(defaultValues);

//eg.
uma.rc.setDefaultValues({
    testKey:'testValue',
});

参数:

名称

类型

默认值

是否必填

描述

defaultValues

Object

null

否

defaultValues是远程配置功能为方便开发者设置默认配置参数而预留,以便应用在连接到远程配置后端之前能够按预期运行,并且在后端中尚未设置任何值时可以使用默认值

获取远程配置 fetch调用方式:

uma.rc.fetch(options)

//eg.
uma.rc.fetch({
    active:false,//active为Boolean类型, 代表开发者获取远程配置后是否自动激活配置, true 自动激活, false 用户手动激活
    callback:function(params){//fetch调用之后的回调方法, 无论成功还是失败都会回调
      console.log("fetch: ", params);
}
})

参数:

名称

类型

默认值

是否必填

描述

options

Object

null

否

建议配置:

  • active 获取完成后是否自动激活

    • true 自动激活

    • false 手动激活

  • callback 获取完成的回调,回调参数类型为object,包含如下字段

    • params 接口调用成功后返回参数列表, 否则返回 undefined|

返回值: 无 手动激活 active调用方式:

uma.rc.active(options)

//eg.
uma.rc.active({
  callback:function(params){
      console.log('active params:', params);
}
})

参数:

名称

类型

默认值

是否必填

描述

options

Object

null

否

建议配置:

  • callback active 方法的回调,回调参数类型为params, 类型为 Object|

返回值: 无 获取某个参数值 getValue**调用方式:

uma.rc.getValue(key);

//eg.
console.log(uma.rc.getValue('testKey'));//输出 testValue

参数:

名称

类型

默认值

是否必填

描述

key

String

undefined

是

参数 key

返回值:配置中键值key对应的value

自定义远程配置功能配置项 setOptions调用方式:

uma.rc.setOptions(config);

//eg.
uma.rc.setOptions({
    minFetchIntervalSeconds:>=1小时的秒数//每次 fetch 数据允许的请求间隔, 默认12小时, 最小为1小时
})

参数:

名称

类型

默认值

是否必填

描述

config

Object

null

否

可选配置:

  • minFetchIntervalSeconds 触发 fetch 的最小时间间隔,在最小时间间隔内多次触发 fetch仅第一次有效|

返回值: 无

2. 云配产品操作流程

应用下拉狂选择需要添加云配的小游戏应用

不同场景操作流程图

1

只用参数

点击“参数”->“添加参数”,在弹框中输入参数名称(必填)、说明、默认值、条件值;]23添加完毕本次远程配置需要的各个参数后,点击“发布”即可完成本次配置的下发

注意

参数名称有命名规则校验(最多256字符,且必须以下划线或英文字母(A-Z、a-z)开头,还可以包含数字),条件值需先创建条件,下拉列表才显示。值不区分类型,都是字符串。必须指定默认值,不指定则为空字符串

条件和参数结合

您可以按12种维度任意组合条件为应用不同细分用户群提供不同用户体验。主要包含以下维度:

  • 应用信息:微信基础库版本

  • 来源场景:场景值、推广渠道、推广活动

  • 设备信息:品牌、机型、屏幕分辨率

  • 系统信息:系统版本、语言

  • 灰度发布:用户百分比

  • 定时生效:拉取时间

  • 用户信息:位置(国家、省份、城市)、人群

点击“参数”->“添加参数”,在弹框中输入参数名称(必填)、说明、默认值、条件值;

23

点击“参数”->“添加条件”,在弹框中输入名称(必填)、颜色、规则,条件名称有命名规则,和参数名称规则一致。 多个规则之间是且的关系,每个规则只能选择一个。支持的条件

点击“参数”,找到需要修改参数条件的参数,点击“编辑”,添加条件值,保存。

完成各个参数配置后,点击“发布”即可完成本次配置的下发。

注意

参数名称有命名规则校验(最多256字符,且必须以下划线或英文字母(A-Z、a-z)开头,还可以包含数字),条件值需先创建条件,下拉列表才显示。值不区分类型,都是字符串。必须指定默认值,不指定则为空字符串

版本diff和回滚

若有查看不同版本的配置对比或者需要将当前配置回滚至某个版本时需做如下操作。点击页面右上角“历史配置”,即可查看已发布的历史版本详情

时间筛选框:可选择查看历史版本的时间范围点击版本:可看到该版本历史配置过的参数及条件对比参数:可对比2个版本的参数差异,可在该页面点击回滚至该对比版本

参数其他操作

点击“显示所有条件值”可全局展开所有条件值,默认收起,也可单个展开收起参数条件值。点击“删除”会从服务端删除该参数,不再下发到SDK端,若SDK端有此参数,生效的是SDK端参数默认值。点击“编辑”可修改参数名称、说明、条件值、默认值,也可拖拽调整多个条件值顺序,以改变条件值优先级,越往上优先级越高,默认值兜底,若应用同一用户满足多个条件,生效最高优先级条件值。

FAQ

  • 问题1:问:参数条件quota限制?答:参数最多400个,条件最多100个,参数值总大小不超过200KB。参数key最多256字符,且必须以下划线或英文字母(A-Z、a-z)开头,还可以包含数字。

  • 问题2:问:参数何时下发?答:应用活跃且有新的配置更新时,会异步自动下发,无需手动下发。