Skip to content

Configuration

The add-on reads Search Console with a service account of your own Google Cloud project. It needs read access only.

  1. Open console.cloud.google.com, create a project (or use one) and open APIs and services > Library. Search for Google Search Console API and click Enable. No billing account is needed.
  2. Open IAM and admin > Service accounts > Create service account. A name is enough; it needs no roles. Open the new account, Keys > Add key > Create new key > JSON. A .json file is downloaded.
  3. In CS-Cart open Website > Search Console, paste the contents of the file or upload it and click Save and test. The page shows the email address of the service account (it ends with iam.gserviceaccount.com).
  4. In Search Console open your property, Settings > Users and permissions > Add user, enter that email address and choose Restricted permission.
  5. Back in CS-Cart click Test connection. The add-on lists the properties the service account can read and picks the one of your storefront. You can choose another one or type it: sc-domain:example.com for a Domain property or https://www.example.com/ for a URL-prefix property.
  6. Click Sync now. The first sync takes a few seconds up to a minute on large stores.

On CS-Cart Ultimate select the storefront in the top bar first: every storefront has its own key and property.

The data is refreshed once a day by the cron job shown on the Search Console page, for example:

0 6 * * * php /path/to/store/admin.php --dispatch=kv_search_console.cron

Over HTTP use admin.php?dispatch=kv_search_console.cron&cron_password=... with the cron password of Settings > Security settings. After a failed sync the cron job tries again after two hours.

General

  • Enable: switches the dashboard, the tabs and the sync on or off.
  • Connection: status of the connection with a link to the Search Console page.
  • Reporting period: last 28 or 90 days. Search Console data is final about three days later, so the period ends three days ago.
  • Search Console tab on product and category pages.
  • Vendors see the tab on their own products (Multi-Vendor only). Vendors never see the dashboard or the key.

Quick wins

  • Minimum impressions (default 100), CTR below (%) (default 2) and Average position from / to (default 4 to 15).