X-Cart:Google Base

From X-Cart 4 Classic
Revision as of 16:40, 15 October 2012 by Dohtur (talk | contribs) (→‎Using Froogle/GoogleBase Export)
Jump to: navigation, search

What Froogle/GoogleBase module does

X-Cart's Froogle/GoogleBase module provides a tool that allows you to submit product feeds to Google Base so the products sold by your store can be found by Internet users using Froogle, Google's shopping search engine.

Froogle is an extension of Google dedicated to helping shoppers quickly find products for sale on the Web. Data in Froogle comes from two sources: product feeds submitted by merchants and a crawl of web pages that identifies product offers. A Froogle product feed is a text file containing specially formatted information about the products offered for sale by a store. As a merchant, you can submit information about your products in the form of a product feed so your products get included into Froogle listings. Submitting a product feed to Froogle is free.

X-Cart's Froogle/GoogleBase module facilitates creation and submission of product feeds to Froogle. It pulls data from all of the products in your store database, creates a properly formatted product feed file and uses FTP to submit this file to Google Base. Google Base then places the submitted product information in Froogle.

You also have the option of downloading the product feed file to your local computer for manual submission or other usage.

Regularly submitting product feeds to Froogle ensures that the information about your products in Froogle's listings is accurate and up to date.

Roles in Froogle/Google Base module management

If you are an X-Cart GOLD or GOLD PLUS administrator/provider or an X-Cart PLATINUM or PRO administrator:

If you are an X-Cart PLATINUM or PRO provider:

  • You can create Froogle/GoogleBase feeds that will include information about your products and submit them to Froogle via Google Base or download them onto your local computer (See #Using Froogle/GoogleBase Export).

Enabling and Configuring 'Froogle/Google Base'

To begin using the module enable Froogle/GoogleBase module (Administration menu->Modules). When the module is enabled, a section titled Froogle/GoogleBase options appears in General settings/Modules options.

Adjust the module settings via General settings/Modules options->Froogle/GoogleBase options:

Googlebase opts.gif

1. Provide the details of the FTP account which you are going to use for uploading data feed to Froogle/GoogleBase: enter your FTP account login and password into the 'Froogle/GoogleBase username' and 'Froogle/GoogleBase password' fields.

To set up an FTP account for use with Froogle/Google Base:
a) If you haven't yet done so, set up a Google account and sign in (You can use the 'Sign in' link provided on the http://www.google.com/merchants page).
b) Go to the 'Data feeds' section (http://www.google.com/merchants/bulkuploads).
c) Follow Google's instructions to create an FTP account - http://www.google.com/support/merchants/bin/answer.py?answer=160627.

2. Specify the type of currency in which you wish product prices to be displayed in Froogle. You should select the type of currency that is accepted by your store.

3. If you wish the customers who will come to your store from Froogle to come directly to the HTTPS part of the store, select the check box 'Generate links to the HTTPS part of the store'.

4. Specify, how many days the information about your products submitted to Froogle/GoogleBase needs to be considered up-to-date.

5. Click the Apply changes button.

Using Froogle/GoogleBase Export

To create a product feed file for Froogle/GoogleBase:

1. Make sure your product thumbnail images are stored on the file system. This is essential because the resultant product feed file will only reference images stored on the file system. If no thumbnail image for a product is found on the file system, the default 'No Image Available' file will be used for the product.

2. Go to the 'Froogle/GoogleBase export' section of the store's back end:

a) Open the 'Import/export data' section of the store's back end.
  • Depending on your role and the version of X-Cart you are using, you will find the Import/Export item in the Tools, Administration or Products menu.
b) Click the 'Froogle/GoogleBase export' link in the 'Import/export data' section menu.
You should see a dialog box titled 'Froogle/GoogleBase export'. This dialog box allows you to perform all the operations on Froogle product feeds (creation of product feed files, downloading of product feed files to your local computer or submission of product feeds to Froogle):
Google base.gif

3. Select a language to be used for export.

4. Make sure the filename proposed by the 'Filename' field is the name you wish to use for your Froogle product feed file (The filename is defined by default as username.txt - based on the Froogle/GoogleBase username you specified in General settings->Froogle/GoogleBase options; however, if you have more than one stores that send product feeds to Froogle, you might want to edit the filename so it includes your store ID - like yourstoreID_username.txt).

Note: If the 'Filename' field says froogle.txt and you do not see the Upload button, it means you probably failed to provide your FTP account details in General settings / Froogle/GoogleBase options section or the current PHP configuration on your store server does not support FTP. Fix the problem to be able to submit product feeds to Froogle/GoogleBase using the module.

5. Click the Export button. The module should create a product feed.

Note: The product feed file will be saved to the directory files (if you are a store administrator) or to the directory files/your_provider_name (if you are a provider).

You should see an Information box with a confirmation message.

To download the created product feed file onto your local computer, click the Download button.

To submit the product feed file to Froogle/Google Base directly, click the Upload button.

Learn how to upload export files using FTP here: http://www.google.com/support/merchants/bin/answer.py?answer=160627

IMPORTANT: Please be aware that Froogle/GoogleBase has some restrictions as to the format of tab-delimited bulk upload. Google's article says:
  • "Do not include tabs, carriage returns, or new line characters in the attributes. If any of these appear in an attribute, we will not be able to display that item."
  • "Do not include HTML tags, comments, and escape sequences. We will try to remove any HTML from your bulk upload, but for best appearance, you should not include HTML."

Because of the above restrictions, HTML tags and HTML entities are stripped from product names, descriptions, keywords and any other types of data being exported to Froogle/GoogleBase.

FAQs

How do I update the Google/Froogle module to meet the latest Google's Product Feed Specification?

X-Cart 4.3.0-4.3.2, 4.4.0-4.4.3

Update instructions for versions 4.4.0-4.4.3 and 4.3.0-4.3.2

1. Download the File:Array combine.php.txt file to your local computer, save it as "array_combine.php", then upload the "array_combine.php" file to the "include/lib/PEAR/Compat/Function/" directory in your X-Cart installation (create the directory first if it does not exist).

2. Apply the changes described in the File:Froogle patch.443.diff or File:Froogle patch.432.diff patch to the files "modules/Froogle/froogle.php" and "modules/Extra_Fields/func.php" in your X-Cart installation.

3. Apply the changes described in the File:Froogle patch.sql patch to your X-Cart database.

NOTE: Patch File:Froogle patch.443.diff can be installed on 4.4.0-4.4.3 versions of X-Cart.
NOTE: Patch File:Froogle patch.432.diff can be installed on 4.3.0-4.3.2 versions of X-Cart.
NOTE: If you use a version older than 4.4.0-4.4.3 or 4.3.0-4.3.2, please contact our support team via your personal Helpdesk area to get a custom solution for updating the module in your old version of X-Cart.

See also:

What attributes are included in the Google/Froogle product feed by default?

The list below shows the attributes, included in the Google/Froogle product feed by default, as well as the correspondence between the product feed attributes and X-Cart data:

IMPORTANT: If you use 4.4.3 and older version, please pay attention to the information provided below.

Here is the list of attributes which are not supported in 4.4.3 and older versions, or differ from the attributes included in the Google/Froogle product feed in version 4.4.4:

  • 'id' corresponds with X-Cart's product ID instead of product/variant SKU
  • 'item_group_id' is not supported (as 4.4.3 and older versions do not export each product variant data into Google/Froogle product feed, but main product data only)
  • 'availability' is not supported

Here is the list of obsolete attributes, exported to the Google/Froogle product feed in 4.4.3 and older versions:

IMPORTANT: If you use 4.4.3 or older version, it is highly recommended to update your Froogle module in order to meet the latest Google's requirements, as described this section.

See also:

How do I include Unique Product Identifiers in the Google/Froogle product feed?

You can include unique product identifiers in the Google/Froogle product feed using Extra Fields.

Here is the list of unique product identifiers, which can be added to your Google/Froogle product feed using Extra Fields:

  • gtin
  • mpn
  • upc
  • ean
  • jan
  • isbn
NOTE: Extra Fields are not currently supported in product variants. If you need to define unique product identifiers for each product variant individually, your X-Cart needs to be customized. Please contact our support team for assistance via your personal Helpdesk area.

See also:

X-Cart 4.4.4

To include Unique Product Identifiers in your product feed for version 4.4.4:

Here is a brief guide on including unique product identifiers in a product feed by the example of MPN and ISBN:

1. Create the Extra Fields that would correspond with the unique product identifiers to be included in your product feed.

Here is what Extra Fields would look like in case you need to include the MPN and ISBN attributes in your product feed:

Extra feilds.jpeg
IMPORTANT: Make sure the service names of your extra fields match the names of the corresponding attributes as specified in Google's Products Feed Specification. In our example, the names are respectfully "mpn" and "isbn".

2. Assign values to the Extra Fields that would correspond with the unique product identifiers for your products.

X-Cart 4.3.0-4.3.2, 4.4.0-4.4.3

To include Unique Product Identifiers in your product feed for earlier versions:

1. Install the update as suggested in this section.

2. Follow steps 1-2 of the "To include Unique Product Identifiers in your product feed for version 4.4.4" section above.

NOTE: If you use a version older than 4.4.0 or 4.3.0, please contact our support team via your personal Helpdesk area to get a custom solution for updating the module in your old version of X-Cart.

How do I include additional attributes in Google/Froogle product feed?

You can include additional attributes in the Google/Froogle product feed using Extra Fields.

Here is the list of additional attributes that can be added to your Google/Froogle product feed using Extra Fields:

  • google_product_category
  • color
  • size
  • material
  • pattern
  • gender
  • age_group

See also:

X-Cart 4.4.4

To include additional attributes in your product feed for version 4.4.4

Here is an example of how to add "size", "color" and "google_product_category" attributes to your product feed:

1. Create the Extra Fields that would correspond with the "size", "color" and "google_product_category" attributes to be included in your product feed.

Here is what the Extra Fields would look like in case you need to include the "size", "color" and "google_product_category" attributes in your product feed:

Additional attributes.jpg
IMPORTANT: Make sure the service names of your extra fields match the names of the corresponding attributes as specified in Google's Products Feed Specification. In our example, the names are respectfully "size", "color" and "google_product_category".

2. Assign values to the Extra Fields that would correspond with the "size", "color" and "google_product_category" attributes for your products.

X-Cart 4.3.0-4.3.2, 4.4.0-4.4.3

To include additional attributes in your product feed for earlier versions

1. Install the update as suggested in this section.

2. Follow steps 1-2 of the "To include additional attributes in your product feed for version 4.4.4" section above.

NOTE: If you use a version older than 4.4.0 or 4.3.0, please contact our support team via your personal Helpdesk area to get a custom solution for updating the module in your old version of X-Cart.

I have products that vary based on colors, materials, patterns, or sizes. How do I include my product variants data in the Google/Froogle product feed?

You can include product variants data in the Google/Froogle product feed using Product Options and the Extra Fields functionality.

For more information on the Product Variants attributes to be included in the product feed, please refer to:

X-Cart 4.4.4

To include product variants data in your product feed for version 4.4.4

Here is an example of how to include variants data for a product which only varies based on "size" and "color" in your product feed:

1. Create a product with options of variant type.

Here is what the product options would look like in case you need to include the "size", "color" attributes in your product feed:

Product options of variant type.png
IMPORTANT: Make sure the name of your product option group (option class) matches the name of the corresponding variant attribute as specified in Google's Products Feed Specification. In our example, the names are respectfully "Color" and "Size".

2. Create the Extra Fields that would correspond with the "size" and "color" attributes to be included in your product feed.

Here is what the Extra Fields would look like in case you need to include the "size" and "color" variant attributes in your product feed:

Additional attributes.jpg

That is all. Now, all the product variants based on "size" and "color" will be exported to your product feed, one item per variant, including the required variant data exported to the "size" and "color" attributes of your product feed.

X-Cart 4.3.0-4.3.2, 4.4.0-4.4.3

To include product variants data in your product feed for earlier versions

1. Install the update as suggested in this section.

2. Follow steps 1-2 of the "To include product variants data in your product feed for version 4.4.4" section above.

NOTE: If you use a version older than 4.4.0 or 4.3.0, please contact our support team via your personal Helpdesk area to get a custom solution for updating the module in your old version of X-Cart.

I use MPN (Manufactuers Part Number) as the SKU in our system. How do I make the SKU export as the MPN in my product feed?

X-Cart 4.4.4

Instructions for version 4.4.4

Modify your X-Cart source files as described below:

1. Find this code in '<xcart_dir>/modules/Froogle/froogle.php' file: 

/* Unique Product Identifiers */
"brand"

and change it to: 

/* Unique Product Identifiers */
"mpn\t" .
"brand"

2. Find this code in '<xcart_dir>/modules/Froogle/froogle.php' file: 

func_froogle_convert($product['manufacturer'], 256).

and change it to: 

$product['productcode']."\t".
func_froogle_convert($product['manufacturer'], 256).
X-Cart 4.3.0-4.3.2, 4.4.0-4.4.3

Instructions for earlier versions

1. First, install the update as suggested in this section.

2. Follow steps 1-2 of the "Instructions for version 4.4.4" section above.

NOTE: Feel free to contact our support team via your personal area should you require assistance with customizing your Google/FroogleBase product feed to meet your specific needs or with updating your Froogle/GoogleBase module in a version older than 4.3.0.

How do I export the 'refurbished' or 'used' condition in place of 'new' for my items?

When we generate a google data feed, it lists all products as "new". We have "new" as well as "refurbished" items. How do I populate the 'condition' attribute with the value specific for each individual item in my product feed?
X-Cart 4.4.4

Instructions for version 4.4.4

1. Create the Extra Field that would correspond with the "condition" attribute to be included in your product feed. Make sure to define its service name as "condition".

2. Assign the values to the "condition" Extra Field for your products. Make sure the values assigned meet Google's specifications.

3. Modify your X-Cart source files as described below:

3a) Find this code in '<xcart_dir>/modules/Froogle/froogle.php' file: 

"condition\t" .

and change it to: 

//"condition\t" .

3b) Find this code in '<xcart_dir>/modules/Froogle/froogle.php' file: 

$tmbn."\t".
"new\t".
$availability."\t".

and change it to: 

$tmbn."\t".
//"new\t".
$availability."\t".

The above changes remove the default "condition" attribute, prepopulated with the "new" value from your product feed.

3c) Find this code in '<xcart_dir>/modules/Froogle/config.php' file: 

/*
* Add a new value below to use the extra_field with the respective service_name for froogle export
*/
$froogle_additional_attributes = array(
/* Google's category of item */
"google_product_category",

and change it to: 

/*
* Add a new value below to use the extra_field with the respective service_name for froogle export
*/
$froogle_additional_attributes = array(
/* Google's category of item */
"google_product_category",
"condition",

The above changes add a new "condition" attribute, related to the respective extra field in your product feed.

X-Cart 4.3.0-4.3.2, 4.4.0-4.4.3

Instructions for earlier versions

1. First install the update as suggested in this section.

2. Follow steps 1-3 of the "Instructions for version 4.4.4" section above. Please note that the changes described in step 3c) should be applied to the '<xcart_dir>/modules/Froogle/froogle.php' file.

NOTE: Feel free to contact our support team via your personal area should you require assistance with customizing your Google/FroogleBase product feed to meet your specific needs or with updating your Froogle/GoogleBase module in a version older than 4.3.0.

How can I export both UPC and MPN for my variant products?

Some (most?) manufacturers use the same UPC for multiple products and change the part number (MPN), for instance if we have a shirt with a UPC of 1234567890987 but the MPN A1231 for white, A1232 for black, A1233 for blue, etc. Is there any way to add the MPN to each product variant?

Unfortunately, additional fields, such as MPN, are not supported in product variants; besides, X-Cart does not allow adding Extra Fields to product variants. However, there is still a solution:

1) First, you can enter MPN into the SKU field for each variant, as well as for the main product (i.e. use MPN as the SKU in your store).

2) Second, make the SKU field exports as MPN to your product feed. For more details please refer to this section;

3) Finally, create an Extra Field to add UPC for the main product, so that the same UPC would be used for all the product variants. For further details, please refer to this section.

What if there are multiple UPC codes for different product variants, can these be added as well?

Actually, Google does not require to provide both UPC and MPN for each product variant. Basically, you need to submit at least two attributes of 'brand', 'gtin' (which include UPC) and 'mpn'. So, you can provide either MPN or UPC for each product variant, for example using the variant's SKU field as described above.

See also:

NOTE: If you still need to provide both UPC and MPN for each product variant in your product feed, you would need a custom modification. Feel free to contact our support team via your personal Helpdesk area should you require assistance with customizing your Google/FroogleBase product feed to meet your specific needs.

Troubleshooting

X-Cart 4.4.4

Google data feed empty & "Too many column delimiters" error

The bug-fix for 4.4.4 can be found here:

X-Cart 4.4.4

Extra fields' default values are not exported into Froogle/GoogleBase product feed

The bug-fix for 4.4.4 can be found here:

See also

Retrieved from "https://help.x-cart.com/index.php?title=X-Cart:Google_Base&oldid=9003"