getPropertiesMetadata (dimenstions, metrics) sync action

Author: ondrajodas

src/Component.php

@@ -29,6 +29,7 @@ class Component extends BaseComponent
     private const ACTION_SEGMENTS = 'segments';
     private const ACTION_CUSTOM_METRICS = 'customMetrics';
     private const ACTION_GET_PROFILES_PROPERTIES = 'getProfilesProperties';
+    private const ACTION_GET_PROPERTIES_METADATA = 'getPropertiesMetadata';
 
     public function getConfig(): Config
     {
@@ -192,6 +193,21 @@ protected function runCustomMetricsAction(): array
         return $result;
     }
 
+    protected function getPropertiesMetadata(): array
+    {
+        $properties = $this->getConfig()->getProperties();
+        $viewId = $this->getConfig()->getQuery()['viewId'] ?? null;
+
+        $result = [];
+        try {
+            $result = $this->getExtractor()->getPropertiesMetadata($properties, $viewId);
+        } catch (RequestException $e) {
+            $this->handleException($e);
+        }
+
+        return $result;
+    }
+
     protected function getProfilesPropertiesAction(): array
     {
         return $this->getExtractor()->getProfilesPropertiesAction();
@@ -222,6 +238,7 @@ protected function getSyncActions(): array
     {
         return [
             self::ACTION_GET_PROFILES_PROPERTIES => 'getProfilesPropertiesAction',
+            self::ACTION_GET_PROPERTIES_METADATA => 'getPropertiesMetadata',
             self::ACTION_SAMPLE => 'runSampleAction',
             self::ACTION_SAMPLE_JSON => 'runSampleJsonAction',
             self::ACTION_SEGMENTS => 'runSegmentsAction',

src/Extractor/Extractor.php

@@ -404,4 +404,31 @@ private function getErrorMessage(string $message): string
             $reason
         );
     }
+
+    public function getPropertiesMetadata(array $properties, ?string $viewId = null): array
+    {
+        $metadata = [
+            'dimensions' => [],
+            'metrics' => [],
+        ];
+        foreach ($properties as $property) {
+            if ($viewId && $property['propertyKey'] !== $viewId) {
+                continue;
+            }
+            $propertyMetadata = $this->gaApi->getPropertyMetadata($property['propertyKey']);
+            foreach (['dimensions', 'metrics'] as $type) {
+                $metadataTypeExists = array_map(fn(array $item) => $item['apiName'], $metadata[$type]);
+                $propertyMetadataType = $propertyMetadata[$type];
+
+                $propertyMetadataType = array_filter($propertyMetadataType, function ($item) use ($metadataTypeExists) {
+                    if (in_array($item['apiName'], $metadataTypeExists)) {
+                        return false;
+                    }
+                    return true;
+                });
+                $metadata[$type] = array_merge($propertyMetadataType, $metadata[$type]);
+            }
+        }
+        return $metadata;
+    }
 }

src/GoogleAnalytics/Client.php

@@ -22,6 +22,7 @@ class Client
     private const MCF_URL = 'https://www.googleapis.com/analytics/v3/data/mcf';
     private const SEGMENTS_URL = 'https://www.googleapis.com/analytics/v3/management/segments';
     private const CUSTOM_METRICS_URL = 'https://www.googleapis.com/analytics/v3/management/accounts/%s/webproperties/%s/customMetrics';
+    private const PROPERTY_METADATA_URL = 'https://analyticsdata.googleapis.com/v1beta/%s/metadata';
     /** @phpcs:enable */
 
     protected GoogleApi $api;
@@ -76,6 +77,14 @@ public function getAccountProperties(int $pageSize = self::PAGE_SIZE): array
         return array_filter(array_merge([], ...$accountSummaries), fn(array $v) => isset($v['propertySummaries']));
     }
 
+    public function getPropertyMetadata(string $propertyId): array
+    {
+        $url = sprintf(self::PROPERTY_METADATA_URL, $propertyId);
+        $response = $this->api->request($url);
+
+        return json_decode($response->getBody()->getContents(), true);
+    }
+
     public function getAccounts(): array
     {
         $response = $this->api->request(self::ACCOUNTS_URL);

tests/functional/DatadirTest.php

@@ -15,7 +15,6 @@ public function __construct(?string $name = null, array $data = [], string $data
             'access_token' => getenv('ACCESS_TOKEN'),
             'refresh_token' => getenv('REFRESH_TOKEN'),
         ];
-
         putenv(sprintf(
             'CREDENTIALS_DATA=%s',
             json_encode($credentialsData)

tests/functional/get-profile-properties-sync-action-error-handling/source/data/config.json

@@ -4,7 +4,7 @@
       "credentials": {
         "appKey": "1025566943657-k9nvvskd1jbet47h0cuhmqktha05mf4s.apps.googleusercontent.com",
         "#appSecret": "%env(string:CLIENT_SECRET)%",
-        "#data": "%env(string:CREDENTIALS_DATA)%"
+        "#data": "{\"access_token\": \"invalid_access_token\", \"refresh_token\": \"invalid_refresh_token\"}"
       }
     }
   },

tests/functional/get-properties-metadata-sync-action/expected-stdout

@@ -0,0 +1 @@
+{"dimensions":[{%s}],"metrics":[{%s}]}

tests/functional/get-properties-metadata-sync-action/expected/data/out/files/.gitkeep

@@ -0,0 +1,25 @@
+{
+  "authorization": {
+    "oauth_api": {
+      "credentials": {
+        "appKey": "%env(string:CLIENT_ID)%",
+        "#appSecret": "%env(string:CLIENT_SECRET)%",
+        "#data": "%env(string:CREDENTIALS_DATA)%"
+      }
+    }
+  },
+  "parameters": {
+    "outputBucket": "in.c-ex-google-analytics-cfg",
+    "outputTable": "test",
+    "retriesCount": 1,
+    "properties": [
+      {
+        "accountKey": "accounts/185283969",
+        "accountName": "Keboola",
+        "propertyKey": "properties/255885884",
+        "propertyName": "users"
+      }
+    ]
+  },
+  "action": "getPropertiesMetadata"
+}