Install Search Statistics

This document describes how to install the Search Statistics feature.

Prerequisites

Install the required features:

1) Install the required modules using Composer

composer require spryker-eco/google-analytics:"^1.0.0" --update-with-dependencies

docker/sdk cli php -m | grep protobuf

docker/sdk boot your_deploy_file.yml && docker/sdk up

2) Generate transfer objects

console transfer:generate

3) Generate translations

console translator:generate-cache

4) Configure navigation

Update the analytics navigation entry in config/Zed/navigation.xml to add Search Statistics as a sub-page. Replace the existing <analytics> entry with the following:

config/Zed/navigation.xml

<analytics>
    <label>Analytics</label>
    <title>Analytics</title>
    <icon>bar_chart_4_bars</icon>
    <pages>
        <analytics>
            <label>Analytics</label>
            <title>Analytics</title>
            <bundle>analytics-gui</bundle>
            <controller>analytics</controller>
            <action>index</action>
        </analytics>
        <google-analytics>
            <label>Search Statistics</label>
            <title>Search Statistics</title>
            <bundle>google-analytics</bundle>
            <controller>search-statistics</controller>
            <action>index</action>
        </google-analytics>
    </pages>
</analytics>

Generate the router and navigation caches:

console router:cache:warm-up:backoffice
console navigation:build-cache

5) Configure TypeScript paths

In tsconfig.yves.json, add the TraceableEventWidget path alias to compilerOptions.paths:

tsconfig.yves.json

{
    "compilerOptions": {
        "paths": {
            "TraceableEventWidget/*": [
                "./vendor/spryker-shop/traceable-event-widget/src/SprykerShop/Yves/TraceableEventWidget/Theme/default/*"
            ]
        }
    }
}

6) Set up behavior

6.1) Synchronize configuration definitions

Import the Search Statistics configuration schema into the Configuration module:

console configuration:sync

6.2) Configure Google Analytics 4 credentials

Before you configure the Back Office, obtain the following parameters from Google:

• Measurement ID (format: G-XXXXXXXXXX): see Find your Measurement ID in the Google Analytics Help Center.
• Property ID: see GA4 Property ID in the Google Analytics Data API documentation.
• Service Account Credentials JSON: see Create and delete service account keys in the Google Cloud documentation.

Configure the Google Analytics 4 connection in the Back Office:

1. In the Back Office, go to Configuration, select Integrations in the sidebar, and open the Google Analytics tab.
2. In Storefront Tracking, set the Measurement ID (for example, G-XXXXXXXXXX).
3. In Data API Connection, set the Property ID and paste the complete JSON content of your Google Cloud service account key into Service Account Credentials JSON.
4. In Event Tracking > Product Events, enable Search. The storefront sends search events to GA4 only when this event is enabled. For details, see Google Analytics Event Tracking.