irazasyed / laravel-gamp
从Laravel发送分析数据到Google Analytics。一个用于GA测量协议API的包
Requires
- php: ^7.2 || ^8.0
- illuminate/support: ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0
- theiconic/php-ga-measurement-protocol: ^2.0
Suggests
- irazasyed/larasupport: Adds Package Support in Lumen, Lets you install any Laravel Package.
README
Laravel GAMP:Laravel & Lumen的Google Analytics测量协议包。
从Laravel/Lumen发送数据到Google Analytics。支持所有GA测量协议API方法。
快速入门
安装
步骤1:通过Composer安装
$ composer require irazasyed/laravel-gamp
(Lumen)添加服务提供者
打开bootstrap/app.php
并在其中添加服务提供者
$app->register(Irazasyed\LaravelGAMP\LaravelGAMPServiceProvider::class);
步骤2:发布配置
打开您的终端窗口并运行以下命令,将配置文件发布到您的配置目录
$ php artisan vendor:publish --provider="Irazasyed\LaravelGAMP\LaravelGAMPServiceProvider"
用法
打开配置文件config/gamp.php
,并将tracking_id
设置为您的Google Analytics跟踪/网站属性ID。请参考配置文件了解其他默认配置设置。
此包通过THE ICONIC提供的GA测量协议PHP库增加了Laravel的支持。它简单地封装了库,并提供默认配置以简化Laravel的使用。因此,这里列出的所有方法都是可用的,并且可以无缝工作。
示例用法
发送页面浏览会话
use Irazasyed\LaravelGAMP\Facades\GAMP; $gamp = GAMP::setClientId( '123456' ); $gamp->setDocumentPath( '/page' ); $gamp->sendPageview();
发送事件
use Irazasyed\LaravelGAMP\Facades\GAMP; $gamp = GAMP::setClientId( '123456' ); $gamp->setEventCategory('Blog Post') ->setEventAction('Create') ->setEventLabel('Using GAMP In Laravel') ->sendEvent();
配置概述
打开配置文件以获取每个选项的详细注释。
在tracking_id
键中设置您的Google Analytics跟踪/网站属性ID(必需)
'tracking_id' => 'UA-XXXX-Y',
所有其他配置选项都是可选的,根据您的需求使用。
要使用SSL发送数据,请将is_ssl
设置为true。
'is_ssl' => true,
要禁用测试/开发环境中的库(防止库向GA发送任何会话),请将is_disabled
设置为true。
'is_disabled' => true,
要匿名化IP,请将anonymize_ip
设置为true。
'anonymize_ip' => true,
要异步请求,请将async_requests
设置为true。
'async_requests' => true,
...
有关其他方法和示例的详细信息,请参阅库的文档,它们都可以正常工作。
注意:您不需要像原始库一样使用协议版本、跟踪ID、匿名化IP和异步请求(非阻塞)方法,因为这些在初始化包时根据配置文件自动设置。只要您更新配置文件以包含正确的设置,它应该就能正常工作。
附加信息
如有任何问题,请在此处报告
鸣谢
- Syed Irfaq R. - 为Laravel和Lumen桥梁。
- THE ICONIC - 为GA测量协议PHP库。
- 所有贡献者
许可
MIT许可(MIT)。有关更多信息,请参阅许可文件。