Skip to main content

Product Feed

Overview​

If customers sell their products on a variety of channels such as Google Shopping, Ebay, Amazon, etc and these channels use the same database, then they can automatically update their items by importing the exported data files from the original channels. Thanks to this, store owners can save more time and manage their sales channels with ease. That's also an awesome feature from Mageplaza Product Feed extension.

Download & Install​

How to use​

Google Shopping API:​

  • Register an account of Google Shopping API and go to this link.
  • After your account has been registered, you will see the value in the field Merchant ID. Save that Merchant ID value to connect with your website later.

  • Go to this link to get the information of 8Google Shopping API: Client ID and Client Secret connect with your website. Click on Create Credentials > OAuth client ID.

  • With the field Application type, you can choose Web application, enter the information like Name. Copy and paste the value of the field Authorized Redirect URLs of your website in the field Authorized Redirect URLs of Google Shopping API. Then click Create button to complete.

  • Select Ok to complete creating OAuth client ID. Save the Client ID and Client Secret to connect with your website.

How to configure​

From the Admin Panel, go to Store > Settings > Configuration > Mageplaza Extensions > Product Feed > Configuration

Configuration​

From the Admin Panel, go to Products > Product Feed > Configuration, choose General section

General​

  • Enable: Choose "Yes" to use this module
  • Categories Path for Product URLs: Create the URL for the product. If select Default, the URl will be generated as the default Magento (Category with the smallest ID).
    • Note: Categories Path is only correct when setting Use Categories Path for Product URLs = Yes

  • Enable Product Feed Report: Select Yes to display the Product Feed Report on the Manage Feeds Grid.
  • Clean Log Every: Select the number of days to clean the created logss at Feed Log after the selected time. If empty or zero, the log will not be cleaned.

Google Shopping API​

  • Enable: Choose Yes to synchronize the value with Google Shopping API
  • Send data every: Select the number of days in the Send data ever field. After the selected number of days, the feed data will be synced to Google Shopping API. Note that this feature is only applied to sync via cron.
  • Merchant ID, Client ID, Client Secret: Enter the value of the fields you have already saved and set up here.
  • Authorized Redirect URLs: Copy and paste the value of this section in URLs of the **Authorized Redirect URLs of Google Shopping API.
  • Click Get Access Token button to check the connection with Google Shopping API.

Email Alert​

  • Enable: Choose "Yes" to enable the email notification for store owners
  • Send to:
    • Enter the email to send the notification
    • Allow entering multiple emails. These emails are separated by commas.
  • When:
    • Choose the events that when it happens, the email notification will be sent
    • Be able to choose many events at once time

Manage Feeds​

Grid​

  • From the Admin Panel, go to Catalog > Product Feeds > Manage Feeds

  • This is where all created feeds are displayed.
  • Here admins can have basic information of the feed such as: ID, Name, Status, File Type, Execution Mode, Store, Action, Click, Impression, CTR,...
  • Admins can select Action if they want to Delete, Generate, or Change Status Feed.
  • Besides that, admins can also Filter, Export, Hide/Show the Columns
  • Note: CTR (Click through rate)= (Click/ Impression) * 100%
    • Click: the number of clicks in the product link uploaded to the app or the feed file
    • Impression: the number of views of the product link uploaded to the app or the feed file

Product Feed Revenue Report​

The Revenue Report is based on the statistic of the ordered products uploaded to the feed file or the app. The pie and column charts shown are the results of the Total Revenue field, with the top 20 feeds with the highest revenue.

Pie chart:

Column chart:

Note: Total Revenue and Refunded do not include the shipping fee.

How to create New Feed​

  • Step 1: Enter full information of General field
  • Step 2: Choose Template type
  • Step 3: Enter full information of Google Analytics
  • Step 4: Choose the condition to export the file
  • Step 5: Enter the Category Map for products
  • Step 6: Setup the method to send the exported file
  • Step 7: Check the update history of the exported file
Step 1: Enter full information of General field​

  • From the Admin Panel, go to Products > Catalog > Product Feed > Manage Feeds

  • In the right corner, choose Add New Feed button

  • Name: Enter the display name in the Grid Feed for the export type

  • Status: Choose Enable to auto-update the products when running cron

  • Store Views: Choose the store to get that store’s product and generate the file

  • File Name: Enter the export file name to send to the server

  • Compress File: Choose the format to compress the file when downloading

  • Generate Config: Choose the export type

    • Execution Mode = Manual: Allow generating the file manually

    • Execution Mode = Cron: Auto-generate the file, depend Frequency & Cron Run Time field

      • Frequency = Daily: Auto-generate the file daily
      • Frequency = Weekly: Auto-generate the file weekly
      • Frequency = Monthly: Auto-generate the file monthly
      • Cron Run Time: Setup the time to auto-generate the file at the time that you have setup. Please note that the time of Cron Job will be the timezone of UTC

Step 2: Choose Template type​
  • Select the template format to export the file. There're 5 template formats. They are: Google Shopping, Google Shopping Review, Amazon Inventory, Amazone Marketplace, Facebook, Ebay and you can choose to customize as your preference.
  • After selecting the Default Template, it will depend on File Types including: TXT, CSV, and XML, TSV, XLS
  • Click on the Load Template button to display the template content
  • For the template format is XML:
    • Template content: The template content is displayed in this field. Admins can edit the template content here.
    • Add the values to the template by clicking on the Insert Variable button.

  • For the template format is CSV
    • Choose the character separating the fields when exporting the file in the Field Separate field
    • Select the character surrounding the fields when exporting the file in the Field Around field
    • To get the header field when exporting the file, choose "Yes" in the Include Field Header field
    • Allow adding any value you want into the Fields Map field. Please note that: The added values must be standard of Google or Facebook or Ebay, Amazon.

Step 3: Enter full information of Google Analytics. These values will be added into URL of the product to know what the search engine is, what analytic keyword is, etc.​
  • Enter the value for the Campaign Source field
  • Enter the value for the Campaign Medium field
  • Enter the value for the Campaign Name field
  • Enter the value for the Campaign Term field
  • Enter the value for the Campaign Content field

Step 4: Product Filter: Choose the condition to export the file. All products meeting the conditions will be exported.​

  • Here you can select the conditions for the feed. Only apply the rules for products meeting the conditions.

  • Maximum Product Displayed on Preview Product: Enter the maximum number of products shown in the Preview Product. If left empty, the number of displayed products when clicking the Preview Products button will not be limited.

Step 5: Enter the Category Map for products. Admins can choose and classific according to the availabe suggestions. For the categories with the same level, it will get the classification type of the top-level category.​

Step 6: Setup the method to send the exported file​
  • Delivery Config: Setup the method to send the exported file to the server
    • To send the exported file to the server, choose "Yes" in the Delivery field
    • Choose the method to send the file in the Protocol field: FTP or SFTP, HTTP Server, API, GraphQL.
      • For the FTP protocol, you can add the selection to use Passive Mode or not. We recommend that you should this mode to avoid being blocked by firewalls/NATs/proxies from sending files to the server.
      • HTTP Server: Send to the HTTP server by sending POST request. For example: https://httpbin.org/post
      • API / GraphQL: Send the feed file to API, GraphQL by sending POST, GET,... requests. For example: http://mageplaza/rest/V1/mpProductfeed/feed/file/, http://mageplaza/graphql,...
    • Enter the host name in the Host Name field
    • Enter the user name in the User Name field
    • Enter the password to access the host in the Password field
    • Private Key: Click [...] and choose key file to connect with the server. You can skip choosing key file when your server can connect without key file.
    • If you want to save the file, only enter the path in the Directory Path field. Note: You need to set the name the export file at the end of the path
    • Request URL: Show this field when selecting Protocol as HTTP Server, API, GraphQL. Enter URL to send POST, GET,... request to HTTP Server, API; GraphQL.
    • Headers: Show this field when selecting Protocol as HTTP Server, API, GraphQL. Enter content to send POST, GET,... request. For example: Content-Type: application/json
    • To check whether it is connected to the host, press Test Connection

  • Step 7: Check the update history of the exported file. Admins can check the update history of the file in the Logs field.

  • Step 8: Synchronize product value with Google Shopping API

Choose the information of the fields in Magento appropriately to send data to Google Shopping API. This tab will appear when Template File Type = XML.

  • Google Shopping API Field: Display the fields which are managed by Google Shopping API for this module based on the selected Magento fields.
  • Magento Fields:
    -> Fill in the Magento fields to get the data corresponding to the fields of Google Shopping API. -> If you leave this column blank or no value is existing, the Default value will be arquired and push to Google Shopping API.
  • Internal Note: Enter the description in the Internal Note section. This is only for admin to notice the information of the synchronization and is invaluable to data processing.
  • Insert Variables: Select the Magento Fields corresponding to the fields of Google Shopping API.
  • You can sync manually or sync via cron data from attributes of Magento Field to Google Shopping API.

Logs​

From the Admin Panel, go to Products > Catalog > Product Feed > Logs

This section will record the change of feeds such as status, type, notification, etc. When you click on any file, it will automatically open the file.

Email notification about the status of the file​

Click on the View Logs, it will redirect the email recipients to the Feed Logs page to view the logs details.

How to Run Command to Generate Feed​

To generate one or more feed quickly, you can run the following command line:

php bin/magento mp-productfeed:generate {id}

  • In which: {id} is the Feed ID. If you do not fill Feed ID, all the feed will be generated.

  • Example: Generate some feed that you want, running the command:

php bin/magento mp-productfeed:generate 1 3 4

Note:

  • After installing the extension, you need to download Liquid by running the command composer require liquid/liquid or need to install the library
  • When the extension is enabled, Manage Feed and Logs will be displayed
  • To reload data of Report, you need to run the command: php bin/magento mp-productfeed:report

FAQs​

  • Question: How to solve the issue of Product URL does not show correctly?

  • Answer: Find the solution here.

Must-have extensions for your Magento stores​