Magento 2 Extended Rich Snippets Manual

Extended Rich Snippets Cover

Introduction

Attracting the targeted traffic has become one of the most important tasks for websites owners these days. Rich Snippets single a website out in the crowd of competitors by means of adding extra details, such as prices, qty, images, etc. to the search results pages.

Rich Snippets module extends the standard markup Magento 2 functionality and introduces a bunch of useful extra features:

• Snippets on the product pages support the JSON-LD method. This method lets to entirely separate the markup data from the HTML code. So one doesn’t need to tweak the actual HTML elements, when using it.

• Organization Info. This feature allows to provide the customers with business information of the store owner, such as store name & description, location, social links, phone, etc. This results in broader recognition of the store.

• The Open Graph protocol allows any web page to become a full-fledged object in social networks such as Facebook, Google+, or LinkedIn. The Twitter Cards manage the display of the webpages in Twitter links

Requirements and Installation

Extended Rich Snippets supports both Community and Enterprise edition of Magento starting from version 2.1. The current version of the Magento installed on your website can be found in the lower right corner of any backend page.

Magento 2 Version

Extended Rich Snippets has 2 separate ways of installation: via Composer or by copying the code.

Installation Via Composer

  1. Create a folder anywhere on your server (preferably not in the Magento installation directory). Put the zip archive into this folder.

  2. Use any SSH client to connect to your server. Navigate to the root Magento folder. Bear in mind that the user should write permissions to this folder and its subfolders.

  3. Add the folder with the extension's archive as a repository. For this, run the Composer command:

    composer config repositories.mageworx artifact {/ABSOLUTE/PATH/TO/FOLDER}
    

    like:

    composer config repositories.mageworx artifact /mageworx/extensions/zip
    

    This command will add these lines to your composer.json file:

    "mageworx": {
        "type": "artifact",
        "url": "/mageworx/extensions/zip"
    }
    
  4. Perform the command:

    composer require mageworx/module-seomarkupmeta
    
  5. Clear the compiled code and the cache:

    php bin/magento setup:upgrade
    
  6. To update the extension via composer perform the command:

    composer update mageworx/module-seomarkupmeta
    

Installation by copying the code

  1. Download the extension's package from your customer account, unzip it.

  2. Use any SSH client to connect to your server. Bear in mind that the user should write permissions to this folder and its subfolders.

  3. Upload all the files and folders from the extension's package to the root Magento folder.

  4. Via SSH, navigate to the root Magento folder and perform the command:

    php bin/magento module:enable MageWorx_SeoAll MageWorx_SeoMarkup
    
  5. Clear the compiled code and cache:

    php bin/magento setup:upgrade
    php bin/magento cache:flush
    php bin/magento setup:static-content:deploy
    

Glossary

Rich Snippets

Rich Snippet is a structured data markup added to your existing website HTML. In fact, these are separate tags that allow the search engines to process information provided on your Magento 2 store. Google confirmed that rich snippets don’t affect rankings directly and, moreover, they do not guarantee that the snippets will actually appear in the search results. Nevertheless, it is quite clear that for the customer the result with the snippets looks more attractive improving CTR.

The search engines support several types of snippets such as recipes and reviews, yet for the e-commerce the most important one is the product.

Please, bear in mind that adding snippets to your site in the search results may take some time as the search bots do not include this information immediately.

Extension Configuration

Log into the Magento Admin panel and go to STORES ⟶ Configuration ⟶ MAGEWORX ⟶ SEO. The configuration of the extension is provided under the SEO Markup tab.

SEO Markup

Product

SEO Markup Products

Enable In Rich Snippets setting enables the possibility to add the snippets that will be shown on the search engine results page. The store owner can preview the snippet data on the special page. Most Search structured data uses schema.org vocabulary The snippets are added using the JSON-LD method. This method entirely separates the markup data from the HTML code. So one doesn’t need to tweak the actual HTML elements, when using it.

Enable in Open Graph setting lets the store owner deliver the highest quality posts on Facebook. Adding Open Graph tags to the store pages will help the Facebook Crawler pick up the right title and description for the shared page, as well as supply them with the most suitable preview image. Visit this page to learn more about the way Open Graph tags work.

Enable in Twitter Cards provides a media-rich experience to those who view your Twitter content. If enabled, the standard Tweet with the website URL will be transformed into the Summary Card and accompanied with an additional title, an extra up-to-200 words description, and an image. To enable the feature, make sure you enter Twitter Username in the Common section. Visit this page to learn more about Twitter Cards.

By default and without any configurations, the product entity will include the following attributes: product name, preview image, rating, price, availability and website language. The extension lets the store owner notify the search bot of extra attribute to include into rich snippets.

Best Rating is the biggest value for the rating can be 5, 10 or 100. By default and in case the best rating field is left blank, “5” is set.

SEO Markup Products

From here, the store owner can actually map the schema.org Product attributes to the attributes created in the website. So enabling some attribute (like color or manufacturer) requires to select the appropriate attribute code.

SEO Markup Products

For Condition attribute the store owner can select the desired one and map its values to the ones that are represented by schema.org such as New, Used or Damaged. The Custom Properties can be added. They are parsed as

schema_code,magento_attribute_name

where the schema_code is taken from this list and the attribute name can be gathered from the attributes grid in STORES ⟶ Attributes ⟶ Product Attributes

Magento 2 Attrbute Codes

Category (Product List)

SEO Markup Category Product List

The first two options, Enable In Rich Snippets and Enable In Open Graph are explained previously in this document.

Show Product Offers option informs search engines about the special product offers.

SEO Markup Category Product offers

The offers section shown on the structured data testing tool

If the Disable for NOINDEX Robots setting is set to Yes and in case there is NOINDEX meta robots tag on some of the category pages (e.g. layered navigation pages with applied filters), then the markup tags won't be shown here.

Landing Pages

Under STORES ⟶ Configuration ⟶ MAGEWORX ⟶ SEO ⟶ SEO Markup, you can create structured data markup for your custom landing pages.

SEO Markup Category Product offers

With the extension, you can:

  • Enable in Rich Snippets adds statured data markup on all custom-created pages (the snippets will be added with the JSON-LD method that entirely separates the markup data from the HTML code, so you won’t have to code them on your own),

  • Enable in Open Graph allows Facebook to pick up the right title and description for each landing page,

  • Product Offers lets you add markup tags for your promoted products/services,

  • and disable markup tags for landing pages with NOINDEX Robots.

Page

SEO Markup Page

The first two options, Enable In Open Graph and Enable In Twitter Cards are explained previously in this document.

Website

SEO Markup Website

The options Enable In Rich Snippets, Enable In Open Graph and Enable in Twitter Cards are explained previously in this document.

Website Name and Website About provide the settings for the appropriate fields in the website section of the schema.org website.

For the correct sharing of the website on Facebook, the store owner should upload the Facebook Logo and the Facebook App Id. This Id can be taken from the facebook for developers website.

Facebook App ID

Merchant (Seller)

SEO Markup Seller

The option Enable In Rich Snippets is explained previously in this document.

The next group of settings lets you markup the seller info. You can select to show your business type (according to schema.org), add a store name, description, and social links.

Additionally, you can add your personal details, such as a telephone number, fax and location (state/region, street, and ZIP code).

SEO Markup Breadcrumbs

If Enabled, the breadcrumbs will be visible on the search results page.

SEO Markup Breadcrumbs

Common

SEO Markup Common

The Twitter Username should be provided in this section for the correct functionality of the Twitter Cards feature.

Got Questions?

MageWorx offers FREE lifetime support and updates for any extension developed for Magento. Need help with the extensions? Feel free submit a ticket from http://www.mageworx.com/support/ 



MageWorx offers outstanding services developing custom-tailored solutions for Magento platform to attain your eCommerce objectives. Our professional impassioned team provides profound and custom oriented development of your project in a short timeframe.