API的对话:检索并提交消费者生成的内容(CGC),检索您的产品目录和关于CGC的统计信息。
评论显示
对话API允许您以编程方式检索和提交Bazaarvoice对话数据以在应用程序中使用。要了解更多信息,请参阅对话API文档主页。
内容
(+显示
——隐藏)
返回评论上发布的评论
例子
⚠
仅供演示用途。不要在应用程序中重用下面的API密码。
审查的例子
请求对特定评审的所有评论
请求特定的审查注释
高级评论请求
这个请求说明了如何使用多个过滤器(只需要添加另一个&filter=[filter]部分)、请求额外的内容(include=[content])、排序(sort=[attribute]:[order])、限制结果计数和请求结果的第二页。
可以以逗号分隔的形式提供多个值,例如所包含的作者、评论、必威手机版本产品和类别相关的评论。
请求所有本地(非联合)评审意见
⚠
仅限本地(非联合)内容。更多细节请继续阅读。
类的此内容类型请求ProductId
,AuthorId
,CategoryAncestorId
,SubmissionId
,或评论Id
过滤器将只工作于API键配置为排除联合内容。
我们建议使用可显示内容导出服务来下载您的所有本地和联合内容。如果你仍然喜欢对话API,那么你可以联系我们的支持团队重新配置对话API键。
参数
名字 | 描述 | 要求 | 默认值 |
---|---|---|---|
ApiVersion |
API版本,例如5.4。 | 是的 | |
(格式) |
回应格式(xml或json) | 是的 | |
万能钥匙 |
API密钥需要验证API用户和检查访问特定客户端数据的权限。 | 是的 | |
属性 |
返回内容时要包含的属性。例如,如果包含和&attributes=ModeratorCodes参数一起被请求,则包含和结果都将包含主持人代码。为了通过ModeratorCode进行筛选,您必须请求ModeratorCodes属性参数。 | 没有 | |
回调 |
与JSONP一起使用的回调函数名。Value为字符串,由以下字符组成:a - z、a - z 0 - 9, _ (不含逗号)。看到JSONP教程获取更多信息。 |
没有 | |
ExcludeFamily |
布尔标志,指示是否从与所请求产品属于同一族的其他产品中排除内容。必威手机版本例如,"&filter=productid:eq:1101& excludefamily =true"将返回的内容限制为产品1101的内容,而不是同一家族中的任何产品。必威手机版本如果未定义值,则返回家族中所有产品的内容。必威手机版本 | 没有 | 假 |
过滤器 |
查询主要内容的筛选条件。支持多个过滤条件。 | 没有 | |
包括 |
相关主题应包括在回应中。可以是一个或多个(逗号分隔)评论、产品、类别或必威手机版本作者。 | 没有 | 如果没有指定,只返回注释 |
限制 |
返回的最大记录数。如果传递的值超过100,则返回错误。 | 没有 | 10 |
语言环境 |
中显示标签、配置、产品属性和类别属性。默认值是与API键关联的显示中定义的区域设置。 | 没有 | |
抵消 |
返回结果所在的索引。默认情况下,在发出查询时,索引从0开始。使用Limit=100, Offset=0返回0-99的结果。当将其更改为Offset=1时,将返回结果1-100。最大支持300000。 | 没有 | 0 |
搜索 |
全文搜索字符串用于查找UGC。有关默认搜索哪些字段的详细信息,请参见API的对话页面。 注意:这将使排序选项无效,因为搜索在返回的数据中具有优先级。 |
没有 | |
Search_(类型) |
包含内容的搜索选项,后面跟着全文搜索字符串。看到API的对话页中搜索所包含数据的示例。 注意:这将使排序选项无效,因为搜索在返回的数据中具有优先级。 |
没有 | |
排序 |
注释的排序标准。支持多属性排序。 |
没有 | 如果未指定,则按提交时间排序 |
统计数据 |
将在所包含的主题上计算的统计数据类型。可用的内容类型有:评论、问题、答案。注意:并非所有统计内容类型都适用于所有可能的include。 |
没有 |
过滤选项
- 每个筛选器参数指定要筛选的属性,后跟以逗号分隔的值列表。例如,“Filter=TotalFeedbackCount:eq:3,4”将匹配TotalFeedbackCount值等于3或4的所有内容。
- 先进的运营商可用于定义筛选器。例如,"Filter=TotalFeedbackCount:lte:10"将匹配评分值小于或等于10的所有内容。文档中记录了所有高级操作符API的对话页面。
- 如果过滤器值包含逗号或冒号,则该字符需要用反斜杠(\,或\:)转义。如果筛选值包含&号(&),该&号必须在筛选值中编码,用%26替换&。
- 多个过滤器被允许作为URL参数,在这种情况下过滤器是AND的。例如,"Filter=TotalFeedbackCount:gt:10&Filter=IsFeatured:true"将匹配TotalFeedbackCount值大于10的所有精选内容。
- 基于时间的过滤器可以用于SubmissionTime, LastModificationTime和LastModeratedTime。基于时间的过滤器中的日期是按照自1970年1月1日00:00:00 UTC以来的秒数计算的。在未来的版本中,我们将添加对比较日期/时间字符串值的支持。下面的示例返回在2009年11月9日提交的内容:&filter=SubmissionTime:gt:1257746400&filter=SubmissionTime:lt:1257832800
下表列出了可用于过滤的属性。
名字 | 描述 |
---|---|
Id |
内容/主题类型的标识符。 |
AuthorId |
编写内容的作者的标识符。 |
CampaignId |
与内容关联的Campaign的标识符 |
CategoryAncestorId |
产品类别祖先的标识符。使用此筛选器时,聚合内容将不会返回。 |
ContentLocale |
要显示的内容的区域设置。如果未定义此筛选器,则返回所有内容(无论其语言环境如何)。若要按地区返回特定内容,请在筛选器中定义值。通配符“*”可以用来定义值,例如,“en*”返回所有英文内容(en_US, en_CA, en_GB等),或者您可以使用单个ContentLocale代码(例如,“fr_FR”)。ContentLocale代码区分大小写。 |
HasPhotos |
PRR布尔标志,指示内容是否有照片 |
HasVideos |
|
IsFeatured |
布尔标志,指示内容是否具有特色 |
LastModeratedTime |
内容最近一次审核的日期/时间。有关使用高级操作符进行过滤的示例,请参见介绍。 |
LastModificationTime |
内容最近一次修改的日期/时间。有关使用高级操作符进行过滤的示例,请参见介绍。 |
ModeratorCode |
表示被拒绝内容的主持人代码的字符串值,例如,&Filter=ModeratorCode:eq:CR返回包含CR(竞争对手参考)代码的UGC。可以在逗号分隔的列表中输入多个代码,例如,&Filter=ModeratorCode:eq:CS,IU返回带有CS(客户服务投诉)或IU(不适当/不可用内容)代码的UGC。有关所有主持人代码的列表,请参见API的对话页面。注意,为了使用这个筛选器,必须显式地请求ModeratorCodes属性参数。请参阅上面的参数部分。 |
ProductId |
产品的标识符 |
ReviewId |
评论的标识符 |
这将返回发布在指定评审上的评论