shareinstall

来自于:Shareinstall立即使用

概述

shareinstallsdk为Shareinstall为APICloud平台应用开发的模块

简介

具有专业的移动应用推广能力,为您的应用提供安装来源追踪,用户免填邀请码绑定邀请关系,一键唤醒应用到指定页面等功能,通过数据可视化展现,准确核对销售地推业绩,协议产品运营决策。

产品特色

  1. 智能传递参数
    通过H5页面传递,产生的用户的安装,下载,打开、拉起应用等行为均可智能传递自定义参数,通过shareinstall后台大数据算法的精准识别,匹配来源邀请行为,绑定邀请、好友关系。亦可根据参数直达应用指定场景,聊天室、游戏室。

  2. 快速分享安装
    分享后点击即可快速安装,省略了中间步骤。减少用户因步骤繁多而引起的流失,准确获取用户推广、地推、销售的业绩指标。兼容国内外主流社交平台,智能快速。

  3. 多维数据统计
    多维数据统计,新增、活跃、启动等多重指标,直达用户行为分析。可添加多重渠道,精准核算销售地推业绩。丰富的折线统计图,详细的数据,协助产品运营作出最佳决策。

使用场景

可以提供的使用场景有移动广告效果统计、免填邀请码绑定邀请关系、安装后自动加群加好友、一键加入游戏房间或app指定页面,用户社交分享统计、渠道分析统计、地推效果分析统计、微信一键拉起app等。

使用流程

1、前往Shareinstall官网中申请开发者账号创建应用,并获取AppKey。
2、前端调用Shareinstallsdk模块方法。

注:Android请使用APICloud平台升级环境编译

模块使用攻略

1、配置 config.xml 文件

使用此模块之前建议先配置config.xml文件,配置完毕,需通过云端编译生效,配置方法如下

  • 参数:urlScheme、appKey
  • 配置示例:
<permission name="internet" />

<preference name="urlScheme" value="shareinstall官方自动分配的scheme" />

<feature name="shareInstall">
    <param name="com.shareinstall.APP_KEY" value="shareinstall官方自动分配的appKey" />
</feature>
  • 字段描述:
    internet:添加网络权限;urlScheme:用于实现应用间跳转及数据交换,本应用可以启动本应用,也可以从微信客户端跳回本应用。urlScheme 的 value 值是shareinstall平台自动分配的scheme(用于拉起就必须配置);com.shareinstall.APP_KEY:(必须配置)从shareinstall平台获取的 AppKey。

2、通用链接相关配置,本步骤仅限iOS 平台,android上忽略此步骤

  • 开启Associated Domains服务
    iOS平台,确保能正常跳转,AppID需开启Associated Domains功能。
    请到苹果开发者后台 (https://developer.apple.com ),选择Certificate, Identifiers & Profiles,选择相应的AppID,开启Associated Domains。
    注意:当AppID重新编辑过之后,需要更新相应的mobileprovision证书。
    (详细配置步骤请看Shareinstall官网文档中心
    更新mobileprovision证书步骤请查看(https://docs.apicloud.com/Dev-Guide/iOS-License-Application-Guidance )中的 "云编译mobileprovision发布证书制作"或"云编译mobileprovision测试证书制作"。
  • 配置通用链接universal links关联域名
    该文件是给iOS平台配置的文件,在widget\res下创建文件名为UZApp.entitlements的文件,UZApp.entitlements内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>com.apple.developer.associated-domains</key><!--固定key值-->
    <array>
     <!--这里换成你在shareinstall后台的关联域名(Associated Domains)-->
        <string>applinks:xxxxxx.shareinstall.net</string>
    </array>
</dict>
</plist>

模块接口详情

1、getWakeup

唤醒功能配置

示例代码

  • android:
    getWakeup({uri:ret.data},callback(ret, err))
  • ios:
    getWakeup({},callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    channel: '渠道编号',//渠道编号,若没有渠道,则无该字段
    自定义参数:  '唤醒携带的参数'  //用户自定义携带的参数
}

err:

示例代码

var shareinstall = api.require('shareinstall');
api.addEventListener({
  name: 'appintent'
}, function(ret, err) {
  shareinstall.getWakeup({
      "uri": ret.data //android需要参数,ios不需要传参
  }, function(ret, err) {
      alert(JSON.stringify(ret));
  });
});

补充说明

此接口用于获取动态唤醒参数,通过动态参数,在拉起APP时,获取由web网页中传递过来的,如邀请码、游戏房间号等自定义参数,跳转指定页面 监听appintent事件,调用以上代码,获取web端传过来的自定义参数,并回调给getwakeup方法调用;

可用性

Android系统,iOS系统

可提供的1.0.0及更高版本

2、getInstall

个性化安装配置

getInstall({},callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    channel: '渠道编号',//渠道编号,若没有渠道,则无该字段
    自定义参数:  '唤醒携带的参数'  //用户自定义携带的参数
}

示例代码

var shareinstall = api.require('shareinstall');
shareinstall.getInstall({
},function(ret, err){
   alert(JSON.stringify(ret));
});

补充说明

此接口用于获取动态安装参数(可重复获取),测试时候建议卸载再安装正确获取参数,在APP需要个性化安装参数时(由web网页中传递过来的,如邀请码、游戏房间号等自定义参数),在回调中获取参数,可实现跳转指定页面、统计渠道数据等

可用性

Android系统,iOS系统

可提供的1.0.0及更高版本

3、regist

注册功能配置

regist()

示例代码

var shareinstall = api.require('shareinstall');
shareinstall.regist();

补充说明

shareinstall 会自动完成安装量、留存率、活跃量、在线时长等渠道统计数据的上报工作,如需统计每个渠道的注册量(对评估渠道质量很重要),可根据自身的业务规则,在确保用户完成app注册的情况下,调用regist()上报注册量。 在shareinstall平台即可看到注册量。

可用性

Android系统,iOS系统

可提供的1.0.0及更高版本