fourlabs / gamp-bundle
Symfony 的 Google Analytics 测量协议包
Requires
- php: >=5.5
- symfony/framework-bundle: ~2.4||~3.0||~4.0||~5.0
- theiconic/php-ga-measurement-protocol: ^2.7
Requires (Dev)
- phpunit/phpunit: ^8.4
README
Google Analytics 测量协议包用于 Symfony。支持所有 GA 测量协议 API 方法。
安装
下载 Bundle
打开命令行控制台,进入您的项目目录,并执行以下命令以下载此 Bundle 的最新版本
$ composer require fourlabs/gamp-bundle
此命令需要您全局安装 Composer,如 Composer 文档中的 安装章节 所述。
与 Guzzle 5 和 6 的兼容性
如果您使用的是 PHP 5.5 或更高版本且使用 Guzzle 6,则
{
"require": {
"fourlabs/gamp-bundle": "^2.0"
}
}
或者,如果您使用的是 PHP 5.4 或更高版本且使用 Guzzle 5,则
{
"require": {
"fourlabs/gamp-bundle": "^1.1"
}
}
启用 Bundle
然后,在您的项目中的 app/AppKernel.php 文件中添加以下行以启用该 Bundle
<?php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new FourLabs\GampBundle\FourLabsGampBundle(), ); }
用法
此 Bundle 暴露了服务 gamp.analytics
。它是一个 非共享服务,即每次您检索服务时都将得到一个新的实例。
示例
$this->get('gamp.analytics') ->setTransactionId('7778922') ->setAffiliation('THE ICONIC') ->setRevenue(250.0) ->setTax(25.0) ->setShipping(15.0) ->setCouponCode('MY_COUPON') ->setProductActionToPurchase() ->setEventCategory('Checkout') ->setEventAction('Purchase') ->sendEvent() ;
有关其他方法和示例,请参阅 库的文档,它们都适用。此库 100% 支持所有 GAMP 功能。
注意:您不需要使用协议版本、跟踪 ID、匿名 IP 和异步请求(非阻塞)方法,因为它们将根据您的配置文件自动设置。
配置
app/config.yml
中的配置示例
four_labs_gamp:
protocol_version: 1
tracking_id: UA-XXXXXXX-X
use_ssl: true
anonymize_ip: false
async_requests: true
sandbox: true
在 tracking_id
键中设置您的 Google Analytics 跟踪 / 网站属性 ID (必需)
请参阅:https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#tid
tracking_id: UA-XXXX-Y
所有其他配置选项都是可选的,请根据您的需求使用。
协议版本。当前值是 '1'。默认值:1
请参阅:https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#v
protocol_version: 1
要使用 SSL 发送数据,将 use_ssl
设置为 true。默认值:true
请参阅:https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#tid
use_ssl: true
要匿名化 IP,将 anonymize_ip
设置为 true。默认值:false
请参阅:https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters#aip
anonymize_ip: true
要异步请求,将 async_requests
设置为 true。默认值:true
async_requests: true
当启用沙盒模式时,实际上不会向 GA 发送任何点击。在这种情况下,库将返回一个具有空值的 AnalyticsResponseInterface 对象。默认值:false
sandbox: true
致谢
此包是 GA 测量协议 PHP 库的包装器。感谢 THE ICONIC 的开发者们!