improvements on null values in requests to ga v4

Author: markvaneijk

src/Analytics.php

@@ -83,22 +83,7 @@ public function getReport(GoogleAnalyticsService $googleAnalytics): AnalyticsRes
     {
         $client = $this->getClient();
 
-        $parameters = [
-            'property' => 'properties/'.$this->getPropertyId(),
-            'dateRanges' => $googleAnalytics->dateRanges,
-            'minuteRanges' => $googleAnalytics->minuteRanges,
-            'dimensions' => $googleAnalytics->dimensions,
-            'metrics' => $googleAnalytics->metrics,
-            'orderBys' => $googleAnalytics->orderBys,
-            'metricAggregations' => $googleAnalytics->metricAggregations,
-            'dimensionFilter' => $googleAnalytics->dimensionFilter,
-            'metricFilter' => $googleAnalytics->metricFilter,
-            'limit' => $googleAnalytics->limit,
-            'offset' => $googleAnalytics->offset,
-            'keepEmptyRows' => $googleAnalytics->keepEmptyRows,
-        ];
-
-        $response = $client->runReport(new RunReportRequest($parameters));
+        $response = $client->runReport(new RunReportRequest($this->reportParameters($googleAnalytics)));
 
         return $this->formatResponse($response);
     }
@@ -111,7 +96,22 @@ public function getRealtimeReport(GoogleAnalyticsService $googleAnalytics): Anal
     {
         $client = $this->getClient();
 
-        $parameters = [
+        $response = $client->runRealtimeReport(new RunRealtimeReportRequest($this->reportParameters($googleAnalytics)));
+
+        return $this->formatResponse($response);
+    }
+
+    /**
+     * Build the request parameters, dropping fields that were never set. The
+     * native protobuf extension rejects null (and empty) values that the
+     * pure-PHP implementation silently tolerates, so unset fields must be
+     * omitted rather than passed through as null.
+     *
+     * @return array<string, mixed>
+     */
+    protected function reportParameters(GoogleAnalyticsService $googleAnalytics): array
+    {
+        return array_filter([
             'property' => 'properties/'.$this->getPropertyId(),
             'dateRanges' => $googleAnalytics->dateRanges,
             'minuteRanges' => $googleAnalytics->minuteRanges,
@@ -124,10 +124,6 @@ public function getRealtimeReport(GoogleAnalyticsService $googleAnalytics): Anal
             'limit' => $googleAnalytics->limit,
             'offset' => $googleAnalytics->offset,
             'keepEmptyRows' => $googleAnalytics->keepEmptyRows,
-        ];
-
-        $response = $client->runRealtimeReport(new RunRealtimeReportRequest($parameters));
-
-        return $this->formatResponse($response);
+        ], fn (mixed $value): bool => $value !== null && $value !== []);
     }
 }

src/Traits/Google/MinuteRangeTrait.php

@@ -11,11 +11,7 @@ trait MinuteRangeTrait
     public function setMinuteRange(?string $name, ?int $start, ?int $end): self
     {
         $this->minuteRanges = [
-            new MinuteRange([
-                'name' => $name,
-                'start_minutes_ago' => $start,
-                'end_minutes_ago' => $end,
-            ]),
+            $this->makeMinuteRange($name, $start, $end),
         ];
 
         return $this;
@@ -26,16 +22,27 @@ public function setMinuteRanges(array ...$items): self
         $this->minuteRanges = [];
 
         foreach ($items as $item) {
-            $this->minuteRanges[] = new MinuteRange([
-                'name' => $item['name'],
-                'start_minutes_ago' => $item['start'],
-                'end_minutes_ago' => $item['end'],
-            ]);
+            $this->minuteRanges[] = $this->makeMinuteRange(
+                $item['name'] ?? null,
+                $item['start'] ?? null,
+                $item['end'] ?? null,
+            );
         }
 
         return $this;
     }
 
+    private function makeMinuteRange(?string $name, ?int $start, ?int $end): MinuteRange
+    {
+        // The native protobuf extension rejects a null name with
+        // "Cannot convert '' to string", so only set it when provided.
+        return new MinuteRange(array_filter([
+            'name' => $name,
+            'start_minutes_ago' => $start,
+            'end_minutes_ago' => $end,
+        ], fn (mixed $value): bool => $value !== null));
+    }
+
     private function validateStartAndEnd(?int $start, ?int $end): void
     {
         if ($start > $end) {