Components
The Review components include:
- ReviewSnippet - Shows the aggregate rating and review count. You will install this above the fold.
- ReviewDisplay - Shows the Review Snapshot, Review List, and Image Gallery (as applicable) of individual customer reviews. You will install this below the fold.
You must also create div containers to house the PowerReviews content on your PDPs.
Installation
1. Ensure you have your Account Credentials, which can be found in your Implementation Project Workbook. If you do not have these in hand, please reach out to your Implementation Team.
2. Install your content containers:
- Install the Review Snippet container
Example:<div id="pr-reviewsnippet"></div> - Install the Review Display container
Example:<div id="pr-reviewdisplay"></div>
3. Install the PowerReviews ui.js library and render function. Load the ui.js file before making the function call in the body of the page. This function should be placed at the bottom of the page after all content containers.
<script src="https://ui.powerreviews.com/stable/4.0/ui.js" async></script>
<script>
POWERREVIEWS.display.render({
api_key: 'API_KEY',
locale: 'LOCALE',
merchant_group_id: 'MERCHANT_GROUP_ID',
merchant_id: 'MERCHANT_ID',
page_id: 'PAGE_ID',
review_wrapper_url: 'WRAPPER_URL',
components: {
ReviewSnippet: 'pr-reviewsnippet',
ReviewDisplay: 'pr-reviewdisplay'
}
});
</script>
4. Replace the values for the following required variables with your specific information.
| Field | Description | Requirements | Example | Additional Notes |
| api_key | Your API key | This value is provided by PowerReviews | ec8f9acb-be0e-489b-a6ff-3eed3811025e | |
| locale | Your Locale | This value is provided by PowerReviews | en_US | |
| merchant_group_id | Your Merchant Group ID | This value is provided by PowerReviews | 49047 | |
| merchant_id | Your Merchant ID | This value is provided by PowerReviews | 512774 | |
| page_id |
The unique identifier at the parent level, typically the master product ID, SKU, style number, etc. The page_id is determined by you |
This field can include up to 50 alphanumeric characters page_id values are case sensitive Hyphens (-) and underscores ( _ ) can be used |
7751057291 | Reviews always roll up to the page_id. For example, if you have a jacket that comes in different colors, the page_id value must be common across all colors for them to display in a single Review Display. |
| review_wrapper_url | The URL of the page hosting the WAR form | You should create one page for all products (not one page per product) | https://www. prdemostore.com /pages/ write-a-review/?pr_page_id =__PAGE_ID__ |
This page will be used by customers who click 'Write-a-Review' on your site and by customers who receive your Follow-Up email. This page will also be used for the Ask a Question page. |
Multiple Render Functions and Performance
The render function can only be called once on each page, so if you find yourself needing to call it separately in different parts of your code, build an array and call the render function on that array.
For an additional performance enhancement, include the parameter enable_content_collection_modal and set it to false if the modal is not being used.
Products That Have Zero Reviews
If you currently have no reviews for a product, an empty Review Display appears. You can modify the way this empty display renders using your own CSS to style the pr-no-reviews class found in the pr-review-snippet-container, or the pr-rd-no-reviews class for the entire display. For more information on CSS styling guidelines, see Customizing Your PowerReviews Platform.
Additional Customizations
If you wish to only display certain elements of the Review Display (i.e., Image Gallery, Review Snapshot, or Review List - see below), or to reorder the items within the Review Display, this can be done by rendering the individual components within the render call in place of the ReviewDisplay component.
You can find a full list of available components within our JavaScript Reference Guide.
Please note that if you change the components you are rendering, you should also update the names of the divs to reflect this. For example, if you wish to use the ReviewList component, you should name your div pr-reviewlist, etc.
<div id="reviewsnippet">
<div id="reviewlist">
<div id="reviewimagedisplay"><script src="https://ui.powerreviews.com/stable/4.0/ui.js" async></script>
<script>
POWERREVIEWS.display.render({ api_key: 'API_KEY', locale: 'LOCALE', merchant_group_id: 'MERCHANT_GROUP_ID', merchant_id: 'MERCHANT_ID', page_id: 'PAGE_ID', review_wrapper_url: 'WRAPPER_URL',
components: {
ReviewSnippet: 'pr-reviewsnippet', ReviewList: 'pr-reviewlist',
ReviewImageDisplay: 'pr-reviewimagedisplay'
}
});
</script>
