Description of the elements processed by Yandex

General requirements for reviews

To let Yandex process the reviews on your site, place each review on a separate page. All information and the review content must be placed inside the root class element hreview.

All review elements must be placed inside the root class element. All text data of the review marked up according to microformats must be fully displayed on the page and be visible to the site visitors. An exception is the technical data recorded with the abbr tag or the value-title class. For more details on how Yandex processes microformats, see the Markup processing rules.

Yandex handles standard elements of a microformat, as well as its own extensions. Properties supported by Yandex but missing from the standard specification are in bold.

To have reviews of organizations from your site displayed in Yandex.Maps, you need to participate in the partner program.

Supported fields

The markup schema implies that the HTML elements contain class attributes and are placed according to the hierarchy shown below.

The root element of the review should be marked with the hreview class. The review components are marked up with the classes listed below:

  • summary — Brief review annotation (tip for the buyer, general impression, and so on).

  • description — The review text.

  • pro — Text about the advantages. If the advantages are enumerated in a list, we recommend that you mark each list item with the pro class. Can be placed inside description.

  • pro — Text about the disadvantages. If the disadvantages are enumerated in a list, we recommend that you mark each list item with the pro class. Can be placed inside description.

Note.

The review must contain at least one of the elements description, pro and contra.

  • dtreviewed — The date the review was written in the ISO 8601 format (for example, 2005-08-09 or 2005-08-09T18:31). Mandatory field.

  • rating — The rating of the review object as a decimal number (for example, 4.0, 4.5 or 4).

    The rating block can contain the upper and the lower border of the rating scale:

    • worst — The minimum rating of the review.

    • best — The maximum rating of the review.

    If the "worst" and "best" fields aren't specified, the minimum rating is considered 1.0, and the maximum rating is 5.0.

    The site may participate in the partner program for organization reviews if most reviews on the site are rated.

  • tag — The rating of a specific aspect of the organization. The value format is the same as for the rating — a decimal number (for example, 4.0, 4.5 or 4).

    The tag property includes the following fields:

    • name — The rated feature.

      Possible values:

      • “cuisine” — Food.

      • “service” — The level of service.

      • “interior” — Design of the interior.

      • “value-for-money” — Value for money.

      • “hall” — Hall.

      • “movie-choice” — The choice of movies.

      • “accommodation” — The quality of the rooms.

      • “location” — Location.

      • “drinks” — Drinks.

      • “equipment” — Equipment available.

      • “pool-size” — Size of the pool.

      • “water-quality” — Water quality.

      • “workmanship” — Work quality.

      • “price-level” — Pricing.

      • “music” — Music.

      • “cleanliness” — The cleanliness of the place.
      • “bea_comfort” — Room comfort.
      • “internet” — Internet connection quality.
    • worst — The minimum rating of the review.

    • best — The maximum rating of the review.

    If the "worst" and "best" fields aren't specified, the minimum rating is assumed to be 1.0, and the maximum rating is 5.0.

  • permalink — The URL of the full review text. Permalink must be specified.

    Each review must have a unique URL. We strongly advise you to keep the permalink value the same with time.

  • mobile-url — Permanent link to the mobile version of the review page. If you use a mobile version of the page with the list of reviews, provide a link to the review marked with an anchor. If the partner doesn't have a mobile version or the field is not provided, the full text of the review will appear in Yandex mobile applications.
  • reviewsurl (URL) — The URL of the page that contains other reviews of similar objects. One review may include several reviewsurl elements for comparative reviews or for different groups of reviews. For example, a restaurant review may include two different reviewsurl elements: one link can forward to a list of all reviews about this restaurant, and the other to a list of reviews about all restaurants available on the site.

    Pages with addresses listed in reviewsurl fields can get improved snippets in the search results.

  • Reviewer — A block that describes the reviewer. Mandatory field.

    The "reviewer" block must include the "hcard" block with information about the author.

    The block must contain the name of the author in the "fn" field. For an organization review, you must also specify the URL of the page with all reviews by the author. If the "url" field contains the link to the author's personal page, place the URL of the page with the author's reviews in the "permalink" field of the "vcard" block, which describes the author.

    All elements are described in the hCard format specification. The Russian translation of the specification is located at http://microformats.org/wiki/hcard-ru.

    See also the section explaining how Yandex works with hCard.

  • type — The type of the reviewed object. Mandatory field. Possible values: product, business, place, person, event, site, url.

    For organization reviews, specify “business” or “place” in the type field.

  • item — Required block describing the organization.

    For organization reviews, the item block must contain one block marked up according to the hCard microformat. The block must contain a link to the organization's page on your site (the permalink field). Example of markup for the item block:

    <div class="item vcard">
      <div class="fn org summary">Prague Restaurant</div>
      <span class="adr">
       <span class="street-address">Arbat street, 2/1 </span>, < span class = "locality" > </span> </span> Moscow < span class = "tel" > +7 (495) 690-31-37 </span>;
      < a class = "url" href = "http://www.praga.ru/" > praga.ru </a> < a class = "permalink" href = "http://www.example.ru/praga" > All reviews of the restaurant </a> </div>

Example of a marked-up review

<div class="hreview">
  <h2 class="summary"><a href="http://example.com/review?10231" class="permalink">Russian cuisine in exile</a></h2>
  <div>Review by <span class="reviewer vcard"><a class="url fn" href="http://example.com/users/vasya">Vasya Pupkin</a></span>,
    <span class="dtreviewed"><abbr class="value" title="2012-07-15">15 July, 2012</abbr>.</span>
  </div>
  <div class="rating">
    <abbr class="worst" title="0"></abbr>
    <p>Rating: <span class="value">9</span> out of <span class="best">10</span>.</p>
  </div>
  <div class="pro">Free parking, nice kids' room and attentive wait staff.</div>
  <div class="contra">Large and noisy non-smoking area.</div>
  <div class="description">
    <abbr class="type" title="business">
    <p>The food was ready relatively quickly and the drinks arrived almost immediately.
    Excellent service, but empty dishes weren't cleared right away.</p>
    <p>I recommend the Russian food, especially the soups.</p></abbr>
  </div>
  <div>The author visited this location on <span class="dtvisited"><abbr class="value" title="2012-07-10">10 July, 2012</abbr></span>.</div>
  <div>Rating of restaurant characteristics:
    <ul>
      <li class="tag">
        <span class="name">
    <span class="value-title" title="cuisine"/>
          Food:
        </span>
  <span class="value">5</span> out of <span class="best">5</span>;
      </li>
   <li class="tag">
        <span class="name">
    <span class="value-title" title="hall"/>
          Hall:
        </span>
  <span class="value">3</span> out of <span class="best">5</span>;
      </li>
    </ul>
  </div>
  <div class="item vcard">
    <h3>Information about the <abbr class="category" title="restaurant">restaurant</abbr></h3>
    <p>Name: <span class="fn org">Abroad</span></p>
    <p class="adr">Address:
      <span class="locality"></span>, <span class="street-address"></span>.
    </p>
    <p>Phone: <abbr class="tel" title=""></abbr>.</p>
    <p>Website: <a class="url" href="http://zagranica.com">http://zagranica.com</a></p>
    <p>Email: <a class="email" href="mailto:hostess@zagranica.com">hostess@zagranica.com</a></p>
  </div>
</div>