Docs

Author: pascalbaljet

README.md

@@ -59,7 +59,7 @@ Add the directive somewhere after initializing/configuring GA. The POST request
 </script>
 ```
 
-If you don't use Axios, you have to implement this call by yourself.
+If you don't use Axios, you have to implement this call by yourself. By default the endpoint is `/gaid` but you can customize it in the configuration file. The request is handled by the `ProtoneMedia\AnalyticsEventTracking\Http\StoreClientIdInSession` class. Make sure to also send the [CSRF token](https://laravel.com/docs/7.x/csrf).
 
 ## Broadcast events to Google Analytics
 
@@ -165,9 +165,9 @@ class OrderWasPaid implements ShouldBroadcastToAnalytics
 You can configure some additional settings in the `config/analytics-event-tracking.php` file:
 
 * `use_ssl`: Use SSL to make calls to GA
-* `anonymize_ip`: Anonymize IP when making calls to GA
+* `anonymize_ip`: Anonymizes the last digits of the user's IP
 * `send_user_id`: Send the ID of the authenticated user to GA
-* `queue_name`: Specify a queue to make the calls to GA
+* `queue_name`: Specify a queue to perform the calls to GA
 * `client_id_session_key`: The session key to store the Client ID
 * `http_uri`: HTTP URI to post the Client ID to (from the Blade Directive)
 

config/config.php

@@ -13,14 +13,14 @@
     'use_ssl' => true,
 
     /**
-     * Anonymize IP when making calls to GA.
+     * Anonymizes the last digits of the user's IP.
      */
     'anonymize_ip' => true,
 
     /**
      * Send the ID of the authenticated user to GA.
      */
-    'send_user_id' => true,
+    'send_user_id' => false,
 
     /*
      * This queue will be used to perform the API calls to GA.

src/Http/StoreClientIdInSession.php

@@ -2,13 +2,17 @@
 
 namespace ProtoneMedia\AnalyticsEventTracking\Http;
 
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 
 class StoreClientIdInSession
 {
-    public function __invoke(Request $request, ClientIdSession $clientIsSession)
+    /**
+     * Stores the posted Client ID in the session.
+     */
+    public function __invoke(Request $request, ClientIdSession $clientIsSession): JsonResponse
     {
-        $data = $request->validate(['id' => 'required']);
+        $data = $request->validate(['id' => 'required|string|max:255']);
 
         $clientIsSession->update($data['id']);