API的对话:检索并提交消费者生成的内容(CGC),检索您的产品目录和关于CGC的统计信息。
徽章
对话API允许您以编程方式检索和提交Bazaarvoice对话数据以在应用程序中使用。要了解更多信息,请参阅对话API文档主页.
内容
本教程向开发人员介绍conversation API中使用的徽章
简介
Bazaarvoice徽章允许内容和/或贡献者被识别或标记为具有额外含义。徽章可以支持“特色”内容等概念,表明贡献者在产品方面的专业知识鼓励内容以及顶级内容提供商。徽章被放置在用户生成的内容(评论、问题、答案)或贡献者上。下面讨论各种徽章类型:
落款类型
内容级徽章
内容级徽章与单个内容(评论、问题、答案)绑定,而不是与贡献者绑定。下面的列表描述了支持的内容级标记:
如果一个特别丰富的内容是可用的,可以突出它。通过将内容标记为“featured”,该操作在workbench中完成。属性从API返回“Featured”内容IsFeatured
节点的值为true,但也可以返回数据徽章
节点。获得“特色”徽章
在实现配置中完成。可以被“推荐”的内容项目数量没有限制。
启用了“Featured”徽章的示例API响应将包括:
....BadgesOrder: ["featured"],徽章:{featured: {BadgeType: "Custom", Id: "featured", ContentType: "REVIEW"}}, AuthorId: "4bn4ndfwf94", SecondaryRatingsOrder: [], IsFeatured: true, ....
使用“特色”徽章可以确保最终用户首先看到特定的特色内容。可以使用排序
参数在API请求内容。
也可以允许最终用户只过滤或查看标记为“特色”的内容。可以使用过滤器
参数。
下面是展示“特色”徽章的可能性:
样本值 | |
---|---|
图标 | |
文本 | “我们真的很喜欢这个!” |
联邦贸易委员会关于消费者生成内容的规定以及Bazaarvoice真实性政策(Bazaarvoice Authenticity Policies)要求,每当消费者因撰写评论而收到或获得实质性补偿时,评论都应显示通知(作为徽章或显示上下文数据答案)。这包括但不限于,提供给消费者的任何以下内容,以换取撰写评论:
- 进入抽奖
- 优惠券或折扣
- 忠诚奖励点数
- 免费产品,必威手机版本无论是在抽样计划之前或之后,作为感谢礼物
重要的是要以标准化的方式完成,这样激励符号也将联合到零售商并正确地显示在他们的网站上。内容的标记不需要在联合站点中显示相同,但必须存在。在一个站点上有清晰可识别的图形图标,在接下来的站点上有文本标签是可以接受的。
的落款的评论教程进一步详细介绍了在提供消费者激励时的要求。
样本值 | |
---|---|
图标 | |
文本 | 这位评测者收到了样品。 |
徽章的位置 |
已验证购买者徽章标识从给定客户端购买产品的最终用户。必威手机版本这提供了内容的真实性,因为可以保证用户确实购买了产品。
经过验证的购买者通常通过使用互动后电子邮件(PIE)来确定目标购买者。互动后电子邮件邀请你的客户对他们购买的产品、收到的服务或在你的网站、电话或实体店中的任何其他类型的互动留下评论。Bazaarvoice可以通过两种方式收集PIE数据:
- 不需维护的馅饼
- 发送基于feed的PIE
下面是一个POST的例子,购买者已经被验证:
ApiVersion = [latestApiVersion] &ProductId = [productId]行动= submit&Rating =(评级)&ReviewText = [reviewText]标题=[标题]&UserNickname =(昵称)万能钥匙= [yourKey]&contextdatavalue_VerifiedPurchaser = True
启用验证购买者标识后,API响应将包括:
....徽章:{徽章类型:"Custom", Id: " verifiedbuyer ",内容类型:"REVIEW"}}, ....
可能包括ContextDataValues
如果这样配置:
...ContextDataValues: {verifiedbuyer: {Value: "True", ValueLabel: "Yes", DimensionLabel: "Verified buyer ", Id: " verifiedbuyer "}, ....},……
以下表示“认证购买者”徽章的显示可能性:
样本值 | |
---|---|
图标 | |
文本 | “客户已确认从XYZ购买了该商品。” |
徽章的位置 | 因为经过验证的购买者徽章的主题是贡献者,所以最好将徽章定位在贡献者的昵称附近。 |
有了最佳答案徽章,社区可以投票选出它认为特定问题的“最佳”答案。这个答案,连同“最佳答案”和“最有帮助的投票”一起,被授予最佳答案徽章。徽章的应用和更新动态,基于当前的投票计数。
最佳答案徽章允许客户轻松识别高质量的内容,特别是当内容数量增加时。这种能力鼓励贡献者提交更多的答案和高质量的答案。
在实现过程中,您可以配置一个问题在“投票为最佳答案”复选框出现之前必须具有的批准答案的最小数量。因此,可以配置最佳答案徽章,使其除非满足最小阈值,否则不会出现。“投票为最佳答案”复选框和“最佳答案”徽章的阈值是相互独立配置的。
从对话API Answers端点返回的响应包含一个布尔值“IsBestAnswer”,表示该答案是否被投票为最佳。使用此参数,可以对响应进行排序和筛选。
....BadgesOrder: ["bestAnswer"],徽章:{bestAnswer: {BadgeType: "Custom", Id: "bestAnswer", ContentType: "ANSWER"}}, ....
样本值 | |
---|---|
图标 | |
文本 | “这是最好的回答!” |
可以为内容创建自定义徽章。这允许客户端更加真实地了解他们收集和显示给用户的内容。在创建支持此类数据的实现配置之后,将出现一个收集此类信息的表单,以收集用户反馈。与表单中收集的其他数据一样,值随后被post到Bazaarvoice API。也许开发者认为性别是一种值得拥有自己徽章的东西。
....BadgesOrder: [" gender - male "],徽章:{性别- male:{徽章类型:"Custom", Id: " gender - male ",内容类型:"REVIEW"}}, ......
样本值 | 男性 |
---|---|
图标 | |
文本 | ——男评论家 |
贡献者层次徽章
Bazaarvoice支持三种类型的贡献者级别徽章:隶属徽章、等级徽章和功绩徽章。这些徽章与贡献者绑定,而不是与内容片段绑定。客户端可以登录到Workbench,使用Manage contributor下的链接为现有用户id配置贡献者级别的徽章选项。
这些徽章与受雇于产品原产地的人员所生产的任何和所有内容相关联。当被识别为与客户端有关联关系的人生产内容时,该用户会被标记为“关联徽章”。的一部分Bazaarvoice的真实性政策要求公开任何关系。
附属关系并不局限于“职员”角色。配置支持自定义从属关系。
有两种方法可以指示贡献者应该显示隶属关系徽章:
- 在Bazaarvoice Workbench中,用户id和贡献者角色可以通过“贡献者设置:分配贡献者角色”页面添加/编辑。
- 在登录时,如果最终用户可以被识别为“员工”,则可以在提交时进行标记。回想一下,隶属关系徽章是特定于贡献者的(而不是特定于内容的)。为此,需要附加参数作为编码用户身份验证字符串的一部分(即affiliation=Staff)
当隶属关系标识被启用时,API响应将显示类似于:
...BadgesOrder: ["Staff"],徽章:{Staff: {BadgeType: "Affiliation", Id: "Staff", ContentType: "REVIEW"}},},…
样本值 | |
---|---|
图标 | |
文本 | “员工” “这位贡献者是产品团队的一员。” |
徽章的位置 | 此徽章与贡献者相关联,因此应该位于用户昵称附近。(图片显示在工具提示中) |
应该使用一个排名徽章来显示哪些贡献者是该产品或类别的专家。必威手机版本默认情况下,“专家”徽章作为等级徽章可用。自定义上的等级徽章名称是可能的。正如是创建了一些不同的级别。例如,创建“白金”、“金”、“银”和“铜”的等级是可能的。
有两种方法可以指示一个贡献者应该显示一个等级徽章:
- 在Bazaarvoice Workbench中,用户id可以被分配为“专家”(或自定义)状态。他们可以通过“贡献者设置:分配贡献者角色”页面添加/编辑。
- 在登录时,如果最终用户可以被识别为“专家”或其他自定义级别,则可以在提交时进行标记。排名徽章是特定于贡献者的(不是特定于内容的)。为此,需要额外的参数作为编码用户身份验证字符串的一部分(即rank=Expert)。
...BadgesOrder:["专家"],徽章:{专家:{BadgeType: "Rank", Id: "专家",内容类型:"REVIEW"}},},…
样本值 | |
---|---|
图标 | |
文本 | “专家” “我们注意到,这种供稿人通常都很详细、信息量大。” |
徽章的位置 | 此徽章与贡献者相关联,因此应该位于用户昵称附近 |
每天晚上都会自动计算出功绩徽章,并根据内容的数量和帮助程度应用于贡献者。下列级别可获颁发优异奖章:
- 第一个贡献者
- 十大贡献者
- 前25名贡献者
- 前50名贡献者
- 前100名贡献者
- 前250名贡献者
- 500强贡献者
- 前1000名贡献者
为了保持奖章的声望,Bazaarvoice会随着客户贡献者数量的增加而分配越来越多的奖章。该系统被刻意设计为为不超过20%的网站贡献者分配一个优秀徽章。
为了进一步提高获得奖章的必要要求,个人贡献者必须提供至少两个批准的贡献,即一些审查和答案的组合,才有资格获得奖章。此最小贡献阈值可由客户端配置。
对网站贡献者因素进行排名的公式包括已批准的评论、已批准的答案(用于问答)和收到的有用性投票。
样本值 | |
---|---|
图标 | |
文本 | “头号贡献者” “十大贡献者” “前25名贡献者” “前50名贡献者” “前100名贡献者” “前250名贡献者” “500强贡献者” “前1000名贡献者” |
徽章的位置 | 此徽章与贡献者相关联,因此应该位于用户昵称附近 |
先决条件
在提交和呈现徽章之前,您的实现必须配置为支持这些选项。请联系Bazaarvoice支持以查询启用选项。
提交
环境级别徽章
根据徽章的不同,数据可以通过以下三种方式之一提交。以下是提交方法以及使用它们的徽章的列表。
数据值提交
这些标记支持通过熟悉的键/值对提交API POST,但需要注意一点。该键使用配置中的徽章Id,但也带有“contextdatavalue_”前缀。一个完整的示例看起来像这样:
&contextdatavalue_IncentivizedReview = True
&contextdatavalue_VerifiedPurchaser = True
&contextdatavalue_SomeCustomBadge = 100
- 鼓励徽章
- 验证徽章
- 自定义标记
计算或推导的值
在这种情况下不需要提交。每天晚上进行计算,以确定要标记的正确内容。
- 最佳答题徽章
设置“特色”徽章只能通过Workbench进行。除了指示特定的内容片段是特色的外,客户端配置还必须启用特色的徽章。
贡献者层次徽章
在贡献者级别的徽章中,只有隶属关系和排名徽章可以通过带有用户生成内容的API提交。提交贡献者级别的徽章是通过在加密和发布之前将徽章类型(“隶属关系”或“等级”)和值(“人员”或“专家”)注入用户身份验证字符串(UAS)来完成的。特定徽章类型的值必须在提交之前存在于客户端配置中。
未编码无人机系统示例:
日期= 2015 - 10 - 23 -用户id = ID12345联系=员工
另一种为贡献者级别提供隶属关系(“员工”)或排名(“专家”)徽章的方法是通过Bazaarvoice Workbench。知识库文章分配徽章描述如何完成此操作。
显示
如何展示徽章?
对话API不会返回图像链接。Conversation API客户端的显示取决于客户端的创造性解释。在显示从API返回的徽章信息时,Bazaarvoice有几个建议。
- 当在API回复中出现时,激励和隶属关系徽章必须始终显示。该策略的详细信息见Bazaarvoice的真实性政策.
- 最多三个徽章应该显示在一个宽的显示器上。在狭窄的显示屏上只显示一个徽章。
- 可以使用图标或文本。在使用图标的情况下,其含义或定义应该很容易获得。这可能意味着包含alt文本,实现工具提示,或将在鼠标悬停事件上显示的弹出窗口。
- 上下文标识应该位于用户生成的内容(回顾、问题、答案)附近。贡献者级别的徽章应该位于贡献者标识(昵称、用户名)附近,以强调这个徽章是在个人而不是内容上。
附录
API响应示例
下面是一个包含多个标记的示例JSON响应。键/值对进一步解释如下:
....徽章:{top100贡献者:{徽章类型:“Merit”,Id:“top100贡献者”,内容类型:“REVIEW”},员工:{徽章类型:“Affiliation”,Id:“Staff”,内容类型:“REVIEW”},认证购买者:{徽章类型:“Custom”,Id:“verifiedbuyer”,内容类型:“REVIEW”}},....
BadgesOrder元素
的BadgesOrder
Array是遗留元素,可以忽略。
徽章的元素
类中包含的后续子对象名称和匹配id可以说是最重要的信息徽章
对象。单个元素由几个键/值对组成,这些键/值对进一步描述标识。的实例。Id键/值重复对象的名称,可以获取ContextDataValues
(即。“topContributor”)。
下表列出了键/值对及其定义:
-
BadgeType
- BadgeType列出徽章类别。价值观包括“功绩”、“习惯”、“隶属关系”和“等级”。这些是Bazaarvoice内部的代码。
-
Id
-
可通过badge Id获取相关信息
ContextDataValues
在配置时也可以在API响应中返回。ContextDataValues
可以包含额外的元数据,例如要显示的标签,而不是图标或工具提示副本。 -
ContentType
- 徽章ContentType指示徽章用于的特定项目。典型值为“REVIEWS”、“QUESTIONS”或“ANSWERS”。
Bazaarvoice使用图标
以下是Bazaarvoice准备的精灵表,可用于客户解决方案。
包括徽章ID作为HTML类名
显示表示标记的图标或文本的一种方法是编写徽章
Id到HTML元素的类。开发人员将知道已配置的徽章及其id,并可以准备CSS来呈现正确的图标或文本。
//遇到激励徽章
//获得激励图标。incentive{高度:80%;背景:url(../img/icon/ incentive .png)background-size:封面;text-align:中心;} //或写一些奖励的具体文本。incentive::后{内容:“-收到免费礼物”;}