Spotlights provides you with a configurable display module that enables you to leverage consumer-generated content (CGC) on pages that typically do not include it, such as category, list, and landing pages. Each Spotlights display module can provide the following:

  • 1,000 to 6,000 words of rich, social content on pages that often hold little content
  • Language that your customers use to describe and search your products
  • Product images and reviews for product categories that you define

By displaying products and services loved by the community, you improve the consumers’ experience and boost their confidence in your site and business. You also make your pages significantly more search-friendly. Pages that display a Spotlights module typically:

  • Display rich snippet stars in search results for Google and Bing.
  • Improve in search rank.
  • Have a reduced bounce rate.
  • Rank well for additional search phrases.
Note: While Spotlights content is marked up to adhere to Google and Bing’s rich snippets guidelines, rich snippets are dependent on both Google and Bing indexing and are not guaranteed. Additional rich snippet information can be found here.

This section provides the tasks you must complete to configure and display Spotlights.

Define Spotlights instances

You must create a Spotlights definitions file that defines each of your Spotlights instances. The definitions file specifies the products and categories to include in each instance using the product ID and category definitions from your product catalog. Each row in the definitions file defines a separate Spotlights instance. The definitions file also defines keywords that are used for SEO.

The definitions file is saved in comma-separated value (CSV) format and UTF-8 encoded. You can create the definitions file using a variety of spreadsheet authoring programs.

Note: EMEA clients need to ensure the CSV file is saved as UTF-8, as that is not a common encoding standard.

Step 1: Create the definitions file

Complete the following steps to create your Spotlights definitions file.

  1. Download the sample Spotlights definitions file to use as a starting point.

  2. Create a test version of your definitions file by manually defining 5-10 Spotlights instances. Refer to the example items in the file as well as the Spotlights definitions file field reference for information about how to define instances.
  3. Encode the definitions file to ensure maximum compatibility of characters outside the standard US English alphabet, including special characters such as the copyright symbol (©) or diacritical marks such as umlauts (ü). By default, Bazaarvoice uses UTF-8 encoding. If you want to encode the definitions file using an encoding type other than UTF-8, be sure to configure this setting as described in Configure Spotlights display.
  4. The file name must be spotlights.csv. This is required.

Once you determine that your definitions file functions appropriately, complete the file by adding additional Spotlights instances.

Note: Bazaarvoice recommends that you automate the creation of the Spotlights definitions file and then upload an updated version daily. This ensures that Spotlights instances do not become stale as your product catalog changes. If you prefer to manually manage your definitions file, discuss doing so with your Bazaarvoice implementation team.

Step 2: Upload the definitions file

Upload your Spotlights definitions file to the appropriate Bazaarvoice SFTP server. Bazaarvoice processes Spotlights definitions files once each day.

  • Upload your Spotlights definitions file to the spotlights-inbox folder.
Note: Use the same SFTP login and credentials that you use to upload your product catalog.

Bazaarvoice recommends uploading your files to both the staging and production folders:

  • If your data is hosted in the US, use the following URLs:
    • Staging server—sftp-stg.bazaarvoice.com
    • Production server—sftp.bazaarvoice.com
  • If your data is hosted in Europe, use the following URLs:
    • Staging server—sftp7-stg.bazaarvoice.com
    • Production server—sftp7.bazaarvoice.com

Be sure to connect to SFTP using port 22. If you do not know your SFTP credentials or where your data is hosted, contact Bazaarvoice Client Care .

Notify your Bazaarvoice implementation team that you have uploaded your test definitions file.

Note: Spotlights definitions files process every morning at 2:00 AM CST.

Spotlights definitions file reference

The Spotlights definitions file is a spreadsheet which you save in comma-separated values (CSV) format. You can create the definitions file using any software program, but be sure to encode the file in UTF-8 format if you use special characters such as the copyright symbol (©) or diacritical marks such as umlauts (ü).

Each row in the Spotlights definition file represents a separate Spotlights instance. You can place the columns in any order.

Refer to Define Spotlights instances for more information about working with the file once you have created it.

The following table lists the columns that are required for the Spotlights definitions file to work properly. While you can place the columns in any order, the table reflects the order Bazaarvoice recommends for required fields.

Name Description Example

ExternalID

Identifies each Spotlights instance. This value references the Spotlights instance in the on-page integration code.

Bazaarvoice recommends adding the prefix "SL" to avoid confusion with other IDs.

The forward slash symbol (/) is not supported in this column.

SL-LedLight

RootFolder

Folder where Spotlights content for each locale is published on the Bazaarvoice cloud. This value is used in the on-page integration code.

The value for this column is usually Spotlights-<primary_locale>. In rare cases, your root folder might be differently named.

This column establishes the base locale for your Spotlights instance. You can share products and categories from multiple locales, but you must use this field to establish a primary locale. Refer to Localize Spotlights for more information about including content from multiple languages and locales.

Spotlights-en_US

SpotlightName

Value that appears to consumers in the Spotlights display module summary data.

Use a relevant keyword to summarize the content of the page.

Running Shoes (displays as "Average Rating for Running Shoes.")

CanonicalURL

Canonical URL of the deployed page. This value is used to correlate webmaster tools and analytics data with the Spotlights Integration for ROI analysis.

Canonical tags are not required on the page, but if they exist, this value should match the value in the canonical tag.

If your pages do not have canonical tags, use the preferred URL for the page.

Note: If the URL contains a reserved (special) character, you must URL-encode the character. For example, use &amp for an ampersand, use %20 for a space, or use %5B and %5D for square brackets ([]).

http://www.endurancecycles.com/tires

CategoriesEligible

A single category ExternalID or a string of category ExternalIDs used to define categories of items that are eligible to be in a Spotlights instance. This column must be included but may be blank if ItemsEligible is used to define the eligible products. Separate values with a forward slash (/).

Values in this field should match the category's ExternalId in the product catalog.

One Spotlights instance can include both CategoriesEligible and ItemsEligible columns. Bazaarvoice will de-duplicate products that overlap. Refer to the CategoriesEligible and ItemsEligible field examples (below) for examples of how to use these fields.

CAT11008/CAT11009

ItemsEligible

A string of one or more product ExternalIDs used to define the items that are eligible to be in a Spotlights instance. This column must be included but may be blank if CategoriesEligible is used to define the eligible products. Separate values with a forward slash (/).

Values in this field should match the product's ExternalId in the product catalog.

One Spotlights instance can include both CategoriesEligible and ItemsEligible columns. Bazaarvoice will de-duplicate products that overlap. Refer to the CategoriesEligible and ItemsEligible field examples (below) for examples of how to use these fields.

PRD11006/PRD11007

The following table lists columns that are not required for the Spotlights definitions file to work properly, but Bazaarvoice recommends including them to improve Spotlights functionality.

Name Description Example

KeywordsExact

Defines one or more keywords to target for search engine optimization for each specific entry in the definitions file. Spotlights attempts to select and include reviews that include the keywords you define. Separate each keyword with a forward slash (/).

Use your existing SEO strategy to define keywords, placing the most important keywords first.

Include both singular and plural forms of keywords to increase effectiveness.

Use no more than 5 to 6 individual words. Using multi-word phrases or more than 5 to 6 individual words decreases SEO effectiveness.

Include duplicate entries of the same keyword to give that keyword more "weight" when Spotlights selects reviews.

leather/sofa/leather/couch

The following table lists columns that are optional in your Spotlights definitions file.

Name Description Example

KeywordsExcluded

Defines keywords that exclude reviews from the Spotlights module. Separate keywords with a forward slash (/).

You might use this if you maintain focused pages for similar products, such as "grey shirts" and "charcoal shirts." You can specify that products from one focused group do not appear in a Spotlights display aimed at a separate focused group.

Use this column infrequently. Overuse can significantly decrease the number of eligible reviews, which will reduce the SEO value of Spotlights.

charcoal

ExcludedCategories

Defines products within a specific category that should be excluded from the Spotlights module. Separate each category ExternalID in this string with a forward slash (/).

CAT11004/CAT11005

ExcludedItems

Defines products that should be excluded from the Spotlights module. Separate each product ExternalID in this string with a forward slash (/).

PRD11006/PRD11007

The CategoriesEligible and ItemsEligible fields control the categories and items that can be included in a Spotlights instance. You can use one or both columns. If you choose not to use a column, you can leave its value blank but you must include it in your file.

If you use both fields, Bazaarvoice de-duplicates any products that overlap. For example, if you include a specific product as well as a category that includes that product, your Spotlights display module does not display the same product twice.

The following table uses sample CategoryID and ProductID values to illustrate how you might use the CategoriesEligible and ItemsEligible columns in your Spotlights definitions file.

Scenario CategoriesEligible example value ItemsEligible example value
Display only products in your store's "Grills" category (CAT11008). CAT11008
Display products from your store's "Patio" category (CAT11009) as well as one of the portable air conditioners in your inventory (PRD11006). CAT11009 PRD11006
Display products from both the "Grills" category (CAT11008) and the "Patio" category (CAT11009). Also include both portable air conditioners in your inventory (PRD11006 and PRD11007). CAT11008/CAT11009 PRD11006/PRD11007
Display only the two portable air conditioners in your inventory (PRD11006 and PRD11007). PRD11006/PRD11007

You can selectively override specified columns of information in your primary Spotlights definition file. The following examples illustrate situations in which you might find this useful.

  • Overriding for SEO management—Some organizations have dedicated SEO specialists who work remotely or on a different schedule from the rest of their developers. By maintaining a Spotlights definitions override file that contains only keyword information, you can ensure that your dedicated SEO team can use a workflow that suits them and does not interrupt the work of your other developers.
  • Overriding for testing—You might want to override one or more columns in your definitions file to test what effect the changes will have before changing the primary file. If you work with Bazaarvoice to perform A/B tests, we use this method to perform the tests.

You can use multiple override files, such as if one department controls SEO keywords for a particular subset of products and a different department controls SEO keywords for a different subset of products.

Complete the following steps to create and upload a Spotlights definitions override file.

  1. Create a CSV spreadsheet that is similar to your Spotlights definitions file but includes only the ExternalID and RootFolder columns, as well as the columns you want to override. For example, an overrides file for SEO keywords might include ExternalID, KeywordsExact, KeywordsTracked, and KeywordsExcluded columns.

    Note: Refer to Spotlights definitions file reference for a full description of each column you can use in your file.
  2. Name the file using the following format: sequence-owner_name-YYYYMMDD.csv, where sequence is a two-digit number specifying the order to process the override file, owner_name is the business owner of the file, and YYYYMMDD is the date the file was created. For example, an overrides file might be named 01-bob_smith-20160201.csv.

    Note: If you use an overrides file to perform A/B tests, use a sequence number of 99 for that file to ensure that it is processed last.
  3. Upload the Spotlights override file to the spotlights-inbox/delta folder, as described in the next step.
Note: Overrides files remain in effect until they are removed from the SFTP folder.

Localize Spotlights

Spotlights offers several localization features. You can:

Each Spotlights instance has a single base locale and base deployment zone. Even if you intend to share content between locales, you must set a single base locale for your instance.

  1. Locate the RootFolder column of your Spotlights configuration file to set the base locale for your Spotlights instance.
  2. Add a locale code to the deployment zone, separated by a single dash (-) character. If you do not specify a locale code, the instance uses the default locale as defined by your implementation.
    Note: Locale codes are case sensitive.

The following table shows examples of using the RootFolder column to specify locale information.

Example RootFolder value Explanation
Spotlights Specifies the deployment zone "Spotlights" but does not specify a deployment locale. The instance uses the default locale as defined by the Spotlights implementation.
Spotlights-fr_CA Specifies the deployment zone "Spotlights" and the French (Canada) deployment locale. The instance uses the French (Canada) locale regardless of the default locale for the Spotlights implementation.
Note: Spotlights deployment zones are usually named Spotlights, but your configuration might vary.

You can configure a Spotlights instance to include content from one or more locales in addition to its base locale.

  1. Locate the ContentLocales column in your Spotlights configuration file.
    Note: If you do not include the ContentLocales column in your Spotlights configuration file, your implementation might inherit locale preferences from other aspects of your Conversations implementation.
  2. Add one or more locale codes to the ContentLocales column. Separate values with a forward slash (/).

The following table shows examples of using the ContentLocales column to specify locale information.

Example ContentLocales value Explanation
fr_FR Content from the French (France) locale is included in the Spotlights instance alone with content from the base locale. You might add this entry to an instance configured for the French (Canada) deployment locale.
en_CA/en_GB Content from the English (Canada) and English (Great Britain) deployment locales is included in the Spotlights instance along with content from the base locale. You might add this entry to an instance configured for the English (US) deployment locale.

If multiple languages are in use in your environment, you must configure the labels that appear within Spotlights, as follows:

  1. From within the Conversations configuration hub, select your Spotlights implementation.

  2. In the User Experience section of the configuration hub, click Copy Editor. The Copy Editor page appears.

  3. Select the locale you want to edit from the drop-down menu.

  4. Hover over the label to select the Edit button.

  5. Make your changes and deploy the Spotlights implementation to the Staging and Production environment.

    Note: Updates to your Spotlights implementation might take a few hours to become visible.

Deploy Spotlights

Spotlights can be deployed using the following methods. You can only use one of the methods to deploy Spotlights on any given page.

  • Server-side deployment—This method is universally search-friendly. Using a software development kit (SDK) that we provide, you deploy code on your page and on your server that supplies your page with relevant consumer generated content (CGC). Bazaarvoice recommends this method for maximum SEO boost and minimum page loading times.
  • Client-side deployment—This method requires less development overhead on your part. You implement JavaScript in your page, which displays relevant CGC. Major search engines, primarily Google and Bing, now crawl and index content served using JavaScript. If your site relies on search traffic from search engines other than Google and Bing, this method provides you with less SEO benefit. For more information about the new JavaScript indexing capability exhibited by major search engines, see this blog post . Refer to this blog post to understand how Google crawls web pages.
Note: If you plan to deploy Spotlights on an HTTPS site, you must provide image URLs at an HTTPS location in your product catalog. If you do not, your customers will see a mixed content warning.

Prerequisites for deployment

To deploy Spotlights using either of the two methods, you must have the following items:

  • Cloud Key—Provided by Bazaarvoice
  • Root Folder—RootFolders configured in your Spotlights definitions file
  • Subject ID—ExternalID configured in your Spotlights definitions file

Best practices

Before deploying Spotlights, observe these best practices:

  • Place Spotlights deployment code on all existing category pages. Bazaarvoice also recommends implementing Spotlights on keyword-targeted landing pages. Pages not containing live Spotlights instances should be identified as control group pages.

  • Place the Spotlights module at the bottom of the page, above any linking modules and footers.
  • When using client-side deployment, Bazaarvoice recommends including the appropriate schema.org/WebPage declaration in the body element of your pages as shown in the following example:

    <body itemscope="" itemtype="http://schema.org/WebPage">
    

    If you cannot add the itemscope and itemtype attributes to the <body> element, you can make the declaration in a <div> or <span> element. However, the schema.org/WebPage declaration must span the entire body contents of the page.

Server-side deployment

This deployment method is universally search-friendly. Using the Bazaarvoice SEO software development kit (SDK), you can deploy code on your page and on your server that supplies your page with relevant consumer generated content (CGC). Bazaarvoice recommends this method for maximum SEO boost and minimum page loading times.

Note: If you plan to deploy Spotlights on an HTTPS site, you must provide image URLs at an HTTPS location in your product catalog. If you do not, your customers will see a mixed content warning.

Bazaarvoice offers SDKs for three different environments. Each of the following links takes you to the full documentation for the corresponding SDK, including implementation instructions, downloads, and code examples. Also, be aware that SDKs are not exclusively used for Spotlights. Look for Spotlights example code within the documentation for each SDK.

Note: In most cases, Bazaarvoice recommends using a production call to the Bazaarvoice integration code. Doing so allows you to test Spotlights behavior in your staging environment using reviews from your production database.

Client-side deployment

This deployment method requires less development overhead on your part. You implement JavaScript in your page, which displays relevant CGC. Major search engines, primarily Google and Bing, now crawl and index content served using JavaScript. If your site relies on search traffic from search engines other than Google and Bing, this method provides you with less SEO benefit. For more information about the new JavaScript indexing capability exhibited by major search engines, see this blog post .

Note: If you plan to deploy Spotlights on an HTTPS site, you must provide image URLs at an HTTPS location in your product catalog. If you do not, your customers will see a mixed content warning.

To use client-side deployment, you must place the following elements into the markup for your page. Refer to Client-side deployment code examples for full code examples showing client-side deployment under different scenarios.

Spotlights container

A <div> element that determines where the Spotlights display module is placed.

Place the Spotlights display module at the bottom of the page, above any linking modules and footers.

Example:

<div data-bv-show="spotlights" data-bv-subject-id="SL-Demo" data-bv-site-id="Spotlights"></div>

Add the following attributes to the <div> tag:

  • data-bv-show="spotlights"—Call needed to show Spotlights widget.
  • data-bv-subject-id—Subject ID needed by the Spotlights application.
  • data-bv-site-id—Name of the deployment zone from which your Spotlights application is built. Capitalize each word and separate each word with an underscore. Your Spotlights deployment zone is created by default, so the data-bv-site-id will be "Spotlights".

JavaScript source element

A <script> element with a src attribute referencing the full path to the BV loader bv.js file.

Add the following JavaScript integration code inside the <head> element of the page:

<head>
  <script async src="https://apps.bazaarvoice.com/deployments/<client_name>/<site_ID>/<environment>/<locale>/bv.js"></script>
</head>

In the <script> element, replace the following:

  • <client_name>—The client name provided by Bazaarvoice. Be sure to use lowercase letters for the value.
  • <site_ID>—The ID of the deployment zone you want to use. This is set in the Bazaarvoice configuration hub within the Bazaarvoice Workbench. The default deployment zone for Spotlights is “spotlights”. Check with your Bazaarvoice representative to ensure the correct ID, or log in to the configuration hub to verify.
  • <environment>—The deployment environment where you want to implement Bazaarvoice features. For a production environment, include production in the path. If you are referencing a staging environment, include staging in the path.
  • <locale>—The locale used by the implementation. If you are not using US English (en_US), use the correct locale code.

Client-side deployment code examples

The following examples show client-side Spotlights deployment code in different scenarios. The examples use the following configuration information:

  • Root Folder: Spotlights-en_US
  • Subject ID: SL-Demo

Client-side integration in a production environment

The following example code shows client-side Spotlights deployment code in a production environment. Replace SL-demo with the ExternalID in your Spotlights definitions file.

<html>
  <head>
    <script async src="https://apps.bazaarvoice.com/deployments/<client_name>/<site_ID>/production/<locale>/bv.js"></script>
  </head>
  <body itemscope="" itemtype="http://schema.org/WebPage">
    <div data-bv-show="spotlights" data-bv-subject-id="SL-Demo" data-bv-site-id="Spotlights"></div>
  </body>
</html>

Client-side integration in a staging environment

The following example shows client-side Spotlights deployment code in a staging environment. Using a staging environment enables you to test changes before deploying to production. Specify a staging path in the src attribute of the JavaScript source element, as shown in the following code.

<html>
  <head>
    <script async src="https://apps.bazaarvoice.com/deployments/<client_name>/<site_ID>/staging/<locale>/bv.js"></script>
  </head>
  <body itemscope="" itemtype="http://schema.org/WebPage">
    <div data-bv-show="spotlights" data-bv-subject-id="SL-Demo" data-bv-site-id="Spotlights"></div>
  </body>
</html>


Note: If your existing implementation uses the scout file (bvapi.js), you must place the following elements into the markup for your page instead. Expand the section below and refer to Client-side deployment code examples for full code examples showing client-side deployment under different scenarios.

Spotlights container

A <div> element that determines where the Spotlights display module is placed.

Place the Spotlights display module at the bottom of the page, above any linking modules and footers.

Example:

<div id="BVSpotlightsContainer"></div>

JavaScript source element

A <script> element with a src attribute referencing the full path to the Bazaarvoice scout.js file. The path includes your unique cloud key.

Requirements:

  • Load only once.
  • Place before the Spotlights display module rendering call.
  • Form the path to the scout.js file as follows, using the cloud key provided to you by Bazaarvoice and the root folder you specify in your Spotlights definitions file.
    http://seo.bazaarvoice.com/<CLOUD_KEY>/<ROOT_FOLDER>/spotlights/scout.js

Example:

<script src="http://seo.bazaarvoice.com/demo-af027b01370af4598c3011ebfd1c3a87/Spotlights-en_US/spotlights/scout.js"></script>

Spotlights display module rendering call

A <script> element containing a call to the BV.Spotlights.render function. You can specify parameters to customize the rendering of the Spotlights display module.

Requirements:

  • Load only once. Client-side deployment supports only one Spotlights display module per page. Attempting to call the render function more than once results in an error.
  • Do not add code that waits for the document to be ready or delays making the initial call to the BV.Spotlights.render function. Doing so could prevent search engines from crawling the content. The Spotlights code loads resources asynchronously, so rendering occurs as soon as possible.

Example:

<script> BV.Spotlights.render({contentType: 'spotlights', subjectId : 'SL-demo'}); </script>
Note: In most cases, Bazaarvoice recommends using a production call to the Bazaarvoice integration code. Doing so allows you to test Spotlights behavior in your staging environment using reviews from your production database.

Client-side deployment code examples (bvapi.js)

The following examples show client-side Spotlights deployment code in different scenarios. The examples use the following configuration information:

  • Cloud Key:demo-af027b01370af4598c3011ebfd1c3a87
  • Root Folder: Spotlights-en_US
  • Subject ID:SL-Demo

Client-side integration in a production environment

The following example code shows client-side Spotlights deployment code in a production environment. Replace demo-af027b01370af4598c3011ebfd1c3a87 with the cloud key provided during implementation and SL-demo with the ExternalID in your Spotlights definitions file.

<html>
  <body itemscope="" itemtype="http://schema.org/WebPage">
    <div id="BVSpotlightsContainer">
    </div>
    <script src="http://seo.bazaarvoice.com/demo-af027b01370af4598c3011ebfd1c3a87/Spotlights-en_US/spotlights/scout.js">
    </script>
    <script>
      BV.Spotlights.render( {
        contentType: 'spotlights', subjectId: 'SL-demo'
        }
      );
    </script>
  </body>
</html>

Client-side integration in a staging environment

The following example shows client-side Spotlights deployment code in a staging environment. Using a staging environment enables you to test changes before deploying to production. Specify a staging path in the src attribute of the JavaScript source element, as shown in the following code.

<html>
  <body itemscope="" itemtype="http://schema.org/WebPage">
    <div id="BVSpotlightsContainer">
    </div>
    <script src="http://seo-stg.bazaarvoice.com/demo-af027b01370af4598c3011ebfd1c3a87/Spotlights-en_US/spotlights/scout.js">
    </script>
    <script>
      BV.Spotlights.render( {
        contentType: 'spotlights', subjectId: 'SL-demo'
        }
      );
    </script>
  </body>
</html>

Configure Spotlights display

Using the Conversations configuration hub, you must configure the display settings for the Spotlights display module, as well as settings for contacting members of your company.

Note: Users of the legacy PRR platform might encounter limited display irregularities that can be corrected by contacting Bazaarvoice Client Care before going live.

Complete these steps to configure the Spotlights display settings:

  1. Log in to the Bazaarvoice Workbench.
  2. Select Settings » Manage Applications.
  3. In the Deployment Zones section of the Site Manager page, ensure that deployment zones exist for both Main Site and Spotlights.
  4. In the Implementations section of the page, ensure that Spotlights Implementation exists.
  5. Click Edit next to the Spotlights Implementation.
    Note: Adjusting Spotlights settings in a deployment zone other than the Spotlights deployment zone has no effect.
  6. To customize product eligibility settings, click Spotlights on the left side of the page under Settings and then configure these settings:

    These options are available:

    Option Explanation Notes and best practices
    Minimum average product rating Works with the Spotlights definitions file to define which products can appear in the Spotlights display module. Set this value to the lowest average product rating for products to include in the Spotlights display module. Recommended: 3.8 to 4.2 stars. After deploying Spotlights, you can refine these values to improve the product selection.
    Minimum review count Works with the Spotlights definitions file to define which products can appear in the Spotlights display module. Set this value to the smallest number of reviews a product may have to be included in the Spotlights display module. Recommended: 2 to 3 reviews. After deploying Spotlights, you can refine these values to improve the product selection.
  7. Configure these settings to customize the Spotlights display template:

    Sets a display template for the Spotlights display module. Templates are responsive and have been tested by Bazaarvoice to support all major browsers.

    You can customize your template by adding your own cascading style sheet (CSS). Overriding styles in the provided templates enables you to ensure that the Spotlights display module fits seamlessly into your page layout. It gives you flexibility but because each company's style sheets are different, Bazaarvoice does not provide tech support for your overrides. Bazaarvoice recommends:

    • Only advanced users attempt to override the Bazaarvoice-hosted style sheets.
    • You perform thorough testing in a staging environment before moving your changes to production.

    Overriding the default style sheets might cause compatibility issues with future updates to the default style sheets.

  8. To customize the header text that is displayed above the Spotlights display module on your pages, complete the following steps:
    1. Click Copy Editor on the left side of the page under User Experience.
    2. Scroll down to the Spotlights section of the page.
    3. Hover over the last row in the table and click the Edit button. The row description states "This field can be used to provide header for the Spotlight. Token{SpotlightName}, if present, will be replaced with the Spotlight name."
    4. Enter the header text in the New Value(s) field.
  9. To customize all other Spotlights settings, click Spotlights on the left side of the page under Settings and then configure these settings:

    These options are available:

    Option Explanation Notes and best practices
    Maximum number of products The largest number of products to include in the Spotlights display module. Recommended: at least 6 products per category.
    Minimum number of products The smallest number of products to display in the Spotlights display module. If fewer qualifying products exist, the Spotlights display module does not appear.
    Maximum number of reviews per product The largest number of reviews that the Spotlights display module displays for a given product. For example, when this setting is configured to 5 reviews, the Spotlights display module excludes any reviews beyond the first 5 that qualify.
    Minimum review rating The lowest review rating that the Spotlights display module displays for a given product. For example, when this setting is configured to 4 stars, the Spotlights display module excludes any reviews with fewer stars even if they exist. Recommended: 4 or more stars

    These options are available:

    Option Explanation Notes and best practices
    CSV Definitions File Encoding Sets the encoding type for the Spotlights definition file. By default, UTF-8 (Unicode) is used.
    Add main entity attribute to most popular product Select Enabled to display the most popular product of those specified in the Spotlights definitions file as the first product in the Spotlights display module. If Disabled is selected, the first product in the module is selected randomly.
    Content Selection Randomization Level

    Controls the amount of randomization applied to content selection. Randomization only applies when the amount of relevant products or reviews exceeds the number of available display slots. Definition of levels:

    • High—Selections are randomized for all slots.
    • Medium—Selections for the first 1/3 of slots are made from the highest rated and most relevant products. Selections are randomized for the last 2/3 of the slots.
    • Low—Selections for the first 2/3 of slots are made from the highest rated and most relevant products. Selections are randomized for the last 1/3 of the slots.
    • None—Selections are made from highest rated and most relevant products for all slots (no randomization).
    If you have a large amount of content, choose a higher randomization level to increase freshness. Be aware that choosing higher randomization may lower relevance.
    CSS Behavior

    Select the CSS to use for styling content:

    • Include CSS (Cleanslate Version)—Use the Bazaarvoice style sheet to style stars and HTML content and to reset options for the default settings. If you choose this option, you cannot easily override the Bazaarvoice style sheet settings.
    • Include CSS—Select this option if you want to style the stars and HTML content in the Spotlights display. You must provide your own style sheet and override the Bazaarvoice styles as needed. Be aware that your styles may interfere with future updates in the Spotlights display.
    • Include CSS for Stars Only—Use the Bazaarvoice style sheet to style stars only. You must provide your own CSS if you want to style HTML content in the Spotlights display.

    Contact Bazaarvoice Client Care to enable this feature in your Conversations implementation.

    Also, use these links to download an example of the Bazaarvoice style sheets:

    Review Recency Emphasis

    Enables you to specify how content is weighted based on its submission date. By selecting one of these options, you can increase the preference of content for inclusion in the Spotlights display based on its age:

    • High—Assign preference to reviews that are less than 31 days old.
    • Medium—Assign preference to reviews that are less than 61 days old.
    • Low—Assign preference to reviews that are less than 91 days old.
    • Legacy—Use the old version of the algorithm to assign preference to reviews, which does not factor in review age.
    Contact Bazaarvoice Client Care to enable this feature in your Conversations implementation.

Before deploying these changes to production, be sure to thoroughly test your Spotlights deployment in the staging environment.

Customize Spotlights CSS

CSS Overrides

If you chose to use the Bazaarvoice style sheet (without cleanslate), complete the following steps to customize the visual styling of the Spotlights display module with your own CSS. 

  1. In your HTML markup, add a link to your CSS file below the Spotlights .css file link:

    <link rel="stylesheet" type="text/css" href="your-custom-styles.css" />
    
  2. Use specificity to override Spotlights base styles if necessary. spotlights.css

    .bv-cleanslate .bv-spotlights .bv-review-title { font-size: 1.2em; }
    

    your-custom-styles.css

    .your-parent-element .bv-cleanslate .bv-spotlights .bv-review-title { font-size: 2em; }
    
Note: Bazaarvoice does not support any changes you make to override the Bazaarvoice-hosted style sheets. Only advanced users should attempt to override the Bazaarvoice-hosted style sheets. You must thoroughly test your changes in a staging environment before moving them to production.

Client-hosted CSS

Bazaarvoice can provide the Spotlights CSS file to be hosted on your website.

Note: If you are going to host the Spotlights CSS file yourself, please notify your Spotlights team.

Grant access to Google Search Console

Complete the following steps to grant Bazaarvoice restricted access to your Google Search Console, which we use to track the search engine optimization (SEO) impact of Spotlights and to provide you with accurate reports.

  1. Navigate to your Google Search Console and log in with administrator rights. A list of the properties you own appears.
  2. Click the Manage property menu to the right of the property to which you are adding Spotlights.
  3. Select Add or remove users. The Users and Property Owners screen appears.
  4. Click Add a new user.
  5. Type seoreporting@bazaarvoice.com in the User email field and select Restricted in the Permission menu.
  6. Click Add.

Grant access to Google Analytics

To track the search engine optimization (SEO) impact of Spotlights and to provide accurate reporting, you must grant read-only access of your Google Analytics account to Bazaarvoice. If you do not use Google Analytics as your analytics platform, contact Bazaarvoice Client Care to enable this capability.

Complete the following steps to grant Bazaarvoice read-only access to your Google Analytics account:

  1. Sign in to your Google Analytics account as a user with administrator rights.
  2. Click the property to which you want to grant access.
  3. In the Account column, click User Management.
  4. In the Add permissions for field, type seoreporting@bazaarvoice.com and then select Read & Analyze from the drop-down menu.
  5. Click Add.
Note: If you do not use Google Analytics as your analytics platform, work with your Spotlights team to discuss alternate measurement strategies using your site analytics platform.