R&R PDP Components

This tutorial describes the standard product display page (PDP) components that make up Bazaarvoice Conversations Ratings and Reviews (R&R).

Introduction

Conversations R&R consists of three PDP components:

  • Ratings summary
  • Content summary
  • Content area

Each component is described in more detail below along with a wireframe identifying where on a typical PDP it should be placed, a list of recommended elements, and a screenshot of the default Bazaarvoice implementation as an example. Although not required, we strongly encourage the inclusion of these components in your Conversations application.

Ratings summary

Description

The ratings summary alerts the consumer to the existence of reviews and provides links for reading reviews and writing a review. The ratings summary should be displayed towards the top of the product page, above the fold. It
displays the overall rating of a product as well as information like thenumber of customers who would recommend the product to a friend.

This component should contain the following elements:

  • Overall rating stars
  • Count of total reviews
  • Recommendation percent
  • Link to read reviews
  • Link to write a review

User interface

The following images show what this component might look like before and after reviews are approved for display:

No reviews

Reviews

Rating summary data

Data used to create the rating summary can be found in the ReviewStatistics
section of the API response

{
  "HasErrors": false,
    "Includes": {
      "Products": {
        "1000001": {
          ...
          "ReviewStatistics": {...},
            ...
       	}
     	},
      "Comments": [...],
      ...
    },
    "Offset": 0,
    "TotalResults": 151,
    "Locale": "en_US",
    "Errors": [],
    "Results": [...],
    "Limit": 1
}

Review statistics are not included in the API response by default. Add Include=Products and Stats=Reviews to reviews.json to request ReviewStatistics.

https://[stg.]api.bazaarvoice.com/data/reviews.json?apiversion=5.4&passkey={API_KEY}&Filter=ProductId:1000001&Include=Products,Comments&Stats=Reviews

πŸ“˜

Refer to the reference documentation to learn more about making Conversations API requests.

Content summary

Description

The content summary provides the user with summary information about the content as well as filtering and sorting controls. The content summary should be displayed immediately above the content area. It may also display any element found in the ratings summary.

This component may contain the following elements:

  • Sort and filter controls
  • Tag clouds, rating dimensions, sliders
  • Any elements from the ratings summary

User interface

The following image shows what this component might look like:

Reviews

There is no need to display this component when no reviews have been approved for display.

Content summary data

Data used to create the content summary can be found in the ReviewStatistics section of the API response:

{
  "HasErrors": false,
    "Includes": {
      "Products": {
        "1000001": {
          ...
          "ReviewStatistics": {...},
            ...
       	}
     	},
      "Comments": [...],
      ...
    },
    "Offset": 0,
    "TotalResults": 151,
    "Locale": "en_US",
    "Errors": [],
    "Results": [...],
    "Limit": 1
}

Review statistics are not included in the API response by default. In the request below, Include=Products and Stats=Reviews instruct the API to return the ReviewStatistics object.

https://[stg.]api.bazaarvoice.com/data/reviews.json?apiversion=5.4&passkey={API_KEY}&Filter=ProductId:1000001&Include=Products,Comments&Stats=Reviews

πŸ“˜

Refer to the reference documentation to learn more about making Conversations API requests.

Content area

Description

The content area is where the consumer generated content is displayed. The content area is typically displayed below product information and may be behind a tab.

  • Reviews
  • Comments
  • Sort and filter controls
  • Pagination controls

User interface

The following images show what this component might look like under several circumstances:

No reviews

Reviews

Reviews & comments

Content area data

Data used to create the content area can be found in the Results and Comments section of the API response:

{
  "HasErrors": false,
    "Includes": {
      "Products": {...},
        "Comments": [...],
                     ...
    },
    "Offset": 0,
    "TotalResults": 151,
    "Locale": "en_US",
    "Errors": [],
    "Results": [...],
    "Limit": 1
}

Comments are not included in the API response by default. In the request below, Comments when added to Include instructs the API to return the Comments array.

https://[stg.]api.bazaarvoice.com/data/reviews.json?apiversion=5.4&passkey={API_KEY}&Filter=ProductId:1000001&Include=Products,Comments&Stats=Reviews

πŸ“˜

Refer to the Display Fundamentals documentation to learn more about making Conversations API requests.