realtydev/analyticstracker

跟踪原始UTM参数

dev-master 2020-12-28 23:51 UTC

This package is auto-updated.

Last update: 2024-09-29 05:43:03 UTC


README

Latest Version on Packagist GitHub Tests Action Status Total Downloads

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

支持我们

我们在创建最佳开源包上投入了大量的资源。您可以通过购买我们的付费产品之一来支持我们。

我们非常感激您从家乡寄给我们明信片,说明您正在使用我们的哪些包。您可以在我们的联系页面上找到我们的地址。我们将所有收到的明信片发布在我们的虚拟明信片墙上

安装

您可以通过composer安装此包

composer require realtydev/laravel-analytics-tracker

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

// app/Http/Kernel.php

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

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

要配置跟踪参数或它们如何映射到URL参数,您可以使用以下命令发布配置文件

php artisan vendor:publish --provider="realtydev\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 `\realtydev\AnalyticsTracker\Sources` namespace.
     */
    'tracked_parameters' => [
        [
            'key' => 'utm_source',
            'source' => realtydev\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_medium',
            'source' => realtydev\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_campaign',
            'source' => realtydev\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_term',
            'source' => realtydev\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'utm_content',
            'source' => realtydev\AnalyticsTracker\Sources\RequestParameter::class,
        ],
        [
            'key' => 'referer',
            'source' => realtydev\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 realtydev\AnalyticsTracker\AnalyticsBag;

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

您还可以用跟踪参数装饰现有的URL。这在将分析转发到您运行的另一个分析域非常有用。

<a href="{{ app(\realtydev\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

变更日志

有关最近更改的更多信息,请参阅CHANGELOG

贡献

有关详细信息,请参阅CONTRIBUTING

安全漏洞

有关如何报告安全漏洞,请参阅我们的安全策略

致谢

许可协议

MIT许可(MIT)。有关更多信息,请参阅许可文件