README

收集有价值的流量统计数据和洞察。

如何使用统计包

安装正确包

首先，让我们确保在您的 composer.json 文件中设置了 automattic/jetpack-stats 包

至少需要三样东西。一个是 automattic/jetpack-autoloader 包，这将确保您不会与站点上可能包含相同包的其他插件发生冲突。二是当然的 automattic/jetpack-stats 包。第三是我们 automattic/jetpack-config 包，这将作为初始化包的工具。

初始化包

其次，我们必须在您的插件中初始化（配置）jetpack-stats 包，并为其提供信息。

这就是 jetpack-config 和 jetpack-autoload 包发挥作用的地方。这样做，您就可以开始使用 Jetpack 连接了！

use Automattic\Jetpack\Config;

require_once plugin_dir_path( __FILE__ ) . '/vendor/autoload_packages.php';

function jpcs_load_plugin() {

	// Here we enable the Jetpack packages.
	$config = new Config();
	$config->ensure( 'stats' );
}

add_action( 'plugins_loaded', 'jpcs_load_plugin', 1 );

跟踪像素

统计包使用跟踪像素向 WordPress.com 发送信息。

这是通过在网站页脚中排入一个 JavaScript 文件来完成的 https://stats.wp.com/e-202103.js（数字每周都会变化，但文件保持不变）。那个 JavaScript 文件反过来在页面的末尾插入一个跟踪像素。例如：https://pixel.wp.com/g.gif?lots_of_parameters_here 当浏览器加载那个跟踪像素时，它实际上会向 WordPress.com 发送关于需要记录的信息。

跟踪参数

默认参数

正在跟踪的默认参数是通过 Automattic\Jetpack\Stats\TrackingPixel::build_view_data 函数构建的。

• v:（内部）用于区分托管在 WordPress.com 的站点和托管在自建站点的站点。枚举：ext, wpcom
• blog：站点的博客 ID
• post：站点的帖子 ID。如果没有帖子则为 0。
• tz：GMT 偏移量
• srv：服务器的 URL。

如何扩展默认参数

有一个过滤器可以用来跟踪更多参数。stats_array

add_filter( 'stats_array', 'filter_stats_array_add_custom_stat' );

/**
 * Add custom stat to the stats tracking data.
 *
 * @param  param array $kvs The stats array in key values.
 * @return array
 */
function filter_stats_array_add_custom_stat( $kvs ) {
	$kvs['custom_stat'] = 'my_custom_stat'
	return $kvs;

WPCOM 统计 API

统计包提供了一个易于使用的 API，可以从 WPCOM 获取数据。

可用方法

在 Automattic\Jetpack\Stats\WPCOM_Stats 类中，您可以找到以下方法。它们内部都依赖于以下方法 Automattic\Jetpack\Connection\Client::wpcom_json_api_request_as_blog。

• get_stats：获取站点的统计信息
• get_stats_summary：获取站点的总结视图、访客、点赞和评论。
• get_top_posts：获取站点的按视图排序的最高帖子。
• get_video_details：获取单个视频的详细信息。
• get_referrers：获取站点的引用者。
• get_clicks：获取站点的出站点击。
• get_tags：按标签和分类获取站点的视图。
• get_top_authors：获取站点的顶级作者。
• get_top_comments：获取站点的顶级评论作者和最多评论的帖子。
• get_video_plays：获取站点的视频播放。
• get_file_downloads：获取站点的文件下载。
• get_post_views：获取帖子的视图。
• get_views_by_country：按国家获取站点的视图。
• get_followers：获取站点的关注者。
• get_comment_followers：获取站点的评论关注者。
• get_publicize_followers：获取站点的公开关注者数量。
• get_search_terms：获取用于查找站点的搜索词。
• get_total_post_views：获取每个帖子的总浏览量。
• get_visits：获取网站的访问次数。

在您的WordPress插件中使用此软件包

如果您计划在您的WordPress插件中使用此软件包，我们建议您使用Jetpack Autoloader作为自动加载器。这将允许与其他也使用此软件包的插件实现最大兼容性。

安全

需要报告安全漏洞？请访问https://automattic.com/security/或直接访问我们的安全漏洞赏金网站https://hackerone.com/automattic。

许可证

stats软件包遵循GNU通用公共许可证第2版（或更新版）