Magento Open Source 2.2.x

Verifying the Google API Key

When opening Google Shopping ads, Magento automatically checks and validates the Google APIApplication Program Interface: A software interface that lets third-party applications read and write to a system using programming language constructs or statements. key you have added in your store configuration. If validated, we send you to the first step of onboarding: Step 1: Linking Magento and Google.

If the key is missing, invalid, or expired, you will need to update the Google API key The following instructions help you update your key and continue onboarding.

To add the Google API Key:

1. On the Admin sidebar, tap Marketing. Then under Advertising Channels, tap Google Shopping ads.

If your API key is invalid, the following screen displays to walk through the process.

Onboarding API Key Verification

2. Tap Sign in to log into your Magento web account. A new tab opens with Magento Accounts with the Api Portal tab open displaying the key.

You may need to login with your Magento web account credentials. If you need to create an account, visit here and register. This account should be part of your company or business.

3. To create a new key, enter a description like "Google Shopping ads" and tap Add.
4. Tap to copy your key.

Copy or generate an API Key

5. Return to the Magento Admin tab and tap Add the key on the Google welcome screen.

A store configuration page opens to Stores > Configuration > Services > Channels.

6. In the Google Shopping ads section, paste the key you copied for API key.
7. Tap Save Config.

Add the API Key

8. On the Admin sidebar, tap Marketing. Then under Advertising Channels, tap Google Shopping ads. Magento verifies and validates the entered API key, continuing with onboarding.

You can also enable service logs during this step. This option is disabled by default and should only be enabled when needed for troubleshooting, as continued logging will negatively impact performance.

checkContinue to Step 1