MatomoTracker

API参考

Matomo跟踪器实现了Matomo跟踪Web API。

更多信息请参见:https://github.com/matomo-org/matomo-php-tracker/

属性

这个类定义了以下属性:

$ URL- Matomo基础URL，例如http://example.org/matomo/必须在使用类调用MatomoTracker::$URL = 'http://yourwebsite.org/matomo/'之前设置;
DEBUG_APPEND_URL美元
DEBUG_LAST_REQUESTED_URL美元-在测试中用于输出有用的错误消息。

`$ URL`

Matomo基础URL，例如http://example.org/matomo/必须在使用类之前通过调用MatomoTracker::$URL = 'http://yourwebsite.org/matomo/'设置;

签名

这是一个字符串价值。

`DEBUG_APPEND_URL美元`

签名

未指定类型。

`DEBUG_LAST_REQUESTED_URL美元`

在测试中用于输出有用的错误消息。

签名

未指定类型。

方法

该类定义了以下方法:

__construct ()-通过使用Matomo Tracking API构建一个Matomo tracker对象，用于跟踪特定网站的访问，页面和目标转换。
setPageCharset ()-默认情况下，Matomo期望utf-8编码的值，例如页面URL参数值，页面标题等。
setUrl ()—设置当前正在跟踪的URL
setUrlReferrer ()-设置URL引用器用于跟踪新访问的引用器详细信息。
setGenerationTime ()—该方法不推荐使用，没有任何作用。
setPerformanceTimings ()-设置各种浏览器性能指标的时间。
clearPerformanceTimings ()-清除/重置之前设置的所有性能指标。
setAttributionInfo ()-设置访问的归属信息，以便后续的目标转换正确地归属于正确的推荐人URL，时间戳，活动名称和关键字。
setCustomVariable ()-设置访问自定义变量。
getCustomVariable ()-返回当前分配的自定义变量。
clearCustomVariables ()-清除任何可能已设置的自定义变量。
setCustomDimension ()—设置自定义维度
clearCustomDimensions ()-清除之前设置的所有自定义尺寸
getCustomDimension ()-返回给定id的自定义维度的值
setCustomTrackingParameter ()—自定义跟踪参数。
clearCustomTrackingParameters ()-清除/重置所有之前设置的自定义跟踪参数。
setNewVisitorId ()—设置当前访客ID为随机的新访客ID。
setIdSite ()—设置当前站点ID。
setBrowserLanguage ()—设置浏览器语言。
setUserAgent ()—设置用户代理，用于检测操作系统和浏览器。
setClientHints ()—设置客户端提示，用于检测操作系统和浏览器。
setCountry ()—设置访问用户所在国家。
setRegion ()—设置访问用户所在区域。
setCity ()—设置访问者所在的城市。
setLatitude ()—设置访问者的纬度。
setLongitude ()—设置访问者的经度。
enableBulkTracking ()—开启批量请求特性。
disableBulkTracking ()—禁用批量请求功能。
enableCookies ()-启用Cookie创建-这将导致在设置或重置VisitorId时设置第一方VisitorId Cookie
disableSendImageResponse ()-如果图像响应被禁用，Matomo将响应一个HTTP 204头，而不是响应一个gif。
doTrackPageView ()—跟踪页面视图
doTrackEvent ()-跟踪事件
doTrackContentImpression ()-跟踪内容印象
doTrackContentInteraction ()-跟踪内容交互。
doTrackSiteSearch ()-跟踪一个内部网站搜索查询，并可选跟踪搜索类别，和搜索结果计数。
doTrackGoal ()—记录进球转换
doTrackAction ()-跟踪下载或输出链接
addEcommerceItem ()-在电子商务订单中添加一个项目。
doTrackEcommerceCartUpdate ()-跟踪购物车更新(添加项目，删除项目，更新项目)。
doBulkTrack ()-一次性发送所有存储的跟踪动作。
doTrackEcommerceOrder ()-跟踪电子商务订单。
doTrackPhpThrowable ()跟踪PHP Throwable崩溃(需要在目标Matomo中启用CrashAnalytics)
doTrackCrash ()-跟踪崩溃(需要在目标Matomo中启用CrashAnalytics)
兴奋剂()—发送ping请求。
setEcommerceView ()-将当前页面视图设置为项目(产品)页面视图，或电子商务类别页面视图。
getUrlTrackPageView ()-构建URL来跟踪页面视图。
getUrlTrackEvent ()-构建URL来跟踪自定义事件。
getUrlTrackContentImpression ()-建立URL跟踪内容印象。
getUrlTrackContentInteraction ()-建立URL跟踪内容印象。
getUrlTrackSiteSearch ()-构建URL跟踪网站搜索。
getUrlTrackGoal ()-建立URL跟踪idGoal和收入的目标。
getUrlTrackAction ()-构建URL来跟踪一个新动作。
getUrlTrackCrash ()-构建URL跟踪崩溃。
setForceVisitDateTime ()—覆盖跟踪请求的服务器日期和时间。
setForceNewVisit ()-强制Matomo为跟踪请求创建一个新的访问。
setIp ()—覆盖IP地址
setUserId ()—强制记录指定用户的动作。
getUserIdHashed ()- Matomo内部使用的哈希函数，将用户ID哈希为访问者ID。
setVisitorId ()—强制记录指定Visitor ID的请求。
getVisitorId ()-如果发起请求的用户有Matomo第一方cookie，这个函数将尝试返回从第一方cookie解析的ID(在$_COOKIE中找到)。
getUserAgent ()—返回当前设置的用户代理。
getIp ()—返回当前设置的IP地址。
getUserId ()-返回用户ID字符串，这可能已经通过:$v->setUserId('username@example.org')设置;
deleteCookies ()—删除客户端的所有第一方cookie
getAttributionInfo ()-返回存储在第一方cookie中的当前分配的归因信息。
setTokenAuth ()-一些跟踪API功能需要明确的身份验证，使用超级用户token_auth，或具有“管理员”访问网站的用户。
setLocalTime ()—设置本地访客时间
setResolution ()—设置用户分辨率的宽度和高度。
setBrowserHasCookies ()灰;设置浏览器是否支持cookie这在Matomo的“插件列表”报告中报告。
setDebugStringAppend ()-将在跟踪请求的末尾附加一个自定义字符串。
setPlugins ()-设置访问浏览器支持的插件
disableCookieSupport ()-默认情况下，MatomoTracker将从请求中读取第一方cookie，并在响应中写入更新的cookie(使用setrawcookie)。
getRequestTimeout ()-返回跟踪器等待Matomo响应的最大秒数。
setRequestTimeout ()-设置跟踪器等待Matomo响应的最大秒数。
setRequestMethodNonBulk ()—设置请求方法为POST，建议在使用setTokenAuth()时使用该方法，以防止令牌被记录到服务器日志中。
setProxy ()—如果需要一个代理来查找Matomo站点的地址，请使用此设置
setOutgoingTrackerCookie ()—设置发送到跟踪服务器的cookie。
getIncomingTrackerCookie ()-获取一个由跟踪服务器设置的cookie。

`__construct ()`

通过使用Matomo Tracking API构建一个Matomo tracker对象，用于跟踪特定网站的访问，页面和目标转换。

签名

它接受以下参数:
- idSite美元（int) -指定要追踪的地点
- apiUrl美元（字符串) - "http://example.org/matomo/"或"http://matomo.example.org/"如果设置，将覆盖MatomoTracker::$URL

`setPageCharset ()`

默认情况下，Matomo期望utf-8编码的值，例如页面URL参数值、页面标题等。

建议只向Matomo发送UTF-8数据。如果需要，还可以使用此函数指定另一个字符集。

签名

它接受以下参数:
- 美元的字符集（字符串) - - -
它返回一个这个美元价值。

`setUrl ()`

设置正在跟踪的当前URL

签名

它接受以下参数:
- $ url（字符串) -原始URL(非URL编码)
它返回一个这个美元价值。

`setUrlReferrer ()`

设置URL引用器，用于跟踪新访问的引用器详细信息。

签名

它接受以下参数:
- $ url（字符串) -原始URL(非URL编码)
它返回一个这个美元价值。

`setGenerationTime ()`

此方法已弃用，并且不执行任何操作。它用来设置在服务器端生成文档所需的时间。

另请参阅

setPerformanceTimings

签名

它接受以下参数:
- timeMs美元（int) -生成时间(毫秒)
它返回一个这个美元价值。

`setPerformanceTimings ()`

为各种浏览器性能指标设置时间。

另请参阅

https://developer.mozilla.org/en-US/docs/Web/API/PerformanceTiming

签名

它接受以下参数:
- 美元的网络（零|int-网络时间单位为ms (connectEnd - fetchStart)
- 美元的服务器（零|int服务器时间单位为ms (responseStart - requestStart)
- 美元转移（零|int-传输时间(毫秒)(responseEnd - responseStart)
- domProcessing美元（零|intDOM处理到交互时间以毫秒为单位(domInteractive - domLoading)
- domCompletion美元（零|intDOM交互完成时间以毫秒为单位(domComplete - domInteractive)
- onload美元（零|int加载时间单位为ms (lodeventend - lodeventstart)
它返回一个这个美元价值。

`clearPerformanceTimings ()`

清除/重置之前设置的所有性能指标。

签名

它不返回任何东西，也不返回混合结果。

`setAttributionInfo ()`

设置访问的归属信息，以便后续的目标转换正确地归属于正确的推荐人URL，时间戳，活动名称和关键字。

这必须是一个JSON编码的字符串，通常会从JS API中获取:matomoTracker.getAttributionInfo()，并且您通过JSON2.stringify()编码了JSON。

如果你调用enableCookies()，那么这些引荐属性值将被设置为'ref'存储引荐信息的第一方cookie。

另请参阅

函数- https://github.com/matomo-org/matomo/blob/master/js/matomo.js中的getAttributionInfo()

签名

它接受以下参数:
- jsonEncoded美元（字符串-包含属性信息的JSON编码数组
它返回一个这个美元价值。
它会抛出以下异常之一:
- 异常

`setCustomVariable ()`

设置访问自定义变量。

参见//m.hju8.com/docs/custom-variables/

签名

它接受以下参数:
- $ id（int) -自定义变量槽号1-5
- 美元的名字（字符串-自定义变量名
- 美元的价值（字符串) -自定义变量值
- 美元的范围（字符串) -自定义变量范围。取值包括:visit、page、event
它返回一个这个美元价值。
它会抛出以下异常之一:
- 异常

`getCustomVariable ()`

返回当前分配的自定义变量。

如果scope是'visit'，它将尝试读取由Matomo Tracker ($_COOKIE数组)创建的第一方cookie中设置的值。

另请参阅

matomo.js- getCustomVariable ()

签名

它接受以下参数:
- $ id（int-从cookie中获取的自定义变量整数索引。应该是1到5之间的值吗
- 美元的范围（字符串) -自定义变量范围。取值包括:visit、page、event
返回:混合—数组格式为:array(0 => CustomVariableName, 1 => CustomVariableValue)或false
它会抛出以下异常之一:
- 异常

`clearCustomVariables ()`

清除可能已设置的任何自定义变量。

当您启用了批量请求，并且希望清除'visit'范围的自定义变量时，这可能很有用。

签名

它不返回任何东西，也不返回混合结果。

`setCustomDimension ()`

设置特定的自定义维度

签名

它接受以下参数:
- $ id（int) -自定义维度的id
- 美元的价值（字符串) -自定义维度的值
它返回一个这个美元价值。

`clearCustomDimensions ()`

清除以前设置的所有自定义维度

签名

它不返回任何东西，也不返回混合结果。

`getCustomDimension ()`

返回具有给定id的自定义维度的值

签名

它接受以下参数:
- $ id（int) -自定义维度的id
返回:字符串|零- - - - - -

`setCustomTrackingParameter ()`

设置自定义跟踪参数。如果你需要发送任何第三方插件的跟踪参数，这是很有用的，因为Matomo本身没有附带。请注意，自定义参数将在每次跟踪请求后清除。

签名

它接受以下参数:
- trackingApiParameter美元（字符串) -跟踪API参数的名称，例如'bw_bytes'
- 美元的价值（字符串) -该跟踪参数应发送的跟踪参数值。
它返回一个这个美元价值。
它会抛出以下异常之一:
- 异常

`clearCustomTrackingParameters ()`

清除/重置之前设置的所有自定义跟踪参数。

签名

它不返回任何东西，也不返回混合结果。

`setNewVisitorId ()`

将当前访问者ID设置为一个随机的新ID。

签名

它返回一个这个美元价值。

`setIdSite ()`

设置当前站点ID。

签名

它接受以下参数:
- idSite美元（int) - - -
它返回一个这个美元价值。

`setBrowserLanguage ()`

设置浏览器语言。当GeoIP未启用时，用于猜测访问者国家

签名

它接受以下参数:
- acceptLanguage美元（字符串) -例如“fr-fr”
它返回一个这个美元价值。

`setUserAgent ()`

设置用户代理，用于检测操作系统和浏览器。

如果未调用此函数，则用户代理将默认为当前用户代理。

签名

它接受以下参数:
- userAgent美元（字符串) - - -
它返回一个这个美元价值。

`setClientHints ()`

设置客户端提示，用于检测操作系统和浏览器。

如果未调用此函数，则将使用与当前请求一起发送的客户端提示。

Matomo 4.12.0支持