Schema piece - Review

Describes a Review. Usually in the context of a Product or an Organization.

Triggers

Should be added as top-level nodes in the graph, as/when required by other nodes. E.g., when an Product has a review.

Required properties

A valid Review must have the following properties.

• @type: Review.
• @id: The site's home URL appended by #/schema/Review/{{ID}}, where {{ID}} is a unique identifier.
• author: A reference-by-ID to the Person who wrote the review.
• reviewRating: A Rating object, with a ratingValue property. If the scale is not from 1 to 5, also add bestRating and worstRating properties.

Failure scenarios

If any of the required fields are missing or invalid, the node should not be output.

If the node is not output, any entities which would otherwise have declared a relationship with the Review (e.g., as reviews referenced by a Product) should remove those references.

Optional properties

The following should be added whenever available and valid:

• reviewBody: The text content of the review.
• name: A title for the review.
• datePublished: The date the review was published, in ISO 8601 date format.

Examples

Minimum criteria

<script type="application/ld+json">{ "@context": "https://schema.org", "@graph": [ { "@type": "Review", "@id": "https://www.example.com/#/schema/Review/abc123", "author": { "@id": "https://www.example.com/#/schema/Person/abc123" }, "reviewRating": { "@type": "Rating", "ratingValue": 4 } } ] }</script>

{
      "@context": "https://schema.org",
      "@graph": [
          {
              "@type": "Review",
              "@id": "https://www.example.com/#/schema/Review/abc123",
              "author": {
                  "@id": "https://www.example.com/#/schema/Person/abc123"
              },
              "reviewRating": {
                  "@type": "Rating",
                  "ratingValue": 4
              }
          }
      ]
  }

Extended criteria

<script type="application/ld+json">{ "@context": "https://schema.org", "@graph": [ { "@type": "Review", "@id": "https://www.example.com/#/schema/Review/abc123", "name": "Example review name", "author": { "@id": "https://www.example.com/#/schema/Person/abc123" }, "reviewRating": { "@type": "Rating", "ratingValue": 8, "bestRating": 10, "worstRating": 1 }, "reviewBody": "Example review body", "datePublished": "2022-07-21" } ] }</script>

{
      "@context": "https://schema.org",
      "@graph": [
          {
              "@type": "Review",
              "@id": "https://www.example.com/#/schema/Review/abc123",
              "name": "Example review name",
              "author": {
                  "@id": "https://www.example.com/#/schema/Person/abc123"
              },
              "reviewRating": {
                  "@type": "Rating",
                  "ratingValue": 8,
                  "bestRating": 10,
                  "worstRating": 1
              },
              "reviewBody": "Example review body",
              "datePublished": "2022-07-21"
          }
      ]
  }