php ga4
1.0.0
composer require alexwestergaard/php-ga4A União Europeia notificou que o Google Analytics não cumpre o GDPR por padrão. Isso ocorre porque o cliente front-end envia detalhes do visitante, como endereço IP e informações do dispositivo, com eventos. Isto pode ser evitado com um servidor intermediário dentro da região europeia.
A configuração requer um ID de medição e um segredo de API . Vá para Administrador (canto inferior esquerdo) -> Conta -> Fluxos de dados -> {Seu fluxo}. Aqui você deve encontrar o Measurement ID na parte superior e "Api Secrets for Measurement Protocol" um pouco abaixo na página, onde você mesmo pode criar um API secret .
Vá para Administrator (canto inferior esquerdo) e selecione sua Account -> Data Streams -> seu fluxo.
Aqui você encontrará Measurement-ID na parte superior e mais abaixo Api Secrets for Measurement Protocol , lá você mesmo pode criar um API Secret .
Depois de obter as credenciais, você pode inicializar o Analytics assim:
use AlexWestergaard PhpGa4 Analytics ;
$ analytics = Analytics:: new (
measurement_id: ' G-XXXXXXXX ' ,
api_secret: ' xYzzX_xYzzXzxyZxX ' ,
debug: true | false #Default: False
); A marcação no lado do servidor não deve substituir o cliente front-end e o início da sessão deve acontecer por meio do cliente gtag.js O fluxo padrão deve acontecer da seguinte forma:
_ga e _gid de volta para Client/GTAG.js_ga (ou _gid ) para enviar/preencher eventos Nota: É perfeitamente possível enviar eventos para backend sem adquirir os cookies de sessão do Google Analytics; você, no entanto, perderá as informações agrupadas na solicitação GTAG.js se não descobrir como enviá-las também por meio do back-end. Você pode substituir as sessões _ga e _gid por seu próprio ID gerado exclusivamente.
Todas as solicitações devem seguir esta estrutura e conter pelo menos 1 evento para que o Google Analytics as aceite.
Analytics [
Events [
Event {
Parameters
? Items [
Item Parameters
]
}
]
User Properties [
Properties {
Key: Value
}
]
? Consent {
Key: Value
}
? User Data {
Key: Value
}
]Esta é uma lista de eventos pré-construídos conforme mostrado na documentação. Todos os eventos possuem os seguintes parâmetros para localizar o local do acionador de cada evento.
// 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 );Esta biblioteca foi criada para rastreamento do lado do servidor back-end, mas você provavelmente acionará a maioria dos eventos por meio do front-end com Javascript ou Websockets. Haverá 2 exemplos, um como back-end puro para eventos registrados/enfileirados e outro para comunicação de front-end para back-end.
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();
} Você pode criar seus próprios eventos personalizados. Tudo que você precisa é implementar e preencher a fachada/interface AlexWestergaardPhpGa4FacadeTypeEventType . Se quiser recursos de facilidade de vida, você pode estender seu evento de AlexWestergaardPhpGa4HelperEventHelper e sobrescrever conforme achar necessário.
// 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
}
} O protocolo de medição para GA4 tem funcionalidade de depuração que pode ser habilitada com o parâmetro debug no construtor do Analytics.
$ analytics = Analytics:: new (
measurement_id: ' G-XXXXXXXX ' ,
api_secret: ' xYzzX_xYzzXzxyZxX ' ,
debug: true // default: false
); Quando Debug está ativada, os eventos são enviados para https://www.google-analytics.com/debug/mp/collect , onde os problemas serão detectados com GA4Exception (esteja ciente das pilhas $exception->getPrevious() ); essa resposta será a seguinte:
{
"validationMessages" : [
{
"fieldPath" : " events " ,
"description" : " Event at index: [0] has invalid name [_badEventName]. Names must start with an alphabetic character. " ,
"validationCode" : " NAME_INVALID "
}
]
} Aviso: Esta biblioteca já valida se os eventos estão formatados corretamente quando adicionados às análises ( $analytics->addEvent(...) ).
Dois pontos importantes:
debugView no administrador do Google Analytics. page_view funciona, porém não está documentado na documentação oficial, portanto não confie nele. 
