Bazaarvoice开发者门户|评论显示

⚠

只有我们的API密钥对话平台有资格使用此API版本。请参阅平台本处平台和API概念以了解您的API密钥所在的平台。

Conversations API允许您以编程方式检索和提交Bazaarvoice Conversations数据，以便在应用程序中使用。要了解更多信息，请参阅对话API文档主页．

内容

（+显示 ——隐藏）

返回发表在评论上的评论。

例子

下面的示例演示了常见的Conversations API显示请求。有关使用Conversations API显示数据的完整概述，请参阅显示教程．

⚠ 仅用于演示目的。不要在应用程序中重用下面的API密钥。

请求对特定审查的所有评论

https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=reviewid:16970457

这将返回发布在指定评审上的评论

请求特定的审查意见

https://stg.api.bazaarvoice.com/data/reviewcomments.json?ApiVersion=5.4&PassKey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&Filter=Id:338201

高级评论请求

https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=productid:data-gen-3jxhm78sfqfy8tg5qyinqioal&include=authors,必威手机版本products,categories&sort=totalpositivefeedbackcount:desc&limit=4&offset=4

这个请求说明了使用多个过滤器(只需添加另一个&filter=[filter]部分)，请求额外的内容(include=[content])，排序(sort=[attribute]:[order])，限制结果计数并请求结果的第二页。

可以以逗号分隔的形式提供多个值，例如所包含的作者、评论、产品和与评论相关的类别的内容类型。必威手机版本

请求所有本地(非联合)审查意见

⚠

仅限本地(非联合)内容。继续阅读了解更多细节。

https://stg.api.bazaarvoice.com/data/reviewcomments.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4

此内容类型的请求不包含ProductId，AuthorId，CategoryAncestorId，SubmissionId，或注释Id过滤器将只适用于配置为排除联合内容的API密钥。

我们建议使用可显示内容导出服务下载所有的本地和辛迪加内容。如果你仍然喜欢对话API，那么你可以联系我们的支持团队重新配置会话API密钥。

参数

名字	描述	要求	默认值
`ApiVersion`	API版本，例如5.4。	是的
`(格式)`	响应格式(json)	是的
`万能钥匙`	需要API密钥来验证API用户并检查访问特定客户端数据的权限。	是的
`属性`	返回内容时要包含的属性。例如，如果包含和&attributes=ModeratorCodes参数一起被请求，则包含和结果都将包含主持人代码。为了通过ModeratorCode进行过滤，您必须请求ModeratorCodes属性参数。	没有
`回调`	JSONP使用的回调函数名称。取值是由以下字符组成的字符串:`a - z、a - z 0 - 9, _`(不含逗号)。看到JSONP教程获取更多信息。	没有
`ExcludeFamily`	布尔标志，指示是否排除与所请求产品相同家族中的其他产品的内容。必威手机版本例如, 过滤器= productid:情商:1101 &excludefamily = true 限制返回的内容仅为产品1101的内容，而不是同一系列中的任何产品的内容。必威手机版本如果未定义值，则返回家族中所有产品的内容。必威手机版本	没有	假
`过滤器`	查询的主要内容的过滤条件。支持多个过滤条件。	没有
`包括`	相关主题将包括在回应中。可以是评论、产品、类别或作者中的一个或多个(逗号分隔)。必威手机版本	没有
`限制`	返回的最大记录数。如果传递的值超过100，则返回错误。	没有	10
`语言环境`	区域设置以显示标签、配置、产品属性和类别属性。默认值是与API键关联的显示中定义的区域设置。	没有
`抵消`	返回结果的索引。默认情况下，在发出查询时，索引从0开始。使用Limit=100, Offset=0返回结果0-99。当将其更改为Offset=1时，将返回结果1-100。最大支持300000。	没有	0
`排序`	注释的排序标准。支持多属性排序。	没有	如果未指定，则按SubmissionTime排序

过滤选项

每个筛选器参数指定要筛选的属性，后面跟着以逗号分隔的值列表。例如，“Filter=TotalFeedbackCount:eq:3,4”将匹配TotalFeedbackCount值等于3或4的所有内容。
先进的运营商可用于定义过滤器。例如，“Filter=TotalFeedbackCount:lte:10”将匹配评级值小于或等于10的所有内容。所有高级操作都记录在API的对话页面。
如果过滤器值包含逗号或冒号，则需要用反斜杠(\或\:)转义该字符。如果筛选值包含&，则必须将&替换为%26，从而在筛选值中对&进行编码。
多个过滤器被允许作为URL参数，在这种情况下过滤器是与的。例如，“Filter=TotalFeedbackCount:gt:10&Filter=IsFeatured:true”将匹配TotalFeedbackCount值大于10的所有特色内容。
基于时间的过滤器可以用于SubmissionTime, LastModificationTime和LastModeratedTime。基于时间的过滤器中的日期计算为自UTC时间1970年1月1日00:00:00以来的秒数。在未来的版本中，我们将增加对比较日期/时间字符串值的支持。下面的示例返回2009年11月9日提交的内容:&filter=SubmissionTime:gt:1257746400&filter=SubmissionTime:lt:1257832800

下表列出了可用于过滤的属性。

名字	描述
`Id`	内容/主题类型的标识符。
`AuthorId`	编写内容的作者的标识符。
`CampaignId`	与内容相关联的活动标识符
`CategoryAncestorId`	产品类别祖先的标识符。使用此过滤器时，将不会返回联合内容。
`ContentLocale`	要显示的内容的区域设置。如果未定义此筛选器，则返回所有内容，而不考虑其区域设置。若要按地区返回特定内容，请在筛选器中定义值。可以使用通配符“”来定义值，例如，“en”返回所有英文内容(en_US, en_CA, en_GB等)，或者您可以使用单个ContentLocale代码(例如，“fr_FR”)。ContentLocale代码区分大小写。
`IsFeatured`	布尔标志，指示内容是否具有特色
`IsSyndicated`	布尔标志，允许您选择是否返回银团或者非联合评论。如果IsSyndicated:eq:true，则响应只返回联合内容和一个synationsource块，其中包含联合来自何处的详细信息。如果IsSyndicated:eq:false，响应只返回本机(非syndicated)内容。注意:API密钥必须配置为显示联合内容。
`LastModeratedTime`	最近一次内容审核的日期/时间。有关使用高级操作符进行过滤的示例，请参阅前言。
`LastModificationTime`	内容最近修改的日期/时间。有关使用高级操作符进行过滤的示例，请参阅前言。
`ModeratorCode`	表示被拒绝内容的主持人代码的字符串值，例如，&Filter=ModeratorCode:eq:CR返回包含CR(竞争对手参考)代码的UGC。多个代码可以在逗号分隔的列表中输入，例如，&Filter=ModeratorCode:eq:CS,IU返回的UGC带有CS(客户服务投诉)或IU(不适当/不可用的内容)代码。有关所有主持人代码的列表，请参见API的对话页面。注意，要使用此过滤器，必须显式请求ModeratorCodes属性参数。请参阅上面的参数部分。
`ProductId`	产品的标识符
`ReviewId`	评审的标识符
`SubmissionId`	最初提交内容时分配给内容的提交标识符
`SubmissionTime`	提交内容的日期/时间。有关使用高级操作符进行过滤的示例，请参阅前言。
`TotalFeedbackCount`	收到的反馈数量
`TotalNegativeFeedbackCount`	收到的负面反馈数量
`TotalPositiveFeedbackCount`	收到正面反馈的数目
`UserLocation`	作者所在地

排序选项

排序条件指定为< Sort option>:asc(升序)和< Sort option>:desc(降序)
通过对内容/主题类型使用逗号分隔的排序标准列表来支持多属性排序。例如Sort=TotalFeedbackCount:desc,TotalPositiveFeedbackCount:asc按收到的反馈数量降序排序，然后按收到的积极反馈数量升序排序

下表列出了可用于排序的属性。

名字	描述
`Id`	内容/主题类型的标识符。
`AuthorId`	撰写内容的作者的标识符
`CampaignId`	与内容相关联的活动标识符
`ContentLocale`	内容的区域设置值
`IsFeatured`	布尔标志，指示内容是否具有特色
`IsSyndicated`	布尔标志，指示内容是否已银团．
`LastModeratedTime`	内容最近一次审核的日期/时间
`LastModificationTime`	内容最近修改的日期/时间
`ProductId`	产品的标识符
`ReviewId`	评审的标识符
`SubmissionId`	最初提交内容时分配给内容的提交标识符
`SubmissionTime`	提交内容的日期/时间
`TotalFeedbackCount`	收到的反馈数量
`TotalNegativeFeedbackCount`	收到的负面反馈数量
`TotalPositiveFeedbackCount`	收到正面反馈的数目
`UserLocation`	作者所在地

响应格式

这是请求审查评论的示例响应。使用上面的链接查看实际示例。

{"包括":{},“HasErrors”:假的,“抵消”:0,“TotalResults”:224775年,“语言环境”:“en_US”,“错误”:[],“结果”:[{…}{…}]，“Limit”:2}

响应的元素

名字	描述
`包括`	纳入与主要结果相关的结果。例如，请求`reviews.json吗?包括=评论`， Include节点将填充与Results节点中的评审相关联的注释。
`HasErrors`	布尔值表示是否发生了一个或多个错误。请参阅下面的错误。
`抵消`	用于分页的数据集偏移量(在查询请求中作为URL参数传递)。最大支持300000。
`TotalResults`	匹配的记录总数。
`语言环境`	指定与客户端实例关联的语言区域(language_region)。这是API返回的字段标签所使用的值，而不是评审产生的区域。
`错误`	如果查询语法错误或执行查询时出现问题，则填充错误部分，而不是填充其他字段。
`结果`	节，其中包含与查询匹配的基本类型对象引用数组。
`限制`	返回的结果总数，由用户在URL中指定。默认值为10，最多100个。

错误代码

价值	描述
`ERROR_ACCESS_DENIED`	执行操作的权限不足
`ERROR_PARAM_INVALID_API_KEY`	无效的API键值
`ERROR_PARAM_INVALID_CALLBACK`	无效的JsonP回调函数名称
`ERROR_PARAM_INVALID_FILTER_ATTRIBUTE`	无效的过滤器属性名称
`ERROR_PARAM_INVALID_INCLUDED`	无效的参数值
`ERROR_PARAM_INVALID_LIMIT`	无效极限值
`ERROR_PARAM_INVALID_LOCALE`	无效的语言环境代码
`ERROR_PARAM_INVALID_OFFSET`	无效的偏移值
`ERROR_PARAM_INVALID_SORT_ATTRIBUTE`	排序属性名称无效
`ERROR_REQUEST_LIMIT_REACHED`	速率限制错误，即每个时间间隔内请求太多
`ERROR_UNKNOWN`	未知错误(例如，内部服务器错误)
`ERROR_UNSUPPORTED`	对于不支持的特性，客户端等。

搜索表单

评论显示

例子