Bazaarvoice开发者门户|产品展示

⚠

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

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

内容

（+显示 ——隐藏）

返回Product数据。

例子

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

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

请求所有产品必威手机版本

https://stg.api.bazaarvoice.com/data/必威手机版本products.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4

按ID请求产品

https://stg.api.bazaarvoice.com/data/必威手机版本products.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=id:data-gen-2s9kaf0ugzn0p2flzl73ahuys

您可以根据ID请求多个产品，ID之间用逗号分隔，例如fil必威手机版本ter= ID:0001,0002,0003。

按ID请求产品，包括评论统计信息(包括平均评级)

这个示例调用展示了如何使用stats参数来检索特定产品的评论统计信息(包括平均评分)。

https://stg.api.bazaarvoice.com/data/必威手机版本products.json?apiversion=5.4&passkey=caB45h2jBqXFw1OE043qoMBD1gJC8EwFNCjktzgwncXY4&filter=id:data-gen-2s9kaf0ugzn0p2flzl73ahuys&stats =评论

结果返回的产品在外部ID、产品名称、产必威手机版本品品牌、产品描述、类别名称、类别层次结构名称中同时具有large和dryer。

在创建API密钥时，不会自动启用产品的全文搜索必威手机版本。请在请求API密钥以启用搜索后联系我们的支持团队。

参数

的名字	描述	要求	默认值
`ApiVersion`	API版本，例如5.4。	是的
`(格式)`	响应格式(json)	是的
`万能钥匙`	API密钥需要验证API用户和检查访问特定客户端数据的权限。	是的
`回调`	与JSONP一起使用的回调函数名。Value为字符串，由以下字符组成:`a - z、a - z 0 - 9, _`(不含逗号)。看到JSONP教程获取更多信息。	没有
`ExcludeFamily`	布尔标志，指示是否从与所请求产品属于同一家族的其他产品中排除内容(评论、问题等)。必威手机版本此设置仅影响返回的任何嵌套内容。例如, 过滤器= productid:情商:1101包括= reviews&excludeFamily = true 将返回的评审内容限制为产品1101的评审内容，而不是同一家族中的任何产品。必威手机版本如果未定义值，则返回家族中所有产品的内容。必威手机版本	没有	假
`过滤器`	查询主要内容的筛选条件。支持多个过滤条件。	没有
`Filter_(类型)`	包含的嵌套内容的过滤选项。TYPE可以是任何相关的内容，即评论、问题、答案、评论、作者、类别。	没有
`IncentivizedStats`	如果设置为`真正的`，显示的个数鼓励评论类中的响应中返回的每个产品`IncentivizedReviewCount`元素。参数必须与`FilteredStats`或`统计数据`参数，以在响应中包含评审的统计信息。	没有	假
`包括`	包括相关主题(如产品、类别、作者、评论、问题)。必威手机版本	没有	只返回产品信息
`限制`	返回的最大记录数。如果传递的值超过100，则返回错误。	没有	10
`Limit_(类型)`	返回的嵌套内容类型的限制选项。类型可以是任何相关的内容，即评论，问题，答案，评论，作者，类别。如果传递的值超过20，则返回错误。	没有	10
`语言环境`	中显示标签、配置、产品属性和类别属性。默认值是与API键关联的显示中定义的区域设置。	没有
`抵消`	返回结果所在的索引。默认情况下，在发出查询时，索引从0开始。使用Limit=100, Offset=0返回0-99的结果。当将其更改为Offset=1时，将返回结果1-100。最大支持300000。	没有	0
`搜索`	全文搜索字符串用于查找UGC。有关默认搜索哪些字段的详细信息，请参见API的对话页面。使用搜索时不能对结果进行排序。	没有
`排序`	查询的主要内容类型的排序条件。需要排序顺序(asc或desc)。支持对每个内容/主题类型进行多属性排序。	没有
`Sort_(类型)`	嵌套内容的排序选项。需要排序顺序(asc或desc)。TYPE可以是任何相关的内容，即评论、问题、答案、评论、作者、类别。	没有
`统计数据`	应该为产品计算统计信息的内容类型。可用的内容类型有:评论、问题、答案。注:统计数字也可以计算包括。	没有

过滤选项

每个筛选器参数指定要筛选的属性，后跟以逗号分隔的值列表。例如，"Filter=Id:eq:50,75"将匹配Id为50或75的所有product。必威手机版本
先进的运营商可用于定义筛选器。例如，"Filter=Id:lte:100"将匹配Id值小于或等于100的所有product。必威手机版本文档中记录了所有高级操作符API的对话页面。
如果过滤器值包含逗号或冒号，则该字符需要用反斜杠(\，或\:)转义。如果筛选值包含&号(&)，该&号必须在筛选值中编码，用%26替换&。
多个过滤器被允许作为URL参数，在这种情况下过滤器是AND的。例如，"filter=IsActive:eq:false&filter=IsDisabled:eq:false"将匹配所有既非激活也非禁用的产品。必威手机版本

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

的名字	描述
`Id`	内容/主题类型的标识符。
`AverageOverallRating`	在此产品上所写的评论的平均总体评分。
`CategoryAncestorId`	产品所属的产品类别的祖先标识符。使用此筛选器时，聚合内容将不会返回。
`被标记`	产品所属的产品类别的标识符。
`IsActive`	布尔标志，指示产品是否处于活动状态。
`IsDisabled`	布尔标志，指示产品是否已禁用。
`的名字`	产品名称。
`TotalAnswerCount`	关于产品的问题的回答的数量。
`TotalQuestionCount`	为产品编写的问题数量。
`TotalReviewCount`	为产品编写的评论的数量。

排序选项

需要排序顺序(asc或desc)。没有违约。
通过对内容/主题类型使用逗号分隔的排序标准列表，支持多属性排序。例如=评级:asc submissiontime: desc

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

的名字	描述
`Id`	内容/主题类型的标识符。
`AverageOverallRating`	在此产品上所写的评论的平均总体评分。这并没有考虑到联合内容。
`被标记`	产品所属的产品类别的标识符。
`IsActive`	布尔标志，指示产品是否处于活动状态。
`IsDisabled`	布尔标志，指示产品是否已禁用。
`的名字`	产品名称。
`TotalAnswerCount`	关于产品的问题的回答的数量。
`TotalQuestionCount`	为产品编写的问题数量。
`TotalReviewCount`	为产品编写的评论的数量。这并没有考虑到联合内容。

响应格式

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

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

响应的元素

的名字	描述
`包括`	包括与主要结果相关的结果。例如，使用请求`reviews.json吗?包括=评论`， Include节点将填充与Results节点中的评审相关联的注释。
`HasErrors`	布尔值，表示是否发生了一个或多个错误。参见下面的错误。
`抵消`	用于分页的数据集偏移量(在查询请求中作为URL参数传递)。最大支持300000。
`TotalResults`	匹配的记录总数。
`语言环境`	按与客户端实例关联的区域(language_region)指示语言。这是API返回的字段标签的值，而不是审查起源于的区域。
`错误`	如果查询语法错误或执行查询时出现问题，则填充Error部分而不是其他字段。
`结果`	节，其中包含与查询匹配的基元类型对象引用数组。
`限制`	返回的结果总数，由用户在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_SEARCH_ATTRIBUTE`	无效的搜索属性名称或不支持搜索
`ERROR_PARAM_INVALID_SORT_ATTRIBUTE`	无效的排序属性名称
`ERROR_REQUEST_LIMIT_REACHED`	速率限制错误，即每个时间间隔请求太多
`ERROR_UNKNOWN`	未知错误(例如，内部服务器错误)
`ERROR_UNSUPPORTED`	对于不支持的功能，客户端等。

搜索表单

产品显示

例子