BVSEO

Search engine optimization (SEO) is critical to boosting organic traffic to your website.

To ensure that all search engines are able to view and index your user-generated content (UGC) in all situations, implement SEO using either:

Schema.org markup: Client-side SEO solution (recommended)
Note: For information about client-side SEO performance, refer to schema.org markup.
BVSEO: Server-side BVSEO solution. This article focuses primarily on our server-side BVSEO solution.

Caution: If your existing implementation uses the scout file (bvapi.js), refer to the BVSEO v1 documentation instead of the information included in this topic. Bazaarvoice encourages you to migrate to v2 (using the BV loader file, bv.js) for performance improvements and future innovations.

In-depth Quick Start Check Your Work

In addition to the server-side SEO solution, Bazaarvoice provides client-side JavaScript integration by default with our hosted solution and takes advantage of Google’s enhanced JavaScript indexing capabilities. If your search traffic comes largely from Google, the client-side JavaScript integration provides similar SEO benefit with less overhead. Together, the server-side and client-side SEO solutions provide outstanding SEO performance and deliver an optimized user experience.

Learn more about optimizing search:

Supported features

Bazaarvoice-managed content is injected into your pages' source code via a server-side software development kit (SDK). Here is the list of supported features for Java, .NET, and PHP.

Feature	Description	Java	.NET	PHP
Ratings & Reviews	Product ratings and reviews are injected using getContent, getReviews, and getAggregateRating.	✔	✔	✔
Questions & Answers	Product questions and answers are injected using getContent.	✔	✔	✔
Seller Ratings	Seller Ratings content is accessed using getContent.	✔	✔	✔
Multiple configuration support	Multiple configurations are supported in a single environment.	✔	✔
SSL	Access content using a secured layer.	✔	✔	✔
Proxy support	Access content using proxy gateways in a restricted network.	✔	✔	✔
Debugging	Troubleshooting information is available for debugging purpose.	✔	✔	✔
Charset	Supports user-specific character sets when retrieving content.	✔	✔	✔

Setup overview

To set up BVSEO, your technical team needs to perform the following:

Perform preparation tasks, including:
- Review the pre-implementation checklist.
- Ensure your site and Bazaarvoice implementation meet prerequisite conditions.
- Gather information needed during setup.
Configure the SEO options.
Add code to your website (using Java, .NET, or PHP).
Ensure that Google's rich snippet stars appear in search results for your product pages.

Compatible JavaScript for Google

User-generated content (UGC) served by Bazaarvoice takes advantage of Google's expanded JavaScript indexing performance. Understanding the following concepts can help you get more search engine optimization (SEO) benefit when using JavaScript to deploy UGC.

schema.org markup

Bazaarvoice adds correctly formed schema.org markup to UGC served to your web pages. When Google indexes this markup, the likelihood of review rich snippets appearing in search results increases.

Note: To ensure the schema.org markup is read correctly, refer to Add schema.org markup for detailed instructions.

Links between UGC content pages

When UGC content spans more than one page, Bazaarvoice uses href links between pages, allowing search engines to index the content more easily.

When shoppers view a product page that contains more than one page of reviews, they interact only with the JavaScript. The URL does not change. Bazaarvoice dynamically creates href links between pages of UGC for search indexing only, allowing search engines to point shoppers directly to relevant results.

Note: If you have an existing deployment, you might need to redeploy to production to experience this SEO benefit.

Pagination link format

Bazaarvoice appends a bvstate parameter to URLs. This parameter uses key/value pairs to define the content type and page of UGC to display. The following table lists examples of possible uses of the bvstate parameter.

Parameter text	Explanation
`?bvstate=pg:2/ct:r`	Content type: Ratings & Reviews Page: 2
`?bvstate=pg:4/ct:q`	Content type: Questions & Answers Page: 4

Bazaarvoice adds the bvstate parameter to URLs in the canonical tag for your implementation. Consumers only encounter the bvstate parameter when following links from search results.

Note: The bvstate parameter replaces pagination parameters formerly used by Bazaarvoice such as bvrrp, bvqap, bvsyp, and bvpage. Older parameters will be phased out over time.

Prepare for SEO setup

Begin your implementation by answering questions in the following sections to help eliminate surprises and delays during setup.

Option A: Use a platform plug-in

If the website is built on Demandware, Magento, Hybris, or GSI, it is probable that a plug-in will be used to deploy BVSEO.

Option B: Use one of the BVSEO SDKs

If the website is built using Java, .NET, or PHP, BVSEO SDKs will make the SEO-friendly integration simple. Proceed to the next question to review information that should be considered prior to deployment of the BVSEO SDKs.

Option C: Develop a custom solution based on the BVSEO SDKs

If the website is built using a different technology, Ruby or Perl for example, you will need to develop a custom solution. The BVSEO SDKs are open-sourced, published in GitHub, and provide a reliable guide for those developing a custom solution. Proceed to Section 2, which is also relevant to custom solution development.

1. Will server-side coding be possible?

Yes – BVSEO integration requires a server-side deployment to inject search-friendly contents into the source code.
No – If you are unable to make server-side changes, you cannot implement the BVSEO on your site. Contact Bazaarvoice Support for information about alternate SEO resources.

2. Is a page-level cache involved? (Akamai is often used for page level caching.)

Caching may be used to improve the speed and efficiency in ways that affect the BVSEO integration. Consider the following questions related to caching.

Yes – If the pages where BVSEO will be implemented use a page-level cache, increase EXECUTION_TIMEOUT to 2000ms. This will ensure that SEO-friendly contents are always included in the cached version.
No – No additional effort.

3. Does the page use the complete URL as its cache key?

Caching may be used to improve the speed and efficiency in ways that affect the BVSEO integration. Consider the following questions related to caching.

BVSEO uses bvrrp, bvqap, bvsyp, and bvpage as URL parameters to manage pagination. http://example.com and http://example.com?bvrrp=stuff are unique pages and must be treated as unique pages by page-level caching systems.

Yes – No additional effort.
No – The cache system or URL masking system must be updated as part of the deployment.

4. Will a local cache be used to reduce server-side calls to the cloud?

BVSEO makes an HTTP or HTTPS request to seo.bazaarvoice.com (seo-stg.bazaarvoice.com for staging), which returns formatted HTML as a string. While our cloud service contains a cache for exceptionally efficient delivery (often sub 20ms), some clients opt to add an additional layer of local caching.

Yes – If a local cache is going to be used, Bazaarvoice recommends a maximum TTL of one hour.
No – No additional effort.

5. Will a proxy be needed?

BVSEO must have access to seo.bazaarvoice.com (seo-stg.bazaarvoice.com for staging) via HTTP or HTTPS. IP addresses are not available. Because BVSEO uses floating IP addresses in the cloud, we do not guarantee that IP addresses will remain consistent. If the firewall requires an IP address, a proxy must be set up to provide a consistent IP address. The SDKs contain proxy configuration options.

Yes – Effort will be required to set up the proxy. Use BVClientConfig.PROXY_HOST and PROXY_PORT to point the SDK at the proxy when deploying the SDK.
No – No additional effort.

6. Will firewall settings need to be adjusted?

BVSEO must have access to seo.bazaarvoice.com (seo-stg.bazaarvoice.com for staging) via HTTP or HTTPS. If the firewall restricts access to this address, adjustments will be needed.

Yes – Effort will be required to open up access.
No – No additional effort.

7. Will SSL connections be required?

While the content retrieved from seo.bazaarvoice.com does not contain any data that needs to be protected, security policies may require that all server-side connections are protected by SSL. SSL support is available in the Java SDK v2.1 (and above) and .NET SDK v2.1 (and above).

Yes – set BVClientConfig.SSL_ENABLED to true when deploying the SDK.
No – No additional effort.

8. Are the pages using schema.org markup?

Bazaarvoice supports both Microdata and JSON-LD formatted markup. However Google prefers JSON-LD structured markup. Bazaarvoice uses the schema.org page to guide schema markup.

Yes – Continue to the next step.
No – Refer to Getting started with schema.org .

9. Do the pages already contain schema.org markup?

If the page where BVSEO is being deployed contains any schema.org markup, meticulous attention to detail must be used to ensure that the schema markup does not conflict.

Yes - All schema.org markup must be properly nested in a single hierarchy. Carefully audit the HTML output to ensure that proper schema.org code hierarchy is present.
No – Refer to these instructions on how to include schema.org markup on your pages.

10. Do the pages already contain a schema.org type?

Pages must only contain one schema.org type

Yes – Make sure the schema.org <script> tag contains both the rating summary and reviews modules.
No – Add a type to the page. Bazaarvoice recommends adding schema.org/Product (Microdata format). Refer to the Java, .NET, or PHP examples for sample code.
- Add the schema.org/Product class into a <div> tag that contains both the rating summary and reviews modules.
- Add the product name within the schema.org/Product class using
  
  <div itemprop=name>[ProductName]</div> or <meta itemprop="name" content="[ProductName]" />
  
  Note: This applies to Microdata structured data only.

11. Do the pages have canonical tags?

If canonical tags are used on pages where BVSEO is implemented, these tags must either be updated or removed when the product contains more than one page of reviews, which is typically more than eight reviews. These canonical tags must be removed since BVSEO is paginating the product page so that all reviews are in the search engines’ index. Canonical tags that point away from a pagination URL will cause search engines to ignore the paginated content.

Note: Refer to Best practices for more information on pagination.

Yes – When any of the BVSEO pagination parameters are present (bvstate, bvrrp, bvqap, bvsyp, bvpage), do either of the following:
1. Remove the canonical tag. This is the most common solution.
2. Append the "name=value" pair to the canonical URL.
No – No additional effort.

Then, make sure you meet the following prerequisite conditions:

Verify that one of the following frameworks is installed:
- Java framework 5 (1.5) or above
- .NET framework 2.0 or above
- PHP 5.5 or above with curl and Mbstring library
Use the Bazaarvoice hosted display, such as JavaScript or iFrame.
Provide a product catalog to Bazaarvoice.
Ensure that your product pages incorporate schema.org markup.
Have at least one product with reviews in the system.

During setup, you must know your BVSEO:

Cloud key
Root folders
Product IDs

If you do not know these values, contact Bazaarvoice Support to request the information.

Configure SEO options

Follow these steps to configure the SEO options:

Sign in to the Bazaarvoice Portal .
From the upper-right corner, select the settings icon .
Select Configuration.
Select the instance.
Select Go to Configuration. The Site Manager appears, listing the available deployment zones and implementations.
From the Implementations list, locate the implementation where you want to configure SEO settings. Select Edit next to the implementation you want to configure.
Select SEO on the left side of the page under Settings. The SEO page appears.
Make selections or enter values for each of the following SEO options:
- Enable SEO file publishing—Select Enabled (default) to publish SEO content to the cloud or compressed SEO file archive. You must also provide values for Cloud key or ZIP/GZIP filename properties.
- Root folder—Enter the syntax to use for the name of the root folder in the cloud and/or compressed file. Use these tokens to inject dynamic properties into the filename: {clientname}, {displaycode}, {deploymentzone}, {locale}. Example: bv-acmeinc-7012-MainSite-en_US.
- SEO-friendly pagination—Users and search engines react favorably when your site contains multiple pages for a product, and when pages after the product overview contain about 30 reviews each. Select Enabled (default) to use multiple-page settings for your product pages.
- Cloud key—Enter your cloud key value to configure the BVSEO SDK. Be sure to include the entire value, not just the encrypted portion. If you don't have a cloud key, request one by submitting a support ticket through the Support Community .
- schema.org/Product type—Ignore this option, which has been deprecated and is no longer used.
- Compression type—Select the compression type for SEO feeds: ZIP (Windows) or GZIP (UNIX). If disabled, archive files will not be published to the SFTP server.
- ZIP/GZIP filename—This option is required for compressed file publishing. Enter the syntax to use for the compressed SEO filename. Use these tokens to inject dynamic properties into the filename: {clientname}, {displaycode}, {deploymentzone}. The file extension is automatically appended based on the compression type you select. Example: bv_acmeinc_7012_MainSite-en_US.zip.
- AggregateRating tag location—Google will only display rich snippet stars for pages with one schema.org AggregateRating tag. Choose a location from the following options to insert this tag:
  - Primary Ratings Summary (default)—Inserts the AggregateRating tag on the primary rating summary page. Bazaarvoice recommends this option.
  - Reviews Container—Inserts the AggregateRating tag at the top of the reviews container.
  - Remove Aggregate Rating tag—Excludes the AggregateRating tag.

Add code using the Java SDK

The following requirements are necessary to install the Java SDK.

Familiarity with Java and Java EE development and deployment to application servers
Java 1.6 or above
BVSEO SDK library for Java

Bazaarvoice follows the Oracle support levels for the JRE supported by the Java SDK. For more information, refer to the Oracle Java SE Support Roadmap .

Download the SDK

Download the appropriate Java SDK file from the following location: BVSEO Java SDK .

After you unzip the file, choose the package from the following table that best suits your environment:

Java SDK	Description
Bv-seo-sdk-{version}-jar-with-dependencies.jar	All dependencies are contained in the file.
Bv-seo-sdk-{version}.jar	No dependencies are contained in the file.
Bv-seo-sdk-{version}-osgi.jar	This SDK is for OSGi supported environments only.

If you're not sure which SDK you should use, choose one based on the following scenarios.

My environment supports OSGi—Use the Bv-seo-sdk-{version}-osgi.jar SDK. This is the recommended library for OSGi environments.
My environment does not support OSGi—Use the Bv-seo-sdk-{version}-jar-with-dependencies.jar file if there are no version conflicts caused by the SDK libraries used in your environment.
My environment does not support OSGi and I have version conflicts—Use bv-seo-sdk-{version}.jar file. This library does not contain any dependencies, so you must identify missing libraries and supply them manually. This can be done during compilation if there are compilation errors, or during runtime if there are "class not found" errors.

Customize the SDK

The BVSEO SDKs suit most environments. However, the BVSEO SDKs are open sourced under an Apache license and can be customized to your needs. Any customizations must be done at your own risk and will not be supported by Bazaarvoice.

Fork from the following link to perform customizations: github.com/bazaarvoice/seo_sdk_java

Set up your project

Follow these steps to set up your project.

To set up your project, configure settings in your server-side Java environment and prepare your development environment.

Configure your server environment

Note: This section applies only to clients using Java EE to deploy their site.

The Java SDK supports the collection of user agent strings, which allows us to provide user-generated content (UGC) better tailored to consumers. If your company uses Java EE to host your website, you must update your web.xml file , located in your WEB-INF folder.

Copy and paste the following text into the <web-app> element in your web.xml file:

<filter>
    <filter-name>BVSeoSdkRequestFilter</filter-name>
    <filter-class>com.bazaarvoice.seo.sdk.servlet.RequestFilter</filter-class>
</filter>
<filter-mapping> 
    <filter-name>BVSeoSdkRequestFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

Configure your development environment

Follow these steps to configure your development environment. Example values for each step are provided along with example code. Refer to Java code examples for full example code for various scenarios that you can configure to your needs.

Create a web project from your IDE.
Example: sampleweb
Paste the SDK library under WebContent/WEB-INF/lib.
Example: bv-seo-sdk-{version}-jar-with-dependencies.jar
Create a JSP page in the WebContent folder. Usually this JSP page will be your product detail page (PDP).
Example: sample.jsp
Set up the JSP file.
Example: Coding sample.jsp
Export the project as a WAR file and deploy to Tomcat .
Example: The project is run from IDE, which uses Tomcat.
Open the URL and view the page source to discover the injected content.
Example: http://localhost:8080/sampleweb/sample.jsp

Your project structure should look like the following example:

Set up the JSP file

Follow these steps to set up the JSP file you created in the previous procedure.

Configure using BVConfiguration.
The example code uses BVSdkConfiguration class, which is an implementation of BVConfiguration. Ensure that com.bazaarvoice.seo.sdk.config.BVConfiguration is imported in the page and add appropriate configurations using addProperty. Refer to the BVConfiguration section of Java SDK inputs and features for details.

The addProperty method is used to add configuration/properties to the BVSdkConfiguration and takes parameters enum type BVClientConfig and String type value. The example shows various properties already added.
Set the parameters for your product detail page using BVParameters.
This step supplies details specific to product page contents. Set parameters using the BVParameters class, which can be imported from com.bazaarvoice.seo.sdk.model.BVParameters. Be sure to include mandatory fields as shown in the Java code examples provided in this topic.
Get the contents using BVManagedUIContent.
BVUIContent has three APIs. Refer to Java SDK inputs and features for more information on each API. The example uses the getContent API and BVManagedUIContent, which is an implementation of BVUIContent. While instantiating BVManagedUIContent, supply the BVSdkConfiguration and invoke getContent passing BVParameters. This API returns a string that contains the BVSEO content, which you can use in the JSP.

Test your application

Follow these steps to test and debug your application of the Java SDK.

Deploy a WAR file or use an application server such as Tomcat to run your application.
Access the application via URL.

Example: http://localhost:8080/SampleWeb/sample.jsp
View the page source. Review contents and SEO <metadata> tags should appear inside the BVRRContainer.
Verify that SEO metadata tags appear after every review, as shown in the following code sample:

<ul id="BVSEOSDK_meta" style="display:none !important">
    <li data-bvseo="sdk">bvseo_sdk, java_sdk, bvseo-x.y.z</li>
    <li data-bvseo="sp_mt">getContent, method:CLOUD, 188ms</li>
    <li data-bvseo="ct_st">REVIEWS, PRODUCT</li>
</ul>

If the SEO metadata tags do not match, troubleshoot and take appropriate action based on the error message in the SEO <metadata> tag.

To debug your application, complete these steps:

Step 1: Add bvreveal=debug

Add the bvreveal=debug parameter to the URL of any page where BVSEO is implemented.

Example: http://yoursite.net/ExampleGetContent.aspx?bvreveal=debug

The bvreveal=debug parameter adds BVSEOSDK_meta and BVSEOSDK_DEBUG lists to the source code, which contain information about your implementation. If there is no user-generated content (UGC), bvseo-msg will provide more details.

Note: If pageURL is not set up correctly, bvreveal=debug will not work. If you do not provide a debug footer, pagination links may be incorrect.
View the page's source code to find information about your implementation. This information is included in BVSEOSDK_meta and BVSEOSDK_DEBUG. Refer to the full example code at the end of this section.

Step 2: Check for content

Check if content exists for the requested contentURL, as described in the following steps:

Find the contentURL in the BVSEOSDK_DEBUG list. Example: <li data-bvseo="contentURL">http://seo-stg.bazaarvoice.com/myshco-69cb945801532dcfb57ad2b0d2471b68/Main_Site-en_US/reviews/product/1/5000001.htm</li>
From the terminal, run the curl –i command. Example: curl –i "http://seo-stg.bazaarvoice.com/myshco-69cb945801532dcfb57ad2b0d2471b68/Main_Site-en_US/reviews/product/1/5000001.htm"

If the curl command does not return content, it could be a firewall issue or no content exists for this ProductID. Contact your Bazaarvoice representative for further troubleshooting.

Error messages

The following error messages may appear when debugging.

HTTP status code of 0 was returned (or) connection refused to seo-stg.bazaarvoice.com—Indicates that a firewall exists on your network. Outbound requests from your network may be blocked by your firewall. Contact your IT team to sort out firewall issues.
The resource to the URL or file is currently unavailable—Indicates that something is wrong with the implementation configuration or no content was generated for the specified product.

Example:

<ul id="BVSEOSDK_meta" style="display:none!important">
    <li data-bvseo="sdk">bvseo_sdk, java_sdk, x.y.z</li> 
    <li data-bvseo="sp_mt">getContent, method:CLOUD, 656ms</li> 
    <li data-bvseo="ct_st">QUESTIONS, PRODUCT</li> 
    <li data-bvseo="ms">bvseo-msg: The resource to the URL or file is currently unavailable.;</li>  
</ul> 

<ul id="BVSEOSDK_DEBUG" style="display:none;"> 
    <li data-bvseo="crawlerAgentPattern">yandex</li> 
    <li data-bvseo="staging">true</li> 
    <li data-bvseo="seo.sdk.enabled">true</li> 
    <li data-bvseo="testingProductionS3Hostname">seo-qa.bazaarvoice.com</li> 
    <li data-bvseo="stagingS3Hostname">seo-stg.bazaarvoice.com</li> 
    <li data-bvseo="seo.sdk.execution.proxy.host">none</li> 
    <li data-bvseo="seo.sdk.execution.timeout.bot">2000</li> 
    <li data-bvseo="socketTimeout">2000</li> 
    <li data-bvseo="testingStagingS3Hostname">seo-qa-stg.bazaarvoice.com</li> 
    <li data-bvseo="cloudKey">myshco-3e3001e88d9c32d19a17cafacb81bec7</li>  
    <li data-bvseo="localSEOFileRoot">/</li> 
    <li data-bvseo="bv.root.folder">9344</li> 
    <li data-bvseo="seo.sdk.execution.proxy.port">0</li> 
    <li data-bvseo="testing">false</li> 
    <li data-bvseo="productionS3Hostname">seo.bazaarvoice.com</li> 
    <li data-bvseo="connectTimeout">2000</li> 
    <li data-bvseo="loadSEOFilesLocally">false</li> 
    <li data-bvseo="seo.sdk.charset">UTF-8</li> 
    <li data-bvseo="seo.sdk.ssl.enabled">false</li> 
    <li data-bvseo="includeDisplayIntegrationCode">false</li> 
    <li data-bvseo="seo.sdk.execution.timeout">1500</li> 
    <li data-bvseo="en">true</li> 
    <li data-bvseo="pn">bvseo-2</li> 
    <li data-bvseo="userAgent">Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.130 Safari/537.36</li> 
    <li data-bvseo="baseURI">http://bvvseodotnetdevelopment.azurewebsites.net/ExampleGetContent.aspx</li>   
    <li data-bvseo="pageURI">http://bvvseodotnetdevelopment.azurewebsites.net/ExampleGetContent.aspx?bvstate=pg:2/ct:q/reveal:debug</li>    
    <li data-bvseo="subjectId">5000001</li> 
    <li data-bvseo="contentType">questions</li> 
    <li data-bvseo="subjectType">product</li> 
    <li data-bvseo="contentURL">http://seo-stg.bazaarvoice.com/myshco-3e3001e88d9c32d19a17cafacb81bec7/9344/questions/product/2/5000001.htm</li> 
</ul>

Java SDK inputs and features

This topic provides details about the core classes in the BVSEO SDK, including configuration options and methods of use for the Java platform.

BVConfiguration

BVConfiguration configures the BVSEO SDK. It has two APIs:

BVConfiguration.addProperty—Adds properties to BVConfiguration.
BVConfiguration.getProperty—Gets properties from BVConfiguration.
Note: BVConfiguration.getProperty is for Bazaarvoice internal use only.

BVConfiguration is an interface under com.bazaarvoice.seo.sdk.config and the known implementation class is com.bazaarvoice.seo.sdk.config.BVSdkConfiguration.

Java usage

BVConfiguration bvConfiguration = new BVSdkConfiguration();

Adding properties using BVConfiguration.addProperty

Adding and setting attributes in BVConfiguration changes the functionality and behavior of the SDK. Configuration options are listed in the SDK configuration attributes table.

Set attributes using BVConfiguration.addProperty (BVClientConfig bvClientConfig, String value).

Java usage

bvConfiguration.addProperty(BVClientConfig.CLOUD_KEY, “your_cloud_key”);

Attribute	Type	Description
CLOUD_KEY	Required	Cloud key string. Specifies the key used to locate the cloud SEO files. Contact Bazaarvoice to obtain the value you need for this property. This attribute is optional if LOAD_LOCAL_FILES is used.
BV_ROOT_FOLDER	Required	Folder path declaration. Specifies the folder where SEO files are located. This is also known as the display code. Unique root folders are created for each deployment zone and locale. Contact Bazaarvoice to obtain the value you need for this property.
SEO_SDK_ENABLED	Optional	Boolean. Specifies whether to enable SEO SDK (True) or disable it (False). Default: True
EXECUTION_TIMEOUT	Optional	Numeric value. Specifies the time in milliseconds (ms) to complete the SEO call for user agents and search engine bots (such as browsers) not in CRAWLER_AGENT_PATTERN. Default: 500
EXECUTION_TIMEOUT_BOT	Optional	Numeric value. Specifies the time in milliseconds (ms) to complete the SEO call for search engine bots that match CRAWLER_AGENT_PATTERN. Default: 2000
CRAWLER_AGENT_PATTERN	Optional	List of search engine bot user agents. Overrides the default list of search engine bot user agents. You can add and remove agents from the list. Multiple values are separated by “\|”. Default: msnbot\|google\|teoma\|bingbot\| yandexbot\|yahoo
STAGING	Optional	Boolean value. Specifies whether to get SEO contents from staging (True) or from production (False) . Not applicable when using LOAD_SEO_FILES_LOCALLY. Default: False Note: It is common to forget to disable staging data. Check if the SDK to retrieve staging data (True) if you are not receiving content from production.
SOCKET_TIMEOUT	Optional	Numeric value. Specifies atimeout for establishing connection and reading complete contents. Used internally by the SDK. Do not modify this value unless there is a network or bandwidth issue causing frequent socket/read timeouts. This value is used for cloud SEO only and is not applicable when using LOAD_SEO_FILES_LOCALLY. Default: 2000 ms
CONNECT_TIMEOUT	Optional	Numeric value. Specifies a timeout for establishing connection to cloud SEO. Used internally by the SDK. Do not modify unless necessary. Default: 2000 ms
CHARSET	Optional	Character set declaration. Specifies a character set. If not specified, the default value is UTF-8. For example, use "shift_jis" when the Shift JIS character set is used. Default: Uses the default value set by your operating system.
SSL_ENABLED	Optional	Boolean value. Specifies whether or not SSL connections are required (True). Not applicable when using LOAD_SEO_FILES_LOCALLY. Default: False
PROXY_HOST	Optional	Proxy host declaration. Specifies a proxy host, which is needed by some clients for security reasons. The most common use case is when firewall rules can only be set for an IP address, not a domain. Cloud SEO uses a wide range of IP addresses that are subject to change at any time, so Bazaarvoice does not provide cloud SEO IP addresses to clients. Not applicable when using LOAD_SEO_FILES_LOCALLY. Note: To enable proxy, both PROXY_HOST and PROXY_PORT must be set.
PROXY_PORT	Optional	Numeric value. Specifies the port number on which the proxy/gateway system is listening. Use with PROXY_HOST.
LOAD_SEO_FILES_LOCALLY	Optional	(Not recommended.) Boolean value. Specifies whether to load SEO files locally (True) or not (False). Local file configurations can help overcome system limitations. A local file system can be fragile since Bazaarvoice is not responsible for the daily retrieval, unpacking, and distribution of SEO files. To enable local files, LOCAL_SEO_FILE_ROOT must be set.
LOCAL_SEO_FILE_ROOT	Optional	(Not recommended.) Boolean value. Specifies whether to set the root path of the extracted SEO contents to BV_ROOT_FOLDER on the local file system (True) or not (False). Use with LOAD_SEO_FILES_LOCALLY.

BVParameters

BVParameters are the page or product display page-level parameters that access the SEO contents of a particular product. Use the attributes listed in the following SDK parameters table to set field values.

This is a model used by the SDK in the com.bazaarvoice.seo.sdk.model.BVParameters class.

Java usage

BVParameters bvParameters = new BVParameters();
bvParameters.setSubjectId(“exampleExternalId”);
bvParameters.set…
…
…

Attribute	Type	Description
setUserAgent	Required	Browser’s user-agent header information. This is used by the SDK to identify if it is a search engine bot or a normal user. This information can be retrieved from HTTPServletRequest in Java. This search engine bot is determined and matched from the configuration set by CRAWLER_AGENT_PATTERN.
setBaseURI	Required	URL that is used to create pagination links. Bazaarvoice will add the parameter bvstate to the base_url. In most cases, this should include the product or service page's canonical URL. Required for product reviews. The URL can be absolute, relative, or blank (null is allowed).
setPageURI	Required	Sends all query parameters attached to the current URL. Bazaarvoice will use these parameters to determine which page of reviews or questions and answers content to include. You must send the full URL.
setSubjectID	Required	Identifier for the SEO subject to retrieve the content, which depends on the SubjectType you select. For example, if SubjectType is Product, this value is the productId. If SubjectType is Category, this value is reviewId.
setContentType	Required	Enum type, defined in ContentType, that retrieves SEO content. Possible values include REVIEWS, REVIEWSPAGE, QUESTIONS, QUESTIONSPAGE, and UNIVERSAL.
setSubjectType	Required	Enum type defined in SubjectType that retrieves content for a specific subject type. Possible values are PRODUCT, CATEGORY, ENTRY, or DETAIL.

BVUIContent

BVUIContent is used to get SEO contents after you supply the correct BVConfiguration and BVParameters.

BVUIContent exposes three APIs: getContent, getReviews, and getAggregateRating. Each of these requires valid BVParameters. The following BVUIContent APIs table explains how to use the APIs.

BVUIContent is the interface located in package com.bazaarvoice.seo.sdk. The implementation class is com.bazaarvoice.seo.sdk.BVManagedUIContent.

Java usage

BVUIContent bvUIContent = new BVManagedUIContent(bvConfiguration);
String theContent = bvUIContent.getContent(bvParameters);

API	Purpose
getContent(BVParameters)	Retrieves the complete content of the subject. Supported content types include REVIEWS and QUESTIONS. Content types are set inside BVParameters. Inject this content in the rating summary section of the product display page. The contents collected are injected as a single block of markup. The markup includes the main content and aggregate content, where applicable.
getReviews(BVParameters)	Retrieves the reviews section and omits the aggregate section of the content type REVIEWS. This content is injected to the Review section of the product display page.
getAggregateRating(BVParameters)	Retrieves the aggregate rating section of the REVIEWS content type. Inject this content in the rating summary section of the product display page.

Java code examples

The examples contained in this topic deploys the SDKs directly in the presentation layer, which simplifies the code but is not a recommended practice. The purpose of this example is to show an SDK integration. Ensure that you update your code to use correct values.

Note: All examples demonstrate integration that retrieves files using the cloud, unless otherwise specified.

This example shows Ratings & Reviews integration of BVSEO.

<%@page import="com.bazaarvoice.seo.sdk.model.ContentType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.SubjectType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.BVParameters"%>
<%@page import="com.bazaarvoice.seo.sdk.BVManagedUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.BVUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVClientConfig"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVSdkConfiguration"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVConfiguration"%>
<%@page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%><%

//Establish a new BVConfiguration. Properties within this configuration are typically set in bvconfig.properties.  
//addProperty can be used to override configurations set in bvconfig.properties.
BVConfiguration _bvConfig = new BVSdkConfiguration();
    _bvConfig.addProperty(BVClientConfig.CLOUD_KEY, "client-1234cloudkeygoeshere4321zxyz9876");
    _bvConfig.addProperty(BVClientConfig.BV_ROOT_FOLDER, "Main_Site-en_US"); //adjust this for each locale
    _bvConfig.addProperty(BVClientConfig.STAGING, "true");
//Prepare pageURL and SubjectID/ProductID values.       
String pageURL = request.getQueryString() == null ? request.getRequestURI() : request.getRequestURI() + "?" + request.getQueryString();
String subjectID = "ExternalId";        

//Set BV Parameters that are specific to the page and content type.
BVParameters _bvParam = new BVParameters();
    _bvParam.setBaseURI(request.getRequestURI()); // this value is used to build pagination links
    _bvParam.setPageURI(pageURL); //this value is used to extract the page number from bv URL parameters
    _bvParam.setContentType(ContentType.REVIEWS);
    _bvParam.setSubjectType(SubjectType.PRODUCT);
    _bvParam.setSubjectId(subjectID);
BVUIContent _bvOutput = new BVManagedUIContent(_bvConfig);

//Get content and place into strings, which output into the injection divs.
String sBvOutputSummary = _bvOutput.getAggregateRating(_bvParam);  //getAggregateRating delivers the AggregateRating section only
String sBvOutputReviews = _bvOutput.getReviews(_bvParam);  //getReviews delivers the review content with pagination only%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<body>
<h1>Ratings & Reviews integration of BVSEO</h1>
<h2>Using cloud for file retrieval</h2>

<div itemscope itemtype="http://schema.org/Product">
  <meta itemprop="name" content="The Amazing Wonder Ball" />
  <div data-bv-show="rating_summary" data-bv-product-id="ExternalId">
    <%=sBvOutputSummary%>
  </div>

  <div data-bv-show="reviews" data-bv-product-id="ExternalId">
    <%=sBvOutputReviews%>
  </div>
</div>

</body>
</html>

This example shows Ratings & Reviews integration of BVSEO with optional configuration parameters.

<%@page import="com.bazaarvoice.seo.sdk.model.ContentType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.SubjectType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.BVParameters"%>
<%@page import="com.bazaarvoice.seo.sdk.BVManagedUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.BVUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVClientConfig"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVSdkConfiguration"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVConfiguration"%>
<%@page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%><%

//Establish a new BVConfiguration. Properties within this configuration are typically set in bvconfig.properties.  
//addProperty can be used to override configurations set in bvconfig.properties.
BVConfiguration _bvConfig = new BVSdkConfiguration();
    _bvConfig.addProperty(BVClientConfig.CLOUD_KEY, "client-1234cloudkeygoeshere4321zxyz9876");
    _bvConfig.addProperty(BVClientConfig.BV_ROOT_FOLDER, "Main_Site-en_US"); //adjust this for each locale
    //optional configuration parameters
    _bvConfig.addProperty(BVClientConfig.CHARSET, "UTF-8");
       _bvConfig.addProperty(BVClientConfig.EXECUTION_TIMEOUT, "250");
    _bvConfig.addProperty(BVClientConfig.EXECUTION_TIMEOUT_BOT, "1500"); 
    _bvConfig.addProperty(BVClientConfig.CRAWLER_AGENT_PATTERN, "google|msnbot|bingbot|yandex"); //set your own bot list
    _bvConfig.addProperty(BVClientConfig.SSL_ENABLED, "false");
    _bvConfig.addProperty(BVClientConfig.STAGING, "true");

//Prepare pageURL and SubjectID/ProductID values.       
String pageURL = request.getQueryString() == null ? request.getRequestURI() : request.getRequestURI() + "?" + request.getQueryString();
String subjectID = "ExternalId";     

//Set BV Parameters that are specific to the page and content type.
BVParameters _bvParam = new BVParameters();
    _bvParam.setBaseURI(request.getRequestURI()); // this value is used to build pagination links
    _bvParam.setPageURI(pageURL); //this value is used to extract the page number from bv URL parameters
    _bvParam.setContentType(ContentType.REVIEWS);
    _bvParam.setSubjectType(SubjectType.PRODUCT);
    _bvParam.setSubjectId(subjectID);
BVUIContent _bvOutput = new BVManagedUIContent(_bvConfig);

//Get content and place into strings, which output into the injection divs.
String sBvOutputSummary = _bvOutput.getAggregateRating(_bvParam);  //getAggregateRating delivers the AggregateRating section only
String sBvOutputReviews = _bvOutput.getReviews(_bvParam);  //getReviews delivers the review content with pagination only%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<body>
<h1>Ratings & Reviews integration of BVSEO</h1>
<h2>Using cloud for file retrieval with optional configuration parameters</h2>

<div itemscope itemtype="http://schema.org/Product">
<meta itemprop="name" content="The Amazing Wonder Ball" />
  <div data-bv-show="rating_summary" data-bv-product-id="ExternalId">
    <%=sBvOutputSummary%>
  </div>

  <div data-bv-show="reviews" data-bv-product-id="ExternalId">
    <%=sBvOutputReviews%>
  </div>
</div>

</body>
</html>

This example shows Seller Ratings integration of BVSEO.

<%@page import="com.bazaarvoice.seo.sdk.model.ContentType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.SubjectType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.BVParameters"%>
<%@page import="com.bazaarvoice.seo.sdk.BVManagedUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.BVUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVClientConfig"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVSdkConfiguration"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVConfiguration"%>
<%@page language="java" contentType="text/html; charset=ISO-8859-1" pageEncoding="ISO-8859-1"%>
<%
   BVConfiguration _bvConfig = new BVSdkConfiguration();
      _bvConfig.addProperty(BVClientConfig.CLOUD_KEY, "srd-testcustomer-1-c3a130de760b3105e75e8202cb22e541");
      _bvConfig.addProperty(BVClientConfig.BV_ROOT_FOLDER, "Main_Site-en_US");
   String pageURL = request.getQueryString() == null ? request.getRequestURI() : request.getRequestURI() + "?" + request.getQueryString();

   BVParameters _bvParam = new BVParameters();
      _bvParam.setUserAgent(request.getHeader( "User-Agent" ));
      _bvParam.setPageURI(pageURL);
      _bvParam.setContentType(ContentType.REVIEWS);
      // Override the default setting of PRODUCT with SELLER
      _bvParam.setSubjectType(SubjectType.SELLER);
      // Set subjectId as seller
      _bvParam.setSubjectId("seller");
   BVUIContent _bvOutput = new BVManagedUIContent(_bvConfig);

   String srdContent = _bvOutput.getContent(_bvParam);%>

<html>
<body>
   <div id="BVSellerRatingsContainer">
      <%=srdContent%>
   </div>
</body>
</html>

This example shows Ratings & Reviews integration of BVSEO using the local file system for file retrieval, instead of the cloud. Refer to Select a file method in Best Practices for more information.

<%@page import="com.bazaarvoice.seo.sdk.model.ContentType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.SubjectType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.BVParameters"%>
<%@page import="com.bazaarvoice.seo.sdk.BVManagedUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.BVUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVClientConfig"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVSdkConfiguration"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVConfiguration"%>
<%@page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>
<%
//Establish a new BVConfiguration.
BVConfiguration _bvConfig = new BVSdkConfiguration();
        _bvConfig.addProperty(BVClientConfig.LOAD_SEO_FILES_LOCALLY, "true"); // set to false if using cloud-based content
        _bvConfig.addProperty(BVClientConfig.LOCAL_SEO_FILE_ROOT, "/"); //include the path to your 
        _bvConfig.addProperty(BVClientConfig.BV_ROOT_FOLDER, "Main_Site-en_US"); //adjust this for each locale
    _bvConfig.addProperty(BVClientConfig.STAGING, "true");
//Prepare pageURL and SubjectID/ProductID values.   
String pageURL = request.getQueryString() == null ? request.getRequestURI() : request.getRequestURI() + "?" + request.getQueryString();
String subjectID = "ExternalId";     

//Set BV Parameters that are specific to the page and content type.
BVParameters _bvParam = new BVParameters();
        _bvParam.setBaseURI(request.getRequestURI()); // this value is used to build pagination links
        _bvParam.setPageURI(pageURL); //this value is used to extract the page number from bv URL parameters
        _bvParam.setContentType(ContentType.REVIEWS);
        _bvParam.setSubjectType(SubjectType.PRODUCT);
        _bvParam.setSubjectId(subjectID);
BVUIContent _bvOutput = new BVManagedUIContent(_bvConfig);

//Get content and place into strings, which output into the injection divs.
String sBvOutputSummary = _bvOutput.getAggregateRating(_bvParam);  //getAggregateRating delivers the AggregateRating section only
String sBvOutputReviews = _bvOutput.getReviews(_bvParam);  //getReviews delivers the review content with pagination only
%>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<body>
<h1>Ratings & Reviews integration of BVSEO</h1>
<h2>Using local file system instead of cloud for file retrieval</h2>

<div itemscope itemtype="http://schema.org/Product">
  <meta itemprop="name" content="The Amazing Wonder Ball" />
  <div data-bv-show="rating_summary" data-bv-product-id="ExternalId">
    <%=sBvOutputSummary%>
  </div>

  <div data-bv-show="reviews" data-bv-product-id="ExternalId">
    <%=sBvOutputReviews%>
  </div>
</div>

</body>
</html>

This example shows Ratings & Reviews integration of BVSEO using a proxy.

<%@page import="com.bazaarvoice.seo.sdk.model.ContentType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.SubjectType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.BVParameters"%>
<%@page import="com.bazaarvoice.seo.sdk.BVManagedUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.BVUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVClientConfig"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVSdkConfiguration"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVConfiguration"%>
<%@page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>

<%
//Establish a new BVConfiguration.  
BVConfiguration _bvConfig = new BVSdkConfiguration();
    _bvConfig.addProperty(BVClientConfig.CLOUD_KEY, "client-1234cloudkeygoeshere4321zxyz9876");
    _bvConfig.addProperty(BVClientConfig.BV_ROOT_FOLDER, "Main_Site-en_US"); //adjust this for each locale
    _bvConfig.addProperty(BVClientConfig.PROXY_HOST, "00.000.000.000");
    _bvConfig.addProperty(BVClientConfig.PROXY_PORT, "80");
    _bvConfig.addProperty(BVClientConfig.STAGING, "true");
//Prepare pageURL and SubjectID/ProductID values.       
String pageURL = request.getQueryString() == null ? request.getRequestURI() : request.getRequestURI() + "?" + request.getQueryString();
String subjectID = "ExternalId";     

//Set BV Parameters that are specific to the page and content type.
BVParameters _bvParam = new BVParameters();
    _bvParam.setBaseURI(request.getRequestURI()); // this value is used to build pagination links
    _bvParam.setPageURI(pageURL); //this value is used to extract the page number from bv URL parameters
    _bvParam.setContentType(ContentType.REVIEWS);
    _bvParam.setSubjectType(SubjectType.PRODUCT);
    _bvParam.setSubjectId(subjectID);
BVUIContent _bvOutput = new BVManagedUIContent(_bvConfig);

//Get content and place into strings, which output into the injection divs.
String sBvOutputSummary = _bvOutput.getAggregateRating(_bvParam);  //getAggregateRating delivers the AggregateRating section only
String sBvOutputReviews = _bvOutput.getReviews(_bvParam);  //getReviews delivers the review content with pagination only
%>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<body>
<h1>Ratings & Reviews integration of BVSEO</h1>
<h2>Using cloud for file retrieval via a proxy</h2>

<div itemscope itemtype="http://schema.org/Product">
  <meta itemprop="name" content="The Amazing Wonder Ball" />

  <div data-bv-show="rating_summary" data-bv-product-id="ExternalId">
    <%=sBvOutputSummary%>
  </div>

  <div data-bv-show="reviews" data-bv-product-id="ExternalId">
    <%=sBvOutputReviews%>
  </div>
</div>

</body>
</html>

This example shows Ratings & Reviews and Questions & Answers integration of BVSEO.

<%@page import="com.bazaarvoice.seo.sdk.model.ContentType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.SubjectType"%>
<%@page import="com.bazaarvoice.seo.sdk.model.BVParameters"%>
<%@page import="com.bazaarvoice.seo.sdk.BVManagedUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.BVUIContent"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVClientConfig"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVSdkConfiguration"%>
<%@page import="com.bazaarvoice.seo.sdk.config.BVConfiguration"%>
<%@page language="java" contentType="text/html; charset=ISO-8859-1"
    pageEncoding="ISO-8859-1"%>

<%
//Establish a new BVConfiguration. Properties within this configuration are typically set in bvconfig.properties.  
//addProperty can be used to override configurations set in bvconfig.properties.
BVConfiguration _bvConfig = new BVSdkConfiguration();
    _bvConfig.addProperty(BVClientConfig.CLOUD_KEY, "client-1234cloudkeygoeshere4321zxyz9876");
    _bvConfig.addProperty(BVClientConfig.BV_ROOT_FOLDER, "Main_Site-en_US"); //adjust this for each locale
    _bvConfig.addProperty(BVClientConfig.STAGING, "true");
//Prepare pageURL and SubjectID/ProductID values.       
String pageURL = request.getQueryString() == null ? request.getRequestURI() : request.getRequestURI() + "?" + request.getQueryString();
String subjectID = "ExternalId";     

//Set BV Parameters that are specific to the page and content type.
//BVParameters for Ratings & Reviews
BVParameters _bvParam = new BVParameters();
    _bvParam.setBaseURI(request.getRequestURI()); // this value is used to build pagination links
    _bvParam.setPageURI(pageURL); //this value is used to extract the page number from bv URL parameters
    _bvParam.setContentType(ContentType.REVIEWS);
    _bvParam.setSubjectType(SubjectType.PRODUCT);
    _bvParam.setSubjectId(subjectID);
BVUIContent _bvOutput = new BVManagedUIContent(_bvConfig);

//Get content and place into strings, which output into the injection divs.
String sBvOutputSummary = _bvOutput.getAggregateRating(_bvParam);  //getAggregateRating delivers the AggregateRating section only
String sBvOutputReviews = _bvOutput.getReviews(_bvParam);  //getReviews delivers the review content with pagination only

//BVQAParameters for Questions & Answers
BVParameters _bvQAParam = new BVParameters();
    _bvQAParam.setBaseURI(request.getRequestURI()); // this value is used to build pagination links
    _bvQAParam.setPageURI(pageURL); //this value is used to extract the page number from bv URL parameters
    _bvQAParam.setContentType(ContentType.QUESTIONS);
    _bvQAParam.setSubjectType(SubjectType.PRODUCT);
    _bvQAParam.setSubjectId(subjectID);
BVUIContent _bvQAOutput = new BVManagedUIContent(_bvConfig);

//Get content and place into strings, which output into the injection divs.
String sBvOutputQAContent = _bvQAOutput.getContent(_bvQAParam);  //For Questions & Answers getContent should always be used.
%>
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<body>
<h1>Ratings & Reviews and Questions & Answers integration of BVSEO</h1>
<h2>Using cloud for file retrieval</h2>

<div itemscope itemtype="http://schema.org/Product">
  <meta itemprop="name" content="The Amazing Wonder Ball" />
  <div data-bv-show="rating_summary" data-bv-product-id="ExternalId">
    <%=sBvOutputSummary%>
  </div>

  <div data-bv-show="reviews" data-bv-product-id="ExternalId">
    <%=sBvOutputReviews%>
  </div>
</div>

  <div data-bv-show="questions" data-bv-product-id="ExternalId">
    <%=sBvOutputQAContent%>
  </div>
</body>
</html>

Add code using the .NET SDK

The following requirements are necessary to install the .NET SDK:

Familiarity with .NET development and Visual Studio IDE
.NET Framework 3.5 or above
Visual Studio
BVSEO SDK library for .NET

Download the SDK

Download the appropriate .NET SDK file from the following location: BVSEO .NET SDK .

The following table describes the files that are included in your download.

Filename	Description
BVSeoSdkDotNet.dll	BVSEO library that supports both cloud SEO and the local file method.
Commons.dll	Library dependency for Apache Commons.
log4net.dll	Library dependency for logging.
NVelocity.dll	Library dependency for Apache NVelocity, which handles templating.
BVSeoSdkDotNet.pdb	Contains debugging information.

Customize the SDK

Fork from the following link to perform customizations: github.com/bazaarvoice/seo_sdk_dotnet

Set up your project

Follow these steps to set up your project. Each step includes an example value.

Create an ASP.NET web application project in Visual Studio IDE, then select an empty template.

Example: SampleWebApplication
Unzip the contents from the downloaded SDK library zip file.
From the Solution Explorer, expand the new project and right-click references to add the following libraries from the SDK binary: BVSeoSdkDotNet.dll, Commons.dll, log4net.dll, and NVelocity.dll.
Add a new aspx page to your application. Usually this page will be your product detail page (PDP).

Example: Sample.aspx example code
Add necessary code in Sample.aspx and Sample.aspx.cs as shown in the example code.
Right-click Sample.aspx and add it as a startup page.
Note: For steps 6 and 7, ensure that SampleWebApplication is your startup project if you have more than one project in your solution.
Press Crtl+F5 to run your application, or open the debug menu and select Start Without Debugging.

Set up the .NET code

Follow these steps to set up the .NET code:

Configure using BVConfiguration.
Set the parameters for your PDP using BVParameters.
Get the contents using BVManagedUIContent.

Refer to .NET SDK inputs and features for more detailed information on each of these steps.

Refer to .NET code examples for code examples.

Test your application

Follow these steps to test and debug your application of the .NET SDK:

Access the application via URL. Running your application using IDE should open up your page automatically if you have set it up as a startup page.

Example: http://localhost:8080/Sample.aspx
View the page source. Review contents and SEO <metadata> tags should appear inside the BVRRContainer.
Verify that SEO <metadata> tags, as shown in the following code sample, appear after every review.

<ul id="BVSEOSDK_meta" style="display:none!important;">
    <li data-bvseo="sdk">bvseo_sdk, net_sdk, x.y.z.0</li>
    <li data-bvseo="sp_mt">getReviews, method:CLOUD, 33ms</li>
    <li data-bvseo="ct_st">REVIEWS, PRODUCT</li>
 </ul>

If the SEO <metadata> tags do not match as shown in the code sample, troubleshoot and take appropriate action based on the error message displayed in the SEO <metadata> tag.

To debug your application, complete these steps:

Step 1: Add bvreveal=debug

Add the bvreveal=debug parameter to the URL of any page where BVSEO is implemented.

Example: http://yoursite.net/ExampleGetContent.aspx?bvreveal=debug

The bvreveal=debug parameter adds BVSEOSDK_meta and BVSEOSDK_DEBUG lists to the source code, which contain information about your implementation. If there is no user-generated content (UGC), bvseo-msg will provide more details.

Note: If pageURL is not set up correctly, bvreveal=debug will not work. If you do not provide a debug footer, pagination links may be incorrect.
View the page's source code to find information about your implementation. This information is included in BVSEOSDK_meta and BVSEOSDK_DEBUG. Refer to the full example code at the end of this section.

Step 2: Check for content

Check if content exists for the requested contentURL, as described in the following steps:

Find the contentURL in the BVSEOSDK_DEBUG list. Example: <li data-bvseo="contentURL">http://seo-stg.bazaarvoice.com/myshco-69cb945801532dcfb57ad2b0d2471b68/Main_Site-en_US/reviews/product/1/5000001.htm</li>
From the terminal, run the curl –i command. Example: curl –i "http://seo-stg.bazaarvoice.com/myshco-69cb945801532dcfb57ad2b0d2471b68/Main_Site-en_US/reviews/product/1/5000001.htm"

If the curl command does not return content, it could be a firewall issue or no content exists for this ProductID. Contact your Bazaarvoice representative for further troubleshooting.

Error messages

The following error messages may appear when debugging.

HTTP status code of 0 was returned (or) connection refused to seo-stg.bazaarvoice.com—Indicates that a firewall exists on your network. Outbound requests from your network may be blocked by your firewall. Contact your IT team to sort out firewall issues.
The resource to the URL or file is currently unavailable—Indicates that something is wrong with the implementation configuration or no content was generated for the specified product.

Example:

<ul id="BVSEOSDK_meta" style="display:none!important">
    <li data-bvseo="sdk">bvseo_sdk, net_sdk, x.y.z.0</li> 
    <li data-bvseo="sp_mt">getContent, method:CLOUD, 656ms</li> 
    <li data-bvseo="ct_st">QUESTIONS, PRODUCT</li> 
    <li data-bvseo="ms">bvseo-msg: The resource to the URL or file is currently unavailable.;</li>  
</ul> 

<ul id="BVSEOSDK_DEBUG" style="display:none;"> 
    <li data-bvseo="crawlerAgentPattern">yandex</li> 
    <li data-bvseo="staging">true</li> 
    <li data-bvseo="seo.sdk.enabled">true</li> 
    <li data-bvseo="testingProductionS3Hostname">seo-qa.bazaarvoice.com</li> 
    <li data-bvseo="stagingS3Hostname">seo-stg.bazaarvoice.com</li> 
    <li data-bvseo="seo.sdk.execution.proxy.host">none</li> 
    <li data-bvseo="seo.sdk.execution.timeout.bot">2000</li> 
    <li data-bvseo="socketTimeout">2000</li> 
    <li data-bvseo="testingStagingS3Hostname">seo-qa-stg.bazaarvoice.com</li> 
    <li data-bvseo="cloudKey">myshco-3e3001e88d9c32d19a17cafacb81bec7</li>  
    <li data-bvseo="localSEOFileRoot">/</li> 
    <li data-bvseo="bv.root.folder">9344</li> 
    <li data-bvseo="seo.sdk.execution.proxy.port">0</li> 
    <li data-bvseo="testing">false</li> 
    <li data-bvseo="productionS3Hostname">seo.bazaarvoice.com</li> 
    <li data-bvseo="connectTimeout">2000</li> 
    <li data-bvseo="loadSEOFilesLocally">false</li> 
    <li data-bvseo="seo.sdk.charset">UTF-8</li> 
    <li data-bvseo="seo.sdk.ssl.enabled">false</li> 
    <li data-bvseo="includeDisplayIntegrationCode">false</li> 
    <li data-bvseo="seo.sdk.execution.timeout">1500</li> 
    <li data-bvseo="en">true</li> 
    <li data-bvseo="pn">bvseo-2</li> 
    <li data-bvseo="userAgent">Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.130 Safari/537.36</li> 
    <li data-bvseo="baseURI">http://bvvseodotnetdevelopment.azurewebsites.net/ExampleGetContent.aspx</li>   
    <li data-bvseo="pageURI">http://bvvseodotnetdevelopment.azurewebsites.net/ExampleGetContent.aspx?bvstate=pg:2/ct:q/reveal:debug</li>    
    <li data-bvseo="subjectId">5000001</li> 
    <li data-bvseo="contentType">questions</li> 
    <li data-bvseo="subjectType">product</li> 
    <li data-bvseo="contentURL">http://seo-stg.bazaarvoice.com/myshco-3e3001e88d9c32d19a17cafacb81bec7/9344/questions/product/2/5000001.htm</li> 
</ul>

.NET SDK inputs and features

This topic provides details about the core classes in the BVSEO SDK, including configuration options and methods of use for the .NET platform.

BVConfiguration

BVConfiguration configures the BVSEO SDK. It has two APIs:

BVConfiguration.addProperty—Adds properties to BVConfiguration.
BVConfiguration.getProperty—Gets properties from BVConfiguration.
Note: BVConfiguration.getProperty is for Bazaarvoice internal use only.

BVSdkConfiguration is an implementation interface for BVConfiguration. Make sure to add using BVSeoSdkDotNet.Config.

.NET usage

BVConfiguration bvConfig = new BVSdkConfiguration();

Adding properties

Adding and setting attributes in BVConfiguration changes the functionality and behavior of the SDK. Configuration options are listed in the following SDK configuration attributes table.

Set these attributes using the addProperty method on BVConfiguration.

.NET usage: bvConfig.addProperty(BVClientConfig.CLOUD_KEY, “your_cloud_key”);

SDK configuration attributes table

Attribute	Type	Description
CLOUD_KEY	Required	Cloud key string. Specifies the key used to locate the cloud SEO files. Contact Bazaarvoice to obtain the value you need for this property. This attribute is optional if LOAD_LOCAL_FILES is used.
BV_ROOT_FOLDER	Required	Folder path declaration. Specifies the folder where SEO files are located. This is also known as the display code. Unique root folders are created for each deployment zone and locale. Contact Bazaarvoice to obtain the value you need for this property.
SEO_SDK_ENABLED	Optional	Boolean. Specifies whether to enable SEO SDK (True) or disable it (False). Default: True
EXECUTION_TIMEOUT	Optional	Numeric value. Specifies the time in milliseconds (ms) to complete the SEO call for user agents and search engine bots (such as browsers) not in CRAWLER_AGENT_PATTERN. Default: 500
EXECUTION_TIMEOUT_BOT	Optional	Numeric value. Specifies the time in milliseconds (ms) to complete the SEO call for search engine bots that match CRAWLER_AGENT_PATTERN. Default: 2000
CRAWLER_AGENT_PATTERN	Optional	List of search engine bot user agents. Overrides the default list of search engine bot user agents. You can add and remove agents from the list. Multiple values are separated by “\|”. Default: msnbot\|google\|teoma\|bingbot\| yandexbot\|yahoo
STAGING	Optional	Boolean value. Specifies whether to get SEO contents from staging (True) or from production (False) . Not applicable when using LOAD_SEO_FILES_LOCALLY. Default: False Note: It is common to forget to disable staging data. Check if the SDK to retrieve staging data (True) if you are not receiving content from production.
SOCKET_TIMEOUT	Optional	Numeric value. Specifies atimeout for establishing connection and reading complete contents. Used internally by the SDK. Do not modify this value unless there is a network or bandwidth issue causing frequent socket/read timeouts. This value is used for cloud SEO only and is not applicable when using LOAD_SEO_FILES_LOCALLY. Default: 2000 ms
CONNECT_TIMEOUT	Optional	Numeric value. Specifies a timeout for establishing connection to cloud SEO. Used internally by the SDK. Do not modify unless necessary. Default: 2000 ms
CHARSET	Optional	Character set declaration. Specifies a character set. If not specified, the default value is UTF-8. For example, use "shift_jis" when the Shift JIS character set is used. Default: Uses the default value set by your operating system.
SSL_ENABLED	Optional	Boolean value. Specifies whether or not SSL connections are required (True). Not applicable when using LOAD_SEO_FILES_LOCALLY. Default: False
PROXY_HOST	Optional	Proxy host declaration. Specifies a proxy host, which is needed by some clients for security reasons. The most common use case is when firewall rules can only be set for an IP address, not a domain. Cloud SEO uses a wide range of IP addresses that are subject to change at any time, so Bazaarvoice does not provide cloud SEO IP addresses to clients. Not applicable when using LOAD_SEO_FILES_LOCALLY. Note: To enable proxy, both PROXY_HOST and PROXY_PORT must be set.
PROXY_PORT	Optional	Numeric value. Specifies the port number on which the proxy/gateway system is listening. Use with PROXY_HOST.
LOAD_SEO_FILES_LOCALLY	Optional	(Not recommended.) Boolean value. Specifies whether to load SEO files locally (True) or not (False). Local file configurations can help overcome system limitations. A local file system can be fragile since Bazaarvoice is not responsible for the daily retrieval, unpacking, and distribution of SEO files. To enable local files, LOCAL_SEO_FILE_ROOT must be set.
LOCAL_SEO_FILE_ROOT	Optional	(Not recommended.) Boolean value. Specifies whether to set the root path of the extracted SEO contents to BV_ROOT_FOLDER on the local file system (True) or not (False). Use with LOAD_SEO_FILES_LOCALLY.

BVParameters

This is a model used by the SDK that is added using BVSeoSdkDotNet.Model

.NET usage

BVParameters bvParameters = new BVParameters
{
BaseURI = <baseURI>,
…
SubjectId = “exampleExternalId”
};

BVParameters bvParameters = new BVParameters();
bvParameters.SubjectId = “exampleExternalId”
…

SDK parameters

Attribute	Type	Description
setUserAgent	Required	Browser’s user-agent header information. This is used by the SDK to identify if it is a search engine bot or a normal user. This information can be retrieved from HTTPServletRequest in Java. This search engine bot is determined and matched from the configuration set by CRAWLER_AGENT_PATTERN.
setBaseURI	Required	URL that is used to create pagination links. Bazaarvoice will add the parameter bvstate to the base_url. In most cases, this should include the product or service page's canonical URL. Required for product reviews. The URL can be absolute, relative, or blank (null is allowed).
setPageURI	Required	Sends all query parameters attached to the current URL. Bazaarvoice will use these parameters to determine which page of reviews or questions and answers content to include. You must send the full URL.
setSubjectID	Required	Identifier for the SEO subject to retrieve the content, which depends on the SubjectType you select. For example, if SubjectType is Product, this value is the productId. If SubjectType is Category, this value is reviewId.
setContentType	Required	Enum type, defined in ContentType, that retrieves SEO content. Possible values include REVIEWS, REVIEWSPAGE, QUESTIONS, QUESTIONSPAGE, and UNIVERSAL.
setSubjectType	Required	Enum type defined in SubjectType that retrieves content for a specific subject type. Possible values are PRODUCT, CATEGORY, ENTRY, or DETAIL.

BVUIContent

BVUIContent is used to get SEO contents after you supply the correct BVConfiguration and BVParameters.

BVUIContent exposes three APIs: getContent, getReviews, and getAggregateRating. Each of these requires valid BVParameters. The following BVUIContent APIs table explains how to use the APIs.

BVManagedUIContent is an implementation for BVUIContent and is added using BVSeoSdkDotNet.Content.

.NET usage

BVUIContent bvUIContent = new BVManagedUIContent(bvConfig);

string theContent = bvUIContent.getContent(bvParameters);

BVUIContent API

API	Purpose
getContent(BVParameters)	Retrieves the complete content of the subject. Supported content types include REVIEWS and QUESTIONS. Content types are set inside BVParameters. Inject this content in the rating summary section of the product display page. The contents collected are injected as a single block of markup. The markup includes the main content and aggregate content, where applicable.
getReviews(BVParameters)	Retrieves the reviews section and omits the aggregate section of the content type REVIEWS. This content is injected to the Review section of the product display page.
getAggregateRating(BVParameters)	Retrieves the aggregate rating section of the REVIEWS content type. Inject this content in the rating summary section of the product display page.

.NET code examples

The examples contained in this topic deploy the SDK directly on an empty ASP.NET project with ASPX webform code behind a page, which simplifies the code but is not a recommended practice. The purpose of these examples is to show how an SDK integration is done. Ensure that you update your code to use proper values.

Note: If you are using a Web Site project, be sure to switch the CodeBehind page directive to CodeFile before copying the examples.

Sample.aspx

<%@ Page Language="C#" AutoEventWireup="true" CodeBehind="Sample.aspx.cs" Inherits="SampleWebApplication.Sample" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><title>Sample SDK Implementation</title></head>
<body>
   <div id="SEO_BVRRSummaryContainer" runat="sever" data-bv-show="rating_summary" data-bv-product-id="ExternalId"></div> 
  <div id="SEO_BVRRContainer" runat="sever" data-bv-show="reviews" data-bv-product-id="ExternalId"></div>
</body>
</html>