php ga4
1.0.0
composer require alexwestergaard/php-ga4La Unión Europea ha notificado que Google Analytics no cumple con el RGPD por defecto. Esto se debe a que el Cliente frontend envía detalles de los visitantes, como su dirección IP e información del dispositivo con eventos. Esto se puede evitar con un servidor intermediario dentro de la región europea.
La configuración requiere un ID de medición y un secreto de API . Vaya a Administrador (abajo a la izquierda) -> Cuenta -> Flujos de datos -> {Su flujo}. Aquí debería encontrar el ID de medición en la parte superior y "Secretos de API para el protocolo de medición" un poco más abajo en la página, donde puede crear usted mismo un API secret .
Vaya a Administrator (abajo a la izquierda) y luego seleccione su Account -> Data Streams -> su flujo.
Aquí encontrará Measurement-ID en la parte superior y más abajo Api Secrets for Measurement Protocol , allí puede crear usted mismo un API Secret .
Una vez que haya obtenido las credenciales, puede inicializar Analytics de esta manera:
use AlexWestergaard PhpGa4 Analytics ;
$ analytics = Analytics:: new (
measurement_id: ' G-XXXXXXXX ' ,
api_secret: ' xYzzX_xYzzXzxyZxX ' ,
debug: true | false #Default: False
); Se supone que el etiquetado del lado del servidor no reemplaza al cliente frontend y el inicio de la sesión debe realizarse a través del cliente gtag.js Se supone que el flujo predeterminado ocurre de la siguiente manera:
_ga y _gid a Client/GTAG.js_ga (o _gid ) para enviar/rellenar eventos Nota: Es completamente posible enviar eventos al backend sin adquirir las cookies de sesión de Google Analytics; Sin embargo, perderá la información incluida en la solicitud GTAG.js si no descubre cómo enviarla también a través del backend. Puede reemplazar las sesiones _ga y _gid con su propia identificación generada de forma exclusiva.
Todas las solicitudes deben seguir esta estructura y contener al menos 1 evento para que Google Analytics las acepte.
Analytics [
Events [
Event {
Parameters
? Items [
Item Parameters
]
}
]
User Properties [
Properties {
Key: Value
}
]
? Consent {
Key: Value
}
? User Data {
Key: Value
}
]Esta es una lista de eventos prediseñados como se muestra en la documentación. Todos los eventos tienen los siguientes parámetros para localizar la ubicación del activador 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 está diseñada para el seguimiento del lado del servidor backend, pero probablemente activará la mayoría de los eventos a través del frontend con Javascript o Websockets. Habrá 2 ejemplos, uno como backend puro para eventos registrados/en cola y otro para comunicación de frontend a backend.
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();
} Puedes crear tus propios eventos personalizados. Todo lo que necesita es implementar y completar la fachada/interfaz AlexWestergaardPhpGa4FacadeTypeEventType . Si desea funciones que le resulten más fáciles de usar, puede ampliar su evento desde AlexWestergaardPhpGa4HelperEventHelper y sobrescribirlo como mejor le parezca.
// 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
}
} El protocolo de medición para GA4 tiene una funcionalidad de depuración que se puede habilitar con el parámetro debug en el constructor de Analytics.
$ analytics = Analytics:: new (
measurement_id: ' G-XXXXXXXX ' ,
api_secret: ' xYzzX_xYzzXzxyZxX ' ,
debug: true // default: false
); Cuando Debug está habilitada, los eventos se envían a https://www.google-analytics.com/debug/mp/collect donde se detectarán los problemas con GA4Exception (tenga en cuenta las pilas $exception->getPrevious() ); dicha respuesta se verá de la siguiente manera:
{
"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 ya valida que los eventos tengan el formato adecuado cuando se agregan a análisis ( $analytics->addEvent(...) ).
Dos puntos importantes:
debugView en el administrador de Google Analytics. page_view funciona, sin embargo, no está documentado en la documentación oficial, así que no confíes en él. 
