Introduction
Google Shopping Akeneo Connector: With the help of Google Shopping Akeneo Connector, you can manage your Google Shopping product listings from Akeneo. You can export complete product catalog information on Google Shopping including product categories and product variations. It works with simple and collection types of products.
Please Note – Google Shopping Akeneo Connector module is compatible with Community Edition, Enterprise Edition, and Cloud (PaaS/Flexibility) Edition of Akeneo.
Basic Requirements:
- This module works with Akeneo 3.0.x, 3.1.x, 3.2.x, 4.0.x, 5.0.x,6.0.x and 7.0.x. Download Akeneo from here
- Node and Yarn packages need to be installed.
- Also works with Akeneo Cloud Flexibility Mode which is a PAAS Edition of Akeneo
Features
- Export categories from Akeneo to Google categories
- Detailed product information exported to Google products list
- Export variation products to the Google products list
- This module is compatible with the latest Akeneo version 7.0.x
- Support Google API Version 2.1
- Single export job for exporting all the product details
- Quick export feature added for product and product variants
Video Tutorial
Check out the following video tutorials below:
How to create Google Shopping credentials?
How to map attributes in Google Shopping?
How to create then export the product in Akeneo to Google Shopping?
Setup Credentials in Google Console
Follow the below steps to create Google Shopping Credentials to be used in Akeneo
- Visit merchants.google.com and sign in to get started.
- Go to content Content API section >Authentication tab create your authentication API keys.
- Then redirect to the https://console.developers.google.com then go to APIs& Services>credentials>OAuthConsent Screen Fill details after that save.
- Here you have to enter Authorized domain name.
- Click on create credential button.
- Find OAuth Client ID option here click on it.
- From Choose Application type select web Application. then give it a name.
- Find your redirect URI from google shopping akeneo connector and paste it to authorized redirect URI section.
- Here you get the secret key and client id.
- Find your clientID and Secret from here paste it in to google shopping connector fields, find your google merchant id from your google merchant account paste it to merchant id fields then authenticate your URL.
- now your connector is ready to use.
Installation
Two different types of module installation processes are available for the module.
- Composer Installation
- Manual Installation
Installation using Composer Installation
Before beginning the composer installation
1: Get the ACCESS KEYS [Create a support ticket]
2: In Akeneo composer.json, add our repository and the installation script.
For Akeneo 6.x and 7.x
{
"scripts": {
"post-update-cmd": [
"vendor/webkul/googleshoppingbundle/src/Webkul/GoogleShoppingBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
],
"post-install-cmd": [
"vendor/webkul/googleshoppingbundle/src/Webkul/GoogleShoppingBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
],
"post-create-project-cmd": [
"vendor/webkul/googleshoppingbundle/src/Webkul/GoogleShoppingBundle/install/config.sh COMPOSER=true NO_DOCKER=true"
]
},
"repositories": [{
"type": "composer",
"url": "https://akeneorepo.webkul.com/"
}]
}
For Akeneo <=5.x
{
"scripts": {
"post-update-cmd": [
"vendor/webkul/googleshoppingbundle/composer_install.sh"
],
"post-install-cmd": [
"vendor/webkul/googleshoppingbundle/composer_install.sh"
],
"post-create-project-cmd": [
"vendor/webkul/googleshoppingbundle/composer_install.sh"
]
},
"repositories": [{
"type": "composer",
"url": "https://akeneorepo.webkul.com/"
}]
}
3: Use composer to install the extension
composer require webkul/googleshoppingbundle
4: Complete the authentication form.
5: Send a Message of Success
6: Delete your browser’s cache.
Manual Installation for Version 6.x and 7.x
- After unzipping the appropriate extension zip, merge the “src” folder into the akeneo project.
- From the PIM directory, run the following command over the NO-DOCKER Instance.
./src/Webkul/GoogleShoppingBundle/install/config.sh COMPOSER=false NO_DOCKER=true
- After that run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/GoogleShoppingBundle/install/config.sh COMPOSER=false NO_DOCKER=false
Manual Installation for Version 4.0.x to 5.x
Please follow these steps for installing the Google Shopping Akeneo Connector module in your Akeneo PIM platform.
- Unzip the respective extension zip then merge “src” folder into akeneo project root directory.
- After that goto config/Bundles.php then add line:
Webkul\GoogleShoppingBundle\GoogleShoppingBundle::class => ['all' => true],
in return array.
- Copy the “config” folder into akeneo project root directory for routing.
- Run this command after ssh to your akeneo server by the terminal
rm -rf var/cache/ && php bin/console wk-google-shopping:setup:install --env=prod
- If you are using php-fpm. Then you need to restart the php-fpm services and apache web server.
For Akeneo 5
sudo service php-fpm7.4 restart
For Akeneo 4
sudo service php-fpm7.3 restart
To run the Quick export in Akeneo 5.0.x, you need to run the below command.
Install composer dependency
php -d memory_limit=4G /usr/local/bin/composer --prefer-dist --no-scripts require navneetbhardwaj/akeneo-quickexport-configurator;
After that, register bundle in config/bundles.php
Webkul\QuickExportConfiguratorBundle\QuickExportConfiguratorBundle::class => ['all' => true],
Define routing to create a file in the config/routes/wk_quick_export.yml
wk_quick_expoort: resource: "@QuickExportConfiguratorBundle/Resources/config/routing.yml" prefix: /
Docker Installation Command :
For Akeneo 5
alias docker_php='docker-compose run -u www-data --rm php php'; alias docker_yarn='docker-compose run -u node --rm node yarn'; docker_php bin/console cache:clear --env=prod; docker_php bin/console pim:installer:assets --symlink --clean --env=prod; docker_php bin/console d:s:u --force; docker_yarn run webpack; docker_yarn run update-extensions; docker_yarn run less;
For Akeneo 4
alias docker_php='docker-compose run -u www-data --rm php php'; alias docker_yarn='docker-compose run -u node --rm node yarn'; docker_php bin/console cache:clear --env=prod; docker_php bin/console pim:installer:assets --symlink --clean --env=prod; docker_php bin/console d:s:u --force; docker_yarn run webpack; docker_yarn run less;
Module Installation for Version 3.x
Please follow these steps for installing Google Shopping Akeneo Connector module in your Akeneo PIM platform.
- Unzip the respective extension zip then merge “src” folder into akeneo project root directory.
- Goto app/AppKernel.php then add the following line in function registerProjectBundles()
new Webkul\GoogleShoppingBundle\GoogleShoppingBundle(),
- After that goto app/config/routing.yml then add these lines at top of the file
google_shopping: resource: "@GoogleShoppingBundle//Resources/config/routing.yml" prefix: /
- You have to navigate first to Akeneo installation directory (Ex: cd /opt/bitnami/apps/akeneo/htdocs). After SSH, you have to run the command to your Akeneo server by the terminal.
rm -rf var/cache/ && php bin/console wk-google-shopping:setup:install --env=prod
-
If you are using php-fpm. Then you need to restart the php-fpm services.
sudo service php-fpm7.2 restart
Uninstall Module: For Akeneo 6 and 7
- From the PIM directory, run the command below over the NO-DOCKER Instance.
./src/Webkul/GoogleShoppingBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=true
- Run the command below over the PIM directory’s DOCKER instance.
./src/Webkul/GoogleShoppingBundle/uninstall/uninstall.sh COMPOSER=false NO_DOCKER=false
COMMON ISSUES AFTER INSTALLATION
It might happen that you see a loading screen even after proper installation upon opening your Akeneo admin dashboard. In that case, do check for the following solution:
- Webpack Installation: If you get the below error
It means that a web pack is not installed in your system. Run the following command
npm install --save-prod webpack npm install
- Module routing.yml is not configured properly. Re-check the routing.yml file as mentioned in the 3rd step of Module Installation
- Clear your browser cache.
Setup Credential in Akeneo
After successfully installing the module in Akeneo, you need to set up the Google Shopping API credentials in Akeneo. Please log in to Akeneo and follow Google Shopping Connector>Create Credential.
In Merchant Id, you need to enter your Google merchant id then enter the Google Shopping API Integration Tokens as created.
- Merchant Id
- Client Id
- Client Secret
Google Shopping Mapping Setting
In the Google Shopping Mapping Setting tab, you need to match the product fields between Google and Akeneo. You need to select the correct Akeneo attribute that matches to the Google Shopping product information.
- Title
- Additional Image Links
- Adword Grouping
- Adwords Label
- Adwords Redirect Link
- Brand
- Color
- Description
- Display Add ID, Add Link, Similar Add ID, and Add Title
- Identifier Exist
- Image Links
- Link
- Material
- MobileLink
- MPN
- Multipack
- Pattern
- Price
- Cost of Good Sold
- SalePrice
- Promotion ID
- Shipping Price
- Adults
- Age-Group
- Availability
- Availability Date
- Condition
- Custom Label
- Energy Efficiency Class
- Expiration Date
- Gender
- Global Trade Item Number
- Maximal product handling time
- Maximal product handling time
- Min Energy Efficiency Class
- Minimal product handling time
- Size System
- Size Type
- Shipping Height, Weight, Length, and Width Value
Status mapping information remains the same on both ends. So if a product is disabled in Akeneo, it will be disabled in Google Shopping as well.
Google Required Setting:
Some setting is required when we connect Google shopping to Akeneo connector.
Channel –Here you can select the channel model.
Local – You can sale in one country or a city.
Online – With this, you can sell the product worldwide.
Language – Content language is when the user can get the information in their own language.
Country – The target country is where a merchant wants to sell the product.
Option A – Creating A Product In Akeneo
To create a product in Akeneo, go to navigate to Products then click Create button. Now, you need to choose product type – as Product or Product Model.
Product – Select this type for creating simple and virtual products.
Product Model – Select this type for creating a configurable product with variations.
Now enter the required SKU, choose a family, then click the Save button.
Product Family – A family is a set of attributes that will be the same for all products belonging to a family. The product family represents products type, imposes product information structure and defines the list of attributes for a product that it belongs.
Add Product Details
Now you need to provide the information about the product. First, select the Channel as well as the Locale then enter the name after that and add the description.
Select Attribute
For adding product information, select attribute options you require. You can also create new options for the attribute. Following Attributes from Akeneo are supported for export:
- Brand
- Variant Name
- Weight
- Model picture
- SKU
- Supplier
- Price
- ERP name
- Color
- Size
- Composition
- Material
Color and Size
Here you can add color and size of the product.
Multi-Lingual Information
Add information to other languages and store views.
Add New Attribute Option
If an attribute option is missing for a select attribute type (simple or multi-select), you can directly add it to the Product Edit Form. Enter a Code and Label values, then click Save.
Select Category
After entering all the product information, save your changes after that go to Product Navigation then select Categories.
Google Shopping Export Job
Now to export your product data you need to create a job profile and then execute it.
First, go to Exports>Create Export Profile.
then enter a unique code, and label after that select a job profile.
Job Profiles
Google Product Export: Exports everything (categories, attributes, attribute options, attribute group families, and products) based on filters in a job. A product must have a category to be included in the export job.
Filter The Data
After that go to the Content section then select the following options:
Channel – Each export job can only be linked to one channel, please select the relevant channel of products to export.
Locales – Select one or more Locales depending on your requirements.
Attributes – You can select which product attributes you want to export all or few of them. Click the Edit button to select the attributes.
Filter The Products
Now you need to decide which products to export on Google Shopping.
Family
After that select one or more product families to export to Google Shopping. If you want to export products belonging to specific families, click on the drop-down list then click on the families to add in the field like clothing, shoes, and t-shirts.
Status
You can also filter on the status of your products, three options available:
Completeness
This enables you to filter on completeness of selected locales. Four options on completeness are proposed:
•
Time Condition
You can now export your product within a specific time condition.
- No date condition (default option) – Products are not filtered using time condition.
- Updated products over the last n days (e.g. 6) – To filter the products that were updated during the last six days, enter 6 value.
- Updated products since this date – To filter the products that were updated during a specific date, select a date.
- Updated products since last export
Category
After that you can configure the categories of the channel tree you want to export. For example, you want to export the clothing products to update.
By default, all categories are exported. To select a category, click on the Edit button the categories of the channel tree are displayed.
Identifier
You can make a selection of identifiers to export by adding them to the SKU field. You can copy then paste a list of identifiers, separated them by using comma, space or line breaks.
After that click Save button then follow the next step to execute this profile.
Export Now
After creating the export profile, click on the Export Now button. The execution of the export process will begin, the page will refresh continually to update the information.
Execution Process
Wait for the execution process to complete after that check the errors. After the completion of the export job, the products will appear in the Google Shopping product list.
Google Shopping Product List
As you can see that the following products have been imported from Akeneo. The merchant can view the products in Google Shopping.
The merchant can see the product details by clicking on the product.
Final Attribute of products
Here a merchant can see all the product details.
Quick Export Job
Google Shopping to Akeneo Connector has an amazing feature, where you can quickly create or export product(s) without going through all the job creation process. The Quick Export feature allows you to quickly export a product to Google Shopping.
To do that, go to the Products page then select product from the list after that click Quick Export.
Now select Google Shopping Export (All Attributes) option. After that small slide notification will stating Quick Export job has been launched.
you can check the progress of the job, by going to Activity>Process Tracker. Also, once the quick export job is complete, you can see the notification message on top.
Support
So, that was much about the User Guide of Google Shopping Connector for any queries or doubts reach out to us at [email protected]. You can also raise a ticket at our HelpDesk System.
Please explore our Akeneo Development Services and Quality Akeneo Extensions.
Current Product Version - Product Version - Akeneo 2 to 5 || 3.0.0 and Akeneo 6 || 4.0.0 and Akeneo 7 || 5.0.0
Supported Framework Version - Google Shopping Akeneo connector 3.0.x, 3.1.x, 3.2.x 4.0.x,5.0.x,6.0.x and 7.0.x
Be the first to comment.