README

跟踪原始UTM（或其他分析）参数

跨域分析很困难。此包可以帮助您跟踪访客的原始UTM参数、引用头和其他分析参数。然后您可以将这些参数随表单提交一起提交，或将它们添加到您跟踪的另一个域的链接中。

支持我们

我们投入了大量资源来创建最优质的开放式源代码包。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从家乡寄来明信片，并提到您正在使用我们的哪个包。您可以在我们的联系方式页面上找到我们的地址。我们将在我们的虚拟明信片墙上发布所有收到的明信片。

安装

您可以通过composer安装此包

composer require spatie/laravel-analytics-tracker

该包通过一个中间件工作，该中间件需要添加到您的kernel.php文件中的web堆栈。请确保在StartSession中间件之后注册此中间件。

// app/Http/Kernel.php

protected $middlewareGroups = [
    'web' => [
        // ...
        \Illuminate\Session\Middleware\StartSession::class,
        // ...

        \Spatie\AnalyticsTracker\Middleware\TrackAnalyticsParametersMiddleware::class,
    ],
];

要配置跟踪的参数或它们如何在URL参数上映射，您可以使用以下命令发布配置文件：

php artisan vendor:publish --provider="Spatie\AnalyticsTracker\AnalyticsTrackerServiceProvider"

这是发布配置文件的内容

return [
    /*
     * These are the analytics parameters that will be tracked when a user first visits
     * the application. The configuration consists of the parameter's key and the
     * source to extract this key from.
     *
     * Available sources can be found in the `\Spatie\AnalyticsTracker\Sources` namespace.
     */
    'tracked_parameters' => [
        [
            'key' => 'utm_source',
            'source' => Spatie\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_medium',
            'source' => Spatie\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_campaign',
            'source' => Spatie\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_term',
            'source' => Spatie\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_content',
            'source' => Spatie\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'referer',
            'source' => Spatie\AnalyticsTracker\Sources\CrossOriginRequestHeader::class,
        ],
    ],

    /**
     * We'll put the tracked parameters in the session using this key.
     */
    'session_key' => 'tracked_analytics_parameters',

    /*
     * When formatting an URL to add the tracked parameters we'll use the following
     * mapping to put tracked parameters in URL parameters.
     *
     * This is useful when using an analytics solution that ignores the utm_* parameters.
     */
    'parameter_url_mapping' => [
        'utm_source' => 'utm_source',
        'utm_medium' => 'utm_medium',
        'utm_campaign' => 'utm_campaign',
        'utm_term' => 'utm_term',
        'utm_content' => 'utm_content',
        'referer' => 'referer',
    ],
];

用法

获取跟踪参数的最简单方法是通过解析TrackedAnalyticsParameters类

use Spatie\AnalyticsTracker\AnalyticsBag;

app(AnalyticsBag::class)->get(); // returns an array of tracked parameters

您还可以装饰现有的URL，添加跟踪参数。这对于将分析转发到您运行的另一个域很有用。

<a href="{{ app(\Spatie\AnalyticsTracker\AnalyticsTracker::class)->decorateUrl('https://mywebshop.com/') }}">
    Buy this product on our webshop
</a>

Will link to https://mywebshop.com?utm_source=facebook&utm_campaign=blogpost

测试

composer test

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

贡献

请参阅贡献以获取详细信息。

安全漏洞

请查看我们的安全策略以了解如何报告安全漏洞。

鸣谢

• Alex Vanderbist
• 所有贡献者

许可

MIT许可证（MIT）。请参阅许可文件以获取更多信息。