GuidesAPI Reference

Google Rich Snippets

Suggest Edits

Star Ratings

By "Star Ratings" we refer to the stars that sometimes appear next to your Google search results. See example images below:

668 649

These Star Ratings are a representation of the average review score for a given product or organisation. In order to encourage Google to show them, structured, machine readable data must be embedded within your pages. This structured data is known as a "rich snippet". This document explains how to include these rich snippets on your site.

📘

A Note on Rich Snippet Placement

Make sure the page where you include the structured data is a product page. By "product page" we mean a page where you are displaying the details of one specific product, along with the reviews collected by Reevoo on your behalf. The reviews should ideally be visible on the product page itself. If the reviews are not visible, the page should at least contain navigational elements to allow consumers to navigate to the product specific page with its reviews.

Examples

Embedded Product Reviews for SKU based products

The following snippets should be included in the <head> section in your HTML, before any other <script> tags you may have on the page.

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=TRKRF&sku=SKU"
></script>

SKU and TRKREF should be replaced with those specific to your account and product, for example.

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=CYS&sku=22091143"
></script>

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=PIU&sku=series:414"
></script>

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=BEV&sku=NEAAC80001"
></script>

Embedded Product Reviews for Automotive Partners

Our automotive partners can display the rich snippets based on automotive metadata instead of a SKU.

🚧

If you use any automotive metadata that includes the underscore symbol, like for example "model_variant", make sure you use it exactly as it is (with underscores), do not replace the underscores with hyphens.

The following snippets should be included in the <head> section in your HTML, before any other <script> tags you may have on the page.

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=TRKRF&manufacturer=MANUFACTURER&model=MODEL"
></script>

MANUFACTURER, MODEL and TRKREF should be replaced with those specific to your account and vehicle, for example.

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=MAZ&manufacturer=mazda&model=mazda3"
></script>

The automotive metadata includes attributes like manufacturer, model, model-year, and many others. The full list of attributes is available in our our automotive product feed specification documentation.

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=VOL&manufacturer=volvo&model=xc90&model_variant=Inscription"
></script>

<script 
  async 
  src="//widgets.reevoo.com/loader/product_reviews_rich_snippets.js?trkref=VOL&manufacturer=volvo&model=xc90&model_variant=Inscription&model_year=2018"
></script>

General Guidelines

  • Please read the the official Google review snippets guidelines for more information on rich snippets.
  • Do not include the structured data for the same product in multiple pages.
  • Do not embed these rich snippets on your home page, see "A Note on Rich Snippet Placement", above.

What Do The Rich Snippets Look Like?

The structured data automatically injected in your page by Reevoo is in LD+JSON format. Google is able to interpret this data, but it is not visible to consumers.

<script type="application/ld+json">
 {
    "@context": "http://schema.org",
    "@type": "Product",
    "@id": "#reviewable_sku_100A",
    "name": "KIA RIO",
    "sku": "100A",
    "aggregateRating": {
        "@type": "aggregateRating",
        "ratingValue": 9.0,
        "bestRating": "10",
        "ratingCount": 4544,
        "worstRating": "1"
    }
  }
</script>

You can check which rich snippets are on your pages by using Google's Rich Results Testing Tool

What If My Page Already Contains Other Structured Data?

The structured data injected by Reevoo's JavaScript on your pages is just the product or services "aggregateRating" along with the product name and SKU, nothing else, as you can see in the example above.

However, the "Product" structured data specification allows many more properties beyond the ones Reevoo supplies. Google only needs the aggregateRating details in order to display star rich snippets so you don't need to add anything extra.

You may choose to add extra structured data that Google will use for other purposes, beyond displaying star rich snippets. Some of these other attributes are for example "description", "brand", "offers", etc... Google's Product Structured Data page is the best place to see all the permitted properties.

A more complete example might look something like this.

<script type="application/ld+json">
  {
    "@context": "http://schema.org/",
    "@type": "Product",
    "name": "KIA RIO",
    "sku": "100A",
    "image": "https://an-image-for-the-product.png",
    "description": "Long description about the product",
    "brand": {
        "@type": "Thing",
        "name": "KIA"
    },
    "offers": {
        "@type": "Offer",
        "priceCurrency": "USD",
        "price": "6999.00"
    }
   }
</script>

If you are already including your own product structured data in the page, alongside Reevoo's content, Google will find two different blocks of product structured data in the page and will deem the implementation invalid. In this case you must link the two blocks of structured data to have them appear valid to Google.

In order to link your structure data to Reevoo's one both blocks must be using the same "@id" attribute.

For SKU based products, Reevoo sets the "@id" attribute with the value "#reviewable_sku_SKU", where SKU is replaced by the SKU of the product. For example if the SKU of the product is "100A", then the @id attribute will be as below:

"@id": "#reviewable_sku_100A"

For our automotive partners, Reevoo sets the "@id" attribute with the value "#reviewable/manufacturer/MANUFACTURER/model/MODEL". For example if the manufacturer is "mazda" and the model is "mazda3", then the @id attribute will be as below:

"@id": "#reviewable/manufacturer/mazda/model/mazda3"

You must ensure that your LD+JSON snippet does not include the "aggregateRating" property, and that you use the same "@id" attribute in the snippet you are inserting into the page.

Updated almost 3 years ago