README

这是一个用于Laravel Spark的自动Segment分析软件包，它将跟踪Segment中的所有页面浏览和电子商务事件。

安装

此版本需要PHP 7，并支持Laravel 5.5+和Spark 5+。

要获取最新版本，请使用Composer引入项目。

$ composer require keithbrink/segment-spark

在Laravel 5.5+上，将自动发现KeithBrink\SegmentSpark\SegmentSparkServiceProvider服务提供者和KeithBrink\SegmentSpark\SegmentSparkFacade外观，因此无需将其添加到配置中。在先前版本中，您需要手动将其添加到您的config/app.php文件中。

配置

首先，在您的.env文件中设置您的Segment写入密钥

MIX_SEGMENT_WRITE_KEY=xxx

使用MIX_前缀来允许在JavaScript中访问该值。

接下来，您需要发布资源

$ php artisan vendor:publish --provider="KeithBrink\SegmentSpark\SegmentSparkServiceProvider" --tag=resources

您还可以选择发布segment-spark.php配置文件

$ php artisan vendor:publish --provider="KeithBrink\SegmentSpark\SegmentSparkServiceProvider" --tag=config

第一个发布命令创建一个resources/js/segment-spark.js文件，这是一个Vue插件，您需要将其包含在您的resources/js/app.js文件中。

var SegmentSpark = require('./segment-spark.js');
Vue.use(SegmentSpark);

var app = new Vue({
    mixins: [require('spark')]
});

请记住，您需要运行npm run dev来编译您的资产。

如果您想将服务器端分析请求与由Google Analytics跟踪的客户端关联起来，您需要在app\Http\Middleware\EncryptCookies.php中的EncryptCookies中间件中添加一个异常，用于cookie加密。

protected $except = [
    '_ga',
];

添加User-ID Tracking到Google Analytics也是一个好主意。

使用方法

设置您的写入密钥并将Vue插件添加到app.js后，该软件包将自动跟踪您的所有页面浏览（包括设置页面上的各个选项卡），并将电子商务活动的事件发送出去，例如查看、订阅、续订、切换或取消计划。

登录用户将自动使用其用户ID（$user->id）进行跟踪，并将整个用户对象作为特性包含。

如果您正在使用Google Analytics，则服务器端事件将自动使用Google Analytics cookie来跟踪事件到正确的用户。请记住在Segment的Google Analytics设置中设置服务器端跟踪ID。

如果您想跟踪任何自定义事件，可以使用原始的Segment类。

Segment::track([
    "event"      => "XXX",
    "properties" => [
        "type" => "Video",
    ]
]);

或者，使用原始的JavaScript Segment库。

analytics.track(event, [properties], [options], [callback]);

Google Analytics增强电子商务

如果您想使用Google Analytics增强电子商务，此软件包将自动跟踪两个结账步骤：当用户点击某个计划的“选择”按钮（步骤1），以及当用户填写完账单信息后点击“订阅”按钮（步骤2）。您可以在Google Analytics增强电子商务设置中为这些步骤命名。

请记住，您需要在Google Analytics和Segment上激活Google Analytics增强电子商务。

许可

SegmentSpark是在MIT许可（MIT）下授权的。

感谢

此库借鉴了AltThree/Segment和Ipunkt/LaravelAnalytics的代码和设计结构。