只有API键在我们的对话平台都有资格使用这个API版本。请参阅平台本处平台和API概念文档,以了解您的API密钥在哪个平台上。

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

内容

+显示 ——隐藏

返回基于产品的回顾统计数据和问答统计数据。此方法已经过优化,用于内联评级显示。

例子

仅供演示用途。不要在应用程序中重用下面的API密码。

请求一个产品的本机评审统计信息

请求一个产品的审查统计信息

请求一个产品的本机评审和评审统计信息

请求多个产品的本机评审和评审统计信息必威手机版本

请求一个产品的北美内容的统计信息

请求一个产品的问题和答案统计

下面的所有示例都将提供相同的响应

请求多个产品的问题和答案统计必威手机版本

请求对一个产品进行本机评审、评审和问答统计

参数

的名字 描述 要求 默认值
万能钥匙 API密钥需要验证API用户和检查访问特定客户端数据的权限。 是的
ApiVersion API版本,例如5.4。 是的
过滤器 查询内容的过滤条件。必须是产品id。 是的
统计数据

将在所包含的主题上计算的统计数据类型。可用的内容类型是:评论,NativeReviews,问题,答案。

  • 评论:返回所有评论的统计数据,包括联合内容(如果在API键上启用)。
  • NativeReviews:只返回在你的网站上提交的评论的统计数据;联合内容和产品家族内容不包括在内。
  • 问题,答案:返回问题和答案的统计信息。

注意:使用逗号分隔提供多种内容类型

是的
回调 与JSONP一起使用的回调函数名。Value为字符串,由以下字符组成:a - z、a - z 0 - 9, _(不含逗号)。看到JSONP教程获取更多信息。 没有
IncentivizedStats 如果设置为真正的,显示的个数鼓励评论类中的响应中返回的每个产品IncentivizedReviewCount元素。参数必须与统计数据参数。 没有

过滤选项

  • 每个筛选器参数指定要筛选的属性,后跟以逗号分隔的值列表。例如,"Filter=ProductId:eq:Product1,Product2"返回Product1和Product2的统计信息。
  • 如果过滤器值包含逗号或冒号,则该字符需要用反斜杠(\,或\:)转义。如果筛选值包含&号(&),该&号必须在筛选值中编码,用%26替换&。

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

的名字 描述
ContentLocale 用于计算统计信息的内容的区域设置。通配符“*”可以用来定义值,例如,“en*”返回所有英文内容(en_US, en_CA, en_GB等)。这个过滤器的两个有效操作符是等于(eq)和不等于(neq)。
ProductId
将在结果中返回的产品标识符。必威手机版本此过滤器是必需的。在过滤器中使用时,存在100个productid的限制。

响应格式

这是请求审查的示例响应。使用上面的链接查看现场示例。

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

这是一个请求问题和答案的示例响应。使用上面的链接查看现场示例。

{"Includes": {}, "HasErrors": false, "Offset": 0, "TotalResults": 1, "Locale": "en_US", "Errors": [], "Results": [{"Prod必威手机版本uctStatistics":{"ProductId": "data- gen2s9kaf0ugzn0p2flzl73ahuys ", "NativeReviewStatistics": {}, "ReviewStatistics": {}, "QAStatistics":{"TotalQuestionCount": 21, "TotalAnswerCount": 27}}}], "Limit": 1}

响应的元素

的名字 描述
包括
总是空的
HasErrors
布尔值,表示是否发生了一个或多个错误。参见下面的错误。
抵消
用于分页的数据集偏移量(在查询请求中作为URL参数传递)。最大支持300000。
TotalResults
匹配的记录总数。
语言环境
按与客户端实例关联的区域(language_region)指示语言。这是API返回的字段标签的值,而不是审查起源于的区域。
错误
如果查询语法错误或执行查询时出现问题,则填充Error部分而不是其他字段。
结果
节,其中包含与查询匹配的基元类型对象引用数组。
限制
返回的结果总数,由用户在URL中使用上面描述的ProductId筛选器参数指定。

错误代码

价值 描述
ERROR_PARAM_INVALID_API_KEY

无效的API键值

ERROR_PARAM_INVALID_FILTER_ATTRIBUTE

无效的筛选器属性名

ERROR_PARAM_INVALID_INCLUDED

无效的参数值

ERROR_PARAM_INVALID_CALLBACK

无效的JsonP回调函数名

ERROR_REQUEST_LIMIT_REACHED

速率限制错误,即每个时间间隔请求太多

ERROR_UNSUPPORTED

对于不支持的功能,客户端等。

ERROR_ACCESS_DENIED

权限不足,无法执行该操作

ERROR_UNKNOWN

未知错误(例如,内部服务器错误)