Installation guide for Magento Marketplace: Squarefeed for Magento 2

Table of contents

Introduction

Google Shopping Ads by Squarefeed is the easiest way for you to advertise your products using Google Shopping Ads.

It creates your product feed, submits it to Google Merchant, then publishes your Google Shopping Campaign to Adwords.

After your campaign is live, the module will show view the statistics right in your Magento admin panel and will update your product information on a daily or weekly basis.

In order for Squarefeed to work you need to install the Magento extension. During the installation process there will be an integration added to your store which will allow for communication between your store and our servers. If the integration is not active or doesn’t have the necessary permissions you will not be able to use the extension.

Installation

There are 3 ways to install the extension. the first two options (1 and 2) rely on Magento’s Setup Wizard and the third option is installation via the command line. If you’re getting errors during the installation process please email us at support@squarefeed.io and indicate your website URL and screenshots of the errors you are seeing.

1. Installation via Setup Wizard

The extension can be installed via Magento Setup Wizard in 2 ways. In both cases you should go to the System -> Web Setup Wizard -> Component Manager. 

1.1. Setup Wizard via FTP upload

  • Download the extension code from the Magento Marketplace
  • Using a FTP client such as FileZilla, connect to your server and go to the magento_root_folder. 
  • Navigate to the /app/code directory (if /code folder doesn’t exist, create it)
  • Create the following directory structure inside the /code folder: Adfix/Squarefeed/ 
  • Unzip the module and copy the contents to the above mentioned folder
  • Then go to the Setup Wizard interface, refresh the page and you will see the needed component.

Watch a screencast: https://cl.ly/0E1P0Z1Y251p 

Click on the ‘Select’ dropdown and click ‘Enable’

Click on ‘Start Readiness Check’ and if all is ok, ‘Next’ button is output. You can make a backups on the next step. 

This option is important (especially ‘Code’ and ‘Database’ backups) to make rollbacks, if something goes wrong (if you get errors during installation but you made code and database backups, you just can click ‘Rollback’ button on the last step and magento should return the previous state of store).

Note that this process can take 20 minutes or more.

Then you have the ability to enable extension and magento will deploy the code.

1.2. Setup Wizard via Magento Marketplace

You need to create an account on Magento Marketplace to use this option. If you don’t already have a Marketplace account, you can open one here.

Get the Squarefeed extension from the Marketplace, then in the account settings you should copy access keys to your account.

And put these keys in the Configuration tab on the Setup Web Wizard page. This should be done only one time to synchronize your account with Magento instance. When you add the keys into Magento, all purchases will be accessible in Magento.

Go to install link and you will see purchased extension

When you click install the extension, you will get the same steps as in option 1. [it will still take about 20 minutes]

2. Installation via Command Line

  • Download the extension code from the Magento Marketplace or from our GitHub
  • Using a FTP client such as FileZilla, connect to your server and go to the magento_root_folder. 
  • Navigate to the /app/code directory (if /code folder doesn’t exist, create it)
  • Create the following directory structure inside the /code folder: Adfix/Squarefeed/ 
  • Unzip the module and copy the contents to the above mentioned folder
  • (Optional) Make a backup
    • php bin/magento setup:backup --code --db
  • Set maintenance mode 
    • php bin/magento maintenance:enable
  • (Optional) Hard clean Magento deploy data. In this case you avoid Magento system error
rm -rf var/generation/*
rm -rf var/cache/*
rm -rf var/page_cache/*
rm -rf var/view_preprocessed/*
rm -rf var/di/*
rm -rf pub/static/*
  •  Upgrade data
    • php bin/magento setup:upgrade
  • Deploy code
    • php bin/magento setup:di:compile
  • Deploy static files
    • php bin/magento setup:static-content:deploy
  • Need to check /var and /pub/static directories. These folders and files which they contain should have write permission.
  • Disable maintenance mode 
    • php bin/magento maintenance:disable

3. Installation via Composer

  • (Optional) Make a backup
    • php bin/magento setup:backup --code --db
  • Set maintenance mode 
    • php bin/magento maintenance:enable
  • Run the next composer command to install extension from Magento marketplace
    • composer require adfix/squarefeed 
  • (Optional) Hard clean Magento deploy data. In this case you avoid Magento system error

rm -rf var/generation/*
rm -rf var/cache/*
rm -rf var/page_cache/*
rm -rf var/view_preprocessed/*
rm -rf var/di/*
rm -rf pub/static/*

  •  Upgrade data
    • php bin/magento setup:upgrade
  • Deploy code
    • php bin/magento setup:di:compile
  • Deploy static files
    • php bin/magento setup:static-content:deploy
  • Need to check /var and /pub/static directories. These folders and files which they contain should have write permission.
  • Disable maintenance mode 
    • php bin/magento maintenance:disable

Installation FAQ

Errors during installation

If you are getting errors during installation, please ask your developer to check if cron job is enabled.

I installed the extension but the configuration screen is not loading

After installation if you click on the Squarefeed icon in the Magento admin menu and nothing happens or you’re experiencing errors please follow these debugging steps:

  1. Tokens should be generated during installation and set in the integrations. If tokens are missing then the Magento instance cannot communicate with our servers. Therefore you have to check Admin Panel -> System -> Integrations. You should see an entry for Squarefeed in there and the status of the integration should be active.
  2. The extension doesn’t work if Magento (backend and/or frontend) is under http password protection. Please remove any password protection and try again.
  3. If there are any errors from our extension, it creates error logs on your server. magento_root/var/log/squarefeed.log should contain the info. In this case please contact our support <support@squarefeed.io>.
  4. Our extension makes a request to our servers to process the product data and display the configuration screen. If you have a firewall or are using an ad-blocker this can interrupt the communication between your Magento store and our server. Ensure that you deactivate your firewall and/or any ad-blocking extensions you may have installed on your browser.