高级集成选项

参考以下高级集成任务:

• 加载bvapi.js异步API
• 使用JavaScript实现登录重定向(站点身份验证)
• 使用ajax类型的登录方法进行集成
• 显示位于选项卡后面的内容
• 实现同页提交
• 使用JavaScript事件回调跟踪事件
• 事件回调报告参数和值
• 事件回调代码示例

异步加载bvape .js API

所有Bazaarvoice内容，除了API加载器文件bvapi.js异步加载。

如果必须异步加载内容，则不要包含bvapi.jsscript标签直接在你的HTML页面。包括bvapi.js改用以下脚本块之一的脚本:

• 如果你使用jQuery，包括以下块:

  <脚本类型=“text / javascript”>varbvapiUrl＝窗口。位置。协议+＂/ / default.ugc.bazaarvoice.com/bvstaging/static/1235-en_us/bvapi.js＂；窗口。loadBazaarvoiceApi＝函数（回调）｛如果（窗口。BV美元）｛回调();｝其他的｛＄。ajax({url：bvapiUrl，缓存：真正的，数据类型：＂脚本＂，成功：函数（）｛＄（BV美元。docReady）;回调();｝});｝};> < /脚本

• 如果不使用jQuery，请包含以下JavaScript:

  <脚本类型=“text / javascript”>（函数（）｛varbvapiUrl＝窗口。位置。协议+＂/ / default.ugc.bazaarvoice.com/bvstaging/static/1235-en_us/bvapi.js＂；函数getScript（url，回调）｛var头＝文档。getElementsByTagName（＂头＂) [0］||文档。documentElement，脚本＝文档。createElement（＂脚本＂）;脚本。src＝url；脚本。类型＝＂text / javascript＂；脚本。字符集＝＂utf - 8＂；脚本。setAttribute（＂异步＂，＂异步＂）;脚本。onload＝脚本。onreadystatechange＝函数（）｛如果（！这。请求处理||这。请求处理= = =＂加载＂||这。请求处理= = =＂完整的＂）｛脚本。onload＝脚本。onreadystatechange＝零；回调();｝};头。方法（脚本，头。写上。）;｝//工作在Firefox 3.0, 3.5缺乏document.readyState/ /属性。//注意:由于这个解决方案，<脚本>片段必须//包含在<头>或<div>元素所以那它//在触发窗口加载事件之前执行。vardocReady，onDocReady＝函数（）{docReady＝真正的};如果（文档。请求处理= = =未定义的& &文档。addEventListener）｛文档。addEventListener（＂DOMContentLoaded＂，onDocReady，假）;窗口。addEventListener（＂负载＂，onDocReady，假）;｝窗口。loadBazaarvoiceApi＝函数（回调）｛如果（窗口。BV美元）｛回调();｝其他的｛getScript（bvapiUrl，函数（）｛如果（docReady）｛BV美元。docReady();｝回调();});｝};}) ();> < /脚本

所有对Bazaarvoice API函数的后续调用，例如$ BV.ui ()，都被包装在loadBazaarvoiceApi调用中，如下例所示:

loadBazaarvoiceApi（函数（）｛BV美元。用户界面（＂rr＂，＂show_reviews＂，｛productId：＂test1＂});});

实现内联评级

在分类或搜索页面上包含内联评级，可以为正在研究或比较产品的消费者提供有用的摘要信息。必威手机版本内联评级帮助消费者选择他们想要查看的产品或他们想要深入研究的pdp。必威手机版本

内联评级代码允许您显示:

• 星级图片
• 总体平均评分的十进制值(例如，4.5)
• 评论数量(例如116)

您可以使用两种不同的方法实现内联评级:

• 方法1:API的对话(推荐方法)
• 方法2:等级出口XML提要

方法比较

方法1:使用对话API显示内联评级(推荐的方法)

内联星级评级帮助您的客户研究和比较产品。必威手机版本的API的对话提供了一个高度优化的API方法，用于检索评论统计数据，如平均评分。

此方法专门用于处理搜索结果页面和产品类别列表页面等高强度应用程序。

例如，在呈现搜索结果页面时，可以为每个所需的产品ID调用对话API。

• 在呈现页面之前，不需要在本地缓存这些统计信息。
• 不需要存储恒星图像的本地副本。Bazaarvoice可以托管明星图像。
• 此方法使您可以根据需要灵活地显示评级和图像。

1. 若要为对话API请求生产和登台密钥，请使用键请求流程。
2. 要请求审查统计数据，使用适当的产品ID调用对话API:

   • 生产:

     http://api.bazaarvoice.com/data/statistics.json?apiversion=5.4&passkey=[api key]&filter=productid:[产品id]&stats=评论

   • 分段:

     http://stg.api.bazaarvoice.com/data/statistics.json?apiversion=5.4&passkey=[api key]&filter=productid:[产品id]&stats=评论

     下面的URL显示了一个现场示例:http://stg.api.bazaarvoice.com/data/statistics.json?apiversion=5.4&passkey=kuy3zj9pr3n7i0wxajrzj04xo&filter=productid:test1&stats=reviews

3. 映射API响应中返回的总体评分值(四舍五入到一位小数点后)，以链接到适当的bazaarvoice承载的星形图像URL。

   • 图片URL模式:

     http://default.ugc.bazaarvoice.com/1235-en_us/[总评分值]/[最大评分:5]/rating.gif

     下面的例子在5颗星中检索3.1颗星的图像:

     http://default.ugc.bazaarvoice.com/1235-en_us/3_1/5/rating.gif

4. 使用API响应和星形图在类别或搜索列表页面上根据需要显示内联评级图像和总体评级值。

方法2:使用仅限评级的导出XML提要显示内联评级

内联星级评级帮助您的客户研究和比较产品。必威手机版本仅限评级的导出提要是每日基于xml的特定于产品的、与评级相关的内容导出，包括一系列明星图像。这些星形图像表示从0.0到5.0的评级值，并以十分之一递增。

1. 将Bazaarvoice XML ZIP文件中的图像存储在服务器上。
2. 下载Bazaarvoice仅限评级的导出提要，并执行以下步骤之一:
   • 将提要存储在服务器上，以便直接引用评级和评论计数。
   • 将总体评分和评论计数插入到数据库中。
3. 使用适当的产品ID在静态文件或本地数据库中查找以下值:
   • 整体评级
   • 评论数量
4. 将数据库中的总体评级值映射到适当的星图文件。例如，如果整体评级值为3.7，则将其映射到名为rating-3_7.gif。

有关更多信息，请参阅等级出口饲料的话题。

使用JavaScript实现登录重定向(站点身份验证)

Bazaarovice建议实现托管身份验证。但是，如果构建托管实现重定向逻辑成本太高或在技术上不可行，请遵循以下说明来实现站点身份验证。

1. 将下面的示例代码放在头您想要显示Bazaarvoice内容的每个页面的部分:

   <脚本类型=“text / javascript”src =" / / default.ugc.bazaarvoice.com/bvstaging/static/1235-en_us/bvapi.js”>> < /脚本<脚本类型=“text / javascript”>BV美元。配置（＂全球＂，｛userToken：＂XXXXX＂，doLogin：函数（successCallback，successUrl）｛窗口。位置＝＂http://www.client.com/login.html?return=＂+encodeURIComponent（successUrl）;｝});> < /脚本

   XXXXX表示Bazaarvoice编码的用户认证字符串(UAS)。指生成用户身份验证字符串获取更多信息。如果没有合适的值，则将此值保留为空。

2. 替换的值doLogin当Bazaarvoice需要用户身份验证时调用该函数。

在单独页面上成功尝试登录后，用户将被重定向回的值successUrl。

使用ajax类型的登录方法进行集成

successCallback如果使用ajax类型的登录方法并且用户仍然在提交容器页面上，则可以执行。

1. 将下面的示例代码放在头部分，您想要显示Bazaarvoice内容的每个页面。

   <脚本类型=“text / javascript”src =" / / default.ugc.bazaarvoice.com/bvstaging/static/1235-en_us/bvapi.js”>> < /脚本<脚本类型=“text / javascript”>BV美元。配置（＂全球＂，｛userToken：＂XXXXX＂，doLogin：函数（successCallback，successUrl）｛myExampleAjaxLogin（函数myExampleAfterLogin（encoded_user_string）｛successCallback（encoded_user_string）;});}，});> < /脚本

   XXXXX代表Bazaarvoice用户认证字符串(UAS)。如果没有合适的值，则将此值保留为空。

2. 替换的值doLogin当Bazaarvoice需要用户身份验证时调用该函数。
3. 用户登录成功后，再进行呼叫successCallback并将UAS作为第一个参数传递。

显示位于选项卡后面的内容

如果Bazaarvoice内容隐藏在选项卡或其他UI元素后面，则实现回调，以便在适当的条件下显示内容，例如指向特定评论或问题或答案内容的目标链接。

要实现这样的回调，请定义doShowContent选项。show_ * $ BV.ui ()调用，如下面的示例代码所示。

<脚本类型=“text / javascript”>BV美元。用户界面（＂rr＂，＂show_reviews＂，｛productId：＂XXXXX＂，doShowContent：函数（）｛myExampleShowTab（＂# ReviewsTab＂）;｝});> < /脚本

虽然前面的示例代码引用了评级和评论集成，但是doShowContent函数适用于所有特性集成。

Bazaarvoice调用指定的函数doShowContent，所以在前面的例子中，这个函数调用myExampleShowTab。

• doShowContent支持异步操作。此类操作的一个常见需求是包含来自流行JavaScript库(如jQuery)的函数。
• 该函数可以配置回调，以防止发生基于内容聚焦的操作。例如，返回值假从doShowContent防止滚动到内容，如下面的代码所示。

函数doShowContent（应用程序，displayCode，主题，deepLinkId，回调，源）｛如果（我想要来滚动）｛myExampleAsyncShowTab（＇# exampleReviewsTab＇，｛onFinish：回调});返回假；｝其他的｛返回假；｝｝

属性的可能值，请参见下表源对象。使用以下值可防止特定的内容集中操作，具体取决于触发这些操作的事件。

实现同页提交

同页提交允许您使用单个页面来显示和提交用户生成的内容。

下面的主题描述了处理登录任务、填充提交的JavaScript函数iframe元素，并管理页面显示:

• ajax类型的登录方法
• 单独的登录页面

使用ajax类型的登录方法实现同页提交

虽然Bazaarvoice支持同页提交，但必须定义额外的配置选项，以考虑所有用户交互，包括涉及登录集成的交互。

即使启用了同页提交，也建议你建立一个独立的提交容器来驱动电子邮件活动期间的UGC提交。

下面的示例代码提供了必须实现的代码存根，以支持使用ajax类型登录方法的同页提交。

<脚本类型=“text / javascript”>BV美元。配置（＂全球＂，｛allowSamePageSubmission：真正的，userToken：＂XXXXX＂，doLogin：函数（successCallback，successUrl）｛myExampleAjaxLogin（函数myExampleAfterLogin（encoded_user_string）｛successCallback（encoded_user_string）;});}，doShowSubmission：函数（）｛myExampleShowLightbox（＂Submission_Lighbox＂）;}，onSubmissionReturn：函数（）｛myExampleCloseLightbox（＂Submission_Lighbox＂）;}，doScrollSubmission：函数（）｛myExampleScrollToSubmission();返回假；｝});> < /脚本

对该代码进行以下更改:

1. 取代userToken的价值XXXXX用Bazaarvoice编码的无人机。如果没有值可以放在这个位置，请将其留空。
2. 替换的值doLogin用你设计的功能。Bazaarvoice在需要用户身份验证时调用此函数，提供值userToken为空白或未设置。
3. 登录成功后，呼叫successCallback并将UAS作为第一个参数传递。
4. 替换的值doShowSubmission用你设计的功能。Bazaarvoice在加载提交表单之前调用这个函数。此函数可用于显示灯箱或切换到必须加载提交表单的选项卡。
5. 替换的值onSubmissionReturn用你设计的功能。Bazaarvoice在提交完成后调用此函数。此函数可用于关闭灯箱或切换到加载提交表单的选项卡。
6. 替换的值doScrollSubmission用你设计的功能。Bazaarvoice在显示或更新提交表单后调用此函数。这个函数可以通过返回false来防止默认的滚动行为。

7. 放置以下内容div元素，您希望在产品或类别页面上加载提交表单的位置。

   < divid =“BVSubmissionContainer”> < / div >

   或者，将提交表单加载到不同的div元素，例如div其中主要Bazaarvoice内容加载，覆盖提交div名称，如下例所示的评级和评论。

   BV美元。用户界面（＂rr＂，＂show_reviews＂，｛productId：＂A1234＂，submissionContainerDiv：＂BVRRContainer＂});

当此代码与示例结合使用时BV.configure美元，“写评论”链接会导致提交表单加载到显示评论主块的位置。

使用单独的登录页面实现同页提交

您可以在单独的登录页面(与ajax类型的登录方法相反)同时启用同页提交。下面的示例代码提供了必须实现的代码存根。

<脚本类型=“text / javascript”>BV美元。配置（＂全球＂，｛allowSamePageSubmission：真正的，userToken：＂XXXXX＂，doLogin：函数（successCallback，successUrl）｛窗口。位置＝＂http://www.client.com/login.html?return=＂+encodeURIComponent（successUrl）;}，doShowSubmission：函数（）｛myExampleShowLightbox（＂Submission_Lighbox＂）;}，onSubmissionReturn：函数（）｛myExampleCloseLightbox（＂Submission_Lighbox＂）;}，doScrollSubmission：函数（）｛myExampleScrollToSubmission();返回假；｝});> < /脚本

对该代码进行以下更改:

1. 取代userToken的价值XXXXX用bazaarvoice编码的无人机。如果您没有要放置在此位置的值，请将其留空。
2. 替换的值doLogin用你设计的功能。Bazaarvoice在需要用户身份验证时调用此函数。确保该函数将用户重定向到登录表单。
3. 在另一个页面上成功尝试登录后，将用户重定向到的值successUrl。
4. 替换的值doShowSubmission用你设计的功能。Bazaarvoice在加载提交表单之前调用这个函数。此函数可用于显示灯箱或切换到必须加载提交表单的选项卡。

5. 替换的值onSubmissionReturn有你自己设计的功能。Bazaarvoice在提交完成后调用此函数。此函数可用于关闭灯箱或切换到加载提交表单的选项卡。

   onSubmissionReturn仅在提交前未将用户重定向到登录页面时调用。如果用户被重定向，onSubmissionReturn没有调用。相反，在用户被重定向到登录页面之前，会使用URL刷新页面。定义submissionReturnUrl重写此URL。

6. 替换的值doScrollSubmission用你设计的功能。Bazaarvoice在显示/更新提交表单后调用此函数。此函数可用于通过返回来防止默认滚动行为假。

7. 放置以下内容div元素，您希望在产品或类别页面上加载提交表单的位置。

   < divid =“BVSubmissionContainer”> < / div >

   或者，将提交表单加载到不同的div元素，例如div其中主要Bazaarvoice内容加载，覆盖提交div名称，如下例所示的评级和评论。

   BV美元。用户界面（＂rr＂，＂show_reviews＂，｛productId：＂A1234＂，submissionContainerDiv：＂BVRRContainer＂});

   当此代码与示例结合使用时BV.configure美元，“写评论”链接会导致提交表单加载到显示评论主块的位置。

实现同页提交(附加选项)

虽然Bazaarvoice支持同页提交，但必须定义额外的配置选项以考虑所有用户交互。

即使启用了同页提交，也建议您构建一个独立的提交容器，以便在电子邮件活动期间驱动用户生成内容的提交。

下面的示例代码提供了必须实现的代码存根，以支持同页提交。

<脚本类型=“text / javascript”>BV美元。配置（＂全球＂，｛allowSamePageSubmission：真正的，doShowSubmission：函数（）｛myExampleShowLightbox（＂Submission_Lighbox＂）;}，onSubmissionReturn：函数（）｛myExampleCloseLightbox（＂Submission_Lighbox＂）;}，doScrollSubmission：函数（）｛myExampleScrollToSubmission();返回假；｝});> < /脚本

对该代码进行以下更改:

1. 替换的值doShowSubmission用你设计的功能。Bazaarvoice在加载提交表单之前调用这个函数。此函数可用于显示灯箱或切换到必须加载提交表单的选项卡。
2. 替换的值onSubmissionReturn用你设计的功能。Bazaarvoice在提交完成后调用此函数。此函数可用于关闭灯箱或切换到加载提交表单的选项卡。
3. 替换的值doScrollSubmission用你设计的功能。Bazaarvoice在显示/更新提交表单后调用此函数。这个函数可以通过返回false来防止默认的滚动行为。

4. 放置以下内容div元素，您希望在产品或类别页面上加载提交表单的位置。

   < divid =“BVSubmissionContainer”> < / div >

   或者，将提交表单加载到不同的div元素，例如div其中主要Bazaarvoice内容加载，覆盖提交div名称，如下例所示的评级和评论。

   BV美元。用户界面（＂rr＂，＂show_reviews＂，｛productId：＂A1234＂，submissionContainerDiv：＂BVRRContainer＂});

当此代码与示例结合使用时BV.configure美元，“写评论”链接会导致提交表单加载到显示评论主块的位置。

使用JavaScript事件回调跟踪事件

使用JavaScript事件回调将访问者与Bazaarvoice用户生成内容(UGC)交互的详细信息发送到单个JavaScript函数。

使用事件回调函数，您可以将有关访问者与UGC交互的粒度信息传递给您的用户网络分析提供商只需从事件回调中选择想要捕获的信息。

JavaScript事件回调的常见用法包括:

• 跟踪提交表单的进度和放弃率。
• 确定产品的平均评级和评论数量。这些信息有助于建立评级或评论计数与产品转化率之间的关系。
• 根据钩子提供的信息(如提交过程的当前阶段)动态生成页面的各个部分。

有关其他指导，请参阅以下内容JavaScript事件回调代码的例子。

事件回调示例

要使用事件回调，请指定onEvent制作时的选项BV美元API调用。

<脚本类型=“text / javascript”>BV美元。用户界面（＂rr＂，＂show_reviews＂，｛productId：＂XXXXX＂，onEvent：函数（json）｛如果（json。eventSource= =＂行动＂）｛myExampleAnalyticsTrackEvent（＂Bazaarvoice互动发生了＂）;｝｝});> < /脚本

评级和评论的事件变量

属性相关联的特定变量，请参见下表属性评级和评论中的变量。

请参阅属性参数获取更详细的信息。

评级和评论的例子

<脚本类型=“text / javascript”>BV美元。用户界面（＂rr＂，＂show_reviews＂，｛productId：＂XXXXX＂，onEvent：函数（json）｛警报（json。属性。numReviews）;｝});> < /脚本

问题和答案的事件变量

属性相关联的特定变量，请参见下表属性问题与答案中的变量。

问答示例

<脚本类型=“text / javascript”>BV美元。用户界面（＂质量保证＂，＂show_questions＂，｛productId：＂XXXXX＂，subjectType：＂产品＂，onEvent：函数（json）｛警报（json。属性。numQuestions）;｝});> < /脚本

所有Bazaarvoice产品的事件变量必威手机版本

属性相关联的特定变量，请参见下表属性变量在所有Bazaarvoice产品。必威手机版本

例子

<脚本类型=“text / javascript”>BV美元。用户界面（＂质量保证＂，＂show_questions＂，｛productId：＂XXXXX＂，subjectType：＂产品＂，onEvent：函数（json）｛警报（json。属性。mediaType）;｝});> < /脚本

额外的“分析”事件变量

下表确定了您可以使用的其他分析变量。

联系Bazaarvoice客户服务获取分析变量的全面列表。

事件回调报告参数和值

传入回调参数的值可以传递给您的web分析提供商:

• 跟踪的粒度取决于您选择传递给web分析提供商的参数。

• 您可以捕获的粒度级别是非常灵活的。您可以组合传递到不同参数中的值，以跟踪发生的交互类型。

例如，您可以将一个值传递给您的web分析提供商，以指示访问者已经阅读了评论。或者为相同的交互传递更细粒度的信息，例如产品ID、平均评级、评论数量和触发读取操作的交互。

以下类型的参数与事件回调相关:

• 参数为总是通过了到JavaScript事件回调的JSON对象。
• 参数为有时通过到JavaScript事件回调的JSON对象(取决于发生的事件)。
• 相关联的参数产品相关属性-当Bazaarvoice发生事件时捕获。

eType(始终传递)

的eType参数回答了“发生了什么一般类型的交互?”使用它来确定Bazaarvoice内容所发生的事件的总体类型。

此参数对特定的访问者交互进行分组，以提供正在阅读、贡献或支持内容的访问者的概述。

eventTarget(始终传递)

使用eventTarget参数来识别Bazaarvoice访问者交互的内容类型。

• 示例1:如果eType值为写通过问答,eventTarget识别访问者是在写问题还是回答。
• 示例2:如果eType值为写使用R&R,eventTarget标识访问者是否正在撰写评论或评论。

的eventTarget参数可以包含下表中的任意值:

eName(有时传递)

使用eName参数回答了“发生了什么特定类型的事件?”用户生成的Bazaarvoice内容。例如，用户是否单击、共享或对内容进行排序。

例如，如果访问者对评论进行排序，则此操作将被捕获为一般的读取操作eType。然而,eName参数指示读取操作是作为访问者排序内容的结果发生的。

的eName参数可以包含下表中的任意值:

pageStatus(有时传递)

的pageStatus参数用于测量在试图提交Bazaarvoice内容时收到错误的访问者数量。它描述了显示给访问者的错误消息。它回答了“当访问者试图提交内容或反馈时，会收到哪种类型的错误消息?”

这个指标通过确定访问者在编写内容时是否遇到困难来帮助衡量内容提交过程中的放弃程度。

如果存在,pageStatus必须包含下表中的一个值:

属性(与产品相关联)

的属性参数回答了“访问者正在浏览的产品的bazaarvoice相关属性是什么?”

使用属性参数来测量值，例如:

• 产品的平均评级
• 查看产品时出现的评论数

的属性参数可以包含下表中的任意值: