php ga4
1.0.0
composer require alexwestergaard/php-ga4Европейский Союз уведомил, что Google Analytics по умолчанию не соответствует GDPR. Это связано с тем, что внешний клиент отправляет данные о посетителях, такие как их IP-адрес и информацию об устройстве, вместе с событиями. Этого можно избежать с помощью сервера-посредника внутри Европейского региона.
Для установки требуется идентификатор измерения и секрет API . Перейдите в раздел «Администратор» (слева внизу) -> Учетная запись -> Потоки данных -> {Ваш поток}. Здесь вы должны найти идентификатор измерения вверху и «Секреты API для протокола измерения» немного ниже по странице, где вы можете создать себе API secret .
Перейдите в Administrator (внизу слева), а затем выберите свою Account -> Data Streams -> свой поток.
Здесь вы найдете Measurement-ID вверху и ниже Api Secrets for Measurement Protocol , там вы можете создать себе API Secret .
После получения учетных данных вы можете инициализировать Analytics следующим образом:
use AlexWestergaard PhpGa4 Analytics ;
$ analytics = Analytics:: new (
measurement_id: ' G-XXXXXXXX ' ,
api_secret: ' xYzzX_xYzzXzxyZxX ' ,
debug: true | false #Default: False
); Маркировка на стороне сервера не должна заменять внешний клиент, а инициирование сеанса должно происходить через клиент gtag.js Поток по умолчанию должен происходить следующим образом:
_ga и _gid обратно в Client/GTAG.js._ga (или _gid ) для отправки/заполнения событий. Примечание. Вполне возможно передавать события на серверную часть без получения файлов cookie сеанса из Google Analytics; однако вы потеряете информацию, включенную в запрос GTAG.js , если не поймете, как передать ее через бэкэнд. Вы можете заменить сеансы _ga и _gid своим собственным уникальным идентификатором.
Все запросы должны следовать этой структуре и содержать хотя бы одно событие, чтобы Google Analytics мог их принять.
Analytics [
Events [
Event {
Parameters
? Items [
Item Parameters
]
}
]
User Properties [
Properties {
Key: Value
}
]
? Consent {
Key: Value
}
? User Data {
Key: Value
}
]Это список предварительно созданных событий, как показано в документации. Все события имеют следующие параметры для определения местоположения триггера каждого события.
// Manual setting of each event
$ event -> setLanguage (string $ var );
$ event -> setPageLocation (string $ var );
$ event -> setPageReferrer (string $ var );
$ event -> setPageTitle (string $ var );
$ event -> setScreenResolution (string $ var );
// Fillable for multiple events
$ eventPage = AlexWestergaard PhpGa4 Helper EventParamsHelper ();
$ event -> setEventPage ( $ eventPage );Эта библиотека создана для отслеживания на стороне внутреннего сервера, но вы, вероятно, будете запускать большинство событий через внешний интерфейс с помощью Javascript или Websockets. Будет 2 примера: один как чистый бэкэнд для зарегистрированных/поставленных в очередь событий и один для взаимодействия между интерфейсом и сервером.
use AlexWestergaard PhpGa4 Exception ;
use AlexWestergaard PhpGa4 Analytics ;
use AlexWestergaard PhpGa4 Event ;
use AlexWestergaard PhpGa4 Item ;
// require vendor/autoload.php
$ visitors = getVisitorsAndEvents (); // pseudo function, make your own logic here
foreach ( $ visitors as $ collection ) {
// Group of events, perhaps need logic to change from json or array to event objects
// Maybe its formatted well for the > ConvertHelper::parseEvents([...]) < helper
$ groups = $ collection [ ' events ' ];
// If gtag.js, this can be the _ga or _gid cookie
// This can be any kind of session identifier
// Usually derives from $_COOKIE['_ga'] or $_COOKIE['_gid'] set by GTAG.js
$ visitor = $ collection [ ' session_id ' ];
// load logged in user/visitor
// This can be any kind of unique identifier, readable is easier for you
// Just be wary not to use GDPR sensitive information
$ user = $ collection [ ' user_id ' ];
// Render events grouped on time (max offset is 3 days from NOW)
foreach ( $ groups as $ time => $ data ) {
try {
$ analytics = Analytics:: new ( $ measurementId , $ apiSecret )
-> setClientId ( $ visitor )
-> setTimestampMicros ( $ time );
if ( $ user !== null ) {
$ analytics -> setUserId ( $ user );
}
$ analytics -> addUserParameter (... $ data [ ' userParameters ' ]); // pseudo logic for adding user parameters
$ analytics -> addEvent (... $ data [ ' events ' ]); // pseudo logic for adding events
$ analytics -> post (); // send events to Google Analytics
} catch ( Exception Ga4Exception $ exception ) {
// Handle exception
// Exceptions might be stacked, check: $exception->getPrevious();
}
}
} // array< array< eventName, array<eventParams> > >
axios . post ( "/your-api-endpoint/ga4-event-receiver" , [
// Note each event is its own object inside an array as
// this allows to pass the same event type multiple times
{
addToCart : {
currency : "EUR" ,
value : 13.37 ,
items : [
{
item_id : 1 ,
item_name : "Cup" ,
price : 13.37 ,
quantity : 1 ,
} ,
] ,
} ,
} ,
] ) ; use AlexWestergaard PhpGa4 Helper ConvertHelper ;
use AlexWestergaard PhpGa4 Exception ;
use AlexWestergaard PhpGa4 Analytics ;
use AlexWestergaard PhpGa4 Event ;
// require vendor/autoload.php
try {
$ events = ConvertHelper:: parseEvents ( $ _POST );
Analytics:: new ( $ measurementId , $ apiSecret )
-> addEvent (... $ events )
-> post ();
} catch ( Exception Ga4Exception $ exception ) {
// Handle exception
// Exceptions might be stacked, check: $exception->getPrevious();
} Вы можете создавать свои собственные события. Все, что вам нужно, это реализовать и заполнить фасад/интерфейс AlexWestergaardPhpGa4FacadeTypeEventType . Если вам нужны удобные функции, вы можете расширить свое событие из AlexWestergaardPhpGa4HelperEventHelper и перезаписать его по своему усмотрению.
// EventHelper implements AlexWestergaardPhpGa4FacadeTypeEventType
class ExampleEvent extends AlexWestergaard PhpGa4 Helper EventHelper
{
// variables should be nullable as unset() will set variable as null
protected null | mixed $ my_variable ;
protected null | mixed $ my_required_variable ;
// Arrays should always be instanciated empty
protected array $ my_array = [];
public function getName (): string
{
return ' example_event ' ;
}
public function getParams (): array
{
return [
' my_variable ' ,
' my_array ' ,
];
}
public function getRequiredParams (): array
{
return [
' my_required_variable ' ,
];
}
public function setMyVariable ( string $ value )
{
$ this -> my_variable = $ value ;
return $ this ; // Allows chained events
}
public function setMyRequiredVariable ( string $ value )
{
$ this -> my_required_variable = $ value ;
return $ this ; // Allows chained events
}
} Протокол измерения для GA4 имеет функцию отладки, которую можно включить с помощью параметра debug в конструкторе Analytics.
$ analytics = Analytics:: new (
measurement_id: ' G-XXXXXXXX ' ,
api_secret: ' xYzzX_xYzzXzxyZxX ' ,
debug: true // default: false
); Когда Debug включена, события отправляются на https://www.google-analytics.com/debug/mp/collect , где проблемы будут обнаруживаться с помощью GA4Exception (следуйте стекам $exception->getPrevious() ); такой ответ будет выглядеть следующим образом:
{
"validationMessages" : [
{
"fieldPath" : " events " ,
"description" : " Event at index: [0] has invalid name [_badEventName]. Names must start with an alphabetic character. " ,
"validationCode" : " NAME_INVALID "
}
]
} Примечание. Эта библиотека уже проверяет правильность форматирования событий при добавлении в аналитику ( $analytics->addEvent(...) ).
Два важных момента:
debugView в администраторе Google Analytics. page_view работает, однако оно не описано в официальной документации, поэтому не полагайтесь на него. 
