piwik.js
百度用户指南
也可以参考的
Javascript
跟踪客户端的用户指南，熟悉
Javascript
的跟踪客户端。
所有方法的列表，请跟踪
API
中
从
Piwik
类请求跟踪实例
Piwik.getTracker
（
trackerUrl
，
SITEID
）
-
获得跟踪器的新实例
Piwik.getAsyncTracker
（）
-
获取跟踪的内部实例用于异步跟踪
使用跟踪对象
enableLinkTracking
（启用）
-
在所有适用的链接元素上安装链接跟踪。
启用参数设置为
true
使用伪单击处理程序来跟踪浏览器
（如
Firefox
）
不产生点击事件鼠标中键。
默认情况下
只有“真正的”鼠标点击事件的处理。
trackEvent
（类别，动作，
[
名
]
，
[
值
]
）
-
记录与事件类的事件（视频，音乐，游戏
...
）
，
事件操作（播放，暂停，持续时间，添加播放列表，下载，点击。
..
）
，以及可选的事件名
称和可选的数字值。
trackPageView
（
[customTitle]
）
-
记录访问此页
trackSiteSearch
（关键字，
[
类别
]
，
[resultsCount]
）
-
登录的内部网站搜索特定的关键字，
在可选类别中，指定页面的搜索结果的可选数量。
trackGoal
（
idGoal
，
[customRevenue]
）
;-
手动登录为目标
idGoal
的转换，通过自定义的
收入
customRevenue
trackLink
（
URL
，
LINKTYPE
）
-
手动记录从你自己的代码点击。
url
是完整的
URL
是被
跟踪为点击。
LINKTYPE
可以是一个
outlink
的下载“链接”或“下载”
。
trackAllContentImpressions
（）
-
扫描整个
DOM
的所有内容块和跟踪所有的印象，一
旦
DOM ready
事件被触发。
trackVisibleContentImpressions
（
checkOnSroll
，
timeIntervalInMs
）
-
只要在页面加载扫
描整个
DOM
的所有内容块。它跟踪的印象只有一个内容块实际上是可见的。
trackContentImpressionsWithinNode
（
domNode
）
-
扫描给定的
DOM
节点及其子女的内
容块，并跟踪一个印象，对他们来说，如果没有印象已经跟踪它。
trackContentInteractionNode
（
domNode
，
contentInteraction
）
-
跟踪给定的
DOM
节点
/
内容块的相互作用。
trackContentImpression
（内容名，
contentPiece
，
contentTarget
）
-
跟踪使用指定的值的
内容的印象。
trackContentInteraction
（
contentInteraction
，
内容名，
contentPiece
，
contentTarget
）
-
跟
踪使用指定的值的内容互动。
在跟踪对象的配置
setDocumentTitle
（字符串）
-
覆盖
document.title
时
setDomains
（阵列）
-
主机名或域名的集阵列被视为本地。对于通配符子域，你可以
使用：
setDomains;
（
“
example.com
”
。
）或
setDomains
（
'* example.com'
）
;
setCustomUrl
（字符串）
-
重写页面的
URL
报告的
setReferrerUrl
（字符串）
-
覆盖检测到的
Http-Referer
信息
setSiteId
（整数）
-
指定的网站
ID
。多余的：能在
getTracker
指定（）构造函数。
setApiUrl
（字符串）
-
指定
Piwik
HTTP
API
URL
端点。点
piwik
的根目录下，如
文库http://piwik.example.org/
或
https://example.org/piwik/
。
此功能仅当
“覆盖”
报告不工作有用。
默认情况下，你不需要使用此功能。
setTrackerUrl
（字符串）
-
指定
Piwik
服务器的
URL
。多余的：能在
getTracker
指定（）
构造函数。
setDownloadClasses
（字符串
|
数组）
-
设置的类被当作下载（除了
piwik_download
）
setDownloadExtensions
（字符串）
-
设置文件扩展名列表被确认为下载。例如：
“文件
|
PDF | TXT
”
addDownloadExtensions
（字符串）
-
指定额外的文件扩展名被确认为下载。例如：
“文
件
| PDF | TXT
”
setIgnoreClasses
（字符串
|
数组）
-
设置类要如果存在于链接忽略（除了
piwik_ignore
）
setLinkClasses
（字符串
|
数组）
-
设置的类被当作
outlinks
（除了
piwik_link
）
setLinkTrackingTimer
（整数）
-
设置延迟以毫秒为单位的链接跟踪。
discardHashTag
（布尔）
-
设置为
true
将不记录哈希标签（锚）的
URL
部分
setGenerationTimeMs
（
generationTime
）
-
默认
Piwik
使用浏览器的
DOM
时序
API
来准
确地确定它需要生成并下载网页的时间。您可以通过在这里指定毫秒值覆盖值。
appendToTrackingUrl
（
appendToUrl
）
-
追加的自定义字符串的
HTTP
请求
piwik.php
的
结束？
setDoNotTrack
（布尔）
-
设置为
true
不跟踪使用
Mozilla
的（提议的）不跟踪设置谁退
出跟踪用户。
disableCookies
（）
-
禁止所有第一方
Cookie
。
现有
Piwik
饼干这个网站将在接下来的页
面视图中删除。
deleteCookies
（）
-
删除当前当前设置的跟踪
Cookie
（创建新的访问时，这很有用）
killFrame
（）
-
使帧克星，以防止被跟踪的网页被陷害
/ iframed
。
redirectFile
（
URL
）
-
强制如果跟踪的网页是从本地文件加载浏览器加载实时
URL
（例
如，保存到某人的桌面）
。
setHeartBeatTimer
（
minimumVisitLength
，
heartBeatDelay
）
-
记录多长时间的页面已经
被若
minimumVisitLength
看
（以秒为单位）
获得
;
在
heartBeatDelay
确定如何频繁地更新服务
器
getVisitorId
（）
-
返回
16
个字符的
ID
为游客
getVisitorInfo
（）
-
返回访问者
Cookie
内容的数组
getAttributionInfo
（）
-
返回访问者归属阵列（
Referer
的信息和
/
或广告系列名称和关
键字）
。
属性信息被用于由
Piwik
当用户触发一目标转换贷记正确引荐
（第一个或最后引用）
中使用。
还可以使用以下任一函数来获取数据的特定属性：
piwikTracker.getAttributionCampaignName
（）
piwikTracker.getAttributionCampaignKeyword
（）
piwikTracker.getAttributionReferrerTimestamp
（）
piwikTracker.getAttributionReferrerUrl
（）
getUserId
（）
-
返回用户
ID
字符串，如果它被设置。
setUserId
（用户
ID
）
-
设置用户
ID
给这个用户（如电子邮件地址或用户名）
。
setCustomVariable
（索引，名称，价值，范围）
-
设置自定义变量。
deleteCustomVariable
（指数范围）
-
删除自定义变量。
getCustomVariable
（指数范围）
-
检索的自定义变量。
storeCustomVariablesInCookie
（）
-
调用时则范围的自定义变量“访问”将被存储（坚
持）在这次访问期间第一方
Cookie
。如果你想在访问以后调用
getCustomVariable
这是非常
有用的。
（默认情况下自定义变量不存储在访问者的计算机上。
）
setCampaignNameKey
（名称）
-
设置广告系列名称参数（
S
）
。
（说明：自定义广告系
列名称参数名）
setCampaignKeywordKey
（关键字）
-
设置活动关键字参数（
S
）
。
（说明：自定义战役
关键字参数名称）
setConversionAttributionFirstReferrer
（布尔）
-
设置为
true
属性转换到第一个引用。默
认情况下，转换是由于最近的引用。
跟踪
Cookie
配置
与
Piwik
1.2
开始，第一方
Cookie
的使用。必须考虑到保留时间和避免冲突与其他饼干，跟
踪和应用程序。
setCookieNamePrefix
（前缀）
-
默认前缀是
'PK'
。
setCookieDomain
（
域
）
-
默
认
是
文
档
域
;
如
果
你
的
网
站
可
以
访
问
在
两
个
www.example.com
和
example.com
，
你可以使用：
tracker.setCookieDomain;
（
“
example.com
”
。
）
或
tracker.setCookieDomain
（
'* example.com
。
'
）
;
setCookiePath
（路径）
-
默认为
'/'
。
setVisitorCookieTimeout
（秒）
-
默认为
13
个月
setReferralCookieTimeout
（秒）
-
默认为
6
个月
setSessionCookieTimeout
（秒）
-
默认为
30
分钟
先进的用途
的
addListener
（元）
-
添加点击监听到一个特定的链接元素。当点击时，
Piwik
将自动
记录点击。
setRequestMethod
（方法）
-
设置请求方法不是
“
GET
”
或
“
POST
”
。
（默认值是
“
GET
”
。
）
要使用
POST
请求方法中，
Piwik
的主机必须是一样的跟踪网站的主机（安装在同一个域中
Piwik
为您追踪网站）
。
setCustomRequestProcessing
（功能）
-
设置一个函数，将处理该请求的内容。该函数
将被调用一次请求（查询参数字符串）已编制，并请求内容发送之前。
setRequestContentType
（的
contentType
）
-
设置请求的
Content-Type
标头值。适用于
当“
POST
”请求方法是通过
setRequestMethod
使用。
单元测试覆盖
piwik.js
在
Piwik
的
JavaScript
API
跟踪覆盖广泛的
JavaScript
单元测试套件，以确保代码质量尽可能
高，而我们从来没有打破这个功能。测试使用
QUnit
写入。运行测试，只需签出
Piwik
Git
仓库，进入
/
路径
/
到
/ piwik /
测试
/
的
JavaScript /
。测试你的浏览器中运行。
在
Piwik
的
JavaScript API
已经过测试，
与众多的网络浏览器。
为了最大限度地提高覆盖范围，
我们使用的服务，如
crossbrowsertesting.com
和
browsershots.org
。
缩小
piwik.js
该
piwik.js
是精缩，以减少您的网站访问者将要下载的大小。该
YUI
压缩机是用来运行如下
JavaScript
的（更多信息）
。你可以找到原来的非缩小的版本
/js/piwik.js
。