GoogleShoppingAPI v2

Min PHP version: 5.4

Magento Module GoogleShoppingAPI

This module is based on the official Magento GoogleShopping module and enhances the original module features with APIv2 support (APIv1 support removed), OAuth2 support and several additional features from the original EnhancedGoogleShopping module.

Data will be migrated from Magento GoogleShopping even if Magento GoogleShopping is not installed.

To prevent problems when users are editing products which have no access to GoogleShopping through OAuth2, products are only updated on GoogleShopping if a valid access token for the store exists.

To authenticate and get an access token go to Magento Admin -> Catalog -> Google Content APIv2 and select the store view in which you want to authenticate. After selecting a store view without valid access token you will be automatically redirected to OAuth2 authentication.

Features

• update item expiration date on sync
• option to renew not listed items on sync
• option to remove disabled items on sync
• convert html entities in description to UTF-8 chars
• strip tags from description
• make sales price available in countries outside the US
• possibility to define a separate google shopping image with base image fallback
• option to add Google Analytics source to product link (utm_source=GoogleShopping)
• option to add custom parameters to product link
• adds Austria as target country
• ability to set Google product category in Magento product details
• backend product edit: auto complete to choose the category for google shopping. DE and EN categories names are pre-installed.
• Debug logging
• Further refactorings

Events

The following events will get dispatched:

• gshoppingv2_attribute_* please see folder: Model/Attribute/
• and more @todo

To implement an observer for the events gshoppingv2_attribute_* you can use this example:

    /**
     * @dispatch gshoppingv2_attribute_imagelink
     *
     * @param Varien_Event_Observer $observer
     *
     * @return mixed
     */
    public function convertImageAttribute(Varien_Event_Observer $observer)
    {
        /** @var Mage_Catalog_Model_Product $product */
        $product = $observer->getEvent()->getProduct();
        /** @var Google_Service_ShoppingContent_Product $shoppingProduct */
        $shoppingProduct = $observer->getEvent()->getShoppingProduct();
        /** @var Varien_Object $dispatchNotifier */
        $dispatchNotifier = $observer->getEvent()->getDispatched();

        // some fancy code ...

        if ($_productThumbnail) {
            $shoppingProduct->setImageLink($_productThumbnail);
            $dispatchNotifier->setData('has_changes', true);
        }
    }

Installation

As the Google ApiClient must be installed in addition, it is recommended to install using composer.

Create or adapt the composer.json file in your Magento root directory with the following content:

{
	"require": {
		"zookal/gshoppingv2": "1.0.0",
		"zookal/google_apiclient": "dev-master"
	},
	"suggest": {
	    "magento-hackathon/magento-composer-installer": "*",
	},
	"repositories": [
		...
		{
				"type": "vcs",
				"url": "[email protected]:Zookal/GoogleShoppingApi.git"
		},
		{
				"type": "vcs",
				"url": "[email protected]:Zookal/google-api-php-client.git"
		}
	],
	...
}

Install composer

mkdir bin
curl -s https://getcomposer.org/installer | php -- --install-dir=bin
php bin/composer.phar install

Configuration

As the module has to use Google OAuth2 a ClientId and ClientSecret for Google Content API is required. This can be generated in the http://console.developers.google.com/

Create a project in Google developers console

• Login to Google developers console or create an account
• Create a Project
  • Name: Magento-GoogleShoppingApi
  • Project-ID: use the generated id or something like magento-gshopping-841
• After the project is created go to "APIs & auth" -> "APIs"
• Search for "Content API for Shopping" and enable it
• Next go to "APIs & auth" -> "Credentials" and click "Create new Client ID"
• Select "Web application"
  • Fill out the fields "Email address" and "Product name"
  • save
• In the next step the shop backend data has to be enterend
  • "Authorized JavaScript origins": https://www.yourmagentobackend.com/
  • "Authorized redirect uris":
  • https://www.yourmagentobackend.com/index.php/admin/gShoppingV2_oauth/auth/
• After finishing the process you can see your API credentials
  • Client ID and Client Secret must be entered in the Magento Module Configuration

Magento Module Configuration

• Basic Module configuration: Magento Admin -> System -> Configuration -> Catalog -> Google Shopping V2

  • Account-ID: Your GoogleShopping Merchant ID
  • Google Developer Project Client ID: The Client ID generated above
  • Google Developer Project Client Secret: The Client Secret generated above
  • Target Country: The country for which you want to upload your products
  • Update Google Shopping Item when Product is Updated
    • Not implemented (observer disabled in current version, will be readded)
  • Renew not listed items
  • When syncing a product which is not listed on GoogleShopping, it will be added
  • Remove disabled items
  • Removes items which are disabled or out of stock from GoogleShopping

• Product configuration

  • In Product edit view you will find a new tab "Google Shopping". Here you can set the Google Shopping Category. The language of the category is taken from the configured store language. Around 6200 taxonomies for each language de_DE and en_US are shipped with the module package and loaded into a database table. Via backend text field you must use the autocomplete to retrieve the appropriate category.

• Attributes configuration and item management can be found in Magento Admin -> Catalog -> Google Content APIv2

• Before uploading an item you will have to set the attribute mapping

  • Magento Admin -> Catalog -> Google Content API V2 -> Manage attributes
  • See https://support.google.com/merchants/answer/1344057 for requirements
  • Example for default attribute set
    • SKU => Manufacturer's Part Number (MPN)
    • Condition => Condition
      • You might have to add the attribute condition as DropDown with the Options new, refurbished, used
    • Name => Title
    • Description => Description
    • Price => Price
      • Sales price is taken if set
    • EAN13 => GTIN
      • You need 2 out of 3 (MPN, GTIN, Brand), so you might add a similar attribute
    • Manufacturer => Brand

Taxonomies

• http://www.google.com/basepages/producttype/taxonomy.en-US.txt
• http://www.google.com/basepages/producttype/taxonomy.de-DE.txt

Contribute

Something missing or wrong? Open an issue or send a PR. ☺️