Involver Developer Network : bazaarvoice
This page last changed on Oct 24, 2011 by jed.wheeler@involver.com.
OverviewInvolver and Bazaarvoice have partnered to bring the power of Bazaarvoice's Ratings and Reviews offering to the audience of Facebook. Powered by SML, the Bazaarvoice SML application lets developers customize each Ratings and Reviews application to provide the best experience to end users possible. Tab and Canvas PagesThe Bazaarvoice application consists of three distinct pages, each driven by a separate SML template. Tab (Fan Page) ViewThe Tab view (bazaarvoice_520px) drives the initial experience shown on a Facebook fan page. This is the standard entry point for an end user, and can be configured to show a combination of product, author and review modules.
Category Canvas PageThe Category Canvas page (bazaarvoice_760px_category) expands the tab view into the full 760px width of a canvas page, allowing for additional navigation UI. The Category canvas page restricts all modules to the current active category. If no category is selected, modules will display the same data as on the tab view. Product Canvas PageThe Product Canvas page is the UI for a single product. This is the only page that allows for user submission of data by submitting a review form. All data displayed on the page is associated with a single product. ConfigurationAt bare minimum, a BazaarvoiceFeature requires the following information:
The current SML templates are stored in a shared Github repository for joint use by Involver and Bazaarvoice. Use the most up to date SML template as included in the bazaarvoice-templates repository. If you do not have access, please make a request for your Github account to be added to the list of approved users. Once the main 520px layout has been saved to the SML feature, a BazaarvoiceFeature will be generated. The feature exposes the rest of the configuration necessary to run the Bazaarvoice application. Featured ProductsTwo methods are allowed for providing products: Automatic and manual configuration.
A list of categories will be backfilled based on the featured products provided. API SettingsThe Bazaarvoice API requires a secret key for data retrieval and an encoding key for review form interactions. We allow any application to use production or staging data at any time. Please exercise caution when configuring test and production pages to ensure the page is configured appropriately. URLsURL settings allow the privacy policy and Terms of Service URLs to be set for a particular client. All image URLs are deprecated in favor of editable_image. The images in use are:
Module ConfigurationEach module displayed on a page can be toggled on or off. Due to width issues, we recommend that exactly TWO of the following modules be enabled at any given time:
Form Field Configuration"Always Shown Fields" is a list of field names that should show above the fold. "Review Field Labels" is used to override labels returned from the Form API. This is required for fields without labels to show in a form view. Styles and TemplatesFor the Bazaarvoice application to function properly, three templates must be provided via the feature settings page. As mentioned above, these templates are stored in the shared Github repository. When provisioning a new application, be sure to use the most recent version of all templates.
Caching ConsiderationsBazaarvoice API data is automatically updated each hour. In addition, data is updated whenever a change is made to feature configuration. The Settings page for a Bazaarvoice application shows time elapsed since the last API data sync. Attributes
Context Variables
Associated ObjectsCategoryThe category object bundles all data for a given category. On a Category Canvas page, the current category drives most of the data on the page. ProductA product object represents a product from the user's catalog, along with any associated metadata. This is the record of note on a Product canvas page. AuthorThe author object represents a user who has left a review. If the user left a review via the Facebook Ratings and Reviews app, more Facebook-specific information will be available in the model. ReviewThe review object represents a review of a product, either pending or complete. FormThe form object encapsulates information from the Bazaarvoice Form API for review form display. This is primarily used by the form SML partial on the Product page. LimitationsThe block does not use a default template. Unless used with a parent SML feature, SML templates must be provided in every case. FAQThere are currently no FAQ questions for this item. Related Topics |
![]() |
Document generated by Confluence on Feb 12, 2013 09:09 |