JiaThis 友言 友荐
登录 | 注册
帮助
JiaThis客户端JS自定义API

通过JiaThis获取代码的功能,网站主可以便捷的获取到符合自己网站风格的分享按钮代码。对于大多数的网站而言,或许已经足够。但是,一定还有不少的网站主想拥有更加个性化的自定义功能。

其实,JiaThis一直都支持非常多的个性化自定义功能,不知道细心的您有没有发现:除了大家经常会使用到的自定义URL、TITLE自定义分享小图标等 功能外,JiaThis还"包含"着许多可以自定义的"秘技",例如:自定义分享面板的社会化媒体,自定义分享面板加粗媒体个数,自定义分享面板媒体个数, 自定义侧栏式按钮分享到图片,自定义是否加入关闭功能…等等,如果您有兴趣,不妨和我们一起动手试试,您一定会发现其中的乐趣。

所有的自定义功能都在jiathis_config中定义,完成配置后,将语句放在主JS的前面即可,以下举例说明:

var jiathis_config = {
    boldNum:0,
    siteNum:7,
    showClose:false,
    sm:"t163,kaixin001,renren,douban,tsina,tqq,tsohu",
    imageUrl:"http://v2.jiathis.com/code/images/r5.gif",
    imageWidth:26,
    marginTop:150,
    url:"http://www.jiathis.com",
    title:"自定义TITLE #微博话题#",
    summary:"分享的文本摘要",
    pic:"自定义分享的图片连接地址",
    data_track_clickback:true,
    appkey:{
        "tsina":"您网站的新浪微博APPKEY",

        "tqq":"您网站的腾讯微博APPKEY",

         "tpeople":"您网站的人民微博APPKEY"

    },
    ralateuid:{
        "tsina":"您的新浪微博UID"
    },
    "shortUrl":是否开启短链接,
    evt:{
        "share":"用户自定义函数" ( 可以根据自己的命名规范来定义一个自定义函数,如:getEvent )

        说明:evt参数可以得到用户的分享操作的相关信息。比如:用户分享的URL,用户分享到的媒体。但是,我们不能确定用
        户是否真正成功的分享了内容,只能确定用户确实是点击了分享按钮……

    }
}

下面来看看各个参数的详细说明:

参数名 描述 类型 默认值
url 自定义分享的URL string 网页地址
title 自定义分享的TITLE string 网页标题
summary 定义要分享页面的摘要,摘要默认为Meta标签中Description部分的内容 string
boldNum 分享面板上加粗媒体的个数。如果缺省,则标准风格的分享面板默认是6个加粗,迷你风格的分享面板默认是3个加粗。
何时会加粗:当用户使用过JiaThis分享到功能后,JiaThis会依据该浏览者的喜好产生一个智能排序的顺序,这个顺序的前几个会被加粗,您可以通过这个参数自由控制加粗的个数,如果您想关闭加粗的功能,则将此参数写成数字0就可以了。
integer 标准:6
迷你:3
siteNum 分享面板上的社会化媒体的个数。通常情况,这个数字应当大于或等于boldNum参数,因为需要加粗的个数不会多于整个分享面板媒体的个数。如果缺省,标准风格默认为15个,迷你风格默认为6个。 integer 标准:15
迷你:6
sm 自定义分享面板上社会化媒体的排序。填写媒体网站的WEBID(如:tsina表示新浪微博,tqq表示腾讯微博,更多的社会化媒体WEBID参见这里),用英文半角逗号分隔。如果网站主使用了此自定义功能,则自定义的媒体网站会优先固定出现在前面,后面紧跟依据网站浏览者分享行为产生的智能排序结果。这个结果不会与您自定义的媒体重复。如果缺省,分享面板会按照智能排序的规则出现媒体。

特别的,siteNum 参数与 sm 参数交替使用几乎可以让您自定义任何您想要的分享面板。
举例一:
var jiathis_config = {
    sm:"tsina,tqq",
    siteNum:7
}
这表示:分享面板上总共会出现7个媒体,前两个是新浪微博和腾讯微博,后面剩下的5个则根据智能排序规则出现。当然,和您想的一样,这剩下的5个不会再次包含新浪微博或者是腾讯微博了。
举例二:
var jiathis_config = {
    sm:"tsina,tqq,t163,tsohu",
    siteNum:4
}
这表示:分享面板公共会出现4个媒体,这4个媒体全都是您自定义的。如果这里的 siteNum小于4,比如假设是3,则分享面板会出现3个媒体,sm参数中的最后一个tsohu(搜狐微博)不会出现。
string
imageWidth (只对侧栏式有效):这是imageUrl参数的一个补充。如果您自定义了分享图片,且这个图片宽度不与我们官方标准风格或迷你风格的图片宽度一致时,可能出现显示的偏差或错位,这时候您就需要将imageUrl参数中图片的实际宽度填写在这里。缺省状态下,标准风格的图片宽度为26,迷你风格的图片宽度为20。 integer 标准:26
迷你:20
marginTop (只对侧栏式有效):如果我们不想让分享按钮处于页面的中间部位,我们就可以用marginTop属性来控制分享按钮在页面中的位置,是位于页面的上边,还是页面的下边,或是偏上、偏下,都可以实现。默认的位置就是中间位置,也就是距离页面上边是150px。 integer
showClose (只对侧栏式有效):是否在分享面板中加入关闭按钮。如果缺省,默认会开启关闭按钮。这表示浏览者可以通过这个关闭按钮关闭侧栏式分享按钮。 boolean true
imageUrl (只对侧栏式有效):侧栏式风格的图片地址。侧栏式风格的"分享到"图片允许网站主自定义,当您觉得JiaThis官方提供的所有图片风格都无法满足您的要求时,您或者您的团队可以自己设计一个分享到图片。将这个图片放入您的服务器。保该图片可以通过因特网正常访问,如:http://yourdomain/images/share.gif, 然后将该地址填写到这里这里即可。 string
appkey 您网站对应各大社会化媒体的APPKEY,内容被分享后,显示的来源将是您自己的网站。 object
ralateuid 目前仅新浪微博支持,此处填写您的新浪微博UID,内容被分享后,将会自动@分享者提示他关注您。默认情况下此值为空,不会出现@提示。 object
data_track_clickback 是否启用回流量统计,启用后,分享出去的链接会自动在后面加上jtss=xxx的参数,这样可以精确统计到您网站的回流量。 boolean false
pic 支持新浪微博、腾讯微博、搜狐微博、网易微博,可以自定义分享的图片,如果此值为空,将会根据社会化媒体原有的抓图机制来获取您网站的图片。 string
shortUrl 是否针对新浪微博开启短链接传递,如果缺省,默认为true(开启),关闭定义为false(不开启) 不加引号 string true

下面来看看EVT参数的详细说明:

比如,某个网站如果想要统计自己网站的每个会员分享到新浪微博、腾讯微博等行为,以这个统计作为某项奖励的依据(例如,增加积分等)就可以使用events事件处理。

代码 描述 数据
share 当用户点击分享后触发返回evt.data,evt.data是一个对象,它包含了该事件所能获取的所有数据:evt.data.url(分享的当前网页),evt.data.service(分享到的媒体)。

实例一:得到用户分享的URL地址( 自定义函数为geturl )
<script>
function geturl(evt) {
    alert('用户分享的网页是:'+evt.data.url);
}
var jiathis_config = {
    evt: {"share":"geturl"}
}
</script>

实例二:得到用户分享到了哪些媒体( 自定义函数为getservice )
<script>
function getservice(evt) {
    alert('用户将当前网页分享到了:'+evt.data.service);
}
var jiathis_config = {
    evt: {"share":"getservice"}
}
</script>

 

如何自定义分享平台的appkey? >>请看这里

开始

安装

自定义

数据分析

各平台安装

媒体分享代码